EventData< T, U > Class Template Reference

A type used to generate GameEvents More...

Public Member Functions
	EventData (string eventName)
	The constructor used to create a new EventData More...
void	Add (EventData< T, U >.OnEvent evt)
	Add a method to be run when the EventData is fired. More...
void	Fire (T data0, U data1)
	Triggers the EventData More...
void	Remove (EventData< T, U >.OnEvent evt)
	Remove a method from the list of methods to be run when the EventData is fired. More...
delegate void	OnEvent (T data0, U data1)
	Any methods added to the event must match the delegate's parameters; two parameters of the given types in this case. More...

Static Public Member Functions
static bool	AddEventScene (string eventName, EventData< T, U >.OnEvent evt, bool addToAll)
static bool	AddEventUpwards (Transform transform, string eventName, EventData< T, U >.OnEvent evt, bool addToAll)
static EventData< T, U >	FindEventScene (string eventName)
static List< EventData< T, U > >	FindEventsScene (string eventName)
static List< EventData< T, U > >	FindEventsUpwards (Transform transform, string eventName)
static EventData< T, U >	FindEventUpwards (Transform transform, string eventName)
static bool	RemoveEventScene (string eventName, EventData< T, U >.OnEvent evt, bool removeFromAll)
static bool	RemoveEventUpwards (Transform transform, string eventName, EventData< T, U >.OnEvent evt, bool removeFromAll)

Public Attributes
bool	debugEvent
	Generate debug logs if true More...

Detailed Description

A type used to generate GameEvents

Use this type with two accompanying parameters

Template Parameters

T	The first type to be passed through on EventData.Fire()
U	The second type to be passed through on EventData.Fire()

Constructor & Destructor Documentation

EventData< T, U >.EventData

(

string

eventName

)

The constructor used to create a new EventData

EventData<Vessel, CelestialBody> myNewEvent = new EventData<Vessel, CelestialBody>("myNewEvent");

Parameters

eventName

Give the event a string name, generally the same as the declared name

Member Function Documentation

void EventData< T, U >.Add

(

EventData< T, U >.OnEvent

evt

)

Add a method to be run when the EventData is fired.

This is generally done in an object's Start or Awake method, or a class' constructor.

Can be setup like:

GameEvents.someEventDataEvent.Add(yourMethod);

or

GameEvents.someEventDataEvent.Add(new EventVoid.OnEvent(yourMethod));

Parameters

evt	The method you want to add; must contain two parameters of types matching those in the host EventData

static bool EventData< T, U >.AddEventScene ( string  eventName, EventData< T, U >.OnEvent  evt, bool  addToAll  )

static

static bool EventData< T, U >.AddEventUpwards ( Transform  transform, string  eventName, EventData< T, U >.OnEvent  evt, bool  addToAll  )

static

static EventData<T, U> EventData< T, U >.FindEventScene ( string  eventName )

static

static List<EventData<T, U> > EventData< T, U >.FindEventsScene ( string  eventName )

static

static List<EventData<T, U> > EventData< T, U >.FindEventsUpwards ( Transform  transform, string  eventName  )

static

static EventData<T, U> EventData< T, U >.FindEventUpwards ( Transform  transform, string  eventName  )

static

void EventData< T, U >.Fire	(	T	data0,
		U	data1
	)

Triggers the EventData

All of the methods added using Add are run after this.

Parameters

data0	A parameter matching the first type of the host EventData Use this to give information relevant to the event
data1	The second type of the host EventData

delegate void EventData< T, U >.OnEvent	(	T	data0,
		U	data1
	)

Any methods added to the event must match the delegate's parameters; two parameters of the given types in this case.

Parameters

data0
data1

void EventData< T, U >.Remove

(

EventData< T, U >.OnEvent

evt

)

Remove a method from the list of methods to be run when the EventData is fired.

This is generally done in an object's OnDestroy method.

Parameters

evt	The method you want to remove; must contain two parameters of types matching those in the host EventData

static bool EventData< T, U >.RemoveEventScene ( string  eventName, EventData< T, U >.OnEvent  evt, bool  removeFromAll  )

static

static bool EventData< T, U >.RemoveEventUpwards ( Transform  transform, string  eventName, EventData< T, U >.OnEvent  evt, bool  removeFromAll  )

static

Member Data Documentation

bool EventData< T, U >.debugEvent

Generate debug logs if true

---

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

• src/EventDataTU.cs