tuxemon.states.sink package

class tuxemon.states.sink.SinkState[source]

Bases: State

State blocking input to lower states in the stack.


Handles player input events.

This function is only called when the player provides input such as pressing a key or clicking the mouse.

Since this is part of a chain of event handlers, the return value from this method becomes input for the next one. Returning None signifies that this method has dealt with an event and wants it exclusively. Return the event and others can use it as well.

You should return None if you have handled input here.


event (PlayerInput) – Player input event.


None if the event should not be passed to the next handlers. Otherwise, return the input event.

Return type:

PlayerInput | None

sprites: SpriteGroup[Sprite]
transparent = True