API-Namen, Parameter und Code stehen in ihrer englischen Originalform.

TVisObj

Methoden

isEmpty()
isAnyObject()
getId()
getParent()
getObject(path, logWarning)
getName()
setName(name)
setValue(field, value)
clearLink(field)
setTextStr(field)
getInt(field)
getFloat(field)
getBool(field)
getStr(field)
getPath(field)
getSprite(field)
getRect(field)
getPoint(field)
getLink(field)
getLinks(field)
debug()
getPoints(field)
getRects(field)
getSprites(field)
getPaths(field)
getInts(field)
getFloats(field)
getTexts(field)
getTextStr(field, language)
to(time, values, easing, repeat, reverse)
duplicate(name)
create(field, name)
remove()
info()
__eq()
__tostring()

Felder

id readonly int
tableId readonly int
name readonly string
parent readonly TVisObj

isEmpty()

Return Type Description
bool

isAnyObject()

Return Type Description
bool

getId()

Return Type Description
table {id = id, tableId = tableId}

Details und Beispiele

Gibt eine Tabelle mit der internen ID des VisionaireObjects und der ID seiner Tabelle zurück.

Parameter

keine

Rückgabewerte
Typ/Struktur Beschreibung
table id (int) Interne ID des VisionaireObjects
tableId (int) ID der Tabelle, zu der das VisionaireObject gehört
Beispiele

Beispiel 1: Prüfen, ob eine Animation zu einem Charakter gehört.

function checkAnimOwner(anim)
  anim = getObject("Animations[" .. anim .. "]")

  if anim:getParent():getId().tableId == eOutfits then
    print("The animation with id=" .. anim:getId().id .. " is a character animation.")
  else
    print("The animation with id=" .. anim:getId().id .. " is not a character animation.")
  end
end

checkAnimOwner("welding_anim")

-- The shorthand notation offers a more convenient way to achieve the same
function checkAnimOwner(anim)
  anim = Animations[anim]

  if anim.parent.tableId == eOutfits then
    print("The animation with id=" .. anim.id .. " is a character animation")
  else
    print("The animation with id=" .. anim.id .. " is not a character animation")
  end
end

checkAnimOwner("welding_anim")

getParent()

Return Type Description
TVisObj

Details und Beispiele

Gibt das übergeordnete Objekt des VisionaireObjects zurück.

Parameter

keine

Rückgabewerte
Typ Beschreibung
TVisObj Das übergeordnete Objekt des VisionaireObjects.
Beispiele

Beispiel 1: Prüfen, ob eine Animation zu einem Charakter gehört.

function checkAnimOwner(anim)
  anim = getObject("Animations[" .. anim .. "]")

  if anim:getParent():getId().tableId == eOutfits then
    print("The animation with id=" .. anim:getId().id .. " is a character animation.")
  else
    print("The animation with id=" .. anim:getId().id .. " is not a character animation.")
  end
end

checkAnimOwner("welding_anim")

-- The shorthand notation offers a more convenient way to achieve the same
function checkAnimOwner(anim)
  anim = Animations[anim]

  if anim.parent.tableId == eOutfits then
    print("The animation with id=" .. anim.id .. " is a character animation")
  else
    print("The animation with id=" .. anim.id .. " is not a character animation")
  end
end

checkAnimOwner("welding_anim")

getObject(path, logWarning)

Parameter Type Description
path string
logWarning bool
Return Type Description
TVisObj

getName()

Return Type Description
string

Details und Beispiele

Gibt den internen Namen des VisionaireObjects zurück.

Nicht zu verwechseln mit der Eigenschaft „Name“, die es bei manchen Objekten gibt und die den mehrsprachigen Namen im Spiel enthält.

Verwandte Funktionen setName
Parameter

keine

Rückgabewerte
Typ Beschreibung
string Der interne Name des VisionaireObjects
Beispiele

Beispiel 1: Den internen Namen der aktuellen Szene abfragen.

local cur_scene_name = game:getLink(VGameCurrentScene):getName()

-- The shorthand notation offers a more convenient way to achieve the same
local cur_scene_name = game.CurrentScene.name

setName(name)

Parameter Type Description
name string

Details und Beispiele

Setzt den internen Namen des VisionaireObjects.

Verwandte Funktionen getName
Parameter
Parameter Typ Beschreibung
name string Der neue interne Name des VisionaireObjects
Rückgabewerte

keine

Beispiele

Beispiel 1: Den internen Namen der aktuellen Szene setzen.

game:getLink(VGameCurrentScene):setName()

-- There is no shorthand method for setting the name
game.CurrentScene:setName()

setValue(field, value)

Parameter Type Description
field int
value variant
Parameter Type Description
field int

Entfernt einen Link aus dem VisionaireObject.

Parameter Typ Beschreibung
Feld integer Das Feld, das geleert wird; es muss vom Typ „t_link“ sein.

Gib den Namen der Feldkonstante an (V + Tabellenname im Singular + Feldname) oder die Feld-ID, siehe Beispiel.

keine

Beispiel 1: Den Link auf das gerade benutzte Item entfernen (ein gezogenes Item verschwindet dadurch vom Mauszeiger).

-- Specify the field constant name or the field id
game:clearLink(VGameUsedItem)
game:clearLink(686)

-- Setting an empty object leads to the same result
game:setValue(VGameUsedItem, emptyObject)

-- The shorthand notation offers a more convenient way to achieve the same
game.UsedItem = emptyObject

setTextStr(field)

Parameter Type Description
field int
Return Type Description
string

getInt(field)

Parameter Type Description
field int
Return Type Description
int

Details und Beispiele

Gibt den Ganzzahlwert eines Felds eines VisionaireObjects zurück.

Parameter
Parameter Typ Beschreibung
Feld integer Das Feld mit der Ganzzahl. Der Feldtyp muss „t_int“ sein.

Gib den Namen der Feldkonstante an (V + Tabellenname im Singular + Feldname) oder die Feld-ID, siehe Beispiel.

Rückgabewerte
Typ Beschreibung
integer Der Ganzzahlwert des Felds.
Beispiele

Beispiel 1: Den Wert eines Werts (Value) abfragen.

-- Specify the field constant name or the field id
local num_coins = getObject("Values[coins]"):getInt(VValueInt)
local num_coins = getObject("Values[coins]"):getInt(328)

-- The shorthand notation offers a more convenient way to achieve the same
local num_coins = Values["coins"].Int

getFloat(field)

Parameter Type Description
field int
Return Type Description
float

Details und Beispiele

Gibt den Kommazahlwert eines Felds eines VisionaireObjects zurück.

Parameter
Parameter Typ Beschreibung
Feld integer Das Feld mit der Kommazahl. Der Feldtyp muss „t_float“ sein.

Gib den Namen der Feldkonstante an (V + Tabellenname im Singular + Feldname) oder die Feld-ID, siehe Beispiel.

Rückgabewerte
Typ Beschreibung
decimal Der Kommazahlwert des Felds.
Beispiele

Beispiel 1: Die aktuelle Größe eines Charakters abfragen.

-- Specify the field constant name or the field id
local char_size = getObject("Characters[hero]"):getFloat(VCharacterSize)
local char_size = getObject("Characters[hero]"):getFloat(749)

-- The shorthand notation offers a more convenient way to achieve the same
local char_size = Characters["hero"].Size

getBool(field)

Parameter Type Description
field int
Return Type Description
bool

Details und Beispiele

Gibt den Wahrheitswert eines Felds eines VisionaireObjects zurück.

Parameter
Parameter Typ Beschreibung
Feld integer Das Feld mit dem Wahrheitswert. Der Feldtyp muss „t_bool“ sein.

Gib den Namen der Feldkonstante an (V + Tabellenname im Singular + Feldname) oder die Feld-ID, siehe Beispiel.

Rückgabewerte
Typ Beschreibung
boolean Der Wahrheitswert des Felds.
Beispiele

Beispiel 1: Den Wert einer Bedingung abfragen.

-- Specify the field constant name or the field id
local door_state = getObject("Conditions[door_closed]"):getBool(VConditionValue)
local door_state = getObject("Conditions[door_closed]"):getBool(194)

-- The shorthand notation offers a more convenient way to achieve the same
local door_state = Conditions["door_closed"].Value

getStr(field)

Parameter Type Description
field int
Return Type Description
string

Details und Beispiele

Gibt den Textwert eines Felds eines VisionaireObjects zurück.

Parameter
Parameter Typ Beschreibung
Feld integer Das Feld mit dem Text. Der Feldtyp muss „t_string“ sein.

Gib den Namen der Feldkonstante an (V + Tabellenname im Singular + Feldname) oder die Feld-ID, siehe Beispiel.

Rückgabewerte
Typ Beschreibung
string Der Textwert des Felds.
Beispiele

Beispiel 1: Die Versionsnummer des Spiels abfragen (aus den Spielinformationen).

-- Specify the field constant name or the field id
local ver = game:getStr(VGameVersion)
local ver = game:getStr(627)

-- The shorthand notation offers a more convenient way to achieve the same
local ver = game.Version

getPath(field)

Parameter Type Description
field int
Return Type Description
string

Details und Beispiele

Gibt den Pfad zu einer Mediendatei zurück, die in einem Feld eines VisionaireObjects verknüpft ist.

Parameter
Parameter Typ Beschreibung
Feld integer Das Feld mit dem Pfad. Der Feldtyp muss „t_path“ sein.

Gib den Namen der Feldkonstante an (V + Tabellenname im Singular + Feldname) oder die Feld-ID, siehe Beispiel.

Rückgabewerte
Typ Beschreibung
string Der im Feld gespeicherte Dateipfad, im Unix-Format („/“ für Ordner) und relativ zur .ved-Datei.
Beispiele

Beispiel 1: Den Dateipfad der Hintergrundmusik einer Szene abfragen.

-- Specify the field constant name or the field id
local bg_file = getObject("Scenes[kitchen]"):getPath(VSceneBackgroundMusic)
local bg_file = getObject("Scenes[kitchen]"):getPath(132)

-- The shorthand notation offers a more convenient way to achieve the same
local bg_file = Scenes["kitchen"].BackgroundMusic

getSprite(field)

Parameter Type Description
field int
Return Type Description
TSprite

Details und Beispiele

Gibt die Sprite-Werte eines Felds eines VisionaireObjects zurück.

Parameter
Parameter Typ Beschreibung
Feld integer Das Feld mit dem Sprite. Der Feldtyp muss „t_sprite“ sein.

Gib den Namen der Feldkonstante an (V + Tabellenname im Singular + Feldname) oder die Feld-ID, siehe Beispiel.

Rückgabewerte
Typ/Struktur Beschreibung
table path (str) relativer Pfad zur im Feld gespeicherten Bilddatei
position (t_point) im Feld gespeicherter Versatz des Sprites, wenn es in einer Animation verwendet wird
transparency (int)
transpcolor (int) Transparenzfarbe
pause (int) im Feld gespeicherte Pause in Millisekunden, wenn das Sprite in einer Animation verwendet wird
Beispiele

Beispiel 1: Das Hintergrund-Sprite eines Interfaces abfragen.

-- Specify the field constant name or the field id
local inv_bg = getObject("Interfaces[inventory]"):getSprite(VInterfaceSprite)
local inv_bg = getObject("Interfaces[inventory]"):getSprite(238)

-- The shorthand notation offers a more convenient way to achieve the same
local inv_bg = Interfaces["inventory"].Sprite

getRect(field)

Parameter Type Description
field int
Return Type Description
rect

Details und Beispiele

Gibt die Rechteckwerte eines Felds eines VisionaireObjects zurück.

Parameter
Parameter Typ Beschreibung
Feld integer Das Feld mit dem Rechteck. Der Feldtyp muss „t_rect“ sein.

Gib den Namen der Feldkonstante an (V + Tabellenname im Singular + Feldname) oder die Feld-ID, siehe Beispiel.

Rückgabewerte
Typ/Struktur Beschreibung
table x (int) x-Koordinate der linken oberen Ecke des im Feld gespeicherten Rechtecks
y (int) y-Koordinate der linken oberen Ecke des im Feld gespeicherten Rechtecks
width (int) Breite des im Feld gespeicherten Rechtecks
height (int) Höhe des im Feld gespeicherten Rechtecks
Beispiele

Beispiel 1: Das Rechteck abfragen, in dem der Aktionstext angezeigt wird.

-- Specify the field constant name or the field id
local actxt_rect = game:getRect(VGameActionTextRect)
local actxt_rect = game:getRect(590)

-- The shorthand notation offers a more convenient way to achieve the same
local actxt_rect = game.ActionTextRect

getPoint(field)

Parameter Type Description
field int
Return Type Description
point

Details und Beispiele

Gibt die Punktwerte eines Felds eines VisionaireObjects zurück.

Parameter
Parameter Typ Beschreibung
Feld integer Das Feld mit dem Punkt. Der Feldtyp muss „t_point“ sein.

Gib den Namen der Feldkonstante an (V + Tabellenname im Singular + Feldname) oder die Feld-ID, siehe Beispiel.

Rückgabewerte
Typ/Struktur Beschreibung
table x (int) x-Koordinate des im Feld gespeicherten Punkts
y (int) y-Koordinate des im Feld gespeicherten Punkts
Beispiele

Beispiel 1: Die Position einer laufenden Animation abfragen.

-- Specify the field constant name or the field id
local anim_pos = getObject("ActiveAnimations[cat]"):getPoint(VAnimationCurrentPosition)
local anim_pos = getObject("ActiveAnimations[cat]"):getPoint(496)

-- The shorthand notation offers a more convenient way to achieve the same
local anim_pos = ActiveAnimations["cat"].CurrentPosition
Parameter Type Description
field int
Return Type Description
TVisObj

Gibt das VisionaireObject zurück, das in einem Feld eines VisionaireObjects verknüpft ist.

Parameter Typ Beschreibung
Feld integer Das Feld mit dem Link auf ein VisionaireObject. Der Feldtyp muss „t_link“ sein.

Gib den Namen der Feldkonstante an (V + Tabellenname im Singular + Feldname) oder die Feld-ID, siehe Beispiel.

Typ Beschreibung
TVisObj Das im Feld verknüpfte VisionaireObject oder ein leeres Objekt, wenn nichts verknüpft ist

Beispiel 1: Den aktuell spielbaren Charakter abfragen.

-- Specify the field constant name or the field id
local curr_char = game:getLink(VGameCurrentCharacter)
local curr_char = game:getLink(468)

-- The shorthand notation offers a more convenient way to achieve the same
local curr_char = game.CurrentCharacter
Parameter Type Description
field int
Return Type Description
table TVisObjs

Gibt eine Tabelle mit mehreren VisionaireObjects zurück.

Parameter Typ Beschreibung
Feld integer Das Feld mit einer Liste von Links auf VisionaireObjects. Der Feldtyp muss „t_links“ sein.

Gib den Namen der Feldkonstante an (V + Tabellenname im Singular + Feldname) oder die Feld-ID, siehe Beispiel.

Typ Beschreibung
table Die Tabelle der im Feld verknüpften VisionaireObjects (t_link-Werte)

Beispiel 1: Die Namen aller Spielsprachen ins Log schreiben.

-- Specify the field constant name or the field id
local lang = game:getLinks(VGameLanguages)
local lang = game:getLinks(259)

-- Iterate the table and print the language ids and names
for i = 1, #lang do
  print(lang[i]:getId().id .. ": " .. lang[i]:getName())
end

-- The shorthand notation offers a more convenient way to achieve the same
local lang = game.Languages

for i = 1, #lang do
  print(lang[i].id .. ": " .. lang[i].name)
end

debug()

getPoints(field)

Parameter Type Description
field int
Return Type Description
table points

Details und Beispiele

Gibt eine Tabelle mit mehreren Punkten zurück (Tabellen mit den Einträgen x und y).

Parameter
Parameter Typ Beschreibung
Feld integer Das Feld mit einer Liste von Punkten. Der Feldtyp muss „t_vpoint“ sein.

Gib den Namen der Feldkonstante an (V + Tabellenname im Singular + Feldname) oder die Feld-ID.

Rückgabewerte
Typ Beschreibung
table Die Tabelle der im Feld gespeicherten t_point-Werte
Beispiele

Beispiel 1: Die Punkte des Bereichspolygons eines Szenenobjekts abfragen.

-- Specify the field constant name or the field id
local poly_pnts = getObject("Scene[kitchen].SceneObjects[door]"):getPoints(VObjectPolygon)
local poly_pnts = getObject("Scene[kitchen].SceneObjects[door]"):getPoints(341)

-- The shorthand notation offers a more convenient way to achieve the same
local poly_pnts = Scene["kitchen"].Objects["door"].Polygon

getRects(field)

Parameter Type Description
field int
Return Type Description
table rects

Details und Beispiele

Gibt eine Tabelle mit mehreren Rechtecken zurück (Tabellen mit den Einträgen x, y, width, height).

Parameter
Parameter Typ Beschreibung
Feld integer Das Feld mit einer Liste von Rechtecken. Der Feldtyp muss „t_vrect“ sein.

Gib den Namen der Feldkonstante an (V + Tabellenname im Singular + Feldname) oder die Feld-ID.

Rückgabewerte
Typ Beschreibung
table Die Tabelle der im Feld gespeicherten t_rect-Werte
Beispiele

Beispiel 1: Die Spielstandbereiche einer Menüszene abfragen.

-- Specify the field constant name or the field id
local save_rects = getObject("Scenes[savemenu]"):getRects(VSceneSavegameAreas)
local save_rects = getObject("Scenes[savemenu]"):getRects(322)

-- The shorthand notation offers a more convenient way to achieve the same
local save_rects = Scenes["savemenu"].SavegameAreas

getSprites(field)

Parameter Type Description
field int
Return Type Description
table sprites

Details und Beispiele

Gibt eine Tabelle mit mehreren Sprites zurück (Tabellen mit den Einträgen path, position, transparency, transpcolor und pause).

Parameter
Parameter Typ Beschreibung
Feld integer Das Feld mit einer Liste von Sprites. Der Feldtyp muss „t_vsprite“ sein.

Gib den Namen der Feldkonstante an (V + Tabellenname im Singular + Feldname) oder die Feld-ID.

Rückgabewerte
Typ Beschreibung
table Die Tabelle der im Feld gespeicherten t_sprite-Werte
Beispiele

Beispiel 1: Alle Sprites einer Animation abfragen.

-- Specify the field constant name or the field id
local anim_sprts = getObject("Animations[waterfall]"):getSprites(VAnimationSprites)
local anim_sprts = getObject("Animations[waterfall]"):getSprites(235)

-- The shorthand notation offers a more convenient way to achieve the same
local anim_sprts = Animations["waterfall"].Sprites

getPaths(field)

Parameter Type Description
field int
Return Type Description
table paths

Details und Beispiele

Gibt eine Tabelle mit mehreren Pfaden zu Mediendateien zurück.

Parameter
Parameter Typ Beschreibung
Feld integer Das Feld mit einer Liste von Pfaden. Der Feldtyp muss „t_vpath“ sein.

Gib den Namen der Feldkonstante an (V + Tabellenname im Singular + Feldname) oder die Feld-ID.

Rückgabewerte
Typ Beschreibung
table Die Tabelle der im Feld gespeicherten t_path-Werte, im Unix-Format („/“ für Ordner) und relativ zur .ved-Datei.
Beispiele

Beispiel 1: Die Dateipfade der Texturen eines 3D-Charaktermodells abfragen.

-- Specify the field constant name or the field id
local txtr_tbl = getObject("Characters[hero].CharacterOutfits[Normal]"):getPaths(VOutfitModelTextures)
local txtr_tbl = getObject("Characters[hero].CharacterOutfits[Normal]"):getPaths(728)

-- The shorthand notation offers a more convenient way to achieve the same
local txtr_tbl = Characters["hero"].Outfits["Normal"].ModelTextures

getInts(field)

Parameter Type Description
field int
Return Type Description
table ints

Details und Beispiele

Gibt eine Tabelle mit mehreren Ganzzahlen zurück.

Parameter
Parameter Typ Beschreibung
Feld integer Das Feld mit einer Liste von Ganzzahlen. Der Feldtyp muss „t_vint“ sein.

Gib den Namen der Feldkonstante an (V + Tabellenname im Singular + Feldname) oder die Feld-ID.

Rückgabewerte
Typ Beschreibung
table Die Tabelle der im Feld gespeicherten t_int-Werte

getFloats(field)

Parameter Type Description
field int
Return Type Description
table floats

Details und Beispiele

Gibt eine Tabelle mit mehreren Kommazahlen zurück.

Parameter
Parameter Typ Beschreibung
Feld integer Das Feld mit einer Liste von Kommazahlen. Der Feldtyp muss „t_vfloat“ sein.

Gib den Namen der Feldkonstante an (V + Tabellenname im Singular + Feldname) oder die Feld-ID.

Rückgabewerte
Typ Beschreibung
table Die Tabelle der im Feld gespeicherten t_float-Werte

getTexts(field)

Parameter Type Description
field int
Return Type Description
table texts

getTextStr(field, language)

Parameter Type Description
field int
language TVisObj default GameStandardLanguage
Return Type Description
string text

to(time, values, easing, repeat, reverse)

game:to(3000, { ScrollPosition = {x = 100, y = 0} }, easeBackInOut)
game.CurrentScene:to(delay, {Brightness = 0}, easeLinearInOut)

-> Tweening

Parameter Type Description
time int
values table
easing int
repeat bool
reverse bool

duplicate(name)

local obj = game.CurrentScene.Objects.Object0:duplicate("duplObj")
obj.Offset = {x=100, y=100}
obj = game.CurrentScene.Objects.duplObj

obj = game.CurrentScene:create(VSceneObjects, "temp0")
obj:create(VObjectSprite, "obj")

obj:remove()

Parameter Type Description
name string
Return Type Description
TVisObj

create(field, name)

Parameter Type Description
field int
name string
Return Type Description
TVisObj

remove()

info()

get all values as a table

__eq()

if a == b then
else
end

compare visobjs

__tostring()

Verwendet in:

Commands.startAction
Commands.startAction
Commands.stopAction
Commands.startAnimation
Commands.startAnimation
Commands.stopAnimation
Commands.startObjectTween
Commands.getObject
TVisObj.getParent
TVisObj.getObject
TVisObj.getLink
TVisObj.getTextStr
TVisObj.duplicate
TVisObj.create
graphics.drawAnimation
graphics.instantiateAnimation
graphics.instantiateAnimation
graphics.getCurrentSpritePath
graphics.getAnimationSize
graphics.getAnimationInnerSize
graphics.getCharacterTextPosition
graphics.getParticles
graphics.registerRenderHook
TextScrollPane.addText

TSprite

Methoden

getPath()
setPath(path)
getSize()
setPosition(position)
getPosition()

getPath()

Return Type Description
string path

setPath(path)

Parameter Type Description
path string

getSize()

Return Type Description
point size

setPosition(position)

Parameter Type Description
position point

getPosition()

Return Type Description
point position

Verwendet in:

Commands.createSprite
TVisObj.getSprite