This contains the source code documentation of the class subsystem_Jump.

subsystem_Jump

Subsystem that holds methods for jumping to specific labels, or return to the previous jump.

Methods

Returns	Method
void	clear_game_state ( `_clear_flag`: int = `0` )
void	load_game_state ( `_load_flag`: int = `0` )
void	jump_to_label ( `label`: String )
void	push_to_jump_stack ( )
void	resume_from_last_jump ( )
bool	is_jump_stack_empty ( )
String	get_last_label_identifier ( )
String	get_last_label_name ( )

Signals

signal switched_timeline ( info: Dictionary )

No description available.

signal jumped_to_label ( info: Dictionary )

Emitted when a jump event jumps to a label. Gives a dictionary witht the keys: Key | Value Type | Value ----------- | ----------------------- | ----- timeline | DialogicTimeline | The timeline we are in now. label | String | The label we went to (empty if beginning).

signal returned_from_jump ( info: Dictionary )

Emitted when a return event is hit and there was a timeline to return to. Gives a dictionary witht the keys: Key | Value Type | Value --------------- | ----------------------- | ----- sub_timeline | DialogicTimeline | The timeline we were in before. label | String | The label we went back to (empty if beginning).

signal passed_label ( info: Dictionary )

Emitted when a label event is executed (usually does nothing else). Gives a dictionary witht the keys: Key | Value Type | Value ------------------- | ----------------------- | ----- identifier | String | The identifier of the label event. display_name | String | The display name, possibly translated. display_name_orig | String | The untranslated display name. timeline | String | The identifier of the timeline we are in.