Gondwana Game Engine Development (master) - 2.6.1
Gondwana is a cross-platform 2.5D game and rendering engine written in C#/.NET 8. It provides fine-grained control over rendering, timing, and scene composition, with built-in support for parallax, z-ordering, pixel overhang, collision detection, and particle effects. Gondwana targets desktop and web platforms using SkiaSharp for graphics and pluggable audio backends for desktop and browser targets.
Loading...
Searching...
No Matches
Gondwana.Widgets.Overlays.PopupWidget Class Referencesealed

Displays short-lived text or image content in view or scene-layer coordinates. More...

Inheritance diagram for Gondwana.Widgets.Overlays.PopupWidget:
Gondwana.Widgets.WidgetBase Gondwana.Drawing.Direct.DirectComposite Gondwana.Drawing.Direct.IDirectCompositeChild Gondwana.Drawing.Direct.IDirectCompositeContainer Gondwana.Drawing.Direct.IDirectDrawable Gondwana.Physics.Movement.IMovable Gondwana.Drawing.IDrawable

Public Member Functions

 PopupWidget (RenderSurfaceHostBase renderSurfaceHost, View view, Rectangle screenBounds, string text, string? nickname=null)
 Initializes a text popup in absolute view/screen coordinates.
 PopupWidget (RenderSurfaceHostBase renderSurfaceHost, SceneLayer sceneLayer, Rectangle worldBounds, string text, string? nickname=null)
 Initializes a text popup in scene-layer world coordinates.
 PopupWidget (RenderSurfaceHostBase renderSurfaceHost, Tile source, Size size, string text, WidgetAnchor sourceAnchor=WidgetAnchor.Center, Point? offsetPx=null, string? nickname=null)
 Initializes a text popup whose source is resolved from a tile when shown.
 PopupWidget (RenderSurfaceHostBase renderSurfaceHost, View view, Rectangle screenBounds, SKImage image, string? nickname=null)
 Initializes an image popup in absolute view/screen coordinates.
 PopupWidget (RenderSurfaceHostBase renderSurfaceHost, SceneLayer sceneLayer, Rectangle worldBounds, SKImage image, string? nickname=null)
 Initializes an image popup in scene-layer world coordinates.
 PopupWidget (RenderSurfaceHostBase renderSurfaceHost, View view, Rectangle screenBounds, SKBitmap bitmap, string? nickname=null)
 Initializes a bitmap popup in absolute view/screen coordinates.
 PopupWidget (RenderSurfaceHostBase renderSurfaceHost, SceneLayer sceneLayer, Rectangle worldBounds, SKBitmap bitmap, string? nickname=null)
 Initializes a bitmap popup in scene-layer world coordinates.
PopupWidget ShowPopup ()
 Shows the popup, resolves its current source, and starts its movement and fades.
PopupWidget SetSourceLocation (Point locationPx)
 Uses a fixed top-left location as the popup source.
PopupWidget BindTo (Tile source, WidgetAnchor sourceAnchor=WidgetAnchor.Center, Point? offsetPx=null)
 Resolves the popup source from an anchor point on a tile when the popup is shown.
PopupWidget BindTo (SceneLayer sceneLayer, Point gridLocation, WidgetAnchor sourceAnchor=WidgetAnchor.Center, Point? offsetPx=null)
 Resolves the popup source from a fixed grid cell when the popup is shown.
PopupWidget SetText (string text)
 Sets the popup text. Throws when this is an image popup.
PopupWidget SetFont (SKTypeface typeface, float size, float? minSize=null)
 Sets the popup font. Throws when this is an image popup.
PopupWidget SetTextColor (SKColor color)
 Sets the popup text color. Throws when this is an image popup.
PopupWidget SetPopupZOrder (int zOrder)
 Sets the popup Z-order.
void Dismiss ()
 Completes and hides the popup immediately.
override void Update (long tick)
 Advances composite movement.
Parameters
tickThe current engine tick.
This method uses the tick to calculate elapsed time and advance the movement controller. If the tick is less than or equal to the last processed tick, no update occurs.
override void Dispose ()
 Disposes the composite and every child it owns.
Public Member Functions inherited from Gondwana.Widgets.WidgetBase
virtual bool HitTest (View view, Point screenPositionPx)
 Determines whether the widget can be hit at the specified screen position within the specified view.
virtual bool HitTest (Point screenPositionPx)
 Determines whether the widget can be hit at the specified screen position.
WidgetBase Show ()
 Shows the widget and registers it for input routing.
WidgetBase Hide ()
 Hides the widget and releases any routed input state.
WidgetBase Activate ()
 Activates the widget and brings it to the front of the input order.
WidgetBase Cancel ()
 Cancels the widget.
Public Member Functions inherited from Gondwana.Drawing.Direct.DirectComposite
 DirectComposite (RenderSurfaceHostBase renderSurfaceHost, DirectDrawingMode mode, PointF anchor=default, string? nickname=null)
 Initializes a new instance of the DirectComposite class.
Vector2 GetPosition ()
 Gets the current composite anchor.
void SetPosition (Vector2 position)
 Sets the composite anchor and repositions all children from their stored offsets.
DirectComposite SetPosition (float x, float y)
 Sets the composite anchor and repositions all children from their stored offsets.
virtual DirectComposite Add (IDirectCompositeChild child, bool keepCurrentOffset=true, Vector2? explicitLocalOffsetPx=null)
 Adds a composite-compatible direct drawable as a child.
virtual DirectComposite Remove (IDirectCompositeChild child)
 Removes a child without disposing it.
virtual DirectComposite Clear ()
 Removes every child without disposing them.
DirectComposite SetLocalOffset (IDirectCompositeChild child, Vector2 newLocalOffsetPx)
 Changes one child's local offset and reapplies its position.
DirectComposite SetZOrder (int zOrder)
 Applies one Z-order to every descendant.
DirectComposite SetOpacity (float opacity)
 Applies one opacity to every descendant.
DirectComposite SetIsVisible (bool visible)
 Applies one visibility value to every descendant.
DirectComposite FadeTo (float targetOpacity, float durationSec)
 Fades every descendant to the requested opacity.
DirectComposite FadeIn (float durationSec)
 Fades every descendant to full opacity.
DirectComposite FadeOut (float durationSec)
 Fades every descendant to zero opacity.
RectangleF GetDrawLocationScreen (View view)
 Gets the union of all visible descendants as projected through a view.
void Draw (BackbufferBase backbuffer, RectangleF destRectScreen)
 Performs no direct rendering because descendants render independently.

Protected Member Functions

override void ProcessShown ()
 Performs processing when the widget is shown before notification callbacks are invoked.
override void ProcessHidden ()
 Performs processing when the widget is hidden before notification callbacks are invoked.
Protected Member Functions inherited from Gondwana.Widgets.WidgetBase
 WidgetBase (RenderSurfaceHostBase renderSurfaceHost, DirectDrawingMode mode, PointF anchor=default, string? nickname=null)
 Initializes a new instance of the WidgetBase class.
virtual void ProcessActivated ()
 Performs processing when the widget is activated before notification callbacks are invoked.
virtual void ProcessCancelled ()
 Performs processing when the widget is cancelled before notification callbacks are invoked.
virtual void ProcessPointerEnter (WidgetPointerEventArgs args)
 Performs processing when a pointer enters the widget before notification callbacks are invoked.
virtual void ProcessPointerLeave (WidgetPointerEventArgs args)
 Performs processing when a pointer leaves the widget before notification callbacks are invoked.
virtual void ProcessPointerDown (WidgetPointerEventArgs args)
 Performs processing when a pointer press begins on the widget before notification callbacks are invoked.
virtual void ProcessPointerMove (WidgetPointerEventArgs args)
 Performs processing when pointer movement is routed to the widget before notification callbacks are invoked.
virtual void ProcessPointerUp (WidgetPointerEventArgs args)
 Performs processing when a pointer press is released for the widget before notification callbacks are invoked.
virtual void ProcessFocusGained ()
 Performs processing when the widget gains focus before notification callbacks are invoked.
virtual void ProcessFocusLost ()
 Performs processing when the widget loses focus before notification callbacks are invoked.
virtual void ProcessKeyboardInput (WidgetKeyboardEventArgs args)
 Performs processing when keyboard input is routed to the widget before notification callbacks are invoked.
virtual bool ShouldDispatchPointerClick (WidgetPointerEventArgs args)
 Determines whether a pointer-click event should be dispatched for the specified pointer event data.
virtual void OnShown ()
 Called when the widget is shown.
virtual void OnHidden ()
 Called when the widget is hidden.
virtual void OnActivated ()
 Called when the widget is activated.
virtual void OnCancelled ()
 Called when the widget is cancelled.
virtual void OnPointerEnter (WidgetPointerEventArgs args)
 Called when a pointer enters the widget bounds.
virtual void OnPointerLeave (WidgetPointerEventArgs args)
 Called when a pointer leaves the widget bounds.
virtual void OnPointerDown (WidgetPointerEventArgs args)
 Called when a pointer press begins on the widget.
virtual void OnPointerMove (WidgetPointerEventArgs args)
 Called when pointer movement is routed to the widget.
virtual void OnPointerUp (WidgetPointerEventArgs args)
 Called when a pointer press is released for the widget.
virtual void OnMouseWheel (WidgetMouseWheelEventArgs args)
 Called when mouse-wheel input is routed to the widget.
virtual void OnPointerClick (WidgetPointerEventArgs args)
 Called when a pointer click is dispatched to the widget.
virtual void OnFocusGained ()
 Called when the widget gains focus.
virtual void OnFocusLost ()
 Called when the widget loses focus.
virtual void OnKeyboardInput (WidgetKeyboardEventArgs args)
 Called when keyboard input is routed to the widget.
Protected Member Functions inherited from Gondwana.Drawing.Direct.DirectComposite
virtual void OnChildAdded (IDirectCompositeChild child)
 Called after a child has been successfully added.
virtual void OnChildRemoved (IDirectCompositeChild child)
 Called after a child has been removed from the composite.

Properties

IDirectCompositeChild Content [get]
 Gets the direct drawing displayed by this popup.
TextBlock? Text [get]
 Gets the popup's text drawing, or null for an image popup.
DirectImage? Image [get]
 Gets the popup's image drawing, or null for a text popup.
Tile? SourceTile [get]
 Gets the tile used to resolve the popup source, when one is configured.
Point? SourceGridLocation [get]
 Gets the fixed grid coordinate used to resolve the popup source, when one is configured.
float LifetimeSec [get, set]
 Gets or sets the popup lifetime in seconds.
float FadeInSec [get, set]
 Gets or sets the fade-in duration in seconds.
float FadeOutSec [get, set]
 Gets or sets the fade-out duration in seconds.
Vector2 VelocityPxPerSec = new(0f, -48f) [get, set]
 Gets or sets the initial popup velocity in pixels per second. Scene-layer popups use world pixels; view popups use screen pixels.
Vector2 AccelerationPxPerSecSquared [get, set]
 Gets or sets popup acceleration in pixels per second squared.
bool DisposeOnComplete = true [get, set]
 Gets or sets whether the popup disposes itself after completion.
Properties inherited from Gondwana.Widgets.WidgetBase
bool IsInputEnabled [get, set]
 Gets or sets a value indicating whether the widget can participate in input routing.
bool IsPointerInputEnabled [get, set]
 Gets or sets a value indicating whether the widget can receive pointer input.
bool IsKeyboardInputEnabled [get, set]
 Gets or sets a value indicating whether the widget can receive keyboard input.
bool CanReceiveFocus [get, set]
 Gets or sets a value indicating whether the widget can receive keyboard focus.
bool IsFocused [get, set]
 Gets a value indicating whether the widget currently has keyboard focus.
Properties inherited from Gondwana.Drawing.Direct.DirectComposite
Guid Id = Guid.NewGuid() [get]
 Gets the unique identifier of the composite.
string? Nickname [get]
 Gets the optional diagnostic nickname of the composite.
RenderSurfaceHostBase RenderSurfaceHost [get]
 Gets the render surface host shared by the composite and its children.
DirectDrawingMode Mode [get]
 Gets the coordinate mode shared by the composite and its children.
SceneLayer? SceneLayer [get]
 Gets the scene layer shared by all children in scene-layer mode.
View? View [get]
 Gets the view shared by all children in view mode.
ReadOnlyCollection< IDirectCompositeChild > Children [get]
 Gets the children owned by the composite.
MovementController Movement [get]
 Gets the movement controller used to move the composite anchor.
MovementSpace PositionSpace [get]
 Gets the coordinate space used by the movement controller.
bool Visible [get, set]
 Gets or sets the visibility of all descendants.
int ZOrder [get]
 Gets the composite Z-order.
Rectangle ScreenBounds [get]
 Gets the union of all visible descendants' screen-space bounds.
Rectangle WorldBounds [get]
 Gets the union of all visible descendants' world-space bounds.

Events

Action? Completed
 Occurs after the popup reaches the end of its configured lifetime.
Events inherited from Gondwana.Widgets.WidgetBase
Action? Shown
 Occurs when the widget is shown.
Action? Hidden
 Occurs when the widget is hidden.
Action? Activated
 Occurs when the widget is activated.
Action? Cancelled
 Occurs when the widget is cancelled.
Action< WidgetPointerEventArgs >? PointerEnter
 Occurs when a pointer enters the widget bounds.
Action< WidgetPointerEventArgs >? PointerLeave
 Occurs when a pointer leaves the widget bounds.
Action< WidgetPointerEventArgs >? PointerDown
 Occurs when a pointer button or touch press begins on the widget.
Action< WidgetPointerEventArgs >? PointerMove
 Occurs when a pointer moves while routed to the widget.
Action< WidgetPointerEventArgs >? PointerUp
 Occurs when a pointer button or touch press is released for the widget.
Action< WidgetPointerEventArgs >? PointerClick
 Occurs when a pointer press and release completes as a click on the widget.
Action< WidgetMouseWheelEventArgs >? MouseWheel
 Occurs when mouse-wheel input is routed to the widget while the pointer is over it.
Action? FocusGained
 Occurs when the widget gains keyboard focus.
Action? FocusLost
 Occurs when the widget loses keyboard focus.
Action< WidgetKeyboardEventArgs >? KeyboardInput
 Occurs when keyboard input is routed to the widget.
Events inherited from Gondwana.Drawing.Direct.DirectComposite
EventHandler< IDirectDrawable >? Disposing
 Occurs when the composite is being disposed.
Events inherited from Gondwana.Drawing.Direct.IDirectDrawable
EventHandler< IDirectDrawable >? Disposing
 Occurs when the object is being disposed.

Detailed Description

Displays short-lived text or image content in view or scene-layer coordinates.

A scene-layer popup can take its source from a Tile or fixed grid cell. The source is resolved when ShowPopup is called and the popup then moves independently, which is appropriate for floating damage, score, and status-effect feedback.

Definition at line 22 of file PopupWidget.cs.

Constructor & Destructor Documentation

◆ PopupWidget() [1/7]

Gondwana.Widgets.Overlays.PopupWidget.PopupWidget ( RenderSurfaceHostBase renderSurfaceHost,
View view,
Rectangle screenBounds,
string text,
string? nickname = null )

Initializes a text popup in absolute view/screen coordinates.

Parameters
renderSurfaceHostThe render-surface host that owns the drawing.
viewThe view used for presentation and coordinate conversion.
screenBoundsThe bounds in screen pixels.
textThe text to display.
nicknameAn optional name used to identify the object.

Definition at line 46 of file PopupWidget.cs.

◆ PopupWidget() [2/7]

Gondwana.Widgets.Overlays.PopupWidget.PopupWidget ( RenderSurfaceHostBase renderSurfaceHost,
SceneLayer sceneLayer,
Rectangle worldBounds,
string text,
string? nickname = null )

Initializes a text popup in scene-layer world coordinates.

Parameters
renderSurfaceHostThe render-surface host that owns the drawing.
sceneLayerThe scene layer that owns the content.
worldBoundsThe bounds in world pixels.
textThe text to display.
nicknameAn optional name used to identify the object.

Definition at line 81 of file PopupWidget.cs.

◆ PopupWidget() [3/7]

Gondwana.Widgets.Overlays.PopupWidget.PopupWidget ( RenderSurfaceHostBase renderSurfaceHost,
Tile source,
Size size,
string text,
WidgetAnchor sourceAnchor = WidgetAnchor::Center,
Point? offsetPx = null,
string? nickname = null )

Initializes a text popup whose source is resolved from a tile when shown.

Parameters
renderSurfaceHostThe render-surface host that owns the drawing.
sourceThe source.
sizeThe size.
textThe text to display.
sourceAnchorThe source anchor.
offsetPxThe offset in pixels.
nicknameAn optional name used to identify the object.

Definition at line 118 of file PopupWidget.cs.

◆ PopupWidget() [4/7]

Gondwana.Widgets.Overlays.PopupWidget.PopupWidget ( RenderSurfaceHostBase renderSurfaceHost,
View view,
Rectangle screenBounds,
SKImage image,
string? nickname = null )

Initializes an image popup in absolute view/screen coordinates.

Parameters
renderSurfaceHostThe render-surface host that owns the drawing.
viewThe view used for presentation and coordinate conversion.
screenBoundsThe bounds in screen pixels.
imageThe image.
nicknameAn optional name used to identify the object.

Definition at line 144 of file PopupWidget.cs.

◆ PopupWidget() [5/7]

Gondwana.Widgets.Overlays.PopupWidget.PopupWidget ( RenderSurfaceHostBase renderSurfaceHost,
SceneLayer sceneLayer,
Rectangle worldBounds,
SKImage image,
string? nickname = null )

Initializes an image popup in scene-layer world coordinates.

Parameters
renderSurfaceHostThe render-surface host that owns the drawing.
sceneLayerThe scene layer that owns the content.
worldBoundsThe bounds in world pixels.
imageThe image.
nicknameAn optional name used to identify the object.

Definition at line 180 of file PopupWidget.cs.

◆ PopupWidget() [6/7]

Gondwana.Widgets.Overlays.PopupWidget.PopupWidget ( RenderSurfaceHostBase renderSurfaceHost,
View view,
Rectangle screenBounds,
SKBitmap bitmap,
string? nickname = null )

Initializes a bitmap popup in absolute view/screen coordinates.

Parameters
renderSurfaceHostThe render-surface host that owns the drawing.
viewThe view used for presentation and coordinate conversion.
screenBoundsThe bounds in screen pixels.
bitmapThe bitmap.
nicknameAn optional name used to identify the object.

Definition at line 216 of file PopupWidget.cs.

◆ PopupWidget() [7/7]

Gondwana.Widgets.Overlays.PopupWidget.PopupWidget ( RenderSurfaceHostBase renderSurfaceHost,
SceneLayer sceneLayer,
Rectangle worldBounds,
SKBitmap bitmap,
string? nickname = null )

Initializes a bitmap popup in scene-layer world coordinates.

Parameters
renderSurfaceHostThe render-surface host that owns the drawing.
sceneLayerThe scene layer that owns the content.
worldBoundsThe bounds in world pixels.
bitmapThe bitmap.
nicknameAn optional name used to identify the object.

Definition at line 252 of file PopupWidget.cs.

Member Function Documentation

◆ BindTo() [1/2]

PopupWidget Gondwana.Widgets.Overlays.PopupWidget.BindTo ( SceneLayer sceneLayer,
Point gridLocation,
WidgetAnchor sourceAnchor = WidgetAnchor::Center,
Point? offsetPx = null )

Resolves the popup source from a fixed grid cell when the popup is shown.

Parameters
sceneLayerThe scene layer that owns the content.
gridLocationThe grid location.
sourceAnchorThe source anchor.
offsetPxThe offset in pixels.
Returns
This instance for fluent chaining.

Definition at line 423 of file PopupWidget.cs.

◆ BindTo() [2/2]

PopupWidget Gondwana.Widgets.Overlays.PopupWidget.BindTo ( Tile source,
WidgetAnchor sourceAnchor = WidgetAnchor::Center,
Point? offsetPx = null )

Resolves the popup source from an anchor point on a tile when the popup is shown.

Parameters
sourceThe source.
sourceAnchorThe source anchor.
offsetPxThe offset in pixels.
Returns
This instance for fluent chaining.

Definition at line 385 of file PopupWidget.cs.

◆ Dismiss()

void Gondwana.Widgets.Overlays.PopupWidget.Dismiss ( )

Completes and hides the popup immediately.

Definition at line 500 of file PopupWidget.cs.

◆ Dispose()

override void Gondwana.Widgets.Overlays.PopupWidget.Dispose ( )
virtual

Disposes the composite and every child it owns.

Reimplemented from Gondwana.Drawing.Direct.DirectComposite.

Definition at line 544 of file PopupWidget.cs.

◆ ProcessHidden()

override void Gondwana.Widgets.Overlays.PopupWidget.ProcessHidden ( )
protectedvirtual

Performs processing when the widget is hidden before notification callbacks are invoked.

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 571 of file PopupWidget.cs.

◆ ProcessShown()

override void Gondwana.Widgets.Overlays.PopupWidget.ProcessShown ( )
protectedvirtual

Performs processing when the widget is shown before notification callbacks are invoked.

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 555 of file PopupWidget.cs.

◆ SetFont()

PopupWidget Gondwana.Widgets.Overlays.PopupWidget.SetFont ( SKTypeface typeface,
float size,
float? minSize = null )

Sets the popup font. Throws when this is an image popup.

Parameters
typefaceThe typeface used to render text.
sizeThe size.
minSizeThe min size.
Returns
This instance for fluent chaining.

Definition at line 460 of file PopupWidget.cs.

◆ SetPopupZOrder()

PopupWidget Gondwana.Widgets.Overlays.PopupWidget.SetPopupZOrder ( int zOrder)

Sets the popup Z-order.

Parameters
zOrderThe drawing order relative to other content.
Returns
This instance for fluent chaining.

Definition at line 491 of file PopupWidget.cs.

◆ SetSourceLocation()

PopupWidget Gondwana.Widgets.Overlays.PopupWidget.SetSourceLocation ( Point locationPx)

Uses a fixed top-left location as the popup source.

Parameters
locationPxThe location px.
Returns
This instance for fluent chaining.

Definition at line 369 of file PopupWidget.cs.

◆ SetText()

PopupWidget Gondwana.Widgets.Overlays.PopupWidget.SetText ( string text)

Sets the popup text. Throws when this is an image popup.

Parameters
textThe text to display.
Returns
This instance for fluent chaining.

Definition at line 444 of file PopupWidget.cs.

◆ SetTextColor()

PopupWidget Gondwana.Widgets.Overlays.PopupWidget.SetTextColor ( SKColor color)

Sets the popup text color. Throws when this is an image popup.

Parameters
colorThe color to apply.
Returns
This instance for fluent chaining.

Definition at line 477 of file PopupWidget.cs.

◆ ShowPopup()

PopupWidget Gondwana.Widgets.Overlays.PopupWidget.ShowPopup ( )

Shows the popup, resolves its current source, and starts its movement and fades.

Returns
This instance for fluent chaining.

Definition at line 358 of file PopupWidget.cs.

◆ Update()

override void Gondwana.Widgets.Overlays.PopupWidget.Update ( long tick)
virtual

Advances composite movement.

Parameters
tickThe current engine tick.
This method uses the tick to calculate elapsed time and advance the movement controller. If the tick is less than or equal to the last processed tick, no update occurs.

Reimplemented from Gondwana.Drawing.Direct.DirectComposite.

Definition at line 509 of file PopupWidget.cs.

Property Documentation

◆ AccelerationPxPerSecSquared

Vector2 Gondwana.Widgets.Overlays.PopupWidget.AccelerationPxPerSecSquared
getset

Gets or sets popup acceleration in pixels per second squared.

Definition at line 347 of file PopupWidget.cs.

◆ Content

IDirectCompositeChild Gondwana.Widgets.Overlays.PopupWidget.Content
get

Gets the direct drawing displayed by this popup.

Definition at line 283 of file PopupWidget.cs.

◆ DisposeOnComplete

bool Gondwana.Widgets.Overlays.PopupWidget.DisposeOnComplete = true
getset

Gets or sets whether the popup disposes itself after completion.

Definition at line 352 of file PopupWidget.cs.

◆ FadeInSec

float Gondwana.Widgets.Overlays.PopupWidget.FadeInSec
getset

Gets or sets the fade-in duration in seconds.

Definition at line 319 of file PopupWidget.cs.

◆ FadeOutSec

float Gondwana.Widgets.Overlays.PopupWidget.FadeOutSec
getset

Gets or sets the fade-out duration in seconds.

Definition at line 330 of file PopupWidget.cs.

◆ Image

DirectImage? Gondwana.Widgets.Overlays.PopupWidget.Image
get

Gets the popup's image drawing, or null for a text popup.

Definition at line 293 of file PopupWidget.cs.

◆ LifetimeSec

float Gondwana.Widgets.Overlays.PopupWidget.LifetimeSec
getset

Gets or sets the popup lifetime in seconds.

Definition at line 308 of file PopupWidget.cs.

◆ SourceGridLocation

Point? Gondwana.Widgets.Overlays.PopupWidget.SourceGridLocation
get

Gets the fixed grid coordinate used to resolve the popup source, when one is configured.

Definition at line 303 of file PopupWidget.cs.

◆ SourceTile

Tile? Gondwana.Widgets.Overlays.PopupWidget.SourceTile
get

Gets the tile used to resolve the popup source, when one is configured.

Definition at line 298 of file PopupWidget.cs.

◆ Text

TextBlock? Gondwana.Widgets.Overlays.PopupWidget.Text
get

Gets the popup's text drawing, or null for an image popup.

Definition at line 288 of file PopupWidget.cs.

◆ VelocityPxPerSec

Vector2 Gondwana.Widgets.Overlays.PopupWidget.VelocityPxPerSec = new(0f, -48f)
getset

Gets or sets the initial popup velocity in pixels per second. Scene-layer popups use world pixels; view popups use screen pixels.

Definition at line 342 of file PopupWidget.cs.

Event Documentation

◆ Completed

Action? Gondwana.Widgets.Overlays.PopupWidget.Completed

Occurs after the popup reaches the end of its configured lifetime.

Definition at line 36 of file PopupWidget.cs.