Version: 2022.3
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 ShapeModule.

Configures the initial positions and directions of particles.

Additional resources: 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 that Unity uses to generate 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 thickness of the Donut shape to emit particles from.
enabledSpecifies whether the ShapeModule is enabled or disabled.
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 to use to generate 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 the system emits particles.
radiusRadius of the shape to emit particles from.
radiusModeThe mode to use to generate 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 the system emits particles.
scaleApply scale to the shape from which the system emits particles.
shapeTypeThe type 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.
textureSpecifies a Texture to tint the particle's start colors.
textureAlphaAffectsParticlesWhen enabled, the system applies the alpha channel of the Texture to the particle alpha when the particle spawns.
textureBilinearFilteringWhen enabled, the system takes four neighboring samples from the Texture then combines them to give the final particle value.
textureClipChannelSelects which channel of the Texture to use for discarding particles.
textureClipThresholdDiscards particles when they spawn on an area of the Texture with a value lower than this threshold.
textureColorAffectsParticlesWhen enabled, the system applies the RGB channels of the Texture to the particle color when the particle spawns.
textureUVChannelWhen using a Mesh as a source shape type, this option controls which UV channel on the Mesh to use 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.