ESCGrammarStmts.DialogOption

Description

Represents an option contained within a dialog. Usually of the form:

- <expression> [condition]
<block>

…where:

The result of <expression> is displayed in a dialog choice UI. The player will be able to select the displayed text as a dialog option.
[condition] is optional and, if specified, is used to determine whether the dialog option is displayed.
<block> is a block of statements to be executed and must be indented like a typical block.

E.g.

- "Why are you here?" [!option_already_visited]
say("current_player", "Why are you here?")
say("worker", "Because I work here.")

func init(translation_key: String, option: ESCGrammarExpr, condition: ESCGrammarExpr, body: ESCGrammarStmt) -> void

Initialization method. Must be called after instantiation.

Name	Type	Description	Required?
translation_key	`String`	an optional translation key for the option text	yes
option	`ESCGrammarExpr`	the expression whose results will be displayed on screen as an option to be selected alongside any other options at the current level	yes
condition	`ESCGrammarExpr`	an optional condition to be evaluated that is used to determine whether the option should be displayed at all	yes
body	`ESCGrammarStmt`	the block of statements to be executed should this dialog option be selected	yes

Returns nothing.

func get_translation_key() -> String

The translation key for this option, if one exists.

None.

Returns the translation key for this option, if one exists. (String)

func get_option() -> ESCGrammarExpr

The option expression.

None.

Returns the option expression. (ESCGrammarExpr)

func get_condition() -> ESCGrammarExpr

The condition for this option, if one exists.

None.

Returns the condition for this option, if one exists. (ESCGrammarExpr)

func get_body() -> ESCGrammarStmt

The statements of the option to be executed should the option be selected.

None.

Returns the statements of the option to be executed should the option be selected. (ESCGrammarStmt)

func accept(visitor: Variant) -> Variant

Method to invoke visitor-specific code.

Name	Type	Description	Required?
visitor	`Variant`	Visitor instance invoked to process this statement.	yes

Returns nothing.