Difference between revisions of "VisionaireObject Commands"

From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 8: Line 8:
 
! Description
 
! Description
 
|-
 
|-
−
| [[VisionaireObject Command: isEmpty|isEmpty]]
+
| [[VisionaireObject Command: clearLink|clearLink]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: isAnyObject|isAnyObject]]
+
| [[VisionaireObject Command: create|create]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getId|getId]]
+
| [[VisionaireObject Command: debug|debug]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getParent|getParent]]
+
| [[VisionaireObject Command: duplicate|duplicate]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getObject|getObject]]
+
| [[VisionaireObject Command: getBool|getBool]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getName|getName]]
+
| [[VisionaireObject Command: getFloats|getFloats]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: setName|setName]]
+
| [[VisionaireObject Command: getFloat|getFloat]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: setValue|setValue]]
+
| [[VisionaireObject Command: getId|getId]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: clearLink|clearLink]]
+
| [[VisionaireObject Command: getInts|getInts]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: setTextStr|setTextStr]]
+
| [[VisionaireObject Command: getInt|getInt]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getInt|getInt]]
+
| [[VisionaireObject Command: getLinks|getLinks]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getFloat|getFloat]]
+
| [[VisionaireObject Command: getLink|getLink]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getBool|getBool]]
+
| [[VisionaireObject Command: getName|getName]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getStr|getStr]]
+
| [[VisionaireObject Command: getObject|getObject]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getPath|getPath]]
+
| [[VisionaireObject Command: getParent|getParent]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getSprite|getSprite]]
+
| [[VisionaireObject Command: getPaths|getPaths]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getRect|getRect]]
+
| [[VisionaireObject Command: getPath|getPath]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getPoint|getPoint]]
+
| [[VisionaireObject Command: getPoints|getPoints]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getLink|getLink]]
+
| [[VisionaireObject Command: getPoint|getPoint]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getLinks|getLinks]]
+
| [[VisionaireObject Command: getRects|getRects]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: debug|debug]]
+
| [[VisionaireObject Command: getRect|getRect]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getPoints|getPoints]]
+
| [[VisionaireObject Command: getSprites|getSprites]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getRects|getRects]]
+
| [[VisionaireObject Command: getSprite|getSprite]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getSprites|getSprites]]
+
| [[VisionaireObject Command: getStr|getStr]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getPaths|getPaths]]
+
| [[VisionaireObject Command: getTextStr|getTextStr]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getInts|getInts]]
+
| [[VisionaireObject Command: getTexts|getTexts]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getFloats|getFloats]]
+
| [[VisionaireObject Command: info|info]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getTexts|getTexts]]
+
| [[VisionaireObject Command: isAnyObject|isAnyObject]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: getTextStr|getTextStr]]
+
| [[VisionaireObject Command: isEmpty|isEmpty]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: to|to]]
+
| [[VisionaireObject Command: remove|remove]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: duplicate|duplicate]]
+
| [[VisionaireObject Command: setName|setName]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: create|create]]
+
| [[VisionaireObject Command: setTextStr|setTextStr]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: remove|remove]]
+
| [[VisionaireObject Command: setValue|setValue]]
 
|
 
|
 
|-
 
|-
−
| [[VisionaireObject Command: info|info]]
+
| [[VisionaireObject Command: to|to]]
 
|
 
|
 
|}
 
|}
Line 121: Line 121:
 
| '''id'''
 
| '''id'''
 
| int
 
| int
−
| (readonly)
+
| The internal id of the object (read-only).
 
|-
 
|-
 
| '''name'''
 
| '''name'''
 
| string
 
| string
−
| (readonly)
+
| 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
−
| (readonly)
+
| Returns the parent object (read-only).
 
|-
 
|-
 
| '''tableId'''
 
| '''tableId'''
 
| int
 
| int
−
| (readonly)
+
| 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 16:33, 11 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
getFloats
getFloat
getId
getInts
getInt
getLinks
getLink
getName
getObject
getParent
getPaths
getPath
getPoints
getPoint
getRects
getRect
getSprites
getSprite
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 (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.


Retrieved from "https://wiki.visionaire-tracker.net/index.php?title=VisionaireObject_Commands&oldid=12140"
  • Powered by MediaWiki