Runner's High
Public Member Functions | Public Attributes | List of all members
CustomEvent Class Reference

Represents an event. More...

Public Member Functions

 CustomEvent (CustomEventType t, UnityEngine.Object c, Dictionary< string, dynamic > d)
 Create an Event. More...
 
 CustomEvent (CustomEventType t, Dictionary< string, dynamic > d)
 Create an Event. More...
 
void stopPropagation ()
 Manually stop propagation of an event. More...
 
bool shouldPropagate ()
 The propagation setting of the event. If set to false, an event is consumed by one listener and then deleted. If set to true, an event is dispatched to all listeners. More...
 

Public Attributes

CustomEventType type
 The type of the event. More...
 
UnityEngine.Object caller
 The object that dispatched the event. More...
 
Dictionary< string, dynamic > data
 [Optional] Provide additional data for the listener. More...
 

Detailed Description

Represents an event.

Constructor & Destructor Documentation

◆ CustomEvent() [1/2]

CustomEvent.CustomEvent ( CustomEventType  t,
UnityEngine.Object  c,
Dictionary< string, dynamic >  d 
)

Create an Event.

Parameters
tThe type of the event.
cThe object that dispatches the event.
d[Optional] Additional data for the listeners.

◆ CustomEvent() [2/2]

CustomEvent.CustomEvent ( CustomEventType  t,
Dictionary< string, dynamic >  d 
)

Create an Event.

Parameters
tThe type of the event.
d[Optional] Additional data for the listeners.

Member Function Documentation

◆ shouldPropagate()

bool CustomEvent.shouldPropagate ( )

The propagation setting of the event. If set to false, an event is consumed by one listener and then deleted. If set to true, an event is dispatched to all listeners.

Returns
True or False.

◆ stopPropagation()

void CustomEvent.stopPropagation ( )

Manually stop propagation of an event.

Member Data Documentation

◆ caller

UnityEngine.Object CustomEvent.caller

The object that dispatched the event.

◆ data

Dictionary<string, dynamic> CustomEvent.data

[Optional] Provide additional data for the listener.

◆ type

CustomEventType CustomEvent.type

The type of the event.


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