Version: 2019.4
LanguageEnglish
  • C#

How do you use documentation throughout your workflow? Share your experience with us by taking this survey.

ParticleSystemRenderer.maskInteraction

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

public SpriteMaskInteraction maskInteraction;

Description

Specifies how the Particle System Renderer interacts with SpriteMask.

By default, particles do not interact with SpriteMasks and are visible regardless of any SpriteMask being present or not. You can also set up the Particle System Renderer to be visible inside a mask. To do this, set this to VisibleInsideMask. To achieve the invers, set this to VisibleOutsideMask. See Also: SpriteMaskInteraction.

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { private ParticleSystemRenderer psr; public SpriteMaskInteraction maskInteraction;

void Start() { psr = GetComponent<ParticleSystemRenderer>(); }

void Update() { psr.maskInteraction = maskInteraction; }

void OnGUI() { maskInteraction = (SpriteMaskInteraction)GUI.SelectionGrid(new Rect(25, 25, 900, 30), (int)maskInteraction, new GUIContent[] { new GUIContent("No Masking"), new GUIContent("Visible Inside Mask"), new GUIContent("Visible Outside Mask") }, 3); } }