User Tools

Site Tools


stop_player

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.

Signature:

stop_player()
ArgumentDescriptionTypeRequired
(No arguments for this function)

Lock/Unlock Player Movement would typically be used after this function in order to prevent the player from making any further movements during a scripted sequence.

Example:

stop_player()

Results: The player is stopped.

Use the Stop Player function to force the player to stop on their current tile prior to a scripted event or cutscene taking place.


Editor Node:

Visual Demo:

stop_player.txt · Last modified: 2018/03/16 09:50 by justin