Dawn of Light - Class documentation 2900
This is the Dawn of Light project
DOL.Events.DOLEvent Class Reference

This class defines an abstract event in DOL It needs to be overridden in order to create custom events. More...

Inheritance diagram for DOL.Events.DOLEvent:
DOL.Events.AreaEvent DOL.Events.DatabaseEvent DOL.Events.GameClientEvent DOL.Events.GameObjectEvent DOL.Events.GameServerEvent DOL.Events.GroupEvent DOL.Events.KeepEvent DOL.Events.PlayerInventoryEvent DOL.Events.RegionEvent DOL.Events.RelicPadEvent DOL.Events.ScriptEvent

List of all members.

Public Member Functions

 DOLEvent (string name)
 Constructs a new event.
override string ToString ()
 Returns the string representation of this event.
virtual bool IsValidFor (object o)
 Returns true if the event target is valid for this event.

Protected Attributes

string m_EventName
 The event name.

Properties

string Name [get]
 Gets the name of this event.

Detailed Description

This class defines an abstract event in DOL It needs to be overridden in order to create custom events.


Constructor & Destructor Documentation

DOL.Events.DOLEvent.DOLEvent ( string  name)

Constructs a new event.

Parameters:
nameThe name of the event

Member Function Documentation

virtual bool DOL.Events.DOLEvent.IsValidFor ( object  o) [virtual]

Returns true if the event target is valid for this event.

Parameters:
oThe object that is hooked
Returns:

Reimplemented in DOL.Events.GameLivingEvent, DOL.Events.GameNPCEvent, DOL.Events.GameObjectEvent, DOL.Events.GamePlayerEvent, DOL.Events.GameTrainerEvent, DOL.Events.KeepEvent, DOL.Events.RelicPadEvent, DOL.Events.AreaEvent, and DOL.Events.RegionEvent.

override string DOL.Events.DOLEvent.ToString ( )

Returns the string representation of this event.

Returns:

Member Data Documentation

string DOL.Events.DOLEvent.m_EventName [protected]

The event name.


Property Documentation

string DOL.Events.DOLEvent.Name [get]

Gets the name of this event.


The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables Enumerations Properties Events