A class that stores information about an engine event. More...

#include <omEngineEvent.h>

Public Member Functions
	Event (const ValueType &newValue, const OpaqueResource &newTarget=OpaqueResource(), const OpaqueResource &newSender=OpaqueResource(), const EngineSystem newSystemSender=((void ) 0), const Time &newTime=Time::getCurrent())
	Create an event with the specified value and parameters. More...

ValueType &	getValue ()
	Return a reference to this event's value. More...

const ValueType &	getValue () const
	Return a const reference to this event's value. More...

const OpaqueResource &	getTarget () const
	Return an opaque reference to the resource which should recieve this event. More...

const OpaqueResource &	getSender () const
	Return an opaque reference to the resource which sent this event. More...

const EngineSystem *	getSystem () const
	Return a pointer to the entity system that produced this event, or NULL if there is no system sender. More...

const Time &	getTime () const
	Return an object that represents the time when this event occurred, relative to an arbitrary base time. More...

Detailed Description

A class that stores information about an engine event.

Constructor & Destructor Documentation

template<typename ValueType >

om::engine::base::Event< ValueType >::Event	(	const ValueType &	newValue,
		const OpaqueResource &	newTarget = `OpaqueResource()`,
		const OpaqueResource &	newSender = `OpaqueResource()`,
		const EngineSystem *	newSystemSender = `((void *)0)`,
		const Time &	newTime = `Time::getCurrent()`
	)

inline

Create an event with the specified value and parameters.

template<typename ValueType >

ValueType& om::engine::base::Event< ValueType >::getValue ( )

inline

Return a reference to this event's value.

template<typename ValueType >

const ValueType& om::engine::base::Event< ValueType >::getValue ( ) const

inline

Return a const reference to this event's value.

template<typename ValueType >

const OpaqueResource& om::engine::base::Event< ValueType >::getTarget ( ) const

inline

Return an opaque reference to the resource which should recieve this event.

template<typename ValueType >

const OpaqueResource& om::engine::base::Event< ValueType >::getSender ( ) const

inline

Return an opaque reference to the resource which sent this event.

template<typename ValueType >

const EngineSystem* om::engine::base::Event< ValueType >::getSystem ( ) const

inline

Return a pointer to the entity system that produced this event, or NULL if there is no system sender.

template<typename ValueType >

const Time& om::engine::base::Event< ValueType >::getTime ( ) const

inline

Return an object that represents the time when this event occurred, relative to an arbitrary base time.

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