ff14bot.NeoProfile.BotEvents Class Reference

Provides events for common situations in the bot. More...

Classes
class	BotChangedEventArgs
	Additional information for bottom changed events. More...
class	BotStartStopRequestEventArgs
	Represents event args for the OnBotStartRequested and OnBotStopRequested events. More...
class	BotStoppedEventArgs
class	NeoProfile
	A profile. More...

Public Member Functions
delegate void	OnBotStartStopRequestedDelegate (BotStartStopRequestEventArgs args)
delegate void	OnBotStartDelegate (EventArgs args)
	The bot start delegate event.
delegate void	OnBotStopDelegate (EventArgs args)
	The bot stop delegate event.
delegate void	OnBotChangedDelegate (BotChangedEventArgs args)
	Raises the bottom changed event.

Static Public Member Functions
static void	PulseEvents ()
	Pulse events.

Events
static OnBotStartStopRequestedDelegate	OnBotStartRequested
	Fired right before the bot is started.
static EventHandler< EventArgs >	PreBotStarting
	Fired right before the bot begins starting.
static OnBotStartDelegate	OnBotStarted
	Fired right after the bot has started.
static OnBotStartStopRequestedDelegate	OnBotStopRequested
	Fired when a bot stop is requested.
static OnBotStopDelegate	OnBotStopped
	Fired right after the bot has been stopped.
static OnBotChangedDelegate	OnBotChanged
	Fired when the current bot is changed with the usage of TreeRoot.SetCurrent.
static EventHandler< EventArgs >	OnPulse
	Fired on every bot pulse if bot events are enabled.

Detailed Description

Provides events for common situations in the bot.

Member Function Documentation

OnBotChangedDelegate()

delegate void ff14bot.NeoProfile.BotEvents.OnBotChangedDelegate

(

BotChangedEventArgs

args

)

Raises the bottom changed event.

Parameters

args	Event information to send to registered event handlers.

OnBotStartDelegate()

delegate void ff14bot.NeoProfile.BotEvents.OnBotStartDelegate

(

EventArgs

args

)

The bot start delegate event.

Parameters

args	Event information to send to registered event handlers.

OnBotStartStopRequestedDelegate()

delegate void ff14bot.NeoProfile.BotEvents.OnBotStartStopRequestedDelegate

(

BotStartStopRequestEventArgs

args

)

OnBotStopDelegate()

delegate void ff14bot.NeoProfile.BotEvents.OnBotStopDelegate

(

EventArgs

args

)

The bot stop delegate event.

Parameters

args	Event information to send to registered event handlers.

PulseEvents()

void ff14bot.NeoProfile.BotEvents.PulseEvents ( )

static

Pulse events.

Event Documentation

OnBotChanged

OnBotChangedDelegate ff14bot.NeoProfile.BotEvents.OnBotChanged

static

Fired when the current bot is changed with the usage of TreeRoot.SetCurrent.

OnBotStarted

OnBotStartDelegate ff14bot.NeoProfile.BotEvents.OnBotStarted

static

Fired right after the bot has started.

This is fired from the bot thread, before any logic starts executing.

OnBotStartRequested

OnBotStartStopRequestedDelegate ff14bot.NeoProfile.BotEvents.OnBotStartRequested

static

Fired right before the bot is started.

Only use this event to signal that a 'Start' should be canceled. In general, use the OnBotStarted event.

This is fired from the thread that invoked the TreeRoot.Start call.

To cancel the start, set the BotStartStopRequestEventArgs.Cancel property to true.

No initialization should be done from subscribers to this event, as it is impossible to know if the bot will be started, because another subscriber might cancel the start.

For initialization, see OnBotStarted.

OnBotStopped

OnBotStopDelegate ff14bot.NeoProfile.BotEvents.OnBotStopped

static

Fired right after the bot has been stopped.

This is fired from the bot thread, before the thread exits.

OnBotStopRequested

OnBotStartStopRequestedDelegate ff14bot.NeoProfile.BotEvents.OnBotStopRequested

static

Fired when a bot stop is requested.

Only use this event to signal that a 'Stop' should be canceled. In general use the OnBotStopped event.

This is fired from the thread that invoked the TreeRoot.Stop call.

To cancel the stop, a subscriber can set BotStartStopRequestEventArgs.Cancel to false.

No cleanup should be done in this event, as it is impossible to know whether the stop will go through, because a following subscriber might cancel the stop.

OnPulse

EventHandler<EventArgs> ff14bot.NeoProfile.BotEvents.OnPulse

static

Fired on every bot pulse if bot events are enabled.

PreBotStarting

EventHandler<EventArgs> ff14bot.NeoProfile.BotEvents.PreBotStarting

static

Fired right before the bot begins starting.

This is fired from the thread that invoked the TreeRoot.Start call.

The current bot can be changed from this event and it will take effect on this start up.