set_entity_property
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
| set_entity_property [2017/05/12 14:21] – external edit 127.0.0.1 | set_entity_property [2021/04/21 18:51] (current) – justin | ||
|---|---|---|---|
| Line 2: | Line 2: | ||
| ---- | ---- | ||
| - | Sets a custom property for an entity to the specified value. This property can then be referenced elsewhere. | + | Sets a custom property for an [[entity]] to the specified value. This property can then be referenced elsewhere, for example when evaluating a condition. When editing this function in the [[Script Editor]], the [[Variable Expression Builder]] provides an easy way to choose which value you'd like to assign to the property. These properties can also be given values via [[script_syntax|assignment statements]] (i.e. the " |
| + | ====Signature: | ||
| <code python> | <code python> | ||
| - | set_entity_property(self, " | + | set_entity_property(entity, property_name, property_value) |
| </ | </ | ||
| ^Argument^Description^Type^Required^ | ^Argument^Description^Type^Required^ | ||
| - | |self|Description.|[[String]]|Yes| | + | |entity|[[entity|Entity]] on which the property will be stored.|[[Entity]]|Yes| |
| - | | " | + | |property_name|Name of the property.|[[String]]|Yes| |
| - | | " | + | |property_value|Value that will be assigned to the property.|[[String]], [[Number]], [[Boolean]]|Yes| |
| + | |||
| + | <WRAP center round info 100%> | ||
| + | You can also store general, game-wide properties that are not specific to a [[tile]], [[object]], or [[character]]. For more information, | ||
| + | </ | ||
| ====Example: | ====Example: | ||
| - | < | + | < |
| - | set_entity_property(self, "prop_name", "prop_value") | + | set_entity_property(" |
| </ | </ | ||
| - | // | + | // |
| <WRAP center round tip 100%> | <WRAP center round tip 100%> | ||
| - | Use the **Set Entity Property** function to ... | + | Use the **Set Entity Property** function to keep track of important information about specific [[entity|entities]], |
| </ | </ | ||
set_entity_property.1494624069.txt.gz · Last modified: 2017/05/12 14:21 by 127.0.0.1
Page Tools
