This contains the source code documentation of the class DialogicJumpEvent.
DialogicJumpEvent
Inherits: Resource
Event that allows starting another timeline. Also can jump to a label in that or the current timeline.
Properties
| Name | Type | Default |
|---|---|---|
| timeline | DialogicTimeline | |
| label_name | String | "" |
| timeline_identifier | String | "" |
Methods
| Returns | Method |
|---|---|
| String | to_text ( ) |
| void | from_text ( string: String ) |
| bool | is_valid_event ( string: String ) |
| Dictionary | get_shortcode_parameters ( ) |
| void | build_event_editor ( ) |
| Dictionary | get_timeline_suggestions ( _filter: String = "" ) |
| Dictionary | get_label_suggestions ( _filter: String = "" ) |
Property Descriptions
The timeline to jump to, if null then it's the current one. This setting should be a dialogic timeline resource.
If not empty, the event will try to find a Label event with this set as name. Empty by default..
Used to set the timeline resource from the unique name identifier and vice versa
Method Descriptions
############################################################################## SAVING/LOADING ##############################################################################
func from_text ( string: String ) ⇒ void
No description available.
func is_valid_event ( string: String ) ⇒ bool
No description available.
func get_shortcode_parameters ( ) ⇒ Dictionary
No description available.
func build_event_editor ( ) ⇒ void
No description available.
func get_timeline_suggestions ( _filter: String = "" ) ⇒ Dictionary
No description available.
func get_label_suggestions ( _filter: String = "" ) ⇒ Dictionary
No description available.