VisionaireObject Commands: Difference between revisions
From The Official Visionaire Studio: Adventure Game Engine Wiki
No edit summary |
No edit summary |
||
| Line 8: | Line 8: | ||
! Description | ! Description | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: clearLink|clearLink]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: create|create]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: debug|debug]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: duplicate|duplicate]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getBool|getBool]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getFloats|getFloats]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getFloat|getFloat]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getId|getId]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getInts|getInts]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getInt|getInt]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getLinks|getLinks]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getLink|getLink]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getName|getName]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getObject|getObject]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getParent|getParent]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getPaths|getPaths]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getPath|getPath]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getPoints|getPoints]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getPoint|getPoint]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getRects|getRects]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getRect|getRect]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getSprites|getSprites]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getSprite|getSprite]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getStr|getStr]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getTextStr|getTextStr]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: getTexts|getTexts]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: info|info]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: isAnyObject|isAnyObject]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: isEmpty|isEmpty]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: remove|remove]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: setName|setName]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: setTextStr|setTextStr]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: setValue|setValue]] | ||
| | | | ||
|- | |- | ||
| [[VisionaireObject Command: | | [[VisionaireObject Command: to|to]] | ||
| | | | ||
|} | |} | ||
| Line 121: | Line 121: | ||
| '''id''' | | '''id''' | ||
| int | | int | ||
| ( | | The internal id of the object (read-only). | ||
|- | |- | ||
| '''name''' | | '''name''' | ||
| string | | string | ||
| ( | | The internal name of the object as defined in the editor (read-only). Not to be confused with the "Name" property (with capitalized "N") which is available for some objects and contains the multi-language object name used in the game. | ||
|- | |- | ||
| '''parent''' | | '''parent''' | ||
| TVisObj | | TVisObj | ||
| ( | | Returns the parent object (read-only). | ||
|- | |- | ||
| '''tableId''' | | '''tableId''' | ||
| int | | int | ||
| ( | | The id of the data structure table the object is part of (read-only). | ||
|- | |||
| ''property'' | |||
| mixed | |||
| All [[Data Structure|properties/fields]] of a VisionaireObject are available through their names. | |||
|} | |} | ||
{{toc}} | {{toc}} | ||
Revision as of 15:33, 11 August 2023
This is a list of methods and fields supported on a Visionaire Object (TVisObj).
Methods
Fields
| Field Name | Type | Description |
|---|---|---|
| id | int | The internal id of the object (read-only). |
| name | string | The internal name of the object as defined in the editor (read-only). Not to be confused with the "Name" property (with capitalized "N") which is available for some objects and contains the multi-language object name used in the game. |
| parent | TVisObj | Returns the parent object (read-only). |
| tableId | int | The id of the data structure table the object is part of (read-only). |
| property | mixed | All properties/fields of a VisionaireObject are available through their names. |