tuxemon.event.actions.clear_variable module

final class tuxemon.event.actions.clear_variable.ClearVariableAction(variable)[source]

Bases: EventAction

Clear the value of a variable from the game.

Script usage

clear_variable <variable>
Script parameters:

variable – The variable to clear.


variable (str) –

name: ClassVar[str] = 'clear_variable'

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:


variable: str