Provides a collection of common behaviors for movement, interaction, and other tasks within the game environment. These behaviors are designed to simplify and standardize frequently used operations, such as moving to a location, stopping, mounting, sprinting, and handling loading screens. More...

Static Public Member Functions
static Composite	MoveTo (ValueRetriever< Vector3 > location, string destination=null, Composite onFailed=null, ValueRetriever< TimeSpan > timeout=null)
	Creates a behavior to move the current character to the specified location. This will always return RunStatus.Success.
static Composite	MoveTo (ValueRetriever< Vector3 > location, ValueRetriever< string > destination, Composite onFailed=null, ValueRetriever< TimeSpan > timeout=null)
	Creates a behavior to move the current character to the specified location. This will always return RunStatus.Success.
static Composite	MoveAndStop (ValueRetriever< Vector3 > location, float range, bool stopInRange=false, string destinationName=null, RunStatus stopStatus=RunStatus.Failure)
	Creates a behavior to move the current character to the specified location, and stop when within the specified range.
static Composite	MoveAndStop (ValueRetriever< Vector3 > location, ValueRetriever< float > range, bool stopInRange=false, string destinationName=null, RunStatus stopStatus=RunStatus.Failure)
	Creates a behavior to move the current character to the specified location, and stop when within the specified range.
static Composite	MoveAndStop (ValueRetriever< Vector3 > location, ValueRetriever< float > range, bool stopInRange=false, ValueRetriever< string > destinationName=null, RunStatus stopStatus=RunStatus.Failure)
	Creates a behavior to move the current character to the specified location, and stop when within the specified range.
static Composite	MoveStop ()
	Creates a behavior to force all movement to stop for the current character. This will always return RunStatus.Success.
static Composite	Dismount ()
	Creates a behavior composite that dismounts the player if they are currently mounted.
static Composite	CreateMountBehavior (ValueRetriever< Vector3 > location)
	Creates a behavior that mounts the player if certain conditions are met.
static Composite	CreateSprintBehavior (ValueRetriever< Vector3 > location)
	Creates a behavior that triggers the sprint action under specific conditions.
static Composite	CreateSprintBehavior ()
	Creates mount behavior.
static Composite	CreateMountBehavior ()
	Creates mount behavior.
static Composite	CreateTeleportBehavior (ValueRetriever< uint > aetheryteId, ValueRetriever< uint > zoneId)
	Creates teleport behavior.
static Composite	CreateTeleportBehavior (ValueRetriever< uint > aetheryteId)
	Creates teleport behavior.
static Composite	MoveToLos (ValueRetriever< GameObject > unit, bool stopInLos=false)
	Creates a behavior to move the curreint character to line of sight with the specified character, and optionally stop when within LOS of the character.

Properties
static bool	IsLoading `[get]`
	Gets a value indicating whether the game is currently in a loading state.
static Composite	HandleLoading `[get]`
	Gets a TreeSharp.Composite that ensures the bot handles loading states gracefully.

Detailed Description

Provides a collection of common behaviors for movement, interaction, and other tasks within the game environment. These behaviors are designed to simplify and standardize frequently used operations, such as moving to a location, stopping, mounting, sprinting, and handling loading screens.

Member Function Documentation

◆ CreateMountBehavior() [1/2]

Composite ff14bot.Behavior.CommonBehaviors.CreateMountBehavior ( )

static

Creates mount behavior.

superreeen, 05.07.2013.

Returns: The new mount behavior.

◆ CreateMountBehavior() [2/2]

Composite ff14bot.Behavior.CommonBehaviors.CreateMountBehavior ( ValueRetriever< Vector3 > location )

static

Creates a behavior that mounts the player if certain conditions are met.

Parameters

location A function that retrieves the target location as a Clio.Utilities.Vector3.

Returns: A TreeSharp.Composite that represents the mount behavior.

The behavior will mount the player if the following conditions are met:

Mounting is enabled in the character settings.
The player is not already mounted.
The distance to the target location is greater than or equal to the configured mount distance.
The player does not currently have the "Sprint" aura.

◆ CreateSprintBehavior() [1/2]

Composite ff14bot.Behavior.CommonBehaviors.CreateSprintBehavior ( )

static

Creates mount behavior.

superreeen, 05.07.2013.

Returns: The new mount behavior.

◆ CreateSprintBehavior() [2/2]

Composite ff14bot.Behavior.CommonBehaviors.CreateSprintBehavior ( ValueRetriever< Vector3 > location )

static

Creates a behavior that triggers the sprint action under specific conditions.

Parameters

location A delegate that retrieves the target location as a Clio.Utilities.Vector3.

Returns: A TreeSharp.Composite that represents the sprint behavior.

The sprint behavior is executed only if the player is in a sanctuary, is not mounted, and the distance to the target location is greater than or equal to the mount distance specified in ff14bot.Settings.CharacterSettings.MountDistance.

◆ CreateTeleportBehavior() [1/2]

Composite ff14bot.Behavior.CommonBehaviors.CreateTeleportBehavior ( ValueRetriever< uint > aetheryteId )

static

Creates teleport behavior.

◆ CreateTeleportBehavior() [2/2]

Composite ff14bot.Behavior.CommonBehaviors.CreateTeleportBehavior	(	ValueRetriever< uint >	aetheryteId,
		ValueRetriever< uint >	zoneId )

static

Creates teleport behavior.

◆ Dismount()

Composite ff14bot.Behavior.CommonBehaviors.Dismount ( )

static

Creates a behavior composite that dismounts the player if they are currently mounted.

This method utilizes the ActionManager.Dismount to initiate the dismount process and includes a delay to ensure the dismount action completes.

Returns: A Composite that represents the dismount behavior.

◆ MoveAndStop() [1/3]

Composite ff14bot.Behavior.CommonBehaviors.MoveAndStop	(	ValueRetriever< Vector3 >	location,
		float	range,
		bool	stopInRange = false,
		string	destinationName = null,
		RunStatus	stopStatus = RunStatus::Failure )

static

Creates a behavior to move the current character to the specified location, and stop when within the specified range.

Created 3/11/2012.

Parameters

location	The location.
range	The range.
stopInRange	Whether to stop when within the specified range.
destinationName
stopStatus	If you are using this within a Sequence, you may want to change this to Success.

Returns: .

◆ MoveAndStop() [2/3]

Composite ff14bot.Behavior.CommonBehaviors.MoveAndStop	(	ValueRetriever< Vector3 >	location,
		ValueRetriever< float >	range,
		bool	stopInRange = false,
		string	destinationName = null,
		RunStatus	stopStatus = RunStatus::Failure )

static

Creates a behavior to move the current character to the specified location, and stop when within the specified range.

Created 3/11/2012.

Parameters

location	The location.
range	The range.
stopInRange	Whether to stop when within the specified range.
destinationName
stopStatus	If you are using this within a Sequence, you may want to change this to Success.

Returns: .

◆ MoveAndStop() [3/3]

Composite ff14bot.Behavior.CommonBehaviors.MoveAndStop	(	ValueRetriever< Vector3 >	location,
		ValueRetriever< float >	range,
		bool	stopInRange = false,
		ValueRetriever< string >	destinationName = null,
		RunStatus	stopStatus = RunStatus::Failure )

static

Creates a behavior to move the current character to the specified location, and stop when within the specified range.

Created 3/11/2012.

Parameters

location	The location.
range	The range.
stopInRange	Whether to stop when within the specified range.
destinationName
stopStatus	If you are using this within a Sequence, you may want to change this to Success.

Returns: .

◆ MoveStop()

Composite ff14bot.Behavior.CommonBehaviors.MoveStop ( )

static

Creates a behavior to force all movement to stop for the current character. This will always return RunStatus.Success.

Created 3/11/2012.

Returns: .

◆ MoveTo() [1/2]

Composite ff14bot.Behavior.CommonBehaviors.MoveTo	(	ValueRetriever< Vector3 >	location,
		string	destination = null,
		Composite	onFailed = null,
		ValueRetriever< TimeSpan >	timeout = null )

static

Creates a behavior to move the current character to the specified location. This will always return RunStatus.Success.

Parameters

location	The location.
destination	The destination name.
onFailed	A composite to run if path generation fails.
timeout	The timeout.

Returns

Created 3/11/2012.

◆ MoveTo() [2/2]

Composite ff14bot.Behavior.CommonBehaviors.MoveTo	(	ValueRetriever< Vector3 >	location,
		ValueRetriever< string >	destination,
		Composite	onFailed = null,
		ValueRetriever< TimeSpan >	timeout = null )

static

Creates a behavior to move the current character to the specified location. This will always return RunStatus.Success.

Parameters

location	The location.
destination	The destination name.
onFailed	A composite to run if path generation fails.
timeout	The timeout.

Returns

Created 3/11/2012.

◆ MoveToLos()

Composite ff14bot.Behavior.CommonBehaviors.MoveToLos	(	ValueRetriever< GameObject >	unit,
		bool	stopInLos = false )

static

Creates a behavior to move the curreint character to line of sight with the specified character, and optionally stop when within LOS of the character.

Created 3/11/2012.

Parameters

unit	The unit.
stopInLos	(optional) the stop in range.

Returns: .

Property Documentation

◆ HandleLoading

Composite ff14bot.Behavior.CommonBehaviors.HandleLoading

staticget

Gets a TreeSharp.Composite that ensures the bot handles loading states gracefully.

This property is commonly used in behavior trees to pause or bypass execution while the game is in a loading state.

◆ IsLoading

bool ff14bot.Behavior.CommonBehaviors.IsLoading

staticget

Gets a value indicating whether the game is currently in a loading state.

true if the game is loading; otherwise, false.

This property checks multiple conditions to determine if the game is in a loading state:

Whether movement is locked.
Whether the revive state is set to reviving.
Whether the "Now Loading" UI element is visible.

Static Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ CreateMountBehavior() [1/2]

◆ CreateMountBehavior() [2/2]

◆ CreateSprintBehavior() [1/2]

◆ CreateSprintBehavior() [2/2]

◆ CreateTeleportBehavior() [1/2]

◆ CreateTeleportBehavior() [2/2]

◆ Dismount()

◆ MoveAndStop() [1/3]

◆ MoveAndStop() [2/3]

◆ MoveAndStop() [3/3]

◆ MoveStop()

◆ MoveTo() [1/2]

◆ MoveTo() [2/2]

◆ MoveToLos()

Property Documentation

◆ HandleLoading

◆ IsLoading