ff14bot.BotBases.OrderBot Class Reference

OrderBot handles the advanced profile system. More...

Inheritance diagram for ff14bot.BotBases.OrderBot:

Public Member Functions
void	Dispose ()
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
override void	Initialize ()
	Called one time when users starts the botbase.
override void	Start ()
	Starts this bot. Do any initialization here.
override void	Stop ()
	Stops this bot. Do any pre-dispose cleanup here.
override string	ToString ()
	inheritdoc/>
override void	OnButtonPress ()
	Called when the user presses the bot settings button.
Public Member Functions inherited from ff14bot.AClasses.BotBase
void	DoInitialize ()
	Executes Initialize and sets Initialized.
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.
override string	ToString ()
	Returns the botbases name.
void	Dispose ()

Static Public Attributes
static readonly Queue< int >	StringSelectIndex = new Queue<int>()
	When there are select string windows during cutscenes, the item to be clicked will be popped off the queue and used.
static bool	BlockSkippingCutscenes
	When set to true the users prefrence to skip cutscenes will be ignored and they will not be skipped.

Properties
override bool	IsAutonomous [get]
	inheritdoc/>
override bool	RequiresProfile [get]
	inheritdoc/>
override string	EnglishName [get]
override string	Name [get]
	Gets the name of this bot.
string	Description [get]
	Gets the description.
override bool	IsPrimaryType [get]
	Gets a value indicating whether this bot is a primary bot. (Should be executed "at all times" excluding when a secondary bot has need to run. See: mixed-mode).
override Composite	Root [get]
	inheritdoc/>
override PulseFlags	PulseFlags [get]
	inheritdoc/>
override bool	WantButton [get]
Properties inherited from ff14bot.AClasses.BotBase
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.

Additional Inherited Members
Public Attributes inherited from ff14bot.AClasses.BotBase
bool	Initialized
	Has Initalize been called?

Detailed Description

OrderBot handles the advanced profile system.

Member Function Documentation

Dispose()

void ff14bot.BotBases.OrderBot.Dispose

(

)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

<filterpriority>2</filterpriority> inheritdoc/>

Initialize()

override void ff14bot.BotBases.OrderBot.Initialize ( )

virtual

Called one time when users starts the botbase.

Reimplemented from ff14bot.AClasses.BotBase.

OnButtonPress()

override void ff14bot.BotBases.OrderBot.OnButtonPress ( )

virtual

Called when the user presses the bot settings button.

Reimplemented from ff14bot.AClasses.BotBase.

Start()

override void ff14bot.BotBases.OrderBot.Start ( )

virtual

Starts this bot. Do any initialization here.

Reimplemented from ff14bot.AClasses.BotBase.

Stop()

override void ff14bot.BotBases.OrderBot.Stop ( )

virtual

Stops this bot. Do any pre-dispose cleanup here.

inheritdoc/>

Reimplemented from ff14bot.AClasses.BotBase.

ToString()

override string ff14bot.BotBases.OrderBot.ToString

(

)

inheritdoc/>

Member Data Documentation

BlockSkippingCutscenes

bool ff14bot.BotBases.OrderBot.BlockSkippingCutscenes

static

When set to true the users prefrence to skip cutscenes will be ignored and they will not be skipped.

StringSelectIndex

readonly Queue<int> ff14bot.BotBases.OrderBot.StringSelectIndex = new Queue<int>()

static

When there are select string windows during cutscenes, the item to be clicked will be popped off the queue and used.

Property Documentation

Description

string ff14bot.BotBases.OrderBot.Description

get

Gets the description.

The description.

EnglishName

override string ff14bot.BotBases.OrderBot.EnglishName

get

IsAutonomous

override bool ff14bot.BotBases.OrderBot.IsAutonomous

get

inheritdoc/>

IsPrimaryType

override bool ff14bot.BotBases.OrderBot.IsPrimaryType

get

Gets a value indicating whether this bot is a primary bot. (Should be executed "at all times" excluding when a secondary bot has need to run. See: mixed-mode).

Name

override string ff14bot.BotBases.OrderBot.Name

get

Gets the name of this bot.

PulseFlags

override PulseFlags ff14bot.BotBases.OrderBot.PulseFlags

get

inheritdoc/>

RequiresProfile

override bool ff14bot.BotBases.OrderBot.RequiresProfile

get

inheritdoc/>

Root

override Composite ff14bot.BotBases.OrderBot.Root

get

inheritdoc/>

WantButton

override bool ff14bot.BotBases.OrderBot.WantButton

get