EK: Created page with "Returns a table containing multiple sprite values (tables containing the elements '''path''', '''position''', '''transparency''', '''transpcolor''' and '''pause'''). == Synt..."

2023-08-31T15:10:22Z

Created page with "Returns a table containing multiple sprite values (tables containing the elements '''path''', '''position''', '''transparency''', '''transpcolor''' and '''pause'''). == Synt..."

New page

Returns a table containing multiple sprite values (tables containing the elements '''path''', '''position''', '''transparency''', '''transpcolor''' and '''pause''').

== Syntax ==
<syntaxhighlight lang="lua">
getSprites(field)
</syntaxhighlight>

== Parameters ==

{| class="ts"
|-
! style="width:15%" | Parameter
! style="width:15%" | Type
! Description
|-
| field
| integer
| The field which specifies a list of sprite values. The field type must be "t_vsprite".
''Specify the field constant name (V + object table name in singular + field name) or the field id.''
|}

== Return values ==

{| class="ts"
|-
! style="width:15%" | Type
! Description
|-
| table
| The table of t_sprite values linked in the field
|}

== Examples ==

'''Example 1:''' Get all sprites of an animation.
<syntaxhighlight lang="lua">
-- 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
</syntaxhighlight>
{{toc}}

VisionaireObject Command: getSprites - Revision history

EK: Created page with "Returns a table containing multiple sprite values (tables containing the elements '''path''', '''position''', '''transparency''', '''transpcolor''' and '''pause'''). == Synt..."