User Tools

Site Tools


disable_container

Differences

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

Link to this comparison view

Next revision
Previous revision
disable_container [2017/11/24 09:27] – created justindisable_container [2021/04/21 18:58] (current) justin
Line 2: Line 2:
 ---- ----
  
-Disables access to an item container, prohibiting usage by the player until re-enabled.+Disables access to an [[item container]], prohibiting usage by the player until re-enabled.
  
 +====Signature:====
 <code python> <code python>
 disable_container(entity_id) disable_container(entity_id)
Line 10: Line 11:
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
 |entity_id|Entity ID of the container to disable.|[[String]]|Yes| |entity_id|Entity ID of the container to disable.|[[String]]|Yes|
 +
 +<WRAP center round info 100%>
 +You can use the complementary [[Enable Container]] function to re-enable an [[item container]] that has previously been disabled.
 +</WRAP>
  
 ====Example:==== ====Example:====
-<code python+<code bauxite
-disable_container("chest_01")+disable_container("chest_01");
 </code> </code>
-//Results:// The item container with an ID of "chest_01"+//Results:// The [[item container]] with an ID of "chest_01" will become inaccessible to the player until re-enabled.
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
-Use the **Disable Container** function in your startup script.+Use the **Disable Container** function in your [[startup script]] to initially disable (i.e. "lock") a treasure chest to prohibit access until the player obtains a means of unlocking it.
 </WRAP> </WRAP>
  
disable_container.1511544422.txt.gz · Last modified: 2017/11/24 09:27 by justin