Difference between revisions of "VisionaireObject Commands"

From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 125: Line 125:
 
| '''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.
+
| The internal name of the object as defined in the editor. It can be changed with the [[VisionaireObject Command: setName|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'''
 
| '''parent'''

Revision as of 12:58, 12 August 2023

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

Methods

Function Name Description
clearLink
create
debug
duplicate
getBool
getFloat
getFloats
getId
getInt
getInts
getLink
getLinks
getName
getObject
getParent
getPath
getPaths
getPoint
getPoints
getRect
getRects
getSprite
getSprites
getStr
getTextStr
getTexts
info
isAnyObject
isEmpty
remove
setName
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.