This contains the source code documentation of the class DialogicCharacterEvent.
DialogicCharacterEvent
Inherits: DialogicEvent
Settings
Properties
| Name | Type | Default |
|---|---|---|
| action | int | 0 |
| animation_length | float | 0.5 |
| animation_name | String | "" |
| animation_repeats | int | 1 |
| animation_wait | bool | false |
| character | DialogicCharacter | null |
| character_identifier | String | |
| extra_data | String | "" |
| mirrored | bool | false |
| portrait | String | "" |
| position | int | 1 |
| position_move_time | float | 0.0 |
| regex | RegEx | |
| set_mirrored | bool | false |
| set_portrait | bool | false |
| set_position | bool | false |
| set_z_index | bool | false |
| z_index | int | 0 |
Methods
| Returns | Method |
|---|---|
| void | build_event_editor ( ) |
| void | from_text ( string: String ) |
| Dictionary | get_animation_suggestions ( search_text: 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_valid_event ( string: String ) |
| bool | should_show_animation_options ( ) |
| bool | should_show_portrait_selector ( ) |
| String | to_text ( ) |
Constants
No description available.
No description available.
No description available.
Property Descriptions
The type of action of this event (JOIN/LEAVE/UPDATE). See .
Length of the animation.
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.
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 character that will join/leave/update.
Used to set the character resource from the unique name identifier and vice versa
If set, will be passed to the portrait scene.
If true, the portrait will be set to mirrored.
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
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.
Indicators for whether something should be updated (UPDATE mode only)
No description available.
No description available.
The z_index that the portrait should have.
Method Descriptions
func build_event_editor ( ) ⇒ void
No description available.
func from_text ( string: String ) ⇒ void
No description available.
func get_animation_suggestions ( search_text: String ) ⇒ Dictionary
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
this is only here to provide a list of default values this way the module manager can add custom default overrides to this event. this is also why some properties are commented out, because it's not recommended to overwrite them this way
func has_no_portraits ( ) ⇒ bool
No description available.
func is_valid_event ( string: String ) ⇒ bool
No description available.
func should_show_animation_options ( ) ⇒ bool
No description available.
func should_show_portrait_selector ( ) ⇒ bool
No description available.
No description available.