Difference between revisions of "Particles:getParticles"

From GiderosMobile
 
(7 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(set,tag)
 
(table) = Particles:getParticles(set,tag)
−
</source>
+
</syntaxhighlight>
 +
 
 
=== Parameters ===
 
=== 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 ===
 
=== 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 20:46, 21 September 2023

Available since: Gideros 2016.10
Class: Particles

Description

Retrieves the 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



Retrieved from ‘https://wiki.gideros.rocks/index.php?title=Particles:getParticles&oldid=22551’