ff14bot.TreeRoot Class Reference

Represents the root controller for bot execution and management within the application. Provides functionality to manage bot lifecycle, including starting, stopping, and monitoring the bot's state and performance. More...

Static Public Member Functions
static void	Start ()
	Starts the main bot execution thread, initializing settings, events, and creating the necessary environment for the bot's operation.
static async Task	StopGently (string reason="")
	Stops the bot operation gradually, ensuring a clean shutdown process and waiting for all processing to complete.
static void	Stop ([CallerMemberName] string reason="")
	Sets the mainbot thread to stop executing.

Static Public Attributes
static byte	TicksPerSecond
	Specifies the number of ticks per second for the bot's execution loop. This value determines how frequently the bot processes logic and limits the frame rate accordingly.
static string	StatusText = ""
	This gets displayed on bottom of the main bot window.

Properties
static bool	IsRunning [get]
	Indicates whether the bot execution thread is currently active and running. Returns true if the bot thread is initialized and alive, otherwise false.
static BotBase	Current [get]
	Gets the currently active bot instance being used by the application. Provides access to the bot's root behaviors, pulse flags, and other associated properties.
static int	AchievedTickRate [get, set]
	Represents the actual achieved tick rate of the bot execution, measured in ticks per second. Indicates how many processing cycles were completed within one second.

Events
static BotEvent	OnStart
	Event queue for all listeners interested in OnStart events.
static BotEvent	OnStop
	Event queue for all listeners interested in OnStop events.

Detailed Description

Represents the root controller for bot execution and management within the application. Provides functionality to manage bot lifecycle, including starting, stopping, and monitoring the bot's state and performance.

Member Function Documentation

Start()

void ff14bot.TreeRoot.Start ( )

static

Starts the main bot execution thread, initializing settings, events, and creating the necessary environment for the bot's operation.

Stop()

void ff14bot.TreeRoot.Stop ( [CallerMemberName] string reason = "" )

static

Sets the mainbot thread to stop executing.

Parameters

reason

StopGently()

async Task ff14bot.TreeRoot.StopGently ( string reason = "" )

static

Stops the bot operation gradually, ensuring a clean shutdown process and waiting for all processing to complete.

Parameters

reason

The reason for stopping the bot. This message will be logged for diagnostic purposes.

Returns

A task that represents the asynchronous operation of gracefully stopping the bot.

Member Data Documentation

StatusText

string ff14bot.TreeRoot.StatusText = ""

static

This gets displayed on bottom of the main bot window.

TicksPerSecond

byte ff14bot.TreeRoot.TicksPerSecond

static

Specifies the number of ticks per second for the bot's execution loop. This value determines how frequently the bot processes logic and limits the frame rate accordingly.

Property Documentation

AchievedTickRate

int ff14bot.TreeRoot.AchievedTickRate

staticgetset

Represents the actual achieved tick rate of the bot execution, measured in ticks per second. Indicates how many processing cycles were completed within one second.

Current

BotBase ff14bot.TreeRoot.Current

staticget

Gets the currently active bot instance being used by the application. Provides access to the bot's root behaviors, pulse flags, and other associated properties.

IsRunning

bool ff14bot.TreeRoot.IsRunning

staticget

Indicates whether the bot execution thread is currently active and running. Returns true if the bot thread is initialized and alive, otherwise false.

Event Documentation

OnStart

BotEvent ff14bot.TreeRoot.OnStart

static

Event queue for all listeners interested in OnStart events.

OnStop

BotEvent ff14bot.TreeRoot.OnStop

static

Event queue for all listeners interested in OnStop events.