ff14bot.AClasses.BotBase Class Reference

Base class all non async botbases should inherit frome. More...

Inheritance diagram for ff14bot.AClasses.BotBase:

Public Member Functions
void	DoInitialize ()
	Executes Initialize and sets Initialized.
virtual void	Initialize ()
	Called one time when users starts the botbase.
virtual void	OnShutdown ()
	Executes the shutdown action. This is called when the bot is shutting down and when botbases are being reloaded.
virtual void	Pulse ()
	Called every tick.
virtual void	Start ()
	Called when the bot is started.
virtual void	Stop ()
	Called when the bot is stopped.
override string	ToString ()
	Returns the botbases name.
void	Dispose ()
virtual void	OnButtonPress ()
	Called when the user presses the bot settings button.

Public Attributes
bool	Initialized
	Has Initalize been called?

Properties
virtual bool	IsAutonomous [get]
	Return false if human presence is needed.
virtual Version	Version [get]
	Version.
virtual bool	WantButton [get]
	Overrides if the bot settings button should be enabled.
virtual bool	IsPrimaryType [get]
	Unused.
string	Name [get]
	Botbase name.
virtual string	EnglishName [get]
	Name of the bot in english for logging purposes.
PulseFlags	PulseFlags [get]
	What flags should the pulsator execute.
virtual bool	RequiresProfile [get]
	Should the load profile button be enabled.
Composite	Root [get]
	Base logic that needs to be implemented.

Detailed Description

Base class all non async botbases should inherit frome.

Member Function Documentation

Dispose()

void ff14bot.AClasses.BotBase.Dispose

(

)

DoInitialize()

void ff14bot.AClasses.BotBase.DoInitialize

(

)

Executes Initialize and sets Initialized.

Initialize()

virtual void ff14bot.AClasses.BotBase.Initialize ( )

virtual

Called one time when users starts the botbase.

Reimplemented in ff14bot.BotBases.FateBot, and ff14bot.BotBases.OrderBot.

OnButtonPress()

virtual void ff14bot.AClasses.BotBase.OnButtonPress ( )

virtual

Called when the user presses the bot settings button.

Reimplemented in ff14bot.BotBases.FateBot, ff14bot.BotBases.Fishbot, and ff14bot.BotBases.OrderBot.

OnShutdown()

virtual void ff14bot.AClasses.BotBase.OnShutdown ( )

virtual

Executes the shutdown action. This is called when the bot is shutting down and when botbases are being reloaded.

Pulse()

virtual void ff14bot.AClasses.BotBase.Pulse ( )

virtual

Called every tick.

Start()

virtual void ff14bot.AClasses.BotBase.Start ( )

virtual

Called when the bot is started.

Reimplemented in ff14bot.BotBases.FateBot, ff14bot.BotBases.Fishbot, ff14bot.BotBases.MiniCactPotBot, and ff14bot.BotBases.OrderBot.

Stop()

virtual void ff14bot.AClasses.BotBase.Stop ( )

virtual

Called when the bot is stopped.

Reimplemented in ff14bot.BotBases.FateBot, ff14bot.BotBases.MiniCactPotBot, and ff14bot.BotBases.OrderBot.

ToString()

override string ff14bot.AClasses.BotBase.ToString

(

)

Returns the botbases name.

Returns

Member Data Documentation

Initialized

bool ff14bot.AClasses.BotBase.Initialized

Has Initalize been called?

Property Documentation

EnglishName

virtual string ff14bot.AClasses.BotBase.EnglishName

get

Name of the bot in english for logging purposes.

IsAutonomous

virtual bool ff14bot.AClasses.BotBase.IsAutonomous

get

Return false if human presence is needed.

IsPrimaryType

virtual bool ff14bot.AClasses.BotBase.IsPrimaryType

get

Unused.

Name

string ff14bot.AClasses.BotBase.Name

getabstract

Botbase name.

PulseFlags

PulseFlags ff14bot.AClasses.BotBase.PulseFlags

getabstract

What flags should the pulsator execute.

RequiresProfile

virtual bool ff14bot.AClasses.BotBase.RequiresProfile

get

Should the load profile button be enabled.

Root

Composite ff14bot.AClasses.BotBase.Root

getabstract

Base logic that needs to be implemented.

Version

virtual Version ff14bot.AClasses.BotBase.Version

get

Version.

WantButton

virtual bool ff14bot.AClasses.BotBase.WantButton

get

Overrides if the bot settings button should be enabled.