This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
stop_player [2017/05/28 12:16] – justin | stop_player [2023/01/25 21:38] – 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 [[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/ | ||
+ | </ | ||
====Example: | ====Example: | ||
- | < | + | < |
- | stop_player() | + | stop_player(); |
</ | </ | ||
- | // | + | // |
<WRAP center round tip 100%> | <WRAP center round tip 100%> | ||
- | Use the **Stop Player** function to force a static view of the current | + | Use the **Stop Player** function to force the player to stop on their current |
</ | </ | ||