Difference between revisions of "Sprite:set"

From GiderosMobile
(formatting)
(added example (is this english?) :-()
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
<languages />
+
'''Available since:''' Gideros 2011.6<br/>
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
+
'''Class:''' [[Sprite]]<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/Sprite|Sprite]]<br/>
 
  
=== <translate>Description</translate> ===
+
=== Description ===
Sets the specified property of this sprite instance by its name. These names are supported:
+
Sets the values of a sprite instance by name.
<ul>
 
<li>''"x"''</li>
 
<li>''"y"''</li>
 
<li>''"z"''</li>
 
<li>''"rotation"''</li>
 
<li>''"rotationX"''</li>
 
<li>''"rotationY"''</li>
 
<li>''"scaleX"''</li>
 
<li>''"scaleY"''</li>
 
<li>''"scaleZ"''</li>
 
<li>''"alpha"''</li>
 
<li>''"redMultiplier"''</li>
 
<li>''"greenMultiplier"''</li>
 
<li>''"blueMultiplier"''</li>
 
<li>''"alphaMultiplier"''</li>
 
<li>''"anchorX"''</li>
 
<li>''"anchorY"''</li>
 
<li>''"anchorZ"''</li>
 
</ul>
 
 
<source lang="lua">
 
<source lang="lua">
Sprite:set(param,value)
+
Sprite:set(param, value)
 
</source>
 
</source>
  
=== <translate>Parameters</translate> ===
 
'''param''': (string) <translate>The name of the parameter</translate> <br/>
 
'''value''': (number) <translate>The new value of the specified parameter</translate> <br/>
 
  
=== <translate>Examples</translate> ===
+
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<br/>
 +
'''value''': (number) the new value of the specified parameter<br/>
 +
 
 +
=== Examples ===
 
<source lang="lua">
 
<source lang="lua">
 
-- the following two lines do the same thing
 
-- the following two lines do the same thing
Line 58: Line 58:
 
sprite:setScale(0.5)
 
sprite:setScale(0.5)
 
sprite:set("scale", 0.5)
 
sprite:set("scale", 0.5)
 +
</source>
 +
 +
''' A camera that follows the player'''
 +
<source 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
 
</source>
 
</source>
  
 
{{Sprite}}
 
{{Sprite}}

Revision as of 22:40, 7 December 2020

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