Difference between revisions of "Particles:getParticles"
From GiderosMobile
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | '''Available since:''' in development<br/> | + | '''<translate>Available since</translate>:''' in development<br/> |
| − | === Description === | + | === <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/> |
Revision as of 07:28, 24 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
