Public Types | Public Member Functions | Properties | List of all members
PixelCrushers.DisappearEvent Class Reference

Invokes an event when the component is disabled or destroyed. More...

Inheritance diagram for PixelCrushers.DisappearEvent:
Inheritance graph
[legend]
Collaboration diagram for PixelCrushers.DisappearEvent:
Collaboration graph
[legend]

Public Types

enum  EventTrigger { OnDisable , OnDestroy }
 

Public Member Functions

void RunEvent ()
 
void OnWillUnload (int sceneIndex)
 

Properties

EventTrigger eventTrigger [get, set]
 Run the event when this happens.
 
UnityEvent onDisappeared [get, set]
 

Detailed Description

Invokes an event when the component is disabled or destroyed.

If you don't want to invoke the event when the component is disabled and destroyed by a scene change, call SceneNotifier.NotifyWillUnloadScene().

Member Enumeration Documentation

◆ EventTrigger

enum PixelCrushers.DisappearEvent.EventTrigger
Enumerator
OnDisable 
OnDestroy 

Member Function Documentation

◆ OnWillUnload()

void PixelCrushers.DisappearEvent.OnWillUnload ( int  sceneIndex)
inline

◆ RunEvent()

void PixelCrushers.DisappearEvent.RunEvent ( )
inline

Property Documentation

◆ eventTrigger

EventTrigger PixelCrushers.DisappearEvent.eventTrigger
getset

Run the event when this happens.

◆ onDisappeared

UnityEvent PixelCrushers.DisappearEvent.onDisappeared
getset
The documentation for this class was generated from the following file: