59 lines
1.9 KiB
GDScript
59 lines
1.9 KiB
GDScript
@tool
|
|
@icon("history_state.svg")
|
|
class_name HistoryState
|
|
extends State
|
|
|
|
## Whether this state is a deep history state. A deep history state
|
|
## will remember all nested states, while a shallow history state will
|
|
## only remember the last active state of the parent state.
|
|
@export var deep:bool = false
|
|
|
|
## The default state to transition to if no history is available.
|
|
@export_node_path("State") var default_state:NodePath:
|
|
set(value):
|
|
default_state = value
|
|
update_configuration_warnings()
|
|
|
|
|
|
## The stored history, if any.
|
|
var history:SavedState = null
|
|
|
|
|
|
func _state_save(saved_state:SavedState, child_levels:int = -1) -> void:
|
|
# History states are pseudo states, so they only save remembered history if any
|
|
var our_state = SavedState.new()
|
|
our_state.history = history
|
|
saved_state.add_substate(self, our_state)
|
|
|
|
|
|
func _state_restore(saved_state:SavedState, child_levels:int = -1) -> void:
|
|
# History states are pseudo states, so they only restore remembered history if any
|
|
var our_state = saved_state.get_substate_or_null(self)
|
|
if our_state != null:
|
|
history = our_state.history
|
|
|
|
|
|
func _get_configuration_warnings() -> PackedStringArray:
|
|
var warnings = super._get_configuration_warnings()
|
|
|
|
# a history state must be a child of a compound state otherwise it is useless
|
|
var parent_state = get_parent()
|
|
if not parent_state is CompoundState:
|
|
warnings.append("A history state must be a child of a compound state.")
|
|
|
|
# the default state must be a state
|
|
var default_state_node = get_node_or_null(default_state)
|
|
if not default_state_node is State:
|
|
warnings.append("The default state is not set or is not a state.")
|
|
else:
|
|
# the default state must be a child of the parent state
|
|
if not get_parent().is_ancestor_of(default_state_node):
|
|
warnings.append("The default state must be a child of the parent state.")
|
|
|
|
# a history state must not have any children
|
|
if get_child_count() > 0:
|
|
warnings.append("History states cannot have child nodes.")
|
|
|
|
return warnings
|
|
|