Version: 5.5 (switch to 5.6b)
LanguageEnglish
  • C#
  • JS

Script language

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

ShapeModule

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

Variables

alignToDirectionAlign particles based on their initial direction of travel.
angleAngle of the cone.
arcCircle arc angle.
boxScale of the box.
enabledEnable/disable the Shape module.
lengthLength of the cone.
meshMesh to emit particles from.
meshMaterialIndexEmit particles from a single material of a mesh.
meshRendererMeshRenderer to emit particles from.
meshScaleApply a scaling factor to the mesh used for generating source positions.
meshShapeTypeWhere on the mesh to emit particles from.
normalOffsetMove particles away from the surface of the source mesh.
radiusRadius of the shape.
randomDirectionAmountRandomizes the starting direction of particles.
shapeTypeType of shape to emit particles from.
skinnedMeshRendererSkinnedMeshRenderer to emit particles from.
sphericalDirectionAmountSpherizes the starting direction of particles.
useMeshColorsModulate the particle colors with the vertex colors, or the material color if no vertex colors exist.
useMeshMaterialIndexEmit from a single material, or the whole mesh.