Difference between revisions of "Particles:getParticles"
From GiderosMobile
(3 intermediate revisions by one other user not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
− | '''Available since:''' in development<br/> | + | <languages /> |
− | === Description === | + | '''<translate>Available since</translate>:''' in development<br/> |
+ | '''<translate>Class</translate>:''' [[Special:MyLanguage/Particles|Particles]]<br/> | ||
+ | === <translate>Description</translate> === | ||
<translate>Retrieve particles states of this system</translate> | <translate>Retrieve particles states of this system</translate> | ||
<source lang="lua"> | <source lang="lua"> | ||
(table) = Particles:getParticles(set,tag) | (table) = Particles:getParticles(set,tag) | ||
</source> | </source> | ||
− | === Parameters === | + | === <translate>Parameters</translate> === |
'''set''': (table, optional) <translate>Optional set of particle indices to query</translate> '''optional'''<br/> | '''set''': (table, optional) <translate>Optional set of particle indices to query</translate> '''optional'''<br/> | ||
'''tag''': (string, optional) <translate>only return particles matching this tag</translate> '''optional'''<br/> | '''tag''': (string, optional) <translate>only return particles matching this tag</translate> '''optional'''<br/> | ||
− | === Return values === | + | === <translate>Return values</translate> === |
− | '''Returns''' (table) <translate>table containing the state of each particle in the system matching tag if any</translate><br/> | + | '''<translate>Returns</translate>''' (table) <translate>table containing the state of each particle in the system matching tag if any</translate><br/> |
+ | |||
+ | {{Particles}} |
Revision as of 22:21, 3 December 2019
Available since: in development
Class: Particles
Description
Retrieve 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