Difference between revisions of "Particles:getParticles"

From GiderosMobile
(Created page with "__NOTOC__ '''Available since:''' in development<br/> === Description === Retrieve particles states of this system <source lang="lua"> (table), = Particles:getParticles(settag,...")
 
Line 4: Line 4:
 
Retrieve particles states of this system
 
Retrieve particles states of this system
 
<source lang="lua">
 
<source lang="lua">
(table), = Particles:getParticles(settag,)
+
(table) = Particles:getParticles(set,tag)
 
</source>
 
</source>
'''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/>
 
'''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 11:20, 23 August 2018

Available since: in development

Description

Retrieve particles states of this system

(table) = Particles:getParticles(set,tag)

set: (table, optional) Optional set of particle indices to query optional
tag: (string, optional) only return particles matching this tag optional
Returns (table) table containing the state of each particle in the system matching tag if any