Difference between revisions of "Particles:getParticles"

From GiderosMobile
Line 6: Line 6:
 
(table) = Particles:getParticles(set,tag)
 
(table) = Particles:getParticles(set,tag)
 
</source>
 
</source>
 +
=== Parameters ===
 
'''set''': (table, optional) Optional set of particle indices to query '''optional'''<br/>
 
'''set''': (table, optional) Optional set of particle indices to query '''optional'''<br/>
 
'''tag''': (string, optional) only return particles matching this tag '''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/>
 
'''Returns''' (table) table containing the state of each particle in the system matching tag if any<br/>

Revision as of 10:45, 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