Version: 2017.1 (switch to 2017.2b)
LanguageEnglish
  • C#
  • JS

Script language

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

MonoBehaviour.OnBecameInvisible()

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

Description

OnBecameInvisible is called when the renderer is no longer visible by any camera.

This message is sent to all scripts attached to the renderer. OnBecameVisible and OnBecameInvisible is useful to avoid computations that are only necessary when the object is visible.

// Disables the behaviour when it is invisible

function OnBecameInvisible () { enabled = false; }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { void OnBecameInvisible() { enabled = false; } }

OnBecameInvisible can be a co-routine, simply use the yield statement in the function. When running in the editor, scene view cameras will also cause this function to be called.