Interface IDialogOption

Represents a dialog option that is shown on the screen as part of a list of options, where the user needs to choose one of the options.

Inherited Members

IDialogActions.Actions

IDialogActions.AddText(ICharacter, String[])

IDialogActions.AddPlayerText(String[])

IDialogActions.AddActions(Action[])

IDialogActions.AddConditionalActions(Func<Boolean>[])

IDialogActions.AddAsyncActions(Func<Task>[])

IDialogActions.AddAsyncConditionalActions(Func<Task<Boolean>>[])

IDialogActions.AddActions(IDialogAction[])

IDialogActions.RunAsync()

System.IDisposable.Dispose()

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface IDialogOption : IDialogActions, IDisposable

Properties

ChangeDialogWhenFinished

Gets or sets another dialog that will be changed to after this dialog option's actions are executed.

Declaration

IDialog ChangeDialogWhenFinished { get; set; }

Property Value

Type	Description
IDialog	The change dialog when finished.

ExitDialogWhenFinished

Gets or sets a value indicating whether the dialog should close after this dialog option's actions are executed.

Declaration

bool ExitDialogWhenFinished { get; set; }

Property Value

Type	Description
System.Boolean	true if exit dialog when finished; otherwise, false.

HasBeenChosenConfig

Gets the text configuration (font, color, outline, etc) for when the option was already previously selected by the player. By default it will color the text gray. Note: if ShowOnce is false, then the option will be hidden and this configuration will be irrelevant.

Declaration

ITextConfig HasBeenChosenConfig { get; }

Property Value

Type	Description
ITextConfig	The "has been chosen" config.

HasOptionBeenChosen

Gets or sets a value indicating whether this IDialogOption has already been chosen by the user before.

Declaration

bool HasOptionBeenChosen { get; set; }

Property Value

Type	Description
System.Boolean	true if has option been chosen; otherwise, false.

HoverConfig

Gets the text configuration (font, color, outline, etc) for when the mouse hovers over the option. By default it will color the text yellow.

Declaration

ITextConfig HoverConfig { get; }

Property Value

Type	Description
ITextConfig	The hover config.

Label

Gets the label which will host the text for the dialog option.

Declaration

ILabel Label { get; }

Property Value

Type	Description
ILabel	The label.

ShowOnce

Gets a value indicating whether this IDialogOption should be shown after it was already selected once. Note: an alternative to this would be using HasBeenChosenConfig, which by default colors an already selected text gray.

Declaration

bool ShowOnce { get; }

Property Value

Type	Description
System.Boolean	true if show once; otherwise, false.

SpeakOption

Gets a value indicating whether this IDialogOption should be spoken by the player before moving on to the list of actions.

Declaration

bool SpeakOption { get; }

Property Value

Type	Description
System.Boolean	true if speak option; otherwise, false.