Provides an NPC-style conversation panel with speaker, wrapped body text, and pointer or keyboard advance semantics. More...

Inheritance diagram for Gondwana.Widgets.Dialogs.ConversationBox:

Public Member Functions
	ConversationBox (RenderSurfaceHostBase renderSurfaceHost, View view, Rectangle bounds, string speaker, string text, string? nickname=null)
	Creates a view-level conversation box.
	ConversationBox (RenderSurfaceHostBase renderSurfaceHost, SceneLayer sceneLayer, Rectangle bounds, string speaker, string text, string? nickname=null)
	Creates a scene-layer conversation box.
ConversationBox	SetConversation (string speaker, string text)
	Changes the speaker and body text together.
ConversationBox	SetSpeaker (string speaker)
	Changes the speaker name.
ConversationBox	SetText (string text)
	Changes the conversation body text.
ConversationBox	ShowContinueIndicator (bool visible=true)
	Shows or hides the continue indicator.
ConversationBox	SetTextColors (SKColor speakerColor, SKColor bodyColor)
	Sets the speaker and body text colors.
ConversationBox	SetPanelColors (Color fill, Color border)
	Sets the panel fill and border colors.
ConversationBox	SetConversationZOrder (int zOrder)
	Sets the base Z-order used by the conversation visuals.
void	Advance ()
	Programmatically requests the next conversation step.
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.
virtual void	Update (long tick)
	Advances composite movement.
virtual void	Dispose ()
	Disposes the composite and every child it owns.

Protected Member Functions

override void ProcessShown ()

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

override void OnPointerClick (WidgetPointerEventArgs args)

Called when a pointer click is dispatched to the widget.

Parameters

args	The pointer event data.

override void OnKeyboardInput (WidgetKeyboardEventArgs args)

Called when keyboard input is routed to the widget.

Parameters

args	The keyboard event data.

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 ProcessHidden ()

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

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 OnFocusGained ()

Called when the widget gains focus.

virtual void OnFocusLost ()

Called when the widget loses focus.

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
DirectRectangle	Panel `[get]`
	Gets the panel background.
TextBlock	SpeakerText `[get]`
	Gets the speaker-name text block.
TextBlock	BodyText `[get]`
	Gets the conversation body text block.
TextBlock	ContinueIndicator `[get]`
	Gets the small visual indicating that the conversation can advance.
string	Speaker `[get]`
	Gets the current speaker name.
string	Text `[get]`
	Gets the current conversation text.
Rectangle	Bounds `[get]`
	Gets the conversation bounds in its native coordinate space.
int	PrimaryAdvanceKey = 13 `[get, set]`
	Gets or sets the primary key used to request the next conversation step. Defaults to Enter (13).
int	SecondaryAdvanceKey = 32 `[get, set]`
	Gets or sets the secondary key used to request the next conversation step. Defaults to Space (32).
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?	AdvanceRequested
	Occurs when the player requests the next line or conversation step.
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

Provides an NPC-style conversation panel with speaker, wrapped body text, and pointer or keyboard advance semantics.

Definition at line 15 of file ConversationBox.cs.

Constructor & Destructor Documentation

◆ ConversationBox() [1/2]

Gondwana.Widgets.Dialogs.ConversationBox.ConversationBox	(	RenderSurfaceHostBase	renderSurfaceHost,
		View	view,
		Rectangle	bounds,
		string	speaker,
		string	text,
		string?	nickname = null )

Creates a view-level conversation box.

Parameters

renderSurfaceHost	The render-surface host that owns the drawing.
view	The view used for presentation and coordinate conversion.
bounds	The widget bounds in view-local pixels.
speaker	The speaker.
text	The text to display.
nickname	An optional name used to identify the object.

Definition at line 40 of file ConversationBox.cs.

◆ ConversationBox() [2/2]

Gondwana.Widgets.Dialogs.ConversationBox.ConversationBox	(	RenderSurfaceHostBase	renderSurfaceHost,
		SceneLayer	sceneLayer,
		Rectangle	bounds,
		string	speaker,
		string	text,
		string?	nickname = null )

Creates a scene-layer conversation box.

Parameters

renderSurfaceHost	The render-surface host that owns the drawing.
sceneLayer	The scene layer that owns the content.
bounds	The widget bounds in world pixels.
speaker	The speaker.
text	The text to display.
nickname	An optional name used to identify the object.

Definition at line 75 of file ConversationBox.cs.

Member Function Documentation

◆ Advance()

void Gondwana.Widgets.Dialogs.ConversationBox.Advance ( )

Programmatically requests the next conversation step.

Definition at line 243 of file ConversationBox.cs.

◆ OnKeyboardInput()

override void Gondwana.Widgets.Dialogs.ConversationBox.OnKeyboardInput ( WidgetKeyboardEventArgs args )

protectedvirtual

Called when keyboard input is routed to the widget.

Parameters

args	The keyboard event data.

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 271 of file ConversationBox.cs.

◆ OnPointerClick()

override void Gondwana.Widgets.Dialogs.ConversationBox.OnPointerClick ( WidgetPointerEventArgs args )

protectedvirtual

Called when a pointer click is dispatched to the widget.

Parameters

args	The pointer event data.

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 259 of file ConversationBox.cs.

◆ ProcessShown()

override void Gondwana.Widgets.Dialogs.ConversationBox.ProcessShown ( )

protectedvirtual

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

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 252 of file ConversationBox.cs.

◆ SetConversation()

ConversationBox Gondwana.Widgets.Dialogs.ConversationBox.SetConversation	(	string	speaker,
		string	text )

Changes the speaker and body text together.

Parameters

speaker	The speaker.
text	The text to display.

Returns: This instance for fluent chaining.

Definition at line 156 of file ConversationBox.cs.

◆ SetConversationZOrder()

ConversationBox Gondwana.Widgets.Dialogs.ConversationBox.SetConversationZOrder ( int zOrder )

Sets the base Z-order used by the conversation visuals.

Parameters

zOrder The drawing order relative to other content.

Returns: This instance for fluent chaining.

Definition at line 231 of file ConversationBox.cs.

◆ SetPanelColors()

ConversationBox Gondwana.Widgets.Dialogs.ConversationBox.SetPanelColors	(	Color	fill,
		Color	border )

Sets the panel fill and border colors.

Parameters

fill	The fill.
border	The border.

Returns: This instance for fluent chaining.

Definition at line 218 of file ConversationBox.cs.

◆ SetSpeaker()

ConversationBox Gondwana.Widgets.Dialogs.ConversationBox.SetSpeaker ( string speaker )

Changes the speaker name.

Parameters

speaker The speaker.

Returns: This instance for fluent chaining.

Definition at line 168 of file ConversationBox.cs.

◆ SetText()

ConversationBox Gondwana.Widgets.Dialogs.ConversationBox.SetText ( string text )

Changes the conversation body text.

Parameters

text	The text to display.

Returns: This instance for fluent chaining.

Definition at line 180 of file ConversationBox.cs.

◆ SetTextColors()

ConversationBox Gondwana.Widgets.Dialogs.ConversationBox.SetTextColors	(	SKColor	speakerColor,
		SKColor	bodyColor )

Sets the speaker and body text colors.

Parameters

speakerColor	The speaker color.
bodyColor	The body color.

Returns: This instance for fluent chaining.

Definition at line 205 of file ConversationBox.cs.

◆ ShowContinueIndicator()

ConversationBox Gondwana.Widgets.Dialogs.ConversationBox.ShowContinueIndicator ( bool visible = true )

Shows or hides the continue indicator.

Parameters

visible Whether the content is visible.

Returns: This instance for fluent chaining.

Definition at line 192 of file ConversationBox.cs.

Property Documentation

◆ BodyText

TextBlock Gondwana.Widgets.Dialogs.ConversationBox.BodyText

get

Gets the conversation body text block.

Definition at line 114 of file ConversationBox.cs.

◆ Bounds

Rectangle Gondwana.Widgets.Dialogs.ConversationBox.Bounds

get

Gets the conversation bounds in its native coordinate space.

Definition at line 134 of file ConversationBox.cs.

◆ ContinueIndicator

TextBlock Gondwana.Widgets.Dialogs.ConversationBox.ContinueIndicator

get

Gets the small visual indicating that the conversation can advance.

Definition at line 119 of file ConversationBox.cs.

◆ Panel

DirectRectangle Gondwana.Widgets.Dialogs.ConversationBox.Panel

get

Gets the panel background.

Definition at line 104 of file ConversationBox.cs.

◆ PrimaryAdvanceKey

int Gondwana.Widgets.Dialogs.ConversationBox.PrimaryAdvanceKey = 13

getset

Gets or sets the primary key used to request the next conversation step. Defaults to Enter (13).

Definition at line 142 of file ConversationBox.cs.

◆ SecondaryAdvanceKey

int Gondwana.Widgets.Dialogs.ConversationBox.SecondaryAdvanceKey = 32

getset

Gets or sets the secondary key used to request the next conversation step. Defaults to Space (32).

Definition at line 148 of file ConversationBox.cs.

◆ Speaker

string Gondwana.Widgets.Dialogs.ConversationBox.Speaker

get

Gets the current speaker name.

Definition at line 124 of file ConversationBox.cs.

◆ SpeakerText

TextBlock Gondwana.Widgets.Dialogs.ConversationBox.SpeakerText

get

Gets the speaker-name text block.

Definition at line 109 of file ConversationBox.cs.

◆ Text

string Gondwana.Widgets.Dialogs.ConversationBox.Text

get

Gets the current conversation text.

Definition at line 129 of file ConversationBox.cs.

Event Documentation

◆ AdvanceRequested

Action? Gondwana.Widgets.Dialogs.ConversationBox.AdvanceRequested

Occurs when the player requests the next line or conversation step.

Definition at line 29 of file ConversationBox.cs.

Public Member Functions

Protected Member Functions

Properties

Events

Detailed Description

Constructor & Destructor Documentation

◆ ConversationBox() [1/2]

◆ ConversationBox() [2/2]

Member Function Documentation

◆ Advance()

◆ OnKeyboardInput()

◆ OnPointerClick()

◆ ProcessShown()

◆ SetConversation()

◆ SetConversationZOrder()

◆ SetPanelColors()

◆ SetSpeaker()

◆ SetText()

◆ SetTextColors()

◆ ShowContinueIndicator()

Property Documentation

◆ BodyText

◆ Bounds

◆ ContinueIndicator

◆ Panel

◆ PrimaryAdvanceKey

◆ SecondaryAdvanceKey

◆ Speaker

◆ SpeakerText

◆ Text

Event Documentation

◆ AdvanceRequested