RPG in a Box
Official Documentation

User Tools

Site Tools

Trace:
put_entity

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
put_entity [2018/03/16 09:46] – justinput_entity [2021/10/30 20:17] (current) – justin
Line 2: Line 2:
 ---- ----
  
-Instantly positions an object or character onto the specified tile.+Instantly positions an [[object]] or [[character]] onto the specified [[tile]].
  
 ====Signature:==== ====Signature:====
 <code python> <code python>
-put_entity(entity_id, tile_id)+put_entity(entity, target_tile)
 </code> </code>
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-|entity_id|ID of the entity to reposition.|[[String]]|Yes| +|entity|[[Entity]] to reposition.|[[Entity]]|Yes| 
-|tile_id|ID of the destination tile.|[[String]]|Yes|+|target_tile|Target [[tile]] onto which the [[entity]] will be placed.|[[Entity]], [[Coordinate]]|Yes|
  
 <WRAP center round info 100%> <WRAP center round info 100%>
-If you are changing the player's position, you can alternatively use the more convenient [[Put Player]] function which also lets you specify the player's direction.+If you are changing the [[player_character|player's]] position, you can alternatively use the more convenient [[Put Player]] function which also lets you specify the [[player_character|player's]] [[cardinal_direction|direction]].
 </WRAP> </WRAP>
  
 ====Example:==== ====Example:====
-<code python> +<code bauxite> 
-put_entity("slippery_chest", "chest_destination")+put_entity(entity["slippery_chest"], "chest_destination");
 </code> </code>
-//Results:// The entity with an ID of "slippery_chest" is immediately repositioned onto the tile with an ID of "chest_destination".+//Results:// The [[entity]] with an ID of "slippery_chest" is immediately repositioned onto the [[tile]] with an ID of "chest_destination".
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
-Use the **Put Entity** function to move objects around the scene, for example to create the illusion that the player has pushed an obstacle out of their way.+Use the **Put Entity** function to move [[object|objects]] around the scene, for example to create the illusion that the [[player_character|player]] has pushed an obstacle out of their way.
 </WRAP> </WRAP>
  
Line 32: Line 32:
 <WRAP half column> <WRAP half column>
 ====Editor Node:==== ====Editor Node:====
-{{:wiki:put_entity_node.png?nolink|}}+{{:put_entity_node.png?nolink|}}
 </WRAP> </WRAP>
  
 <WRAP half column> <WRAP half column>
 ====Visual Demo:==== ====Visual Demo:====
-{{:wiki:put_entity_demo.gif?nolink|}}+{{:put_entity_demo.gif?nolink|}}
 </WRAP> </WRAP>
 </WRAP> </WRAP>
put_entity.1521218810.txt.gz · Last modified: 2018/03/16 09:46 by justin

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki