VisionaireObject Commands
From The Official Visionaire Studio: Adventure Game Engine Wiki
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 |
|---|---|---|
| empty | boolean | True if the object is an emptyObject (read-only). |
| id | integer | 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. Although this field is read-only, the internal name can be changed with the setName method. |
| parent | TVisObj | The parent object (read-only). |
| tableId | integer | 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. |
