RPG in a Box
Official Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

======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:====
<code python>
set_player_movement_locked(is_locked)
</code>

^Argument^Description^Type^Required^
|is_locked|State of player movement.|[[Boolean]]|Yes|

<WRAP center round info 100%>
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.
</WRAP>

====Example:====
<code bauxite>
set_player_movement_locked(true);
</code>
//Results:// The player is no longer able to move around the scene until their movement is re-enabled.

<WRAP center round tip 100%>
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 [[set_player_interaction_locked|Lock/Unlock Player Interaction]].
</WRAP>

----

<WRAP group>
<WRAP half column>
====Editor Node:====
{{:wiki:set_player_movement_locked_node.png?nolink|}}
</WRAP>

<WRAP half column>
</WRAP>
</WRAP>

~~NOTOC~~

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Page Tools

RPG in a Box
Official Documentation