### StartInstallDownloadThread() Source: https://rebornbuddy.com/doxygen/functions_func_s.html Starts a thread for handling installation and download processes. ```APIDOC ## StartInstallDownloadThread() ### Description Initiates a thread dedicated to managing installation and download tasks. This is useful for background operations like software updates or asset downloads. ### Method Not applicable (SDK/Library function) ### Endpoint Not applicable (SDK/Library function) ### Parameters None ### Request Example Not applicable (SDK/Library function) ### Response - **InstallDownloadTask** (UpdateBuddy.Helpers.Tasks.InstallDownloadTask) - Represents the task for installation and downloads. ### Response Example Not applicable (SDK/Library function) ``` -------------------------------- ### InstallCommand Property Source: https://rebornbuddy.com/doxygen/class_update_buddy_1_1_direct_downloads_1_1_direct_download.html Gets the command that can be invoked to initiate the installation of the direct download. ```APIDOC ## InstallCommand Property ### Description Gets the command to install the direct download. ### Type ICommand ### Access get ``` -------------------------------- ### StartInstallDownloadThread Source: https://rebornbuddy.com/doxygen/class_update_buddy_1_1_helpers_1_1_tasks_1_1_install_download_task-members.html Starts a new thread to handle the download and installation process for a specific direct download. Allows for progress tracking and completion callbacks. ```APIDOC ## StartInstallDownloadThread ### Description Starts a new thread to handle the download and installation process for a specific direct download. Allows for progress tracking and completion callbacks. ### Method static ### Endpoint UpdateBuddy.Helpers.Tasks.InstallDownloadTask.StartInstallDownloadThread(DirectDownload download, Action? onComplete=null, Action< object, ProgressChangedEventArgs >? onProgressChanged=null) ### Parameters #### Path Parameters - **download** (DirectDownload) - Required - The direct download object to process. - **onComplete** (Action?) - Optional - A callback action to be executed upon completion. - **onProgressChanged** (Action< object, ProgressChangedEventArgs >?) - Optional - A callback action to report progress changes. ``` -------------------------------- ### Start Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_bot_bases_1_1_fate_bot.html Starts this bot. Do any initialization here. ```APIDOC ## Start ### Description Starts this bot. Do any initialization here. ### Method override void ### Parameters None ``` -------------------------------- ### Start() Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_tree_root-members.html Starts the TreeRoot. ```APIDOC ## Start() ### Description Starts the TreeRoot. ### Method - **Start()** (static) - Starts the TreeRoot. ``` -------------------------------- ### Start Method Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_behavior_1_1_hook_executor.html Starts the behavior hook. ```APIDOC ## Start(object context) ### Description Starts the behavior hook with the given context. ### Parameters * **context** (object) - The context for starting the hook. ``` -------------------------------- ### Start Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_tree_root.html Starts the main bot execution thread, initializing settings, events, and creating the necessary environment for the bot's operation. ```APIDOC ## Start ### Description Starts the main bot execution thread, initializing settings, events, and creating the necessary environment for the bot's operation. ### Method static void ### Parameters None ``` -------------------------------- ### Start() Source: https://rebornbuddy.com/doxygen/class_tree_sharp_1_1_action_run_coroutine.html Starts the coroutine action. ```APIDOC ## ◆ Start() ### Description Starts the coroutine action. ### Method override void Start(object context) ``` -------------------------------- ### Start() Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_neo_profiles_1_1_profile_behavior.html Called when the profile behavior is initiated. ```APIDOC ## Start() ### Description Called when [start]. ### Returns - void ``` -------------------------------- ### Start Method Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_behavior_1_1_hook_executor-members.html Starts the hook executor with the given context. ```APIDOC ## Start(object context) ### Description Starts the hook executor with the given context. ### Parameters - **context** (object) - The context to start the hook executor with. ``` -------------------------------- ### Start Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_bot_bases_1_1_mini_cact_pot_bot.html Called when the bot is started. This method overrides the base class method to provide specific starting logic for the MiniCactPotBot. ```APIDOC ## Start ### Description Called when the bot is started. ### Method override void ### Parameters None ``` -------------------------------- ### TransitionStart Property Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_navigation_1_1_nav_graph_1_1_zone_transition_node-members.html Gets a value indicating whether this node is the starting point of a transition. ```APIDOC ## TransitionStart ### Description Gets a value indicating whether this node is the starting point of a transition. ### Return Value (bool) - True if this node is a transition start; otherwise, false. ``` -------------------------------- ### Starts Property Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_service_client_1_1_can_fully_navigate_from_request.html A list of starting points for the navigation request. ```APIDOC ## ◆ Starts | List ff14bot.ServiceClient.CanFullyNavigateFromRequest.Starts --- getset A list of starting points for the navigation request. ``` -------------------------------- ### Start Method Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_behavior_1_1_hook_executor.html Starts the execution of the HookExecutor. ```APIDOC ## Start Method ### Description Starts the execution of the HookExecutor. ### Signature public override void Start(object context) ### Parameters * **context** (object) - The context for the execution. ``` -------------------------------- ### IsNotInstalled Property Source: https://rebornbuddy.com/doxygen/class_update_buddy_1_1_direct_downloads_1_1_direct_download.html Gets a boolean value indicating whether the direct download is not installed. ```APIDOC ## IsNotInstalled Property ### Description Gets a value indicating if the direct download is not installed. ### Type bool ### Access get ``` -------------------------------- ### IsInstalled Property Source: https://rebornbuddy.com/doxygen/class_update_buddy_1_1_direct_downloads_1_1_direct_download.html Gets a boolean value indicating whether the direct download is currently installed. ```APIDOC ## IsInstalled Property ### Description Gets a value indicating if the direct download is installed. ### Type bool ### Access get ### Implements UpdateBuddy.DirectDownloads.IDirectDownload.IsInstalled ``` -------------------------------- ### Start Method Source: https://rebornbuddy.com/doxygen/class_update_buddy_1_1_helpers_1_1_semaphore_task_runner-2-g-members.html Starts the execution of tasks managed by the SemaphoreTaskRunner. ```APIDOC ## Start(IEnumerable< T > inputs) ### Description Starts the execution of tasks for the given inputs using the configured semaphore. ### Parameters * **inputs** (IEnumerable< T >) - A collection of inputs for the tasks. ``` ```APIDOC ## Start(IEnumerable< T > inputs, StatusCallback< TS > callback) ### Description Starts the execution of tasks for the given inputs, providing a callback for status updates. ### Parameters * **inputs** (IEnumerable< T >) - A collection of inputs for the tasks. * **callback** (StatusCallback< TS >) - A callback function to report the status of the tasks. ``` ```APIDOC ## Start(IEnumerable< T > inputs, BackgroundWorker callback) ### Description Starts the execution of tasks for the given inputs, using a BackgroundWorker for progress reporting. ### Parameters * **inputs** (IEnumerable< T >) - A collection of inputs for the tasks. * **callback** (BackgroundWorker) - The BackgroundWorker to report progress to. ``` -------------------------------- ### Start Bot Execution Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_tree_root.html Starts the main bot execution thread, initializing settings, events, and creating the necessary environment for the bot's operation. ```APIDOC ## Start() ### Description Starts the main bot execution thread, initializing settings, events, and creating the necessary environment for the bot's operation. ### Method static void ### Endpoint ff14bot.TreeRoot.Start() ``` -------------------------------- ### InstanceStarted Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_directors_1_1_instance_content_director-members.html Indicates that the instance content has started. ```APIDOC ## InstanceStarted ### Description Event triggered when the instance content has started. ``` -------------------------------- ### OnStart Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_tree_root-members.html Event that is triggered when the TreeRoot starts. ```APIDOC ## OnStart ### Description Event that is triggered when the TreeRoot starts. ### Event - **OnStart** (static) - An event that is triggered when the TreeRoot starts. ``` -------------------------------- ### MoveForwardStart Source: https://rebornbuddy.com/doxygen/functions_func_m.html Starts forward movement. ```APIDOC ## MoveForwardStart() ### Description Starts forward movement. ### Class ff14bot.Managers.MovementManager ``` -------------------------------- ### OnBotStartDelegate Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_neo_profile_1_1_bot_events.html Delegate for the bot start event. ```APIDOC delegate void OnBotStartDelegate(EventArgs args) ``` -------------------------------- ### Get Blacklist Entry by GUID Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_helpers_1_1_blacklist.html Retrieves the blacklist entry associated with a specific unique identifier (GUID). ```APIDOC ## GetEntry(uint guid) ### Description Retrieves the blacklist entry associated with a specific unique identifier. ### Parameters - **guid** (uint) - The unique identifier of the entry. ### Returns - The BlacklistEntry associated with the GUID. ``` -------------------------------- ### StartNode Source: https://rebornbuddy.com/doxygen/class_pathfinding_1_1_arc-members.html Gets the start node of the arc. ```APIDOC ## StartNode ### Description Gets the start node of the arc. ### Property - **StartNode** (Node) - The node at the start of the arc. ``` -------------------------------- ### StartNode Property Source: https://rebornbuddy.com/doxygen/class_pathfinding_1_1_arc.html Gets or sets the starting node of the arc. ```APIDOC ## StartNode ### Description Gets/Sets the node from which the arc starts. ### Type Node ### Access [get, set] ``` -------------------------------- ### HasBeenStarted Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_neo_profiles_1_1_complex_node_tag.html Gets or sets a boolean value indicating whether the ComplexNodeTag has been started. ```APIDOC ## HasBeenStarted bool ff14bot.NeoProfiles.ComplexNodeTag.HasBeenStarted ### Description Gets or sets a boolean value indicating whether the ComplexNodeTag has been started. ### Accessors getset ``` -------------------------------- ### Start() Source: https://rebornbuddy.com/doxygen/functions_func_s.html Initiates the main bot process, returning various manager and executor types. ```APIDOC ## Start() ### Description Initiates the main bot process. This function is a starting point for various functionalities within the bot framework. ### Method Not applicable (SDK/Library function) ### Endpoint Not applicable (SDK/Library function) ### Parameters None ### Request Example Not applicable (SDK/Library function) ### Response - **BotBase** (ff14bot.AClasses.BotBase) - Base class for bot functionalities. - **HookExecutor** (ff14bot.Behavior.HookExecutor) - Handles behavior hooks. - **Throttle** (ff14bot.Behavior.Throttle) - Manages process throttling. - **ThrottlePasses** (ff14bot.Behavior.ThrottlePasses) - Indicates throttle status. - **FateBot** (ff14bot.BotBases.FateBot) - Specific bot for Fate events. - **Fishbot** (ff14bot.BotBases.Fishbot) - Specific bot for fishing. - **MiniCactPotBot** (ff14bot.BotBases.MiniCactPotBot) - Specific bot for Mini CactPot. - **OrderBot** (ff14bot.BotBases.OrderBot) - Specific bot for order-based tasks. - **ProfileBehavior** (ff14bot.NeoProfiles.ProfileBehavior) - Handles profile-based behaviors. - **TreeRoot** (ff14bot.TreeRoot) - The root of the behavior tree. - **ActionRunCoroutine** (TreeSharp.ActionRunCoroutine) - Action for running coroutines. - **SemaphoreTaskRunner** (UpdateBuddy.Helpers.SemaphoreTaskRunner) - Task runner with semaphore. ### Response Example Not applicable (SDK/Library function) ``` -------------------------------- ### PreSetInstalled Method Source: https://rebornbuddy.com/doxygen/class_update_buddy_1_1_direct_downloads_1_1_direct_download.html Prepares the direct download for installation status changes. This is an internal or preparatory method. ```APIDOC ## PreSetInstalled() ### Description Performs pre-installation setup for the direct download. ### Method void ### Parameters None ``` -------------------------------- ### IsNotInstalledVisibility Property Source: https://rebornbuddy.com/doxygen/class_update_buddy_1_1_direct_downloads_1_1_direct_download.html Gets the visibility state related to the not installed status of the direct download. ```APIDOC ## IsNotInstalledVisibility Property ### Description Gets the visibility state when the item is not installed. ### Type Visibility ### Access get ``` -------------------------------- ### IsInstalledVisibility Property Source: https://rebornbuddy.com/doxygen/class_update_buddy_1_1_direct_downloads_1_1_direct_download.html Gets the visibility state related to the installed status of the direct download. ```APIDOC ## IsInstalledVisibility Property ### Description Gets the visibility state when the item is installed. ### Type Visibility ### Access get ``` -------------------------------- ### InstallAllDownloads Source: https://rebornbuddy.com/doxygen/class_update_buddy_1_1_helpers_1_1_tasks_1_1_install_download_task.html Initiates the download and installation of all pending downloads. ```APIDOC ## InstallAllDownloads() ### Description Initiates the download and installation of all pending downloads. ### Method static void ### Endpoint UpdateBuddy.Helpers.Tasks.InstallDownloadTask.InstallAllDownloads() ``` -------------------------------- ### ExamplePlugin Constructor Source: https://rebornbuddy.com/doxygen/class_example_plugin_1_1_example_plugin-members.html Initializes a new instance of the ExamplePlugin class. ```APIDOC ## BotPlugin() ### Description Initializes a new instance of the ExamplePlugin class. ### Method protected ### Endpoint ExamplePlugin.ExamplePlugin ``` -------------------------------- ### Start Method Source: https://rebornbuddy.com/doxygen/class_update_buddy_1_1_helpers_1_1_semaphore_task_runner-2-g.html Initiates the task runner with a collection of inputs and a status callback. ```APIDOC ## Start() ### Description Asynchronously starts the task runner, processing a collection of inputs and providing status updates via a callback. ### Method Signature `async Task Start(IEnumerable _inputs, StatusCallback _callback)` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```csharp // Example usage (assuming SemaphoreTaskRunner and StatusCallback are defined) var runner = new SemaphoreTaskRunner(); var inputs = new List { /* ... */ }; StatusCallback callback = (status) => { /* handle status */ }; await runner.Start(inputs, callback); ``` ### Response #### Success Response (Task Completion) This method returns a `Task` that completes when all tasks have been processed. #### Response Example No specific response body is returned upon successful completion, as the method is `async Task`. ``` -------------------------------- ### Initialize Method Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_managers_1_1_invalid_routine_wrapper.html Function that gets called when the routine is started. This method overrides the base class Initialize method. ```APIDOC ## ◆ Initialize() | override void ff14bot.Managers.InvalidRoutineWrapper.Initialize | ( | __| ) | ---|---|---|---|--- virtual Function that gets called when the routine is started. Reimplemented from ff14bot.AClasses.CombatRoutine. ``` -------------------------------- ### StartNode Property Source: https://rebornbuddy.com/doxygen/class_pathfinding_1_1_arc.html Gets or sets the node from which the arc starts. Includes validation to prevent null or setting it to the end node. ```APIDOC ## StartNode ### Description Gets/Sets the node from which the arc starts. ### Property Type (Node) ### Exceptions - **ArgumentNullException**: StartNode cannot be set to null. - **ArgumentException**: StartNode cannot be set to EndNode. ``` -------------------------------- ### Initialize Source: https://rebornbuddy.com/doxygen/class_pathfinding_1_1_a_starz.html Initializes the AStar algorithm for step-by-step pathfinding. ```APIDOC ## Initialize() ### Description Use for a 'step by step' search only. This method is alternate to SearchPath. Initializes AStar before performing search steps manually with NextStep. ### Parameters - **_StartNode_** (Node) - The node from which the path must start. - **_EndNode_** (Node) - The node to which the path must end. ### Exceptions - **ArgumentNullException**: StartNode and EndNode cannot be null. ``` -------------------------------- ### Initialize Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_bot_bases_1_1_fate_bot.html Called one time when users starts the botbase. ```APIDOC ## Initialize ### Description Called one time when users starts the botbase. ### Method override void ### Parameters None ``` -------------------------------- ### EndNode Property Source: https://rebornbuddy.com/doxygen/class_pathfinding_1_1_arc.html Gets or sets the node to which the arc ends. Includes validation to prevent null or setting it to the start node. ```APIDOC ## EndNode ### Description Gets/Sets the node to which the arc ends. ### Property Type (Node) ### Exceptions - **ArgumentNullException**: EndNode cannot be set to null. - **ArgumentException**: EndNode cannot be set to StartNode. ``` -------------------------------- ### PreKeyAction Source: https://rebornbuddy.com/doxygen/class_s_q_lite_1_1_s_q_lite_connection_string.html Gets or sets an action to be performed before the database connection is established and the key is applied. This can be used for pre-connection setup or validation. ```APIDOC ## Property PreKeyAction ### Description Gets or sets an action to be performed before the database connection is established and the key is applied. ### Type Action ``` -------------------------------- ### InstallByDefault Property Source: https://rebornbuddy.com/doxygen/interface_update_buddy_1_1_direct_downloads_1_1_i_direct_download.html Indicates whether the direct download should be installed by default. This is a read-only property. ```APIDOC ## InstallByDefault ### Description Gets a value indicating whether the direct download should be installed by default. ### Property Type bool ### Access get ``` -------------------------------- ### DoInitialize Method Source: https://rebornbuddy.com/doxygen/class_example_plugin_1_1_example_plugin-members.html Performs initialization tasks for the plugin. ```APIDOC ## DoInitialize() ### Description Performs initialization tasks for the plugin. ### Endpoint ff14bot.AClasses.BotPlugin ``` -------------------------------- ### PostKeyAction Source: https://rebornbuddy.com/doxygen/class_s_q_lite_1_1_s_q_lite_connection_string.html Gets or sets an action to be performed after the database connection is established and the key is applied. This can be used for post-connection setup or validation. ```APIDOC ## Property PostKeyAction ### Description Gets or sets an action to be performed after the database connection is established and the key is applied. ### Type Action ``` -------------------------------- ### setupGraph Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_managers_1_1_way_point_profile-members.html Sets up the graph for the waypoint profile. ```APIDOC ## setupGraph() ### Description Sets up the graph for the waypoint profile. ### Method setupGraph() ``` -------------------------------- ### DoInitialize Method Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_a_classes_1_1_bot_plugin.html Executes the Initialize action if it hasn't been run already. ```APIDOC ## DoInitialize() ### Description Executes Initialize if it hasn't been run already. ### Method void ``` -------------------------------- ### Get Mount ID - ActionManager Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_managers_1_1_action_manager.html Retrieves the mount ID the bot will attempt to use. Returns uint.MaxValue for random mounts. This example checks if the configured mount ID is 1 and the Chocobo is stabled, in which case it returns uint.MaxValue; otherwise, it returns the configured mount ID. ```csharp var settings = CharacterSettings.Instance; if (settings.MountId == 1 && ChocoboManager.IsStabled) return uint.MaxValue; return settings.MountId; ``` -------------------------------- ### StartUpdate() Source: https://rebornbuddy.com/doxygen/functions_func_s.html Initiates an update process within the UpdateBuddy plugin. ```APIDOC ## StartUpdate() ### Description Triggers the update process for the UpdateBuddy plugin. This function is used to check for and apply updates. ### Method Not applicable (SDK/Library function) ### Endpoint Not applicable (SDK/Library function) ### Parameters None ### Request Example Not applicable (SDK/Library function) ### Response - **UpdateBuddyPlugin** (UpdateBuddy.UpdateBuddyPlugin) - The main plugin class for updates. ### Response Example Not applicable (SDK/Library function) ``` -------------------------------- ### StartUpdate Source: https://rebornbuddy.com/doxygen/class_update_buddy_1_1_update_buddy_plugin.html Initiates the update process for the plugin. ```APIDOC ## StartUpdate ### Description Starts the update process. ### Method void ### Signature StartUpdate() ``` -------------------------------- ### InitializeComponent Method Source: https://rebornbuddy.com/doxygen/class_update_buddy_1_1_main_window.html Initializes the components of the MainWindow. ```APIDOC ## InitializeComponent() ### Description Initializes the components of the MainWindow. This method is called internally. ### Method `void InitializeComponent()` ``` -------------------------------- ### OnInitialize Method Source: https://rebornbuddy.com/doxygen/class_example_plugin_1_1_example_plugin-members.html Handles the initialization of the plugin. ```APIDOC ## OnInitialize() ### Description Handles the initialization of the plugin. ### Method virtual ### Endpoint ff14bot.AClasses.BotPlugin ``` -------------------------------- ### setupGraph Method Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_managers_1_1_mesh_profile.html Documentation for the setupGraph method, used for graph processing within MeshProfile. ```APIDOC ## Member Function Documentation ## ◆ setupGraph() void ff14bot.Managers.MeshProfile.setupGraph | ( | __| ) | ``` -------------------------------- ### GetEntry(uint guid) Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_helpers_1_1_blacklist-members.html Retrieves a blacklist entry using a unique identifier (GUID). ```APIDOC ## GetEntry(uint guid) ### Description Retrieves a blacklist entry using a unique identifier (GUID). ### Method static ### Parameters #### Path Parameters - **guid** (uint) - Description not available in source ``` -------------------------------- ### InstanceStarted Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_directors_1_1_instance_content_director.html Checks if the current game instance has begun. ```APIDOC ## Property: InstanceStarted ### Description Checks if the instance has started. ### Type bool ### Access get ``` -------------------------------- ### Class Members starting with 'Y' Source: https://rebornbuddy.com/doxygen/functions_y.html Lists class members that start with the letter 'Y', along with the classes they belong to. ```APIDOC ## Class Members starting with 'Y' ### Description This section lists class members whose names begin with 'Y'. For each member, it indicates the class(es) it is associated with. ### Members - **Y** : ff14bot.Navigation.BlackSpot, ff14bot.Navigation.HotSpot, ff14bot.Objects.GameObject, Pathfinding.Node - **YellRecevied** : ff14bot.Managers.GamelogManager - **Yes()** : ff14bot.RemoteWindows.MaterializeDialog, ff14bot.RemoteWindows.SelectYesno ``` -------------------------------- ### Properties starting with 'X' Source: https://rebornbuddy.com/doxygen/functions_prop_x.html Lists properties that start with the letter 'X', along with the classes they belong to. ```APIDOC ## Properties starting with 'X' ### Description This section details properties beginning with 'X'. ### Properties - **X** (various types) - Belongs to: ff14bot.Navigation.BlackSpot, ff14bot.Navigation.HotSpot, ff14bot.NeoProfile.Spot2D, ff14bot.Objects.GameObject, Pathfinding.Node - **XAxisModified** (various types) - Belongs to: ff14bot.Objects.CraftSpellData, ff14bot.Objects.EmptySpell, ff14bot.Objects.SpellData - **XAxisModifier** (various types) - Belongs to: ff14bot.Managers.SpellResult - **XPPerHour** (various types) - Belongs to: ff14bot.Managers.GameStatsManager - **XYZ** (various types) - Belongs to: ff14bot.Navigation.BlackSpot, ff14bot.Navigation.HotSpot ``` -------------------------------- ### Check if Entry by GUID is Blacklisted with Flags Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_helpers_1_1_blacklist.html Checks if a specific entry, identified by its GUID, is blacklisted with the specified flags. ```APIDOC ## Contains(uint guid, BlacklistFlags flags=BlacklistFlags.All) ### Description Checks if a specific entry is blacklisted with the specified flags. ### Parameters - **guid** (uint) - The unique identifier of the entry. - **flags** (BlacklistFlags, optional) - The blacklist flags to check against. Defaults to BlacklistFlags.All. ### Returns - True if the entry is blacklisted with the specified flags; otherwise, false. ``` -------------------------------- ### Initialize Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_bot_bases_1_1_order_bot.html Called one time when users starts the botbase. This method is intended for initialization tasks. ```APIDOC ## Initialize ### Description Called one time when users starts the botbase. Use this for initialization. ### Method void ### Parameters None ``` -------------------------------- ### CombatRoutine SupportedCapabilities Example Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_a_classes_1_1_combat_routine.html This example shows how to indicate that a Combat Routine supports all capabilities except summoning a pet. ```csharp public virtual CombatRoutineCapability SupportedCapabilities { get { return CombatRoutineCapability.All & ~CombatRoutineCapability.PetSummoning; } } ``` -------------------------------- ### PreparedSqlLiteInsertCommand Constructor Source: https://rebornbuddy.com/doxygen/class_s_q_lite_1_1_prepared_sql_lite_insert_command-members.html Initializes a new instance of the PreparedSqlLiteInsertCommand class. ```APIDOC ## PreparedSqlLiteInsertCommand Constructor ### Description Initializes a new instance of the PreparedSqlLiteInsertCommand class. ### Method `PreparedSqlLiteInsertCommand(SQLiteConnection conn, string commandText)` ### Parameters * **conn** (SQLiteConnection) - The SQLite connection to use. * **commandText** (string) - The SQL command text. ``` -------------------------------- ### this[string subKey] Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_helpers_1_1_localized_dictionary-2-g.html Gets or sets the value associated with the specified key. Throws KeyNotFoundException if the key is not found during a get operation. ```APIDOC ## ◆ this[string subKey] | V ff14bot.Helpers.LocalizedDictionary< K, V >.this[string subKey] --- get Gets or sets the value associated with the specified key. Parameters subKey| The key of the value to get or set. --- Returns The value associated with the specified key. If the specified key is not found, a get operation throws a T:System.Collections.Generic.KeyNotFoundException, and a set operation creates a new element with the specified key. Exceptions T:System.ArgumentNullException| _subKey_ is `null`. --- T:System.Collections.Generic.KeyNotFoundException| The property is retrieved and _subKey_ does not exist in the collection. ``` -------------------------------- ### PreparedSqlLiteInsertCommand Constructor Source: https://rebornbuddy.com/doxygen/class_s_q_lite_1_1_prepared_sql_lite_insert_command.html Initializes a new instance of the PreparedSqlLiteInsertCommand class. ```APIDOC ## PreparedSqlLiteInsertCommand(SQLiteConnection conn, string commandText) ### Description Initializes a new instance of the `PreparedSqlLiteInsertCommand` class. ### Parameters * **conn** (SQLiteConnection) - The SQLite connection object. * **commandText** (string) - The SQL command text for the insert operation. ``` -------------------------------- ### this[K primaryKey] Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_helpers_1_1_localized_dictionary-2-g.html Gets or sets the value associated with the specified key. Throws KeyNotFoundException if the key is not found during a get operation. ```APIDOC ## Property Documentation ## ◆ this[K primaryKey] | V ff14bot.Helpers.LocalizedDictionary< K, V >.this[K primaryKey] --- get Gets or sets the value associated with the specified key. Parameters primaryKey| The key of the value to get or set. --- Returns The value associated with the specified key. If the specified key is not found, a get operation throws a T:System.Collections.Generic.KeyNotFoundException, and a set operation creates a new element with the specified key. Exceptions T:System.ArgumentNullException| _primaryKey_ is `null`. --- T:System.Collections.Generic.KeyNotFoundException| The property is retrieved and _primaryKey_ does not exist in the collection. ``` -------------------------------- ### Commence Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_remote_windows_1_1_contents_finder_confirm-members.html Initiates the contents finder confirmation process. This is a static method. ```APIDOC ## Commence ### Description Initiates the contents finder confirmation process. ### Method static ``` -------------------------------- ### Initialize Source: https://rebornbuddy.com/doxygen/class_s_q_lite_1_1_s_q_lite3.html Initializes the SQLite3 library. ```APIDOC ## Initialize() ### Description Initializes the SQLite3 library. This function must be called before any other SQLite3 functions are used. ### Method Signature `Result SQLite.SQLite3.Initialize()` ``` -------------------------------- ### Initiate Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_remote_windows_1_1_w_k_s_mission-members.html Initializes the workshop mission system with a specific mission ID. This is a static method. ```APIDOC ## Initiate(uint missionId) ### Description Initializes the workshop mission system with a specific mission ID. ### Method static ### Parameters #### Path Parameters - **missionId** (uint) - Required - The ID of the mission to initiate. ``` -------------------------------- ### Add Entry by GUID Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_helpers_1_1_blacklist.html Adds an entry to the blacklist using its unique identifier (GUID) with specified flags, duration, and an optional reason. ```APIDOC ## Add(uint guid, BlacklistFlags flags, TimeSpan duration, string reason="") ### Description Adds an entry to the blacklist with specified flags, duration, and reason. ### Parameters - **guid** (uint) - The unique identifier of the entry. - **flags** (BlacklistFlags) - The blacklist flags associated with the entry. - **duration** (TimeSpan) - The duration for which the entry should remain blacklisted. - **reason** (string, optional) - The reason for blacklisting the entry. Defaults to "". ``` -------------------------------- ### MainWpf Constructor Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_forms_1_1ugh_1_1_main_wpf.html Initializes a new instance of the MainWpf class. ```APIDOC ## MainWpf() ### Description Initializes a new instance of the MainWpf class. ### Constructor `ff14bot.Forms.ugh.MainWpf.MainWpf()` ``` -------------------------------- ### Start Method Overloads Source: https://rebornbuddy.com/doxygen/class_update_buddy_1_1_helpers_1_1_semaphore_task_runner-2-g.html Starts the execution of tasks managed by the SemaphoreTaskRunner. Multiple overloads are available to handle different callback mechanisms and return types. ```APIDOC ## async Task> Start(IEnumerable inputs) ### Description Asynchronously starts the execution of tasks for the given inputs and returns a list of results. This overload does not use a callback. ### Parameters * **inputs** (IEnumerable) - A collection of inputs for the tasks. ``` ```APIDOC ## async Task Start(IEnumerable inputs, StatusCallback callback) ### Description Asynchronously starts the execution of tasks for the given inputs, providing progress updates through a status callback. ### Parameters * **inputs** (IEnumerable) - A collection of inputs for the tasks. * **callback** (StatusCallback) - A callback function to report the status of task execution. ``` ```APIDOC ## List Start(IEnumerable inputs, BackgroundWorker callback) ### Description Starts the execution of tasks for the given inputs using a `BackgroundWorker` for progress reporting. This overload is synchronous. ### Parameters * **inputs** (IEnumerable) - A collection of inputs for the tasks. * **callback** (BackgroundWorker) - A `BackgroundWorker` instance to report progress. ``` -------------------------------- ### Initialize Source: https://rebornbuddy.com/doxygen/class_pathfinding_1_1_a_starz.html Initializes the AStar algorithm for a step-by-step search. This method is an alternative to SearchPath. ```APIDOC ## Initialize ### Description Use for a 'step by step' search only. This method is alternate to SearchPath. Initializes AStar before performing search steps manually with NextStep. ### Method void ### Parameters #### Path Parameters - **StartNode** (Node) - Required - The starting node for the path search. - **EndNode** (Node) - Required - The target node for the path search. ``` -------------------------------- ### Add Entry by GUID with End Time Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_helpers_1_1_blacklist.html Adds an entry to the blacklist using its unique identifier (GUID) with a specified end time and an optional reason. ```APIDOC ## Add(uint guid, TimeSpan end, string reason="") ### Description Adds an entry to the blacklist with a specified duration and reason. ### Parameters - **guid** (uint) - The unique identifier of the entry. - **end** (TimeSpan) - The duration for which the entry should remain blacklisted. - **reason** (string, optional) - The reason for blacklisting the entry. Defaults to "". ``` -------------------------------- ### IsOpen Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_remote_windows_1_1_q_t_e-members.html Gets a value indicating whether the QTE window is open. ```APIDOC ## IsOpen ### Description Gets a value indicating whether the QTE window is open. ### Property - **IsOpen** (bool) - static ``` -------------------------------- ### Y Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_objects_1_1_battle_character.html Get the objects Y axis. ```APIDOC ## Y ### Description Get the objects Y axis. ### Endpoint `/BattleCharacter/Y` ### Method GET ### Returns - **float** - The Y coordinate of the object. ``` -------------------------------- ### Main Source: https://rebornbuddy.com/doxygen/functions_func_m.html The main entry point for the application. ```APIDOC ## Main() ### Description The main entry point for the application. ### Class ff14bot.App ``` -------------------------------- ### Commence Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_remote_windows_1_1_contents_finder_confirm.html Initiates the process to start a duty via the Contents Finder. ```APIDOC ## Commence() ### Description Starts the duty finder process. ### Method static void ### Endpoint N/A (Method call) ### Parameters None ``` -------------------------------- ### SearchStarted Source: https://rebornbuddy.com/doxygen/class_pathfinding_1_1_a_starz.html Checks if the search has started. ```APIDOC ## SearchStarted ### Description To know if the search has been started. ### Property Type bool [get] ``` -------------------------------- ### Start Method Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_behavior_1_1_throttle_passes.html Initializes the throttle passes. This is an override method, typically called internally. ```APIDOC ## Start() ### Description Initializes the throttle passes. ### Method override ### Parameters * `_context_` (object) - The context for initialization. ``` -------------------------------- ### ClassLevel Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_objects_1_1_local_player.html Get the characters level. ```APIDOC ## ClassLevel ### Description Get the characters level. ### Property `byte ClassLevel` [get] ``` -------------------------------- ### Initialize Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_neo_profiles_1_1_condition_parser.html Initializes the ConditionParser. ```APIDOC ## Initialize() ### Description Initializes the ConditionParser. ### Method static void ``` -------------------------------- ### Priority Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_pathing_1_1_avoidance_1_1_avoid_info-1-g-members.html Gets the priority of this avoidance. ```APIDOC ## Priority ### Description Retrieves the priority level assigned to this avoidance, influencing its order of execution relative to other avoidances. ### Method (Implicitly called, likely a property getter) ### Endpoint N/A (Class member) ``` -------------------------------- ### Type Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_objects_1_1_minion-members.html Gets the type of the GameObject. ```APIDOC ## Type ### Description Gets the type of the GameObject (e.g., NPC, Player, Monster). ### Property GameObjectType Type { get; } ``` -------------------------------- ### Name Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_objects_1_1_minion-members.html Gets the name of the GameObject. ```APIDOC ## Name ### Description Gets the name of the GameObject as displayed in the game. ### Property string Name { get; } ``` -------------------------------- ### MainWindow Constructors and Methods Source: https://rebornbuddy.com/doxygen/class_update_buddy_1_1_main_window-members.html This section lists the constructors and methods available for the UpdateBuddy.MainWindow class. ```APIDOC ## MainWindow() ### Description Constructor for the MainWindow class. ### Method Constructor ### Endpoint N/A ### Parameters None ### Request Example None ### Response None ## InitializeComponent() ### Description Initializes the components of the MainWindow. This is typically called by the framework. ### Method Method ### Endpoint N/A ### Parameters None ### Request Example None ### Response None ``` -------------------------------- ### OnStart Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_neo_profiles_1_1_complex_node_tag.html Handles the initialization logic for the ComplexNodeTag. This method is an override from the base ProfileBehavior class. ```APIDOC ## OnStart() protected virtual void ff14bot.NeoProfiles.ComplexNodeTag.OnStart() ### Description Handles the initialization logic for the ComplexNodeTag. This method is an override from the base ProfileBehavior class. ``` -------------------------------- ### GrandCompany Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_objects_1_1_local_player.html Gets the active GrandCompany. ```APIDOC ## GrandCompany ### Description Gets the active GrandCompany. ### Property `GrandCompany GrandCompany` [get] ``` -------------------------------- ### Blackspots Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_pathing_1_1_aerial_blackspot_manager-members.html Gets all aerial blackspots. ```APIDOC ## Blackspots ### Description Gets all aerial blackspots. ### Method static ### Return Value Description not available ``` -------------------------------- ### SetInstalled Method Source: https://rebornbuddy.com/doxygen/class_update_buddy_1_1_direct_downloads_1_1_direct_download.html Marks the direct download as installed. This method is part of the public interface for managing download states. ```APIDOC ## SetInstalled() ### Description Sets the installation status for the direct download. ### Method void ### Parameters None ``` -------------------------------- ### Y Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_objects_1_1_housing_combined_object.html Get the object's Y axis. ```APIDOC ## Y ### Description Get the object's Y axis. ### Property - **float**: The Y coordinate of the object. ``` -------------------------------- ### Main Method (Application Entry Point) Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_app.html The main entry point for the ff14bot application. This static method is executed when the application starts. ```APIDOC ## Main() ### Description Application Entry Point. This static method serves as the starting point for the ff14bot application. ### Signature `static void ff14bot.App.Main()` ``` -------------------------------- ### LuaString Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_objects_1_1_housing_combined_object.html Get the LuaString for the unit. ```APIDOC ## LuaString ### Description Get the LuaString for the unit. ### Property - **string**: The LuaString of the unit. ``` -------------------------------- ### Type Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_objects_1_1_character.html Get the GameObjectType of the object. ```APIDOC ## GameObjectType Type ### Description Get the GameObjectType of the object. ### Get Returns the GameObjectType enumeration value for the object. ``` -------------------------------- ### CurrentHealth Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_objects_1_1_character.html Gets the health of the unit. ```APIDOC ## uint CurrentHealth ### Description Gets the health of the unit. ### Get Returns the current health of the unit as an unsigned integer. ``` -------------------------------- ### OnInitialize Source: https://rebornbuddy.com/doxygen/class_update_buddy_1_1_update_buddy_plugin.html Executes the initialize action for the plugin. ```APIDOC ## OnInitialize ### Description Executes the initialize action. ### Method override void ### Signature OnInitialize() ``` -------------------------------- ### Mark Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_objects_1_1_character.html Get the units mark/sign. ```APIDOC ## Mark Mark ### Description Gets the units mark/sign. ### Get Returns the mark or sign associated with the unit. ``` -------------------------------- ### InstallAllDownloads Source: https://rebornbuddy.com/doxygen/class_update_buddy_1_1_helpers_1_1_tasks_1_1_install_download_task-members.html Installs all pending downloads. This is a static method of the InstallDownloadTask class. ```APIDOC ## InstallAllDownloads ### Description Installs all pending downloads. ### Method static ### Endpoint UpdateBuddy.Helpers.Tasks.InstallDownloadTask.InstallAllDownloads() ``` -------------------------------- ### Type Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_objects_1_1_battle_character.html Get the GameObjectType of the object. ```APIDOC ## Type ### Description Get the GameObjectType of the object. ### Endpoint `/BattleCharacter/Type` ### Method GET ### Returns - **GameObjectType** - The type of the GameObject. ``` -------------------------------- ### QTE Source: https://rebornbuddy.com/doxygen/namespaceff14bot_1_1_remote_windows.html Class that handles interacting with the QTE window. ```APIDOC ## Class: QTE ### Description Class that handles interacting with the QTE window. ### Methods (No specific methods documented in the source) ``` -------------------------------- ### CurrentHealth Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_objects_1_1_battle_character.html Gets the health of the unit. ```APIDOC ## CurrentHealth ### Description Gets the health of the unit. ### Endpoint `/BattleCharacter/CurrentHealth` ### Method GET ### Returns - **uint** - The current health of the unit. ``` -------------------------------- ### StartMeasuring() Source: https://rebornbuddy.com/doxygen/functions_func_s.html Begins measurement tracking using the GameStatsManager. ```APIDOC ## StartMeasuring() ### Description Starts the process of measuring game statistics. This function is used to begin tracking various in-game metrics. ### Method Not applicable (SDK/Library function) ### Endpoint Not applicable (SDK/Library function) ### Parameters None ### Request Example Not applicable (SDK/Library function) ### Response - **GameStatsManager** (ff14bot.Managers.GameStatsManager) - The manager responsible for game statistics. ### Response Example Not applicable (SDK/Library function) ``` -------------------------------- ### Mark Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_objects_1_1_battle_character.html Get the units mark/sign. ```APIDOC ## Mark ### Description Get the units mark/sign. ### Endpoint `/BattleCharacter/Mark` ### Method GET ### Returns - **Mark** - The mark or sign of the unit. ``` -------------------------------- ### PreBotStarting Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_neo_profile_1_1_bot_events-members.html Event triggered just before the bot begins its startup sequence. ```APIDOC ## PreBotStarting ### Description This event is triggered just before the bot begins its startup sequence. ### Method static ``` -------------------------------- ### Location Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_objects_1_1_battle_character.html Gets the objects location. ```APIDOC ## Location ### Description Gets the objects location. ### Endpoint `/BattleCharacter/Location` ### Method GET ### Returns - **Vector3** - The location of the object. ``` -------------------------------- ### FirstUnit Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_neo_profiles_1_1_targeting.html Gets the first NPC. ```APIDOC ## Property: FirstUnit ### Description Gets the first NPC. ### Type BattleCharacter ### Access get ``` -------------------------------- ### FishbotSettings Constructor Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_bot_bases_1_1_fishbot_settings.html Initializes a new instance of the FishbotSettings class. ```APIDOC ## FishbotSettings () ### Description Initializes a new instance of the FishbotSettings class. ### Method Constructor ``` -------------------------------- ### FirstEntity Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_neo_profiles_1_1_targeting.html Gets the first object. ```APIDOC ## Property: FirstEntity ### Description Gets the first object. ### Type BattleCharacter ### Access get ``` -------------------------------- ### InitializeComponent Method Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_forms_1_1ugh_1_1_main_wpf.html Initializes the components of the MainWpf window. This method is called by the constructor. ```APIDOC ## InitializeComponent() ### Description Initializes the components of the MainWpf window. This method is called by the constructor. ### Method `void ff14bot.Forms.ugh.MainWpf.InitializeComponent()` ``` -------------------------------- ### Y Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_navigation_1_1_black_spot.html Gets or sets the Y coordinate of the BlackSpot. ```APIDOC ## Y ### Description Gets or sets the Y coordinate of the BlackSpot. ### Property `Y` ### Type `float` ### Access `getset` ### Notes Gets Y coordinate. ``` -------------------------------- ### Name Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_managers_1_1_atk_addon_control-members.html Gets the name of the addon. ```APIDOC ## Name ### Description Gets the name of the addon. ### Property `Name` (string) ``` -------------------------------- ### DirectFullControl Constructors and Methods Source: https://rebornbuddy.com/doxygen/class_update_buddy_1_1_controls_1_1_direct_full_control-members.html This section details the constructors and methods available for the DirectFullControl class. It includes InitializeComponent, which is crucial for setting up the UI elements. ```APIDOC ## DirectFullControl() ### Description Constructor for the DirectFullControl class. ### Method Constructor ### Endpoint N/A ### Parameters None ### Request Example None ### Response None ## InitializeComponent() ### Description Initializes the components of the DirectFullControl class. This method is typically called during the object's creation to set up its user interface. ### Method Method ### Endpoint N/A ### Parameters None ### Request Example None ### Response None ``` -------------------------------- ### SubId Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_directors_1_1_public_content_director-members.html Gets the sub-identifier of the director. ```APIDOC ## SubId ### Description Gets the sub-identifier associated with the director. ### Method GET (assumed) ### Endpoint /PublicContentDirector/SubId (assumed) ### Parameters None explicitly documented. ### Response Success Response (200) - Returns the director's sub-ID. ``` -------------------------------- ### Instance Property Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_helpers_1_1_json_settings-1-g.html Gets or sets the singleton instance of the settings class. ```APIDOC ## Instance ### Description Gets or sets the singleton instance of the settings class. This property allows access to the single instance of the settings object throughout the application. ### Property static T Instance { get; set; } ``` -------------------------------- ### QuickSynthesize Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_remote_windows_1_1_crafting_log.html Initiates the QuickSynthesize action. ```APIDOC ## QuickSynthesize() ### Description Presses the QuickSynthesize button. ### Method static void ### Endpoint N/A (Method call) ### Parameters None ``` -------------------------------- ### Id Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_directors_1_1_public_content_director-members.html Gets the identifier of the director. ```APIDOC ## Id ### Description Gets the unique identifier of the director. ### Method GET (assumed) ### Endpoint /PublicContentDirector/Id (assumed) ### Parameters None explicitly documented. ### Response Success Response (200) - Returns the director's ID. ``` -------------------------------- ### Version Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_helpers_1_1_json_settings-1-g-members.html Gets the version of the settings. ```APIDOC ## Version ### Description Retrieves the version information associated with the current settings. ### Method int ### Endpoint N/A (Property access) ### Parameters None ### Request Example ```csharp int settingsVersion = JsonSettings.Version; ``` ### Response int - The version number of the settings. ``` -------------------------------- ### MoveForwardStart Source: https://rebornbuddy.com/doxygen/classff14bot_1_1_managers_1_1_movement_manager.html Starts autorunning the player character forward. ```APIDOC ## MoveForwardStart() ### Description Start autorunning forward. ### Method `static void MoveForwardStart()` ```