Particles:getParticles: Difference between revisions

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,..."
 
No edit summary
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
'''Available since:''' in development<br/>
'''Available since:''' Gideros 2016.10<br/>
'''Class:''' [[Particles]]<br/>
 
=== Description ===
=== Description ===
Retrieve particles states of this system
Retrieves the particles states of this system.
<source lang="lua">
<syntaxhighlight lang="lua">
(table), = Particles:getParticles(settag,)
(table) = Particles:getParticles(set,tag)
</source>
</syntaxhighlight>
'''set:''' (table, optional) Optional set of particle indices to query '''optional'''<br/>
 
'''tag:''' (string, optional) only return particles matching this tag '''optional'''<br/>
=== Parameters ===
'''set''': (table, optional) optional set of particle indices to query '''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/>
{{Particles}}

Latest revision as of 19:46, 21 September 2023