RPG in a Box
Official Documentation

User Tools

Site Tools

Trace:
stop_player

Differences

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

Link to this comparison view

Next revision		Previous revision
stop_player [2017/05/28 11:55] – external edit 127.0.0.1stop_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 and the player will then be 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 12: Line 13:
  
 <WRAP center round info 100%> <WRAP center round info 100%>
-This function must be called to put the camera into a locked state before using any of the camera movement functions: [[Move Camera]], [[Move Camera At Speed]], [[Move Camera Over Time]], [[Look At Target]], [[Look At Target Over Time]], [[Rotate Camera]], and [[Rotate Camera Over Time]].+[[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>
  
 ====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>
  
Line 35: Line 36:
 <WRAP half column> <WRAP half column>
 ====Visual Demo:==== ====Visual Demo:====
-{{:wiki:stop_player_demo.gif?nolink|}}+{{:wiki:fade_out_demo.gif?nolink|}}
 </WRAP> </WRAP>
 </WRAP> </WRAP>
stop_player.1495997705.txt.gz · Last modified: 2017/05/28 11:55 by 127.0.0.1

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki