Version: 2017.3 (switch to 2017.4)
LanguageEnglish
  • C#
  • JS

Script language

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

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 var maskInteraction: SpriteMaskInteraction;
public SpriteMaskInteraction maskInteraction;

Description

Specifies how the Particle System Renderer interacts with SpriteMask.

Particles by default do not interact with SpriteMasks and will be visible irrespective of any SpriteMask being present or not. Particle System Renderer can also be setup to be visible inside a mask by setting this value to VisibleInsideMask. The inverse can be achieved by seting the maskInteraction to VisibleOutsideMask. See Also: SpriteMaskInteraction.

no example available in JavaScript
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); } }

Did you find this page useful? Please give it a rating: