Difference between revisions of "Particles:addParticles"
From GiderosMobile
(9 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
− | '''Available since:''' Gideros 2016.06<br/> | + | |
− | === Description === | + | <languages /> |
− | Add particle a single particle (short form) or several ones (long form) to this particle system. | + | |
− | <br/> | + | '''<translate>Available since</translate>:''' Gideros 2016.06<br/> |
− | Short form (single particle): | + | '''<translate>Class</translate>:''' [[Special:MyLanguage/Particles|Particles]]<br/> |
− | + | ||
− | <br/> | + | === <translate>Description</translate> === |
− | Extended form: | + | <translate> |
− | + | Add particle a single particle (short form) or several ones (long form) to this particle system.<br/> | |
+ | '''Short form''' (single particle): ''particles:addParticles(x,y,size,angle,ttl)''<br/> | ||
+ | '''Extended form''': ''particles:addParticles{particleDesc1,particleDesc2,...,particleDescN}''<br/> | ||
where particleDescX is a table describing a particle to be added. This table can contain the following parameters: | where particleDescX is a table describing a particle to be added. This table can contain the following parameters: | ||
<ul> | <ul> | ||
Line 21: | Line 23: | ||
<li>decay,decayAngular,decayGrowth,decayAlpha: factor applied to speedX and speedY, speedAngular, speedGrowth and alpha at the beginning of each frame</li> | <li>decay,decayAngular,decayGrowth,decayAlpha: factor applied to speedX and speedY, speedAngular, speedGrowth and alpha at the beginning of each frame</li> | ||
</ul> | </ul> | ||
+ | </translate> | ||
+ | <br/> | ||
+ | |||
<source lang="lua"> | <source lang="lua"> | ||
(number or table) = Particles:addParticles(particles) | (number or table) = Particles:addParticles(particles) | ||
</source> | </source> | ||
− | === Parameters === | + | <br/> |
− | '''particles''': (table or arguments) table for multiple particles or arguments for single <br/> | + | |
− | === Return values === | + | === <translate>Example</translate> === |
− | '''Returns''' (number or table) index or table with indexes of added particles<br/> | + | '''Example:''': |
+ | <source lang="lua"> | ||
+ | local stars = Particles.new() | ||
+ | stars:setPosition(64, 64) | ||
+ | stage:addChild(stars) | ||
+ | stage:addEventListener(Event.ENTER_FRAME, function() | ||
+ | stars:addParticles({ | ||
+ | {x=math.random(4*64),y=math.random(5*64),size=math.random(1,30),color=0xD9B589,ttl=1*60,speedX=0,speedY=0}, | ||
+ | {x=math.random(2*64),y=math.random(5*64),size=math.random(1,30),color=0xffff00,ttl=30*60,speedX=1,speedY=0}, | ||
+ | }) | ||
+ | end) | ||
+ | </source> | ||
+ | |||
+ | === <translate>Parameters</translate> === | ||
+ | '''particles''': (table or arguments) <translate>table for multiple particles or arguments for single</translate> | ||
+ | <br/> | ||
+ | |||
+ | === <translate>Return values</translate> === | ||
+ | '''<translate>Returns</translate>''' (number or table) <translate>index or table with indexes of added particles</translate><br/> | ||
+ | <br/> | ||
+ | <br/> | ||
+ | |||
+ | {{Particles}} |
Revision as of 23:18, 3 December 2019
Available since: Gideros 2016.06
Class: Particles
Description
Add particle a single particle (short form) or several ones (long form) to this particle system.
Short form (single particle): particles:addParticles(x,y,size,angle,ttl)
Extended form: particles:addParticles{particleDesc1,particleDesc2,...,particleDescN}
where particleDescX is a table describing a particle to be added. This table can contain the following parameters:
- x,y: particle position
- size: particle size
- angle: particle orientation
- color: particle color
- alpha: particle alpha
- ttl: time to leave, number of frames this particle will stay on screen
- tag: tag associated with this particle
- speedX,speedY,speedAngular,speedGrowth: Amount added to x,y,angle and size at the beginning of each frame
- decay,decayAngular,decayGrowth,decayAlpha: factor applied to speedX and speedY, speedAngular, speedGrowth and alpha at the beginning of each frame
(number or table) = Particles:addParticles(particles)
Example
Example::
local stars = Particles.new()
stars:setPosition(64, 64)
stage:addChild(stars)
stage:addEventListener(Event.ENTER_FRAME, function()
stars:addParticles({
{x=math.random(4*64),y=math.random(5*64),size=math.random(1,30),color=0xD9B589,ttl=1*60,speedX=0,speedY=0},
{x=math.random(2*64),y=math.random(5*64),size=math.random(1,30),color=0xffff00,ttl=30*60,speedX=1,speedY=0},
})
end)
Parameters
particles: (table or arguments) table for multiple particles or arguments for single
Return values
Returns (number or table) index or table with indexes of added particles
- Particles
- Particles.new
- Particles:addParticles
- Particles:clearTexture
- Particles:getDeadParticles
- Particles:getNearestParticle
- Particles:getNumParticles
- Particles:getParticleAcceleration
- Particles:getParticleAngle
- Particles:getParticleColor
- Particles:getParticleDecay
- Particles:getParticleExtra
- Particles:getParticlePosition
- Particles:getParticleSize
- Particles:getParticleSpeed
- Particles:getParticleTag
- Particles:getParticleTtl
- Particles:getParticles
- Particles:isPaused
- Particles:removeParticles
- Particles:scaleParticles
- Particles:setParticleAcceleration
- Particles:setParticleAngle
- Particles:setParticleColor
- Particles:setParticleDecay
- Particles:setParticleExtra
- Particles:setParticlePosition
- Particles:setParticleSize
- Particles:setParticleSpeed
- Particles:setParticleTag
- Particles:setParticleTtl
- Particles:setPaused
- Particles:setTexture