Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

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

ParticleSystem.ShapeModule.alignToDirection

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
public var alignToDirection: bool;
public bool alignToDirection;

Description

Align particles based on their initial direction of travel.

The Shape Module supports setting the initial rotation of particles based on their direction of travel. This can be useful to make particles appear to have originated from the surface of a Mesh (for example, paint flaking off a surface). This works with any shape type. Any ParticleSystem.startRotation set gets applied on top of this setting, so you can use both together.

You can use this setting in conjunction with the ParticleSystem.MainModule.startRotation setting; the rotation given by ParticleSystem.MainModule.startRotation is added on top of that calculated by ParticleSystem.ShapeModule.alignToDirection.

For example: add a ParticleSystem.MainModule.startRotation of 90 degrees when using ParticleSystem.ShapeModule.alignToDirection, and all the particles become perpendicular to the surface, like little spikes sticking out of it.

#pragma strict
private var ps: ParticleSystem;
public var toggle: boolean = true;
function Start() {
	ps = GetComponent.<ParticleSystem>();
}
function Update() {
	var shape: var = ps.shape;
	shape.alignToDirection = toggle;
}
function OnGUI() {
	toggle = GUI.Toggle(new Rect(25, 45, 200, 30), toggle, "Align To Direction");
}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { private ParticleSystem ps; public bool toggle = true;

void Start() { ps = GetComponent<ParticleSystem>(); }

void Update() { var shape = ps.shape; shape.alignToDirection = toggle; }

void OnGUI() { toggle = GUI.Toggle(new Rect(25, 45, 200, 30), toggle, "Align To Direction"); } }