Difference between revisions of "Particles"

From GiderosMobile
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
<languages />
 
 
<!-- GIDEROSOBJ:Particles -->
 
<!-- GIDEROSOBJ:Particles -->
'''<translate>Supported platforms</translate>:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]][[File:Platform html5.png]][[File:Platform winrt.png]][[File:Platform win32.png]]<br/>
+
'''Supported platforms:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]][[File:Platform html5.png]][[File:Platform winrt.png]][[File:Platform win32.png]]<br/>
'''<translate>Available since</translate>:''' Gideros 2016.06<br/>
+
'''Available since:''' Gideros 2016.06<br/>
'''<translate>Inherits from</translate>:''' [[Special:MyLanguage/Sprite|Sprite]]<br/>
+
'''Inherits from:''' [[Special:MyLanguage/Sprite|Sprite]]<br/>
=== <translate>Description</translate> ===
+
 
<translate>Particles sprite (alpha), which allows to draw several identical dots or bitmaps with varying colour and orientation</translate>
+
=== Description ===
 +
A particle system which allows to draw several identical dots or bitmaps, with varying colour and orientation.
 +
 
 
{|-
 
{|-
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
=== <translate>Methods</translate> ===
+
=== Methods ===
[[Special:MyLanguage/Particles.new|Particles.new]] ''<translate>Create new particles group</translate>''<br/><!-- GIDEROSMTD:Particles.new -->
+
[[Special:MyLanguage/Particles.new|Particles.new]] ''Create new particles group''<br/><!-- GIDEROSMTD:Particles.new() Create new particles group -->
[[Special:MyLanguage/Particles:addParticles|Particles:addParticles]] ''<translate>Add particles</translate>''<br/><!-- GIDEROSMTD:Particles:addParticles -->
+
[[Special:MyLanguage/Particles:addParticles|Particles:addParticles]] ''Add particles''<br/><!-- GIDEROSMTD:Particles:addParticles(particles) Add particles -->
[[Special:MyLanguage/Particles:clearTexture|Particles:clearTexture]] ''<translate>Clear texture for all particles</translate>''<br/><!-- GIDEROSMTD:Particles:clearTexture -->
+
[[Special:MyLanguage/Particles:clearTexture|Particles:clearTexture]] ''Clear texture for all particles''<br/><!-- GIDEROSMTD:Particles:clearTexture() Clear texture for all particles -->
[[Special:MyLanguage/Particles:getParticleAngle|Particles:getParticleAngle]] ''<translate>get particle angle</translate>''<br/><!-- GIDEROSMTD:Particles:getParticleAngle -->
+
[[Special:MyLanguage/Particles:getNearestParticle|Particles:getNearestParticle]] ''Get the index of the nearest particle to the given point'' <br/><!-- GIDEROSMTD:Particles:getNearestParticle(x,y)  Get the index of the nearest particle to the given point-->
[[Special:MyLanguage/Particles:getParticleColor|Particles:getParticleColor]] ''<translate>Get color and alpha value of particle</translate>''<br/><!-- GIDEROSMTD:Particles:getParticleColor -->
+
[[Special:MyLanguage/Particles:getParticleAngle|Particles:getParticleAngle]] ''get particle angle''<br/><!-- GIDEROSMTD:Particles:getParticleAngle(i) get particle angle -->
[[Special:MyLanguage/Particles:getParticleDecay|Particles:getParticleDecay]] <br/><!-- GIDEROSMTD:Particles:getParticleDecay -->
+
[[Special:MyLanguage/Particles:getParticleColor|Particles:getParticleColor]] ''Get color and alpha value of particle''<br/><!-- GIDEROSMTD:Particles:getParticleColor(i) Get color and alpha value of particle -->
[[Special:MyLanguage/Particles:getParticlePosition|Particles:getParticlePosition]] ''<translate>get position of particle</translate>''<br/><!-- GIDEROSMTD:Particles:getParticlePosition -->
+
[[Special:MyLanguage/Particles:getParticleDecay|Particles:getParticleDecay]] ''Get particle decay factor'' <br/><!-- GIDEROSMTD:Particles:getParticleDecay(i) Get particle decay factor -->
[[Special:MyLanguage/Particles:getParticleSize|Particles:getParticleSize]] ''<translate>get size of particle in pixels</translate>''<br/><!-- GIDEROSMTD:Particles:getParticleSize -->
+
[[Special:MyLanguage/Particles:getParticlePosition|Particles:getParticlePosition]] ''get position of particle''<br/><!-- GIDEROSMTD:Particles:getParticlePosition(i) get position of particle -->
[[Special:MyLanguage/Particles:getParticleSpeed|Particles:getParticleSpeed]] ''<translate>Get speed of particle</translate>''<br/><!-- GIDEROSMTD:Particles:getParticleSpeed -->
+
[[Special:MyLanguage/Particles:getParticleSize|Particles:getParticleSize]] ''get size of particle in pixels''<br/><!-- GIDEROSMTD:Particles:getParticleSize(i) get size of particle in pixels -->
[[Special:MyLanguage/Particles:getParticleTag|Particles:getParticleTag]] <br/><!-- GIDEROSMTD:Particles:getParticleTag -->
+
[[Special:MyLanguage/Particles:getParticleSpeed|Particles:getParticleSpeed]] ''Get speed of particle''<br/><!-- GIDEROSMTD:Particles:getParticleSpeed(i) Get speed of particle -->
[[Special:MyLanguage/Particles:getParticleTtl|Particles:getParticleTtl]] ''<translate>get initial time to live of particle</translate>''<br/><!-- GIDEROSMTD:Particles:getParticleTtl -->
+
[[Special:MyLanguage/Particles:getParticleTag|Particles:getParticleTag]] ''Get the tag associated to the particle'' <br/><!-- GIDEROSMTD:Particles:getParticleTag(i) Get the tag associated to the particle -->
[[Special:MyLanguage/Particles:getParticles|Particles:getParticles]] <br/><!-- GIDEROSMTD:Particles:getParticles -->
+
[[Special:MyLanguage/Particles:getParticleTtl|Particles:getParticleTtl]] ''get initial time to live of particle''<br/><!-- GIDEROSMTD:Particles:getParticleTtl(i) get initial time to live of particle -->
[[Special:MyLanguage/Particles:isPaused|Particles:isPaused]] <br/><!-- GIDEROSMTD:Particles:isPaused -->
+
[[Special:MyLanguage/Particles:getParticles|Particles:getParticles]] ''get particles'' <br/><!-- GIDEROSMTD:Particles:getParticles(set,tag) get particles -->
[[Special:MyLanguage/Particles:removeParticles|Particles:removeParticles]] ''<translate>Remove particles by index in table or as arguments</translate>''<br/><!-- GIDEROSMTD:Particles:removeParticles -->
+
[[Special:MyLanguage/Particles:isPaused|Particles:isPaused]] ''Tell if the Particle set is paused'' <br/><!-- GIDEROSMTD:Particles:isPaused() Tell if the Particle set is paused -->
[[Special:MyLanguage/Particles:setParticleAngle|Particles:setParticleAngle]] ''<translate>set angle of particle</translate>''<br/><!-- GIDEROSMTD:Particles:setParticleAngle -->
+
[[Special:MyLanguage/Particles:removeParticles|Particles:removeParticles]] ''Remove particles by index in table or as arguments''<br/><!-- GIDEROSMTD:Particles:removeParticles(particle indeces) Remove particles by index in table or as arguments -->
[[Special:MyLanguage/Particles:setParticleColor|Particles:setParticleColor]] ''<translate>set color of particles</translate>''<br/><!-- GIDEROSMTD:Particles:setParticleColor -->
+
[[Special:MyLanguage/Particles:scaleParticles|Particles:scaleParticles]] ''scale or resize all particles in this sprite''<br/><!-- GIDEROSMTD:Particles:scaleParticles(scale,absolute) scale or resize all particles in this sprite -->[[Special:MyLanguage/Particles:setParticleAngle|Particles:setParticleAngle]] ''set angle of particle''<br/><!-- GIDEROSMTD:Particles:setParticleAngle(i,angle) set angle of particle -->
[[Special:MyLanguage/Particles:setParticleDecay|Particles:setParticleDecay]] <br/><!-- GIDEROSMTD:Particles:setParticleDecay -->
+
[[Special:MyLanguage/Particles:setParticleColor|Particles:setParticleColor]] ''set color of particles''<br/><!-- GIDEROSMTD:Particles:setParticleColor(i,color,alpha) set color of particles -->
[[Special:MyLanguage/Particles:setParticlePosition|Particles:setParticlePosition]] ''<translate>set position of particle</translate>''<br/><!-- GIDEROSMTD:Particles:setParticlePosition -->
+
[[Special:MyLanguage/Particles:setParticleDecay|Particles:setParticleDecay]] ''set the decay factor of particles'' <br/><!-- GIDEROSMTD:Particles:setParticleDecay(i,decay,decayAlpha,decayGrowth,decayAngular)  set the decay factor of particles -->
[[Special:MyLanguage/Particles:setParticleSize|Particles:setParticleSize]] ''<translate>set size of particle</translate>''<br/><!-- GIDEROSMTD:Particles:setParticleSize -->
+
[[Special:MyLanguage/Particles:setParticlePosition|Particles:setParticlePosition]] ''set position of particle''<br/><!-- GIDEROSMTD:Particles:setParticlePosition(i,x,y) set position of particle -->
[[Special:MyLanguage/Particles:setParticleSpeed|Particles:setParticleSpeed]] ''<translate>Set speed of particles</translate>''<br/><!-- GIDEROSMTD:Particles:setParticleSpeed -->
+
[[Special:MyLanguage/Particles:setParticleSize|Particles:setParticleSize]] ''set size of particle''<br/><!-- GIDEROSMTD:Particles:setParticleSize(i,size) set size of particle -->
[[Special:MyLanguage/Particles:setParticleTag|Particles:setParticleTag]] <br/><!-- GIDEROSMTD:Particles:setParticleTag -->
+
[[Special:MyLanguage/Particles:setParticleSpeed|Particles:setParticleSpeed]] ''Set speed of particles''<br/><!-- GIDEROSMTD:Particles:setParticleSpeed(i,x,y,a,s) Set speed of particles -->
[[Special:MyLanguage/Particles:setParticleTtl|Particles:setParticleTtl]] ''<translate>set time to live</translate>''<br/><!-- GIDEROSMTD:Particles:setParticleTtl -->
+
[[Special:MyLanguage/Particles:setParticleTag|Particles:setParticleTag]] ''Set a tag to a particle'' <br/><!-- GIDEROSMTD:Particles:setParticleTag(i,tag) Set a tag to a particle -->
[[Special:MyLanguage/Particles:setParticlesTag|Particles:setParticlesTag]] <br/><!-- GIDEROSMTD:Particles:setParticlesTag -->
+
[[Special:MyLanguage/Particles:setParticleTtl|Particles:setParticleTtl]] ''set time to live''<br/><!-- GIDEROSMTD:Particles:setParticleTtl(i,ttl) set time to live -->
[[Special:MyLanguage/Particles:setPaused|Particles:setPaused]] <br/><!-- GIDEROSMTD:Particles:setPaused -->
+
[[Special:MyLanguage/Particles:setPaused|Particles:setPaused]] ''Pause or resume the Particle set'' <br/><!-- GIDEROSMTD:Particles:setPaused(paused) Pause or resume the Particle set -->
[[Special:MyLanguage/Particles:setTexture|Particles:setTexture]] ''<translate>Set texture to all particles</translate>''<br/><!-- GIDEROSMTD:Particles:setTexture -->
+
[[Special:MyLanguage/Particles:setTexture|Particles:setTexture]] ''Set texture to all particles''<br/><!-- GIDEROSMTD:Particles:setTexture(texture) Set texture to all particles -->
 +
 
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
=== <translate>Events</translate> ===
+
 
=== <translate>Constants</translate> ===
+
=== Events ===
 +
=== Constants ===
 
|}
 
|}
 +
 +
{{GIDEROS IMPORTANT LINKS}}

Revision as of 17:38, 7 January 2021

Supported platforms: Platform android.pngPlatform ios.pngPlatform mac.pngPlatform pc.pngPlatform html5.pngPlatform winrt.pngPlatform win32.png
Available since: Gideros 2016.06
Inherits from: Sprite

Description

A particle system which allows to draw several identical dots or bitmaps, with varying colour and orientation.

Methods

Particles.new Create new particles group
Particles:addParticles Add particles
Particles:clearTexture Clear texture for all particles
Particles:getNearestParticle Get the index of the nearest particle to the given point
Particles:getParticleAngle get particle angle
Particles:getParticleColor Get color and alpha value of particle
Particles:getParticleDecay Get particle decay factor
Particles:getParticlePosition get position of particle
Particles:getParticleSize get size of particle in pixels
Particles:getParticleSpeed Get speed of particle
Particles:getParticleTag Get the tag associated to the particle
Particles:getParticleTtl get initial time to live of particle
Particles:getParticles get particles
Particles:isPaused Tell if the Particle set is paused
Particles:removeParticles Remove particles by index in table or as arguments
Particles:scaleParticles scale or resize all particles in this sprite
Particles:setParticleAngle set angle of particle
Particles:setParticleColor set color of particles
Particles:setParticleDecay set the decay factor of particles
Particles:setParticlePosition set position of particle
Particles:setParticleSize set size of particle
Particles:setParticleSpeed Set speed of particles
Particles:setParticleTag Set a tag to a particle
Particles:setParticleTtl set time to live
Particles:setPaused Pause or resume the Particle set
Particles:setTexture Set texture to all particles

Events

Constants