User Tools

Site Tools


remove_entity

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
remove_entity [2018/03/16 09:47] justinremove_entity [2021/04/21 18:40] (current) justin
Line 2: Line 2:
 ---- ----
  
-Permanently removes the specified entity from the scene.+Permanently removes the specified [[entity]] from the [[map]].
  
 ====Signature:==== ====Signature:====
Line 10: Line 10:
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-|entity|The entity to remove from the scene.|[[Entity]]|Yes|+|entity|The [[entity]] to remove from the [[map]].|[[Entity]]|Yes|
  
 ====Example:==== ====Example:====
-<code python+<code bauxite
-remove_entity(entity["key01"])+remove_entity(entity["key_01"]);
 </code> </code>
-//Results:// The entity with an ID of "key01" is permanently removed from the scene.+//Results:// The [[entity]] with an ID of "key_01" is permanently removed from the [[map]].
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
-Use the **Remove Entity** function to remove characters that have exited during a cutscene or as a way for the player to "collect" objects from the scene (i.e. item pickups).+Use the **Remove Entity** function to remove [[character|characters]] that have exited during a cutscene or as a way for the player to "collect" [[object|objects]] from the scene (i.e. [[item]] pickups).
 </WRAP> </WRAP>
  
remove_entity.1521218820.txt.gz · Last modified: 2018/03/16 09:47 by justin