Differences

This shows you the differences between two versions of the page.

--- set_player_movement_locked [2017/04/14 14:41] – external edit 127.0.0.1
+++ set_player_movement_locked [2020/04/25 16:14] – justin
@@ Line 2: / Line 2: @@
 ----
-Locks or unlocks the player's ability to walk or turn.
+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(true)
+set_player_movement_locked(is_locked)
 </code>
 ^Argument^Description^Type^Required^
-|true|Description.|[[String]]|Yes|
+|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 python>
+<code bauxite>
 set_player_movement_locked(true)
 </code>
-//Results://
+//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 ...
+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>
@@ Line 30: / Line 35: @@
 <WRAP half column>
-====Visual Demo:====
-{{:wiki:set_player_movement_locked_demo.gif?nolink|}}
 </WRAP>
 </WRAP>

RPG in a BoxOfficial Documentation