This contains the source code documentation of the class DialogicTextEvent.
DialogicTextEvent
Inherits: DialogicEvent
Settings
Properties
| Name | Type | Default |
|---|---|---|
| character | DialogicCharacter | null |
| character_identifier | String | |
| completion_text_character_getter_regex | RegEx | |
| completion_text_effects | Dictionary | |
| portrait | String | "" |
| regex | RegEx | |
| split_regex | RegEx | |
| state | int | 1 |
| text | String | "" |
| text_effect_color | Color | Color(0.537255, 0.509804, 0.462745, 1) |
| text_effects | String | "" |
| text_effects_regex | RegEx | |
| text_random_word_regex | RegEx |
Methods
| Returns | Method |
|---|---|
| void | build_event_editor ( ) |
| bool | do_any_characters_exist ( ) |
| void | end_text_event ( ) |
| void | from_text ( string: String ) |
| Dictionary | get_character_suggestions ( search_text: String ) |
| Dictionary | get_portrait_suggestions ( search_text: String ) |
| Dictionary | get_shortcode_parameters ( ) |
| bool | has_no_portraits ( ) |
| bool | is_string_full_event ( string: String ) |
| bool | is_valid_event ( string: String ) |
| void | load_text_effects ( ) |
| void | suggest_bbcode ( text: CodeEdit ) |
| String | to_text ( ) |
Constants
No description available.
No description available.
No description available.
Signals
No description available.
Property Descriptions
If this is not null, the given character (as a resource) will be associated with this event. The DialogicNode_NameLabel will show the characters display_name. If a typing sound is setup, it will play.
Used to set the character resource from the unique name identifier and vice versa
var completion_text_character_getter_regex =
No description available.
No description available.
If a character is set, this setting can change the portrait of that character.
No description available.
No description available.
No description available.
This is the content of the text event. It is supposed to be displayed by a DialogicNode_DialogText node. That means you can use bbcode, but also some custom commands.
var text_effect_color = Color(0.537255, 0.509804, 0.462745, 1)
No description available.
No description available.
No description available.
No description available.
Method Descriptions
func build_event_editor ( ) ⇒ void
No description available.
func do_any_characters_exist ( ) ⇒ bool
No description available.
func end_text_event ( ) ⇒ void
No description available.
func from_text ( string: String ) ⇒ void
No description available.
func get_character_suggestions ( search_text: String ) ⇒ Dictionary
No description available.
func get_portrait_suggestions ( search_text: String ) ⇒ Dictionary
No description available.
func get_shortcode_parameters ( ) ⇒ Dictionary
No description available.
func has_no_portraits ( ) ⇒ bool
No description available.
func is_string_full_event ( string: String ) ⇒ bool
No description available.
func is_valid_event ( string: String ) ⇒ bool
No description available.
func load_text_effects ( ) ⇒ void
No description available.
func suggest_bbcode ( text: CodeEdit ) ⇒ void
No description available.
No description available.