Difference between revisions of "VisionaireObject Commands"
From The Official Visionaire Studio: Adventure Game Engine Wiki
| Line 9: | Line 9: | ||
|- | |- | ||
| [[VisionaireObject Command: clearLink|clearLink]] | | [[VisionaireObject Command: clearLink|clearLink]] | ||
| − | | | + | | Removes a link from the VisionaireObject. |
|- | |- | ||
| [[VisionaireObject Command: create|create]] | | [[VisionaireObject Command: create|create]] | ||
| Line 21: | Line 21: | ||
|- | |- | ||
| [[VisionaireObject Command: getBool|getBool]] | | [[VisionaireObject Command: getBool|getBool]] | ||
| − | | | + | | Returns the boolean value of a VisionaireObject field. |
|- | |- | ||
| [[VisionaireObject Command: getFloat|getFloat]] | | [[VisionaireObject Command: getFloat|getFloat]] | ||
| − | | | + | | Returns the decimal value of a VisionaireObject field. |
|- | |- | ||
| [[VisionaireObject Command: getFloats|getFloats]] | | [[VisionaireObject Command: getFloats|getFloats]] | ||
| − | | | + | | Returns a table containing multiple float (decimal) values. |
|- | |- | ||
| [[VisionaireObject Command: getId|getId]] | | [[VisionaireObject Command: getId|getId]] | ||
| − | | | + | | Returns a table containing the internal id of the VisionaireObject and the id of the table it belongs to. |
|- | |- | ||
| [[VisionaireObject Command: getInt|getInt]] | | [[VisionaireObject Command: getInt|getInt]] | ||
| − | | | + | | Returns the integer value of a VisionaireObject field. |
|- | |- | ||
| [[VisionaireObject Command: getInts|getInts]] | | [[VisionaireObject Command: getInts|getInts]] | ||
| − | | | + | | Returns a table containing multiple integer values. |
|- | |- | ||
| [[VisionaireObject Command: getLink|getLink]] | | [[VisionaireObject Command: getLink|getLink]] | ||
| − | | | + | | Returns the VisionaireObject which is linked in a VisionaireObject field. |
|- | |- | ||
| [[VisionaireObject Command: getLinks|getLinks]] | | [[VisionaireObject Command: getLinks|getLinks]] | ||
| − | | | + | | Returns a table containing multiple VisionaireObjects. |
|- | |- | ||
| [[VisionaireObject Command: getName|getName]] | | [[VisionaireObject Command: getName|getName]] | ||
| − | | | + | | Returns the internal name of the VisionaireObject. |
|- | |- | ||
| [[VisionaireObject Command: getObject|getObject]] | | [[VisionaireObject Command: getObject|getObject]] | ||
| Line 51: | Line 51: | ||
|- | |- | ||
| [[VisionaireObject Command: getParent|getParent]] | | [[VisionaireObject Command: getParent|getParent]] | ||
| − | | | + | | Returns the parent object of the VisionaireObject. |
|- | |- | ||
| [[VisionaireObject Command: getPath|getPath]] | | [[VisionaireObject Command: getPath|getPath]] | ||
| − | | | + | | Returns the path to a media file, linked in a VisionaireObject field. |
|- | |- | ||
| [[VisionaireObject Command: getPaths|getPaths]] | | [[VisionaireObject Command: getPaths|getPaths]] | ||
| − | | | + | | Returns a table containing multiple paths to media files. |
|- | |- | ||
| [[VisionaireObject Command: getPoint|getPoint]] | | [[VisionaireObject Command: getPoint|getPoint]] | ||
| − | | | + | | Returns the point values of a VisionaireObject field. |
|- | |- | ||
| [[VisionaireObject Command: getPoints|getPoints]] | | [[VisionaireObject Command: getPoints|getPoints]] | ||
| − | | | + | | Returns a table containing multiple point values. |
|- | |- | ||
| [[VisionaireObject Command: getRect|getRect]] | | [[VisionaireObject Command: getRect|getRect]] | ||
| − | | | + | | Returns the rectangle values of a VisionaireObject field. |
|- | |- | ||
| [[VisionaireObject Command: getRects|getRects]] | | [[VisionaireObject Command: getRects|getRects]] | ||
| − | | | + | | Returns a table containing multiple rectangle values. |
|- | |- | ||
| [[VisionaireObject Command: getSprite|getSprite]] | | [[VisionaireObject Command: getSprite|getSprite]] | ||
| − | | | + | | Returns the sprite values of a VisionaireObject field. |
|- | |- | ||
| [[VisionaireObject Command: getSprites|getSprites]] | | [[VisionaireObject Command: getSprites|getSprites]] | ||
| − | | | + | | Returns a table containing multiple sprite values. |
|- | |- | ||
| [[VisionaireObject Command: getStr|getStr]] | | [[VisionaireObject Command: getStr|getStr]] | ||
| − | | | + | | Returns the string value of a VisionaireObject field. |
|- | |- | ||
| [[VisionaireObject Command: getTextStr|getTextStr]] | | [[VisionaireObject Command: getTextStr|getTextStr]] | ||
| Line 99: | Line 99: | ||
|- | |- | ||
| [[VisionaireObject Command: setName|setName]] | | [[VisionaireObject Command: setName|setName]] | ||
| − | | | + | | Sets the internal name of the VisionaireObject. |
|- | |- | ||
| [[VisionaireObject Command: setTextStr|setTextStr]] | | [[VisionaireObject Command: setTextStr|setTextStr]] | ||
Revision as of 19:21, 31 August 2023
This is a list of methods and fields supported on a Visionaire Object (TVisObj).
Methods
| Function Name | Description |
|---|---|
| clearLink | Removes a link from the VisionaireObject. |
| create | |
| debug | |
| duplicate | |
| getBool | Returns the boolean value of a VisionaireObject field. |
| getFloat | Returns the decimal value of a VisionaireObject field. |
| getFloats | Returns a table containing multiple float (decimal) values. |
| getId | Returns a table containing the internal id of the VisionaireObject and the id of the table it belongs to. |
| getInt | Returns the integer value of a VisionaireObject field. |
| getInts | Returns a table containing multiple integer values. |
| getLink | Returns the VisionaireObject which is linked in a VisionaireObject field. |
| getLinks | Returns a table containing multiple VisionaireObjects. |
| getName | Returns the internal name of the VisionaireObject. |
| getObject | |
| getParent | Returns the parent object of the VisionaireObject. |
| getPath | Returns the path to a media file, linked in a VisionaireObject field. |
| getPaths | Returns a table containing multiple paths to media files. |
| getPoint | Returns the point values of a VisionaireObject field. |
| getPoints | Returns a table containing multiple point values. |
| getRect | Returns the rectangle values of a VisionaireObject field. |
| getRects | Returns a table containing multiple rectangle values. |
| getSprite | Returns the sprite values of a VisionaireObject field. |
| getSprites | Returns a table containing multiple sprite values. |
| getStr | Returns the string value of a VisionaireObject field. |
| getTextStr | |
| getTexts | |
| info | |
| isAnyObject | |
| isEmpty | |
| remove | |
| setName | Sets the internal name of the VisionaireObject. |
| setTextStr | |
| setValue | |
| to |
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. It can be changed with the setName method 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. |
