This contains the source code documentation of the class DialogicCharacterEvent.
DialogicCharacterEvent
Inherits: DialogicEvent
Settings
Properties
| Name | Type | Default |
|---|---|---|
| action | int | 0 |
| character | DialogicCharacter | null |
| portrait | String | "" |
| transform | String | "center" |
| animation_name | String | "" |
| animation_length | float | 0.5 |
| animation_repeats | int | 1 |
| animation_wait | bool | false |
| fade_animation | String | "" |
| fade_length | float | 0.5 |
| transform_time | float | 0.0 |
| transform_ease | int | 2 |
| transform_trans | int | 1 |
| ease_options | Array | [...] |
| trans_options | Array | [...] |
| z_index | int | 0 |
| mirrored | bool | false |
| extra_data | String | "" |
| set_portrait | bool | false |
| set_transform | bool | false |
| set_z_index | bool | false |
| set_mirrored | bool | false |
| character_identifier | String | |
| regex | RegEx | create_from_string(...) |
Methods
| Returns | Method |
|---|---|
| String | to_text ( ) |
| void | from_text ( string: String ) |
| Dictionary | get_shortcode_parameters ( ) |
| bool | is_valid_event ( string: String ) |
| void | build_event_editor ( ) |
| bool | should_show_transform_options ( ) |
| bool | should_show_animation_options ( ) |
| bool | should_show_fade_options ( ) |
| bool | should_show_portrait_selector ( ) |
| bool | has_no_portraits ( ) |
| Dictionary | get_character_suggestions ( search_text: String ) |
| Dictionary | get_portrait_suggestions ( search_text: String ) |
| Dictionary | get_position_suggestions ( search_text: String = "" ) |
| Dictionary | get_animation_suggestions ( search_text: String = "" ) |
| Dictionary | get_fade_suggestions ( search_text: String = "" ) |
| void | suggest_parameter ( parameter: String, line: String, TextNode: TextEdit ) |
| Dictionary | list_to_suggestions ( list: Array ) |
Constants
No description available.
No description available.
No description available.
Property Descriptions
The type of action of this event (JOIN/LEAVE/UPDATE). See .
The character that will join/leave/update.
For Join/Update, this will be the portrait of the character that is shown. Not used on Leave. If empty, the default portrait will be used.
The index of the position this character should move to
Name of the animation script (extending DialogicAnimation). On Join/Leave empty (default) will fallback to the animations set in the settings. On Update empty will mean no animation.
Length of the animation.
How often the animation is repeated. Only for Update events.
If true, the events waits for the animation to finish before the next event starts.
The fade animation to use. If left empty, the default cross-fade animation AND time will be used.
No description available.
For Update only. If bigger then 0, the portrait will tween to the new position (if changed) in this time (in seconds).
No description available.
No description available.
No description available.
No description available.
The z_index that the portrait should have.
If true, the portrait will be set to mirrored.
If set, will be passed to the portrait scene.
Indicators for whether something should be updated (UPDATE mode only)
No description available.
No description available.
No description available.
Used to set the character resource from the unique name identifier and vice versa
var regex = create_from_string(...)
No description available.
Method Descriptions
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 should_show_transform_options ( ) ⇒ bool
No description available.
func should_show_animation_options ( ) ⇒ bool
No description available.
func should_show_fade_options ( ) ⇒ bool
No description available.
func should_show_portrait_selector ( ) ⇒ bool
No description available.
func has_no_portraits ( ) ⇒ bool
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_position_suggestions ( search_text: String = "" ) ⇒ Dictionary
No description available.
func get_animation_suggestions ( search_text: String = "" ) ⇒ Dictionary
No description available.
func get_fade_suggestions ( search_text: String = "" ) ⇒ Dictionary
No description available.
func suggest_parameter ( parameter: String, line: String, TextNode: TextEdit ) ⇒ void
No description available.
func list_to_suggestions ( list: Array ) ⇒ Dictionary
HELPER