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:

add_object(model_name, tile, entity_id)
ArgumentDescriptionTypeRequired
model_nameModel to use for the new object.StringYes
tileID or coordinate of the tile where the object will be placed.String, CoordinateYes
entity_idUnique entity ID that will be assigned.StringNo
Return ValueDescriptionType
Object AddedReturns a reference to the object that was added.Entity

The Remove Entity function can be triggered later to remove an object that was previously added to the scene with the Add Object function.

Example:

add_object("tree_small", "target_tile", "new_tree");

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”.

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.


Editor Node:

Visual Demo: