This contains the source code documentation of the class DialogicChoiceEvent.
DialogicChoiceEvent
Inherits: DialogicEvent
Event that allows adding choices. Needs to go after a text event (or another choices EndBranch).
Properties
| Name | Type | Default |
|---|---|---|
| text | String | "" |
| condition | String | "" |
| else_action | int | 2 |
| disabled_text | String | "" |
| extra_data | Dictionary | {} |
| regex | RegEx | create_from_string(...) |
Methods
| Returns | Method |
|---|---|
| Control | get_end_branch_control ( ) |
| String | to_text ( ) |
| void | from_text ( string: String ) |
| Dictionary | get_shortcode_parameters ( ) |
| bool | is_valid_event ( string: String ) |
| void | build_event_editor ( ) |
| bool | allow_alt_text ( ) |
Constants
No description available.
No description available.
No description available.
Property Descriptions
Settings The text that is displayed on the choice button.
If not empty this condition will determine if this choice is active.
Determines what happens if is false. Default will use the action set in the settings.
The text that is displayed if is false and is Disable. If empty will be used for disabled button as well.
A dictionary that can be filled with arbitrary information This can then be interpreted by a custom choice layer
var regex = create_from_string(...)
No description available.
Method Descriptions
func get_end_branch_control ( ) ⇒ Control
No description available.
No description available.
func from_text ( string: String ) ⇒ void
No description available.
func get_shortcode_parameters ( ) ⇒ Dictionary
No description available.
func is_valid_event ( string: String ) ⇒ bool
No description available.
func build_event_editor ( ) ⇒ void
No description available.
func allow_alt_text ( ) ⇒ bool
No description available.