RPG in a Box
Official Documentation

User Tools

Site Tools

Trace:
scripting_reference

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
scripting_reference [2025/03/11 14:59] – justinscripting_reference [2025/03/11 20:22] (current) – justin
Line 4: Line 4:
 ^Variable^Description^Data Type^ ^Variable^Description^Data Type^
 |global.property["x"]|Custom [[global_properties|global property]], where "x" is a [[string]] containing the name of the property. This can be used to either retrieve or change the property's value.|Varies| |global.property["x"]|Custom [[global_properties|global property]], where "x" is a [[string]] containing the name of the property. This can be used to either retrieve or change the property's value.|Varies|
 +|global.properties|All custom global properties. As it's a [[codex]], its keys can be iterated using a "for" loop (refer to the [[codex]] documentation for an example).|[[Codex]]|
 |global.theme|Current UI [[theme_editor|theme]]. Can be used to retrieve or modify the [[theme_editor|theme]].|[[String]]| |global.theme|Current UI [[theme_editor|theme]]. Can be used to retrieve or modify the [[theme_editor|theme]].|[[String]]|
 |global.gameplay|Gameplay settings. Can be used to retrieve the gameplay settings as defined in your [[Game Configuration]].|[[Codex]]| |global.gameplay|Gameplay settings. Can be used to retrieve the gameplay settings as defined in your [[Game Configuration]].|[[Codex]]|
Line 16: Line 17:
 |map.name|Name of the current [[map]].|[[String]]| |map.name|Name of the current [[map]].|[[String]]|
 |map.groups|List of [[groups]] defined for the current [[map]].|[[Array]]| |map.groups|List of [[groups]] defined for the current [[map]].|[[Array]]|
-|map.properties|Custom properties defined for the current [[map]].|[[Codex]]|+|map.property["x"]|Custom property stored on the [[map]], where "x" is a [[string]] containing the name of the property. This can be used to either retrieve or change the property's value.|Varies| 
 +|map.properties|All custom properties defined for the current [[map]]. As it's a [[codex]], its keys can be iterated using a "for" loop (refer to the [[codex]] documentation for an example).|[[Codex]]|
  
 =====Camera Variables===== =====Camera Variables=====
scripting_reference.1741730366.txt.gz · Last modified: 2025/03/11 14:59 by justin

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki