(Added and defined SParticleSystem's all public member functions) |
(Added and defined all properties in SParticleSystem) |
||
Line 29: | Line 29: | ||
==Properties== | ==Properties== | ||
− | {{ScriptFunction| | + | {{ScriptFunction|float|Duration|{ get; }|The duration of the Particle System in seconds.|5=<pre></pre>}} |
− | {{ScriptFunction| | + | {{ScriptFunction|float|EmissionRate|{ get;set; }|The rate of particle emission.|5=<pre></pre>}} |
− | {{ScriptFunction| | + | {{ScriptFunction|float|EmissionRateOverDistance|{ get;set; }|The rate at which the emitter spawns new particles over distance. |
− | {{ScriptFunction| | + | The emitter only spawns new particles when it moves.|5=<pre></pre>}} |
− | {{ScriptFunction| | + | {{ScriptFunction|float|EmissionRateOverTime|{ get;set; }|The rate at which the emitter spawns new particles over time.|5=<pre></pre>}} |
− | {{ScriptFunction| | + | {{ScriptFunction|bool|EnableEmission|{ get;set; }|When set to false, the Particle System will not emit particles.|5=<pre></pre>}} |
− | {{ScriptFunction| | + | {{ScriptFunction|float|GravityModifier|{ get;set }|A scale that this Particle System applies to gravity.|5=<pre></pre>}} |
− | {{ScriptFunction| | + | {{ScriptFunction|bool|IsEmitting|{ get; }|Determines whether the Particle System is emitting particles. |
− | {{ScriptFunction| | + | A Particle System may stop emitting when its emission module has finished, it has been paused or if the system has been stopped.|5=<pre></pre>}} |
− | {{ScriptFunction| | + | {{ScriptFunction|bool|IsPaused|{ get; }|Determines whether the Particle System is paused.|5=<pre></pre>}} |
− | {{ScriptFunction| | + | {{ScriptFunction|bool|IsPlaying|{ get; }|Determines whether the Particle System is playing.|5=<pre></pre>}} |
− | {{ScriptFunction| | + | {{ScriptFunction|bool|IsStopped|{ get; }|Determines whether the Particle System is stopped.|5=<pre></pre>}} |
− | {{ScriptFunction| | + | {{ScriptFunction|bool|Loop|{ get;set; }|Specifies whether the Particle System is looping. |
− | {{ScriptFunction| | + | If you disable looping on a playing Particle System, it stops at the end of the current loop.|5=<pre></pre>}} |
− | {{ScriptFunction| | + | {{ScriptFunction|int|MaxParticles|{ get;set; }|The maximum number of particles to emit.|5=<pre></pre>}} |
− | {{ScriptFunction| | + | {{ScriptFunction|int|ParticleCount|{ get; }|The current number of particles.|5=<pre></pre>}} |
− | {{ScriptFunction| | + | {{ScriptFunction|float|PlaybackSpeed|{ get;set; }|The playback speed of the Particle System. 1 is normal playback speed.|5=<pre></pre>}} |
− | {{ScriptFunction| | + | {{ScriptFunction|bool|PlayOnAwake|{ get;set; }|If set to true, the Particle System will automatically start playing on startup. |
− | {{ScriptFunction| | + | Note that this setting is shared between all Particle Systems in the current particle effect.|5=<pre></pre>}} |
− | {{ScriptFunction| | + | {{ScriptFunction|uint|RandomSeed|{ get;set; }|Override the random seed used for the Particle System emission.|5=<pre></pre>}} |
− | {{ScriptFunction| | + | {{ScriptFunction|Scolor|StartColor|{ get;set; }|The initial color of particles when the Particle System first spawns them.|5=<pre></pre>}} |
− | {{ScriptFunction| | + | {{ScriptFunction|float|StartDelay|{ get;set; }|Start delay in seconds. |
− | {{ScriptFunction| | + | Use this to delay when playback starts on the system.|5=<pre></pre>}} |
− | {{ScriptFunction| | + | {{ScriptFunction|float|StartLifetime|{ get;set; }|The total lifetime in seconds that particles will have when emitted. When using curves, this value acts as a scale on the curve. This value is set in the particle when it is created by the Particle System.|5=<pre></pre>}} |
− | {{ScriptFunction| | + | {{ScriptFunction|float|StartRotation|{ get;set; }|The initial rotation of particles when emitted. When using curves, this value acts as a scale on the curve. |
+ | Note that the value should be given in radians.|5=<pre></pre>}} | ||
+ | {{ScriptFunction|SVector|StartRotation3D|{ get;set; }|The initial 3D rotation of particles when emitted. When using curves, this value acts as a scale on the curves. | ||
+ | Note that the values are Euler angles and should be given in radians.|5=<pre></pre>}} | ||
+ | {{ScriptFunction|float|StartSize|{ get;set; }|The initial size of particles when the Particle System first spawns them.|5=<pre></pre>}} | ||
+ | {{ScriptFunction|float|StartSpeed|{ get;set; }|The initial speed of particles when the Particle System first spawns them.|5=<pre></pre>}} | ||
+ | {{ScriptFunction|float|Time|{ get;set; }|Playback position in seconds. | ||
+ | Use this to read current playback time or to seek to a new playback time.|5=<pre></pre>}} | ||
+ | {{ScriptFunction|bool|UseAutoRandomSeed|{ get;set; }|Controls whether the Particle System uses an automatically-generated random number to seed the random number generator. | ||
+ | If set to true, the Particle System will generate a new random seed each time it is played. If set to false, ParticleSystem.randomSeed will be used instead, allowing for a constant seed (useful if you want your particles to play in exactly the same way each time) or user-defined random value (for example, you may want to cycle through an array of seeds).|5=<pre></pre>}} |
Remove all particles in the Particle System.
This method also removes the particles from any linked sub-emitters. Use the withChildren parameter to remove particles from child Particle Systems that are not sub-emitters of the system.
Remove all particles in the Particle System.
This method also removes the particles from any linked sub-emitters. Use the withChildren parameter to remove particles from child Particle Systems that are not sub-emitters of the system.
Emit 'count' particles immediately.
Returns True if the Particle System contains live particles or is still creating new particles. False if the Particle System has stopped emitting particles and all particles are dead. Parameter withChildren: checks all child Particle Systems as well.
Pauses the system so no new particles are emitted and the existing particles are not updated.
Pauses the system so no new particles are emitted and the existing particles are not updated. Parameter: withChildren: Pauses all child Particle Systems as well.
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.
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. Parameter withChildren: Plays all child Particle Systems as well.
Fast-forwards the Particle System by simulating particles over 'time' seconds, then pauses it.
Stops playing the Particle System.
Stops playing the Particle System. Parameter withChildren: Plays all child Particle Systems as well.
The duration of the Particle System in seconds.
The rate of particle emission.
The rate at which the emitter spawns new particles over distance. The emitter only spawns new particles when it moves.
The rate at which the emitter spawns new particles over time.
When set to false, the Particle System will not emit particles.
A scale that this Particle System applies to gravity.
Determines whether the Particle System is emitting particles. A Particle System may stop emitting when its emission module has finished, it has been paused or if the system has been stopped.
Determines whether the Particle System is paused.
Determines whether the Particle System is playing.
Determines whether the Particle System is stopped.
Specifies whether the Particle System is looping. If you disable looping on a playing Particle System, it stops at the end of the current loop.
The maximum number of particles to emit.
The current number of particles.
The playback speed of the Particle System. 1 is normal playback speed.
If set to true, the Particle System will automatically start playing on startup. Note that this setting is shared between all Particle Systems in the current particle effect.
Override the random seed used for the Particle System emission.
The initial color of particles when the Particle System first spawns them.
Start delay in seconds. Use this to delay when playback starts on the system.
The total lifetime in seconds that particles will have when emitted. When using curves, this value acts as a scale on the curve. This value is set in the particle when it is created by the Particle System.
The initial rotation of particles when emitted. When using curves, this value acts as a scale on the curve. Note that the value should be given in radians.
The initial 3D rotation of particles when emitted. When using curves, this value acts as a scale on the curves. Note that the values are Euler angles and should be given in radians.
The initial size of particles when the Particle System first spawns them.
The initial speed of particles when the Particle System first spawns them.
Playback position in seconds. Use this to read current playback time or to seek to a new playback time.
Controls whether the Particle System uses an automatically-generated random number to seed the random number generator. If set to true, the Particle System will generate a new random seed each time it is played. If set to false, ParticleSystem.randomSeed will be used instead, allowing for a constant seed (useful if you want your particles to play in exactly the same way each time) or user-defined random value (for example, you may want to cycle through an array of seeds).