Legacy Documentation: Version 2017.2 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

MainModule

struct in UnityEngine

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Description

Script interface for the main module.

Properties

customSimulationSpaceSimulate particles relative to a custom transform component.
durationThe duration of the particle system in seconds.
emitterVelocityModeControl how the Particle System calculates its velocity, when moving in the world.
gravityModifierScale applied to the gravity, defined by Physics.gravity.
gravityModifierMultiplierChange the gravity mulutiplier.
loopIs the particle system looping?
maxParticlesThe maximum number of particles to emit.
playOnAwakeIf set to true, the particle system will automatically start playing on startup.
prewarmWhen looping is enabled, this controls whether this particle system will look like it has already simulated for one loop when first becoming visible.
randomizeRotationDirectionCause some particles to spin in the opposite direction.
scalingModeControl how the particle system's Transform Component is applied to the particle system.
simulationSpaceThis selects the space in which to simulate particles. It can be either world or local space.
simulationSpeedOverride the default playback speed of the Particle System.
startColorThe initial color of particles when emitted.
startDelayStart delay in seconds.
startDelayMultiplierStart delay multiplier in seconds.
startLifetimeThe total lifetime in seconds that each new particle will have.
startLifetimeMultiplierStart lifetime multiplier.
startRotationThe initial rotation of particles when emitted.
startRotation3DA flag to enable 3D particle rotation.
startRotationMultiplierStart rotation multiplier.
startRotationXThe initial rotation of particles around the X axis when emitted.
startRotationXMultiplierStart rotation multiplier around the X axis.
startRotationYThe initial rotation of particles around the Y axis when emitted.
startRotationYMultiplierStart rotation multiplier around the Y axis.
startRotationZThe initial rotation of particles around the Z axis when emitted.
startRotationZMultiplierStart rotation multiplier around the Z axis.
startSizeThe initial size of particles when emitted.
startSize3DA flag to enable specifying particle size individually for each axis.
startSizeMultiplierStart size multiplier.
startSizeXThe initial size of particles along the X axis when emitted.
startSizeXMultiplierStart rotation multiplier along the X axis.
startSizeYThe initial size of particles along the Y axis when emitted.
startSizeYMultiplierStart rotation multiplier along the Y axis.
startSizeZThe initial size of particles along the Z axis when emitted.
startSizeZMultiplierStart rotation multiplier along the Z axis.
startSpeedThe initial speed of particles when emitted.
startSpeedMultiplierA multiplier of the initial speed of particles when emitted.
stopActionConfigure whether the GameObject will automatically disable or destroy itself, when the Particle System is stopped and all particles have died.
useUnscaledTimeWhen true, use the unscaled delta time to simulate the Particle System. Otherwise, use the scaled delta time.

Did you find this page useful? Please give it a rating: