Difference between revisions of "Particles:getParticles"
From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>") |
|||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | + | '''Available since:''' Gideros 2016.10<br/> | |
| − | ''' | + | '''Class:''' [[Particles]]<br/> |
| − | ''' | + | |
| − | === | + | === Description === |
| − | + | Retrieves the particles states of this system. | |
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
(table) = Particles:getParticles(set,tag) | (table) = Particles:getParticles(set,tag) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | === | + | |
| − | '''set''': (table, optional) | + | === Parameters === |
| − | '''tag''': (string, optional) | + | '''set''': (table, optional) optional set of particle indices to query '''optional'''<br/> |
| − | === | + | '''tag''': (string, optional) only return particles matching this tag '''optional'''<br/> |
| − | ''' | + | |
| + | === Return values === | ||
| + | '''Returns''' (table) table containing the state of each particle in the system matching tag if any<br/> | ||
{{Particles}} | {{Particles}} | ||
Latest revision as of 20:46, 21 September 2023
Available since: Gideros 2016.10
Class: Particles
Description
Retrieves the particles states of this system.
(table) = Particles:getParticles(set,tag)
Parameters
set: (table, optional) optional set of particle indices to query optional
tag: (string, optional) only return particles matching this tag optional
Return values
Returns (table) table containing the state of each particle in the system matching tag if any
- 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
