Difference between revisions of "Particles:removeParticles"
From GiderosMobile
(13 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
'''Available since:''' Gideros 2016.06<br/> | '''Available since:''' Gideros 2016.06<br/> | ||
+ | '''Class:''' [[Particles]]<br/> | ||
+ | |||
=== Description === | === Description === | ||
− | + | Removes particles by index (table) or as arguments. | |
+ | <syntaxhighlight lang="lua"> | ||
+ | Particles:removeParticles(particleIndices) | ||
+ | </syntaxhighlight> | ||
− | remove all particles | + | To remove all particles: |
− | + | *''particles:removeParticles()'' | |
− | + | To remove specific particles: | |
+ | *''particles:removeParticles({1,2,3})'' | ||
− | + | equivalent to: | |
+ | *''particles:removeParticles(1,2,3)'' | ||
− | or | + | === Parameters === |
+ | '''particleIndices''': (table or arguments) table or arguments of particle indices to remove<br/> | ||
− | + | {{Particles}} | |
− | |||
− | |||
− | |||
− | |||
− |
Latest revision as of 20:50, 21 September 2023
Available since: Gideros 2016.06
Class: Particles
Description
Removes particles by index (table) or as arguments.
Particles:removeParticles(particleIndices)
To remove all particles:
- particles:removeParticles()
To remove specific particles:
- particles:removeParticles({1,2,3})
equivalent to:
- particles:removeParticles(1,2,3)
Parameters
particleIndices: (table or arguments) table or arguments of particle indices to remove
- 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