Version: 2019.2
LanguageEnglish
  • C#

ShapeModule

struct in UnityEngine

/

Implemented in:UnityEngine.ParticleSystemModule

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 Shape module.

Configures the initial positions and directions of particles.

See Also: ParticleSystem, ParticleSystem.shape.

Properties

alignToDirectionAlign particles based on their initial direction of travel.
angleAngle of the cone to emit particles from.
arcAngle of the circle arc to emit particles from.
arcModeThe mode used for generating particles around the arc.
arcSpeedIn animated modes, this determines how quickly the particle emission position moves around the arc.
arcSpeedMultiplierA multiplier of the arc speed of the particle emission shape.
arcSpreadControl the gap between particle emission points around the arc.
boxThicknessThickness of the box to emit particles from.
donutRadiusThe radius of the Donut shape to emit particles from.
enabledEnable/disable the Shape module.
lengthLength of the cone to emit particles from.
meshMesh to emit particles from.
meshMaterialIndexEmit particles from a single material of a mesh.
meshRendererMeshRenderer to emit particles from.
meshShapeTypeWhere on the mesh to emit particles from.
meshSpawnModeThe mode used for generating particles on a mesh.
meshSpawnSpeedIn animated modes, this determines how quickly the particle emission position moves across the mesh.
meshSpawnSpeedMultiplierA multiplier of the mesh spawn speed.
meshSpawnSpreadControl the gap between particle emission points across the mesh.
normalOffsetMove particles away from the surface of the source mesh.
positionApply an offset to the position from which particles are emitted.
radiusRadius of the shape to emit particles from.
radiusModeThe mode used for generating particles along the radius.
radiusSpeedIn animated modes, this determines how quickly the particle emission position moves along the radius.
radiusSpeedMultiplierA multiplier of the radius speed of the particle emission shape.
radiusSpreadControl the gap between particle emission points along the radius.
radiusThicknessRadius thickness of the shape's edge from which to emit particles.
randomDirectionAmountRandomizes the starting direction of particles.
randomPositionAmountRandomizes the starting position of particles.
rotationApply a rotation to the shape from which particles are emitted.
scaleApply scale to the shape from which particles are emitted.
shapeTypeType of shape to emit particles from.
skinnedMeshRendererSkinnedMeshRenderer to emit particles from.
sphericalDirectionAmountMakes particles move in a spherical direction from their starting point.
spriteSprite to emit particles from.
spriteRendererSpriteRenderer to emit particles from.
textureSelects a texture to be used for tinting particle start colors.
textureAlphaAffectsParticlesWhen enabled, the alpha channel of the texture is applied to the particle alpha when spawned.
textureBilinearFilteringWhen enabled, 4 neighboring samples are taken from the texture, and combined to give the final particle value.
textureClipChannelSelects which channel of the texture is used for discarding particles.
textureClipThresholdDiscards particles when they are spawned on an area of the texture with a value lower than this threshold.
textureColorAffectsParticlesWhen enabled, the RGB channels of the texture are applied to the particle color when spawned.
textureUVChannelWhen using a Mesh as a source shape type, this option controls which UV channel on the Mesh is used for reading the source texture.
useMeshColorsModulate the particle colors with the vertex colors, or the material color if no vertex colors exist.
useMeshMaterialIndexEmit particles from a single material, or the whole mesh.