Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


maskInteraction

Specifies how the TrailRenderer interacts with SpriteMask.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Property
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule
public SpriteMaskInteraction maskInteraction { get; set; }

Remarks

By default, trails do not interact with SpriteMasks and are visible regardless of whether you assign a SpriteMask or not. You can make the TrailRenderer visible either inside or outside a SpriteMask. To do the former, set this to SpriteMaskInteraction.VisibleInsideMask. To do the latter, set this to SpriteMaskInteraction.VisibleOutsideMask. Additional Resources: SpriteMaskInteraction.

Examples

using UnityEngine;using System.Collections;[RequireComponent(typeof(TrailRenderer))]public class ExampleClass : MonoBehaviour{ private TrailRenderer r; public SpriteMaskInteraction maskInteraction; void Start() { r = GetComponent<TrailRenderer>(); } void Update() { r.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); }}