User Tools

Site Tools


set_player_movement_locked

Lock/Unlock Player Movement


Locks or unlocks the player's ability to walk around. This also affects strafing and turning in first-person view.

Signature:

set_player_movement_locked(is_locked)
ArgumentDescriptionTypeRequired
is_lockedState of player movement.BooleanYes

Similar to Lock Camera, this function needs to be called prior to scripting the player's movement with Move Player or Move Character to prevent any player interference.

Example:

set_player_movement_locked(true)

Results: The player is no longer able to move around the scene until their movement is re-enabled.

Use the Lock/Unlock Player Movement function to prevent the player from manually moving during a cutscene. This will typically be used in conjunction with Lock/Unlock Player Interaction.


Editor Node:

set_player_movement_locked.txt · Last modified: 2018/03/16 09:45 by justin