Access to certain information and functions about a dialogue. More...

Inheritance diagram for IDialogue:

abstract int	ID `[get]`
	Gets the unique ID of this Dialogue. More...

abstract string	Text `[get]`
	Gets the dialogue Text/Message. Empty if dialogue is closed. More...

abstract Color	TextColor `[get]`
	Gets the dialogue text color. More...

abstract string	Name `[get]`
	Gets the source Name. Empty if dialogue is closed. More...

abstract bool	IsVisible `[get]`
	Gets if the dialogue is currently visible and active. More...

abstract float	DisplayDuration `[get]`
	Gets the total display duration in milliseconds. Returns 0 when closed. More...

abstract float	ElapsedTime `[get]`
	Gets the elapsed time in milliseconds this dialogue has been shown. Returns 0 when closed. More...

abstract int	TargetObjectID `[get]`
	Gets the target object ID of the dialogue. 0 if not used. More...

abstract Vector2	TargetWorldPosition `[get]`
	Gets the target world position where the dialogue box is displayed. Returns Vector2.Zero when closed. More...

abstract void	Close ()
	Close and removes the dialogue. More...

Detailed Description

Access to certain information and functions about a dialogue.

Member Function Documentation

◆ Close()

abstract void Close ( )

pure virtual

Close and removes the dialogue.

Property Documentation

◆ DisplayDuration

abstract float DisplayDuration

get

Gets the total display duration in milliseconds. Returns 0 when closed.

Returns: Total display duration ms

◆ ElapsedTime

abstract float ElapsedTime

get

Gets the elapsed time in milliseconds this dialogue has been shown. Returns 0 when closed.

Returns: Elapsed time ms

◆ ID

abstract int ID

get

Gets the unique ID of this Dialogue.

Returns: Unique ID

◆ IsVisible

abstract bool IsVisible

get

Gets if the dialogue is currently visible and active.

Returns: Visible

◆ Name

abstract string Name

get

Gets the source Name. Empty if dialogue is closed.

Returns: Source Name

◆ TargetObjectID

abstract int TargetObjectID

get

Gets the target object ID of the dialogue. 0 if not used.

Returns: Object ID

◆ TargetWorldPosition

abstract Vector2 TargetWorldPosition

get

Gets the target world position where the dialogue box is displayed. Returns Vector2.Zero when closed.

Returns: World position

◆ Text

abstract string Text

get

Gets the dialogue Text/Message. Empty if dialogue is closed.

Returns: Dialoge Text/Message

◆ TextColor

abstract Color TextColor

get

Gets the dialogue text color.

Returns: Color