Sprite:get: Difference between revisions

From GiderosMobile
No edit summary
m Text replacement - "</source>" to "</syntaxhighlight>"
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
'''Available since:''' Gideros 2011.6<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/Sprite|Sprite]]<br/>
'''Class:''' [[Sprite]]<br/>
=== <translate>Description</translate> ===
 
<translate><br />
=== Description ===
Returns the specified property of this sprite instance by its name. These names are supported:<br />
Returns the specified property of this sprite instance by its name.
<br />
<syntaxhighlight lang="lua">
<ul><br />
<li>''"x"''</li><br />
<li>''"y"''</li><br />
<li>''"z"''</li><br />
<li>''"rotation"''</li><br />
<li>''"rotationX"''</li><br />
<li>''"rotationY"''</li><br />
<li>''"scaleX"''</li><br />
<li>''"scaleY"''</li><br />
<li>''"scaleZ"''</li><br />
<li>''"alpha"''</li><br />
<li>''"redMultiplier"''</li><br />
<li>''"greenMultiplier"''</li><br />
<li>''"blueMultiplier"''</li><br />
<li>''"alphaMultiplier"''</li><br />
<li>''"anchorX"''</li><br />
<li>''"anchorY"''</li><br />
<li>''"anchorZ"''</li><br />
</ul><br />
<br /></translate>
<source lang="lua">
(number) = Sprite:get(param)
(number) = Sprite:get(param)
</source>
</syntaxhighlight>
=== <translate>Parameters</translate> ===
 
'''param''': (string) <translate>The name of the parameter</translate> <br/>
Supported names are:
=== <translate>Return values</translate> ===
*''"x"''
'''<translate>Returns</translate>''' (number) <translate>The value of the parameter</translate><br/>
*''"y"''
=== <translate>Examples</translate> ===
*''"z"''
'''Example'''<br/>
*''"rotation"''
<source lang="lua">-- the following two lines do the same thing
*''"rotationX"''
*''"rotationY"''
*''"scaleX"''
*''"scaleY"''
*''"scaleZ"''
*''"alpha"''
*''"redMultiplier"''
*''"greenMultiplier"''
*''"blueMultiplier"''
*''"alphaMultiplier"''
*''"anchorX"''
*''"anchorY"''
*''"anchorZ"''
 
=== Parameters ===
'''param''': (string) the name of the parameter<br/>
 
=== Return values ===
'''Returns''' (number) the value of the parameter<br/>
 
=== Examples ===
<syntaxhighlight lang="lua">
-- the following two lines do the same thing
x = sprite:getX()
x = sprite:getX()
x = sprite:get(&quot;x&quot;)
x = sprite:get("x")
-- the following two lines do the same thing
-- the following two lines do the same thing
y = sprite:getY()
y = sprite:getY()
y = sprite:get(&quot;y&quot;)
y = sprite:get("y")


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


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


-- the following two lines do the same thing
-- the following two lines do the same thing
scaleY = sprite:getScaleY()
scaleY = sprite:getScaleY()
scaleY = sprite:get(&quot;scaleY&quot;)</source>
scaleY = sprite:get("scaleY")
</syntaxhighlight>
 
{{Sprite}}

Latest revision as of 13:33, 13 July 2023

Available since: Gideros 2011.6
Class: Sprite

Description

Returns the specified property of this sprite instance by its name.

(number) = Sprite:get(param)

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

-- 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")