VisionaireObject Command: getId - Revision history

EK: Created page with "Returns a table containing the internal id of the VisionaireObject and the id of the table it belongs to. == Syntax == getId()
2023-08-31T15:39:37Z

Created page with "Returns a table containing the internal id of the VisionaireObject and the id of the table it belongs to. == Syntax == <syntaxhighlight lang="lua"> getId() </syntaxhighlight..."

New page
Returns a table containing the internal id of the VisionaireObject and the id of the table it belongs to.

== Syntax ==
<syntaxhighlight lang="lua">
getId()
</syntaxhighlight>

== Parameters ==

none

== Return values ==

{| class="ts"
|-
! style="width:15%" colspan="2" | Type/Structure
! Description
|-
| rowspan="2" | table
| id (int)
| Internal id of the VisionaireObject
|-
| tableId (int)
| Id of the table the VisionaireObject belongs to
|}

== Examples ==

'''Example 1:''' Check if an animation belongs to a character or not.
<syntaxhighlight lang="lua">
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")
</syntaxhighlight>
{{toc}}