Platformer Pro  2.3.2
A platform game kit for Unity.
PlatformerPro.AutoEvent Class Reference

Attach this to an object to raise an event from standard Unity hooks (awake, start, enable, etc). More...

Inheritance diagram for PlatformerPro.AutoEvent:

Public Member Functions

void RaiseEvent ()
 Raises the event. More...
 

Public Attributes

bool raiseOnStart
 Rasie event on Start. More...
 
bool raiseOnEnable
 Raise event on enable. More...
 
bool raiseOnDestroy
 Raise event on destroy. More...
 

Protected Member Functions

void OnGenericEvent ()
 Raises the generic event event. More...
 
IEnumerator CheckEnableAfterYield ()
 Delay enabled check by one frame to avoid issues with unintialised variables on activation. More...
 

Events

System.EventHandler< EmptyEventArgsGenericEvent
 Generic event raised by this object. More...
 

Detailed Description

Attach this to an object to raise an event from standard Unity hooks (awake, start, enable, etc).

Member Function Documentation

◆ CheckEnableAfterYield()

IEnumerator PlatformerPro.AutoEvent.CheckEnableAfterYield ( )
protected

Delay enabled check by one frame to avoid issues with unintialised variables on activation.

Returns
The enable after yield.

◆ OnGenericEvent()

void PlatformerPro.AutoEvent.OnGenericEvent ( )
protected

Raises the generic event event.

◆ RaiseEvent()

void PlatformerPro.AutoEvent.RaiseEvent ( )

Raises the event.

Member Data Documentation

◆ raiseOnDestroy

bool PlatformerPro.AutoEvent.raiseOnDestroy

Raise event on destroy.

◆ raiseOnEnable

bool PlatformerPro.AutoEvent.raiseOnEnable

Raise event on enable.

◆ raiseOnStart

bool PlatformerPro.AutoEvent.raiseOnStart

Rasie event on Start.

Event Documentation

◆ GenericEvent

System.EventHandler<EmptyEventArgs> PlatformerPro.AutoEvent.GenericEvent

Generic event raised by this object.


The documentation for this class was generated from the following file: