User Tools

Site Tools


stop_player

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
stop_player [2017/05/28 12:16] justinstop_player [2023/01/25 21:39] (current) justin
Line 2: Line 2:
 ---- ----
  
-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.+Stops the player and cancels any queued movement. If the player is currently in the process of walking to the next adjacent [[tile]] in their planned path, that movement will first be completed before the player is stopped.
  
 +====Signature:====
 <code python> <code python>
 stop_player() stop_player()
Line 10: Line 11:
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
 |  (No arguments for this function)  |||| |  (No arguments for this function)  ||||
 +
 +<WRAP center round info 100%>
 +[[set_player_movement_locked|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.
 +</WRAP>
  
 ====Example:==== ====Example:====
-<code python+<code bauxite
-stop_player()+stop_player();
 </code> </code>
-//Results:// The camera is locked into its current position within the scene and the player's movements no longer affect the camera until it has been reset. Zooming and rotating of the camera are also disabled.+//Results:// The player is stopped.
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
-Use the **Stop Player** function to force a static view of the current map or to freeze the camera in place for the duration of a cutscene.+Use the **Stop Player** function to force the player to stop on their current [[tile]] prior to a scripted event or cutscene taking place.
 </WRAP> </WRAP>
  
stop_player.1495998984.txt.gz · Last modified: 2017/05/28 12:16 by justin