User Tools

Site Tools


set_player_movement_locked

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
set_player_movement_locked [2017/04/14 15:02]
justin
set_player_movement_locked [2021/04/21 18:35] (current)
justin
Line 2: Line 2:
 ---- ----
  
-Locks or unlocks the player's ability to walk around. This also affects strafing and turning in first-person view.+Locks or unlocks the player's ability to walk around. This also affects strafing and turning in first-person view. 
  
 +====Signature:====
 <code python> <code python>
 set_player_movement_locked(is_locked) set_player_movement_locked(is_locked)
Line 10: Line 11:
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
 |is_locked|State of player movement.|[[Boolean]]|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:==== ====Example:====
-<code python+<code bauxite
-set_player_movement_locked(true)+set_player_movement_locked(true);
 </code> </code>
-//Results:// The player is no longer able to move around the scene until their movement is unlocked.+//Results:// The player is no longer able to move around the scene until their movement is re-enabled.
  
 <WRAP center round tip 100%> <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 cutsceneThis will typically be used in conjunction with [[set_player_interaction_locked|Lock/Unlock Player Interaction]].
 </WRAP> </WRAP>
  
set_player_movement_locked.1492207372.txt.gz · Last modified: 2017/04/14 15:02 by justin