User Tools

Site Tools


add_object

Differences

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

Link to this comparison view

add_object [2019/10/21 09:29] (current)
Line 1: Line 1:
 +======Add Object======
 +----
  
 +Adds an object to the specified tile within the map (if the tile is not already occupied by another object). The entity ID is optional and will be assigned to the new object if supplied.
 +
 +====Signature:​====
 +<code python>
 +add_object(model_name,​ tile, entity_id)
 +</​code>​
 +
 +^Argument^Description^Type^Required^
 +|model_name|Model to use for the new object.|[[String]]|Yes|
 +|tile|ID or coordinate of the tile where the object will be placed.|[[String]] or [[Coordinate]]|Yes|
 +|entity_id|Unique entity ID that will be assigned.|[[String]]|No|
 +
 +<WRAP center round info 100%>
 +The [[Remove Entity]] function can be triggered later to remove an object that was previously added to the scene with the Add Object function.
 +</​WRAP>​
 +
 +====Example:​====
 +<code python>
 +add_object("​tree_small",​ "​target_tile",​ "​new_tree"​)
 +</​code>​
 +//​Results://​ A small tree will be added to the map on the tile having ID "​target_tile"​ and will be assigned an ID of "​new_tree"​.
 +
 +<WRAP center round tip 100%>
 +Use the **Add Object** function to introduce new interactable objects or obstacles into the scene. After being added, you can use the [[Set Entity Script]] function to assign a script to the object or the [[Modify Navigation]] function to mark a now blocked path as impassable.
 +</​WRAP>​
 +
 +----
 +
 +<WRAP group>
 +<WRAP half column>
 +====Editor Node:====
 +{{:​wiki:​add_object_node.png?​nolink|}}
 +</​WRAP>​
 +
 +<WRAP half column>
 +====Visual Demo:====
 +{{:​wiki:​add_object_demo.gif?​nolink|}}
 +</​WRAP>​
 +</​WRAP>​
 +
 +~~NOTOC~~
add_object.txt ยท Last modified: 2019/10/21 09:29 (external edit)