Differences

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

--- move_player [2017/04/24 12:27] – justin
+++ move_player [2021/04/21 18:36] (current) – justin
@@ Line 2: / Line 2: @@
 ----
-Moves the player to the specified tile at their assigned movement speed. If a walkable path is not open then the player will remain at their current position. The player's movement must first be locked before using this function.
+Moves the player to the specified [[tile]] at their assigned movement speed. If a walkable path is not open the player will remain at their current position. The player's movement must first be locked before using this function.
+====Signature:====
 <code python>
-move_player(tile_id)
+move_player(tile)
 </code>
 ^Argument^Description^Type^Required^
-|tile_id|ID of the destination tile.|[[String]]|Yes|
+|tile|ID or [[coordinate]] of the destination [[tile]] or a reference to the destination [[tile]] itself.|[[String]], [[Coordinate]], or [[Entity]]|Yes|
+<WRAP center round info 100%>
+[[set_player_movement_locked|Lock/Unlock Player Movement]] must be called before using this function to prevent the player from interfering with the scripted movement.
+</WRAP>
 ====Example:====
-<code python>
+<code bauxite>
-move_player("tile_id")
+move_player("bridge01");
 </code>
-//Results://
+//Results:// The [[player character]] walks from their current location to the bridge [[tile]] with an ID of "bridge01".
 <WRAP center round tip 100%>
-Use the **Move Player** function to ...
+Use the **Move Player** function to move the [[player character]] around the [[map]] during scripted sequences or cutscenes.
 </WRAP>

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Differences

Page Tools

RPG in a Box
Official Documentation