Difference between revisions of "Sprite:set"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Class:''' [[Sprite]]<br/>
 +
 
=== Description ===
 
=== Description ===
<br />
+
Sets the values of a sprite instance by name.
Sets the specified property of this sprite instance by its name. These names are supported:<br />
+
<syntaxhighlight lang="lua">
<br />
+
Sprite:set(param, value)
<ul><br />
+
</syntaxhighlight>
<li>`"x"`</li><br />
+
 
<li>`"y"`</li><br />
+
 
<li>`"z"`</li><br />
+
The possible names for '''param''' are:
<li>`"rotation"`</li><br />
+
*''"x"''
<li>`"rotationX"`</li><br />
+
*''"y"''
<li>`"rotationY"`</li><br />
+
*''"z"''
<li>`"scaleX"`</li><br />
+
*''"rotation"''
<li>`"scaleY"`</li><br />
+
*''"rotationX"''
<li>`"scaleZ"`</li><br />
+
*''"rotationY"''
<li>`"alpha"`</li><br />
+
*''"scaleX"''
<li>`"redMultiplier"`</li><br />
+
*''"scaleY"''
<li>`"greenMultiplier"`</li><br />
+
*''"scaleZ"''
<li>`"blueMultiplier"`</li><br />
+
*''"alpha"''
<li>`"alphaMultiplier"`</li><br />
+
*''"redMultiplier"''
<li>`"anchorX"`</li><br />
+
*''"greenMultiplier"''
<li>`"anchorY"`</li><br />
+
*''"blueMultiplier"''
<li>`"anchorZ"`</li><br />
+
*''"alphaMultiplier"''
</ul><br />
+
*''"anchorX"''
<br />
+
*''"anchorY"''
<source lang="lua">
+
*''"anchorZ"''
Sprite:set(param,value)
+
 
</source>
 
 
=== Parameters ===
 
=== Parameters ===
'''param''': (string) The name of the parameter <br/>
+
'''param''': (string) the name of the parameter<br/>
'''value''': (number) The new value of the specified parameter <br/>
+
'''value''': (number) the new value of the specified parameter<br/>
 +
 
 
=== Examples ===
 
=== Examples ===
'''Example'''<br/>
+
<syntaxhighlight lang="lua">
<source lang="lua">-- the following two lines do the same thing<br />
+
-- the following two lines do the same thing
sprite:setX(10)<br />
+
sprite:setX(10)
sprite:set(&quot;x&quot;, 10)<br />
+
sprite:set("x", 10)
<br />
+
-- the following two lines do the same thing<br />
+
-- the following two lines do the same thing
sprite:setY(10)<br />
+
sprite:setY(10)
sprite:set(&quot;y&quot;, 10)<br />
+
sprite:set("y", 10)
<br />
+
 
-- the following two lines do the same thing<br />
+
-- the following two lines do the same thing
sprite:setRotation(10)<br />
+
sprite:setRotation(10)
sprite:set(&quot;rotation&quot;, 10)<br />
+
sprite:set("rotation", 10)
<br />
+
 
-- the following two lines do the same thing<br />
+
-- the following two lines do the same thing
sprite:setScaleX(0.5)<br />
+
sprite:setScaleX(0.5)
sprite:set(&quot;scaleX&quot;, 0.5)<br />
+
sprite:set("scaleX", 0.5)
<br />
+
 
-- the following two lines do the same thing<br />
+
-- the following two lines do the same thing
sprite:setScaleY(0.5)<br />
+
sprite:setScaleY(0.5)
sprite:set(&quot;scaleY&quot;, 0.5)<br />
+
sprite:set("scaleY", 0.5)
<br />
+
 
-- the following two lines do the same thing<br />
+
-- the following two lines do the same thing
sprite:setScale(0.5)<br />
+
sprite:setScale(0.5)
sprite:set(&quot;scale&quot;, 0.5)<br /></source>
+
sprite:set("scale", 0.5)
 +
</syntaxhighlight>
 +
 
 +
''' A camera that follows the player'''
 +
<syntaxhighlight lang="lua">
 +
-- GAME LOOP
 +
function Level:onEnterFrame(e)
 +
-- camera follow
 +
posx, posy = self.player1.player:getPosition()
 +
self.camanchorx, self.camanchory = self.camera:getAnchorPosition()
 +
self.camera:set("anchorX", posx / self.camera:getScale())
 +
self.camera:set("anchorY", posy / self.camera:getScale())
 +
end
 +
</syntaxhighlight>
 +
 
 +
{{Sprite}}

Latest revision as of 14:33, 13 July 2023

Available since: Gideros 2011.6
Class: Sprite

Description

Sets the values of a sprite instance by name.

Sprite:set(param, value)


The possible names for param 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
value: (number) the new value of the specified parameter

Examples

-- the following two lines do the same thing
sprite:setX(10)
sprite:set("x", 10)
		
-- the following two lines do the same thing
sprite:setY(10)
sprite:set("y", 10)

-- the following two lines do the same thing
sprite:setRotation(10)
sprite:set("rotation", 10)

-- the following two lines do the same thing
sprite:setScaleX(0.5)
sprite:set("scaleX", 0.5)

-- the following two lines do the same thing
sprite:setScaleY(0.5)
sprite:set("scaleY", 0.5)

-- the following two lines do the same thing
sprite:setScale(0.5)
sprite:set("scale", 0.5)

A camera that follows the player

-- GAME LOOP
function Level:onEnterFrame(e)
	-- camera follow
	posx, posy = self.player1.player:getPosition()
	self.camanchorx, self.camanchory = self.camera:getAnchorPosition()
	self.camera:set("anchorX", posx / self.camera:getScale())
	self.camera:set("anchorY", posy / self.camera:getScale())
end