VisionaireObject Commands - Revision history

EK at 11:49, 13 September 2023

2023-09-13T11:49:26Z

EK at 11:37, 13 September 2023

2023-09-13T11:37:00Z

EK at 18:21, 31 August 2023

2023-08-31T18:21:31Z

EK at 11:58, 12 August 2023

2023-08-12T11:58:32Z

EK at 22:59, 11 August 2023

2023-08-11T22:59:06Z

EK at 21:52, 11 August 2023

2023-08-11T21:52:53Z

EK at 18:42, 11 August 2023

2023-08-11T18:42:42Z

EK at 14:33, 11 August 2023

2023-08-11T14:33:07Z

EK at 13:19, 5 August 2023

2023-08-05T13:19:30Z

EK: Created page with "This is a list of methods and fields supported on a Visionaire Object (TVisObj). == Methods == {| class="ts" |- ! style="width:20%" | Function Name ! Description |- | Vis..."

2023-08-05T12:11:51Z

Created page with "This is a list of methods and fields supported on a Visionaire Object (TVisObj). == Methods == {| class="ts" |- ! style="width:20%" | Function Name ! Description |- | Vis..."

New page

This is a list of methods and fields supported on a Visionaire Object (TVisObj).

== Methods ==

{| class="ts"
|-
! style="width:20%" | Function Name
! Description
|-
| [[VisionaireObject Command: isEmpty|isEmpty]]
|
|-
| [[VisionaireObject Command: isAnyObject|isAnyObject]]
|
|-
| [[VisionaireObject Command: getId|getId]]
|
|-
| [[VisionaireObject Command: getParent|getParent]]
|
|-
| [[VisionaireObject Command: getObject|getObject]]
|
|-
| [[VisionaireObject Command: getName|getName]]
|
|-
| [[VisionaireObject Command: setName|setName]]
|
|-
| [[VisionaireObject Command: setValue|setValue]]
|
|-
| [[VisionaireObject Command: clearLink|clearLink]]
|
|-
| [[VisionaireObject Command: setTextStr|setTextStr]]
|
|-
| [[VisionaireObject Command: getInt|getInt]]
|
|-
| [[VisionaireObject Command: getFloat|getFloat]]
|
|-
| [[VisionaireObject Command: getBool|getBool]]
|
|-
| [[VisionaireObject Command: getStr|getStr]]
|
|-
| [[VisionaireObject Command: getPath|getPath]]
|
|-
| [[VisionaireObject Command: getSprite|getSprite]]
|
|-
| [[VisionaireObject Command: getRect|getRect]]
|
|-
| [[VisionaireObject Command: getPoint|getPoint]]
|
|-
| [[VisionaireObject Command: getLink|getLink]]
|
|-
| [[VisionaireObject Command: getLinks|getLinks]]
|
|-
| [[VisionaireObject Command: debug|debug]]
|
|-
| [[VisionaireObject Command: getPoints|getPoints]]
|
|-
| [[VisionaireObject Command: getRects|getRects]]
|
|-
| [[VisionaireObject Command: getSprites|getSprites]]
|
|-
| [[VisionaireObject Command: getPaths|getPaths]]
|
|-
| [[VisionaireObject Command: getInts|getInts]]
|
|-
| [[VisionaireObject Command: getFloats|getFloats]]
|
|-
| [[VisionaireObject Command: getTexts|getTexts]]
|
|-
| [[VisionaireObject Command: getTextStr|getTextStr]]
|
|-
| [[VisionaireObject Command: to|to]]
|
|-
| [[VisionaireObject Command: duplicate|duplicate]]
|
|-
| [[VisionaireObject Command: create|create]]
|
|-
| [[VisionaireObject Command: remove|remove]]
|
|-
| [[VisionaireObject Command: info|info]]
|
|}

== Fields ==
{| class="ts"
|-
! style="width:20%" | Field Name
! Type
! Description
|-
| '''id'''
| int
| (readonly)
|-
| '''name'''
| string
| (readonly)
|-
| '''parent'''
| TVisObj
| (readonly)
|-
| '''tableId'''
| int
| (readonly)
|}
{{toc}}

@@ Line 121: / Line 121: @@
 | '''empty'''
 | boolean
-| Returns true if the object is an emptyObject.
+| True if the object is an emptyObject (read-only).
 |-
 | '''id'''
@@ Line 129: / Line 129: @@
 | '''name'''
 | string
-| The internal name of the object as defined in the editor. It can be changed with the [[VisionaireObject Command: setName|setName]] method only.
+| 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.<br><br>''Although this field is read-only, the internal name can be changed with the [[VisionaireObject Command: setName|setName]] method.''
 |-
 | '''parent'''
 | TVisObj
-| Returns the parent object (read-only).
+| The parent object (read-only).
 |-
 | '''tableId'''

@@ Line 118: / Line 118: @@
 ! style="width:10%" | Type
 ! Description
 |-
 | '''id'''
-| int
+| integer
 | The internal id of the object (read-only).
 |-
@@ Line 133: / Line 137: @@
 |-
 | '''tableId'''
-| int
+| integer
 | The id of the data structure table the object is part of (read-only).
 |-

@@ Line 74: / Line 74: @@
+|
 |-
-| [[VisionaireObject Command: getSprite|getSprites]]
+| [[VisionaireObject Command: getSprites|getSprites]]
+|
 |-

@@ Line 65: / Line 65: @@
+|
 |-
-| [[VisionaireObject Command: getRect|getRects]]
+| [[VisionaireObject Command: getRect|getRect]]
+|
 |-

@@ Line 9: / Line 9: @@
 |-
 | [[VisionaireObject Command: clearLink|clearLink]]
+| Removes a link from the VisionaireObject.
 |-
 | [[VisionaireObject Command: create|create]]
@@ Line 21: / Line 21: @@
 |-
 | [[VisionaireObject Command: getBool|getBool]]
+| Returns the boolean value of a VisionaireObject field.
 |-
 | [[VisionaireObject Command: getFloat|getFloat]]
+| Returns the decimal value of a VisionaireObject field.
 |-
 | [[VisionaireObject Command: getFloats|getFloats]]
+| Returns a table containing multiple float (decimal) values.
 |-
 | [[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]]
+| Returns the integer value of a VisionaireObject field.
 |-
 | [[VisionaireObject Command: getInts|getInts]]
+| Returns a table containing multiple integer values.
 |-
 | [[VisionaireObject Command: getLink|getLink]]
+| Returns the VisionaireObject which is linked in a VisionaireObject field.
 |-
 | [[VisionaireObject Command: getLinks|getLinks]]
+| Returns a table containing multiple VisionaireObjects.
 |-
 | [[VisionaireObject Command: getName|getName]]
+| Returns the internal name of the VisionaireObject.
 |-
 | [[VisionaireObject Command: getObject|getObject]]
@@ Line 51: / Line 51: @@
 |-
 | [[VisionaireObject Command: getParent|getParent]]
+| Returns the parent object of the VisionaireObject.
 |-
 | [[VisionaireObject Command: getPath|getPath]]
+| Returns the path to a media file, linked in a VisionaireObject field.
 |-
 | [[VisionaireObject Command: getPaths|getPaths]]
+| Returns a table containing multiple paths to media files.
 |-
 | [[VisionaireObject Command: getPoint|getPoint]]
+| Returns the point values of a VisionaireObject field.
 |-
 | [[VisionaireObject Command: getPoints|getPoints]]
+| Returns a table containing multiple point values.
 |-
 | [[VisionaireObject Command: getRect|getRect]]
+| Returns the rectangle values of a VisionaireObject field.
 |-
 | [[VisionaireObject Command: getRects|getRects]]
+| Returns a table containing multiple rectangle values.
 |-
 | [[VisionaireObject Command: getSprite|getSprite]]
+| Returns the sprite values of a VisionaireObject field.
 |-
 | [[VisionaireObject Command: getSprites|getSprites]]
+| Returns a table containing multiple sprite values.
 |-
 | [[VisionaireObject Command: getStr|getStr]]
+| Returns the string value of a VisionaireObject field.
 |-
 | [[VisionaireObject Command: getTextStr|getTextStr]]
@@ Line 99: / Line 99: @@
 |-
 | [[VisionaireObject Command: setName|setName]]
+| Sets the internal name of the VisionaireObject.
 |-
 | [[VisionaireObject Command: setTextStr|setTextStr]]

@@ Line 5: / Line 5: @@
 {| class="ts"
 |-
-! style="width:20%" | Function Name
+! style="width:15%" | Function Name
 ! Description
 |-
@@ Line 115: / Line 115: @@
 {| class="ts"
 |-
-! style="width:20%" | Field Name
+! style="width:15%" | Field Name
-! Type
+! style="width:10%" | Type
 ! Description
 |-