This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
stop_player [2020/03/16 11:16] – justin | stop_player [2023/01/25 21:37] – 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]], the movement |
====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/ | + | <WRAP center round info 100%> |
+ | [[set_player_movement_locked|Lock/ | ||
+ | </ | ||
====Example: | ====Example: | ||
<code bauxite> | <code bauxite> | ||
- | stop_player() | + | stop_player(); |
</ | </ | ||
// | // | ||
<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 |
</ | </ | ||