Differences

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

--- assign_entity_id [2020/04/21 22:57] – created justin
+++ assign_entity_id [2023/01/02 21:26] (current) – justin
@@ Line 11: / Line 11: @@
 ^Argument^Description^Type^Required^
 |entity|[[Entity]] that will be assigned the ID.|[[Entity]]|Yes|
-|entity_id|ID the [[entity]] will be assigned.|[[String]]|Yes|
+|entity_id|Unique ID that the [[entity]] will be assigned.|[[String]]|Yes|
+^Return Value^Description^Type^
+|Result|Returns true if the ID was successfully assigned to the [[entity]], false otherwise.|[[Boolean]]|
+<WRAP center round info 100%>
+Entity IDs are case-sensitive and must be unique among other [[entity|entities]] within the same [[map]].
+</WRAP>
 ====Example:====
 <code bauxite>
-assign_entity_id(tile[2, 4, 0], "trap_tile")
+assign_entity_id(tile[random(2, 5), 0, 0], "trap_tile");
 </code>
-//Results:// Adds the [[entity]] with ID "slime01" to the "slimes" [[groups|group]].
+//Results:// Assigns an ID of "trap_tile" to a random [[tile]] along [[coordinate|coordinates]] (2, 0, 0) through (5, 0, 0).
 ----

RPG in a BoxOfficial Documentation