tuxemon.event.actions.remove_state module

final class tuxemon.event.actions.remove_state.RemoveStateAction(state_name=None)[source]

Bases: EventAction

Remove the specified state.

Script usage

remove_state <state_name>
Script parameters:

state_name – The state name to remove (e.g. PCState)


state_name (str | None) –

name: ClassVar[str] = 'remove_state'

Called only once, when the action is started.

For all actions, you will need to override this method.

For actions that only need to run one frame you can simply put all the code here. If the action will need to run over several frames, you can init your action here, then override the update method.

Return type:


state_name: str | None = None