Particles Lua API: Difference between revisions
(adding DocStart) |
No edit summary |
||
(6 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
<!-- This file is auto generated, please don't edit manually! --> | |||
= Particles = | = Particles = | ||
== Description == | == Description == | ||
The Particles API allows modders to trigger behaviours on the particle systems attached to mission objects and their children. For more information see [https://docs.unity3d.com/Manual/class-ParticleSystem.html Unity's documentation] on Particle Systems | |||
The Particles API allows modders to trigger behaviours on the particle systems attached to mission objects and their children. | |||
For more information see [https://docs.unity3d.com/Manual/class-ParticleSystem.html Unity's documentation] on Particle Systems | |||
== Functions == | == Functions == | ||
=== Play === | === Play === | ||
Line 8: | Line 10: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| deviceName || string | | deviceName || string | ||
Line 24: | Line 28: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| deviceName || string | | deviceName || string | ||
Line 37: | Line 43: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| deviceName || string | | deviceName || string | ||
Line 50: | Line 58: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| deviceName || string | | deviceName || string | ||
Line 63: | Line 73: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| deviceName || string | | deviceName || string | ||
Line 78: | Line 90: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| deviceName || string | | deviceName || string | ||
Line 89: | Line 103: | ||
'''Docs last hacked together on''': 09/ | This file is auto generated, please don't edit manually! | ||
'''Docs last hacked together on''': 06/09/2018 14:53 | |||
[[Category:Modding]][[Category:LuaAPI]] |
Revision as of 14:17, 6 September 2018
Particles
Description
The Particles API allows modders to trigger behaviours on the particle systems attached to mission objects and their children. For more information see Unity's documentation on Particle Systems
Functions
Play
Particles.Play(deviceName, searchChildren)
Expected parameter types
Name | Type |
---|---|
deviceName | string |
searchChildren | bool (optional) |
Description: Sets the particle system into play mode and beings emitting
Returns: Nothing
Notes: Sets the particle systems into play mode and enables emitting (if it has been disabled). If the particle system has been paused, then this resumes playing from the previous time. If the particle system has stopped, then the system starts from time 0, and, if it is relevant, the startDelay is applied.
Pause
Particles.Pause(deviceName, searchChildren)
Expected parameter types
Name | Type |
---|---|
deviceName | string |
searchChildren | bool (optional) |
Description: Pauses playing the particle system.
Returns: Nothing
Stop
Particles.Stop(deviceName, searchChildren)
Expected parameter types
Name | Type |
---|---|
deviceName | string |
searchChildren | bool (optional) |
Description: Stops playing the particle system.
Returns: Nothing
Toggle
Particles.Toggle(deviceName, searchChildren)
Expected parameter types
Name | Type |
---|---|
deviceName | string |
searchChildren | bool (optional) |
Description: Toggles the particle system playing
Returns: Nothing
Emit
Particles.Emit(deviceName, count, searchChildren)
Expected parameter types
Name | Type |
---|---|
deviceName | string |
count | number |
searchChildren | bool (optional) |
Description: Emit _count_ particles immediately.
Returns: Nothing
IsPlaying
Particles.IsPlaying(deviceName, searchChildren)
Expected parameter types
Name | Type |
---|---|
deviceName | string |
searchChildren | bool (optional) |
Description: Is the particle system playing right now?
Returns: bool
This file is auto generated, please don't edit manually!
Docs last hacked together on: 06/09/2018 14:53