Sprite:get: Difference between revisions

From GiderosMobile
No edit summary
m Text replacement - "<source" to "<syntaxhighlight"
Line 5: Line 5:
=== Description ===
=== Description ===
Returns the specified property of this sprite instance by its name.
Returns the specified property of this sprite instance by its name.
<source lang="lua">
<syntaxhighlight lang="lua">
(number) = Sprite:get(param)
(number) = Sprite:get(param)
</source>
</source>
Line 35: Line 35:


=== Examples ===
=== Examples ===
<source lang="lua">
<syntaxhighlight lang="lua">
-- the following two lines do the same thing
-- the following two lines do the same thing
x = sprite:getX()
x = sprite:getX()

Revision as of 13:31, 13 July 2023

Available since: Gideros 2011.6
Class: Sprite

Description

Returns the specified property of this sprite instance by its name. <syntaxhighlight lang="lua"> (number) = Sprite:get(param) </source>

Supported names are:

  • "x"
  • "y"
  • "z"
  • "rotation"
  • "rotationX"
  • "rotationY"
  • "scaleX"
  • "scaleY"
  • "scaleZ"
  • "alpha"
  • "redMultiplier"
  • "greenMultiplier"
  • "blueMultiplier"
  • "alphaMultiplier"
  • "anchorX"
  • "anchorY"
  • "anchorZ"

Parameters

param: (string) the name of the parameter

Return values

Returns (number) the value of the parameter

Examples

<syntaxhighlight lang="lua"> -- the following two lines do the same thing x = sprite:getX() x = sprite:get("x")

-- the following two lines do the same thing y = sprite:getY() y = sprite:get("y")

-- the following two lines do the same thing rotation = sprite:getRotation() rotation = sprite:get("rotation")

-- the following two lines do the same thing scaleX = sprite:getScaleX() scaleX = sprite:get("scaleX")

-- the following two lines do the same thing scaleY = sprite:getScaleY() scaleY = sprite:get("scaleY") </source>