RPG in a Box
Official Documentation

User Tools

Site Tools

Trace: • steam_workshop
object

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
object [2024/01/25 10:43] – justinobject [2025/03/11 20:25] (current) – justin
Line 21: Line 21:
 |<object>.interact_cursor|Interaction cursor for the object, as set in the [[Map Editor]] from the [[Entity Properties]] panel. This can be used to either retrieve or change the interaction cursor for the object. Valid values include "default", "walk", "interact", "speak", "attack", or any custom cursor defined in your [[game configuration]].| |<object>.interact_cursor|Interaction cursor for the object, as set in the [[Map Editor]] from the [[Entity Properties]] panel. This can be used to either retrieve or change the interaction cursor for the object. Valid values include "default", "walk", "interact", "speak", "attack", or any custom cursor defined in your [[game configuration]].|
 |<object>.property["x"]|Custom property stored on the object, where "x" is a [[string]] containing the name of the property. This can be used to either retrieve or change the property's value.| |<object>.property["x"]|Custom property stored on the object, where "x" is a [[string]] containing the name of the property. This can be used to either retrieve or change the property's value.|
 +|<object>.properties|All custom properties defined for the object. As it's a [[codex]], its keys can be iterated using a “for” loop (refer to the [[codex]] documentation for an example).|
 |<object>.model|Name of the object's model (e.g. "tree").| |<object>.model|Name of the object's model (e.g. "tree").|
 |<object>.frame|Current [[animation]] frame (as a [[number]], with the first frame being 1). This can be used to either retrieve or change the model's current frame. If this property is changed and an [[animation]] is playing, the [[animation]] will first be stopped.| |<object>.frame|Current [[animation]] frame (as a [[number]], with the first frame being 1). This can be used to either retrieve or change the model's current frame. If this property is changed and an [[animation]] is playing, the [[animation]] will first be stopped.|
 +|<object>.animation|Name of the [[animation]] currently playing for this object (as a [[string]]). Value will be null if no [[animation]] is playing.|
 |<object>.animations|An [[array]] of [[animation]] names defined for this object. The names will be [[string]] values.| |<object>.animations|An [[array]] of [[animation]] names defined for this object. The names will be [[string]] values.|
 |<object>.attach_points|An [[array]] of [[attach_points|attach point]] names defined for this object (across all [[animation]] frames). The names will be [[string]] values. The [[array]] will be empty if no [[attach points]] are defined.| |<object>.attach_points|An [[array]] of [[attach_points|attach point]] names defined for this object (across all [[animation]] frames). The names will be [[string]] values. The [[array]] will be empty if no [[attach points]] are defined.|
object.1706208223.txt.gz · Last modified: 2024/01/25 10:43 by justin

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki