State

dump_save_game()

Export the save game data, if it exists, to an external json file

get_active_skill() → str

Get the active skill. Used for targeting mode.

get_active_skill_target() → Tuple[int, int]

Get the active skill target. Used for targeting mode.

get_current() → scripts.engine.internal.constant.GameState

Get the current game state

get_internal_clock()

Get the internal clock

get_previous() → scripts.engine.internal.constant.GameState

Get the previous game state

get_skill_target_valid() → bool

Get the validity of the current target. Used for targeting mode.

initialise_engine()

Initialise engine resources.

N.B. Must be called before using the rest of the engine.

load_game(filename: str)

Deserialise the game data from a file. Filename does not include path to save folder.

save_game()

Serialise the game data to an internal container

set_active_skill(skill_name: str)

Set the active skill. Used for targeting mode.

set_active_skill_target(skill_target: Tuple[int, int])

Set the active skill target. Used for targeting mode.

set_new(new_game_state: scripts.engine.internal.constant.GameState)

Set the current game state

set_skill_target_valid(skill_target_valid: bool)

Set the validity of the current target. Used for targeting mode.

update_clock() → float

Tick the internal clock. Manages the frame rate. Returns delta time.