RPG in a Box
Official Documentation

User Tools

Site Tools

Trace:
move_player

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Last revisionBoth sides next revision
move_player [2017/04/24 14:49] – justinmove_player [2020/04/22 17:47] – 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> <code python>
-move_player(tile_id)+move_player(tile)
 </code> </code>
  
 ^Argument^Description^Type^Required^ ^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%> <WRAP center round info 100%>
Line 16: Line 17:
  
 ====Example:==== ====Example:====
-<code python>+<code bauxite>
 move_player("bridge01") move_player("bridge01")
 </code> </code>
-//Results:// The player character walks from their current location to the bridge tile with an ID of "bridge01".+//Results:// The [[player character]] walks from their current location to the bridge [[tile]] with an ID of "bridge01".
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
-Use the **Move Player** function to move the player character around the map during scripted segments or cutscenes.+Use the **Move Player** function to move the [[player character]] around the [[map]] during scripted sequences or cutscenes.
 </WRAP> </WRAP>
  
move_player.txt · Last modified: 2021/04/21 18:36 by justin

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki