RPG in a Box
Official Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

======Stop Player======
----

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>
stop_player()
</code>

^Argument^Description^Type^Required^
|  (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:====
<code bauxite>
stop_player();
</code>
//Results:// The player is stopped.

<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.
</WRAP>

----

<WRAP group>
<WRAP half column>
====Editor Node:====
{{:wiki:stop_player_node.png?nolink|}}
</WRAP>

<WRAP half column>
====Visual Demo:====
{{:wiki:fade_out_demo.gif?nolink|}}
</WRAP>
</WRAP>

~~NOTOC~~

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Page Tools

RPG in a Box
Official Documentation