User Tools

Site Tools


stop_player

This is an old revision of the document!


Stop Player


Stops the player and cancels any queued movement. If the player is currently in the process of walking to a new tile, that movement will first be completed before the player is stopped.

stop_player()
ArgumentDescriptionTypeRequired
(No arguments for this function)

Example:

stop_player()

Results: The camera is locked into its current position within the scene and the player's movements no longer affect the camera until it has been reset. Zooming and rotating of the camera are also disabled.

Use the Stop Player function to force a static view of the current map or to freeze the camera in place for the duration of a cutscene.


Editor Node:

Visual Demo:

stop_player.1495998009.txt.gz · Last modified: 2017/05/28 12:00 by justin