RPG in a Box
Official Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

======Add Character======
----

Adds a [[character|character]] to the specified [[tile|tile]] within the [[map|map]] (if the [[tile|tile]] is not already occupied by another [[character|character]]). The [[entity|entity]] ID is optional and will be assigned to the new [[character|character]] if supplied.

====Signature:====
<code python>
add_character(model_name, tile, entity_id)
</code>

^Argument^Description^Type^Required^
|model_name|Model to use for the new [[character|character]].|[[string|String]]|Yes|
|tile|ID or [[coordinate|coordinate]] of the [[tile|tile]] where the [[character|character]] will be placed.|[[string|String]], [[coordinate|Coordinate]]|Yes|
|entity_id|Unique [[entity|entity]] ID that will be assigned.|[[string|String]]|No|

<WRAP center round info 100%>
The [[remove_entity|Remove Entity]] function can be triggered later to remove a [[character|character]] that was previously added to the scene with the Add Character function.
</WRAP>

^Return Value^Description^Type^
|Character Added|Returns a reference to the [[character]] that was added.|[[Entity]]|

====Example:====
<code bauxite>
add_character("purple_slime", "dungeon_door_01", "slime_01");
</code>
//Results:// A purple slime will be added to the [[map|map]] on the [[tile|tile]] having ID "dungeon_door_01" and will be assigned an ID of "slime_01".

<WRAP center round tip 100%>
Use the **Add Character** function to introduce new [[npc|NPCs]] into the scene. After being added, you can use the [[set_dialogue|Set Dialogue]] function to assign a [[dialogue|dialogue]] to the [[character|character]] or the [[set_character_name|Set Character Name]] function to change their name.
</WRAP>

----

<WRAP group>
<WRAP half column>
====Editor Node:====
{{:add_character_node.png?nolink|}}
</WRAP>

<WRAP half column>
====Visual Demo:====
{{:add_character_demo.gif?nolink|}}
</WRAP>
</WRAP>

~~NOTOC~~

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Page Tools

RPG in a Box
Official Documentation