RPG in a Box
Official Documentation

User Tools

Site Tools

Trace:
add_character

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
add_character [2020/04/22 17:22] – justinadd_character [2023/01/02 21:15] (current) – justin
Line 2: Line 2:
 ---- ----
  
-Adds a [[character]] to the specified [[tile]] within the [[map]] (if the [[tile]] is not already occupied by another [[character]]). The [[entity]] ID is optional and will be assigned to the new [[character]] if supplied.+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:==== ====Signature:====
Line 10: Line 10:
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-|model_name|Model to use for the new [[character]].|[[String]]|Yes| +|model_name|Model to use for the new [[character|character]].|[[string|String]]|Yes| 
-|tile|ID or [[coordinate]] of the [[tile]] where the [[character]] will be placed.|[[String]] or [[Coordinate]]|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]] ID that will be assigned.|[[String]]|No|+|entity_id|Unique [[entity|entity]] ID that will be assigned.|[[string|String]]|No|
  
 <WRAP center round info 100%> <WRAP center round info 100%>
-The [[Remove Entity]] function can be triggered later to remove a [[character]] that was previously added to the scene with the Add Character function.+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> </WRAP>
 +
 +^Return Value^Description^Type^
 +|Character Added|Returns a reference to the [[character]] that was added.|[[Entity]]|
  
 ====Example:==== ====Example:====
 <code bauxite> <code bauxite>
-add_character("purple_slime", "dungeon_door_01", "slime_01")+add_character("purple_slime", "dungeon_door_01", "slime_01");
 </code> </code>
-//Results:// A purple slime will be added to the [[map]] on the [[tile]] having ID "dungeon_door_01" and will be assigned an ID of "slime_01".+//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%> <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]] function to assign a [[dialogue]] to the [[character]] or the [[Set Character Name]] function to change their name.+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>
  
Line 33: Line 36:
 <WRAP half column> <WRAP half column>
 ====Editor Node:==== ====Editor Node:====
-{{:wiki:add_character_node.png?nolink|}}+{{:add_character_node.png?nolink|}}
 </WRAP> </WRAP>
  
 <WRAP half column> <WRAP half column>
 ====Visual Demo:==== ====Visual Demo:====
-{{:wiki:add_character_demo.gif?nolink|}}+{{:add_character_demo.gif?nolink|}}
 </WRAP> </WRAP>
 </WRAP> </WRAP>
  
 ~~NOTOC~~ ~~NOTOC~~
add_character.1587601336.txt.gz · Last modified: 2020/04/22 17:22 by justin

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki