Difference between revisions of "Particles:getParticles"
From GiderosMobile
| Line 2: | Line 2: | ||
'''Available since:''' in development<br/> | '''Available since:''' in development<br/> | ||
=== Description === | === Description === | ||
| − | Retrieve particles states of this system | + | <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 === | === Parameters === | ||
| − | '''set''': (table, optional) Optional set of particle indices to query '''optional'''<br/> | + | '''set''': (table, optional) <translate>Optional set of particle indices to query</translate> '''optional'''<br/> |
| − | '''tag''': (string, optional) only return particles matching this tag '''optional'''<br/> | + | '''tag''': (string, optional) <translate>only return particles matching this tag</translate> '''optional'''<br/> |
=== Return values === | === Return values === | ||
| − | '''Returns''' (table) table containing the state of each particle in the system matching tag if any<br/> | + | '''Returns''' (table) <translate>table containing the state of each particle in the system matching tag if any</translate><br/> |
Revision as of 13:34, 23 August 2018
Available since: in development
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
