tuxemon.event.actions.start_cinema_mode module

final class tuxemon.event.actions.start_cinema_mode.StartCinemaModeAction

Bases: EventAction

Start cinema mode by animating black bars to narrow the aspect ratio.

Script usage

start_cinema_mode

name: ClassVar[str] = 'start_cinema_mode'

session: Session

start()

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:

None