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 revision Previous revision
Next revision
Previous revision
stop_player [2018/03/16 09:50]
justin
stop_player [2020/04/22 17:59] (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 a new [[tile]], that movement will first be completed before the player is stopped.
  
 ====Signature:​==== ====Signature:​====
Line 12: Line 12:
 |  (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>​+<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>​
Line 21: Line 23:
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
-Use the **Stop Player** function to force the player to stop on their current tile prior to a scripted event or cutscene taking place.+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.1521219013.txt.gz · Last modified: 2018/03/16 09:50 by justin