ff14bot.AClasses.CombatRoutine Class Reference

Represents an abstract base class for creating combat routines in the bot. More...

Inheritance diagram for ff14bot.AClasses.CombatRoutine:

Public Member Functions
void	Dispose ()
virtual void	Initialize ()
	Function that gets called when the routine is started.
virtual void	OnButtonPress ()
	Called when the gui button is pressed.
virtual void	Pulse ()
	Called every tick of the bot.
virtual void	ShutDown ()
	Called when the routine is being switched out.
override string	ToString ()
bool	HasCapability (CapabilityFlags capability)
	Determines whether the Combat Routine has the given capability/capabilities. It is assumed that capabilities can be toggled if available.

Protected Member Functions
CapabilityState	GetCapabilityState (CapabilityFlags capability)
	Returns the state of a capability. This can only be used by the combat routine.

Properties
float	PullRange [get]
	Pull range for the routine.
string	ButtonText [get]
	Text of the button in the gui.
ClassJobType[]	Class [get]
	Which classes the routine supports.
virtual Composite	CombatBehavior [get, set]
	Gets the combat behavior composite that handles the main combat rotation.
virtual Composite	CombatBuffBehavior [get, set]
	Gets the combat buff behavior composite that handles buff application during combat.
virtual Composite	DeathBehavior [get, set]
	Gets the death behavior composite that handles actions when the character dies.
virtual Composite	HealBehavior [get, set]
	Gets the heal behavior composite that handles healing actions.
virtual Composite	PullBuffBehavior [get, set]
	Gets the pull buff behavior composite that handles buff application during the pull phase.
virtual Composite	RestBehavior [get, set]
	Gets the rest behavior composite that handles actions during rest periods.
virtual Composite	PreCombatBuffBehavior [get, set]
	Gets the pre-combat buff behavior composite that handles buff application before entering combat.
virtual Composite	PullBehavior [get]
	Gets the pull behavior composite that handles pulling enemies into combat.
string	Name [get]
	Name of the routine.
virtual bool	WantButton [get]
	Does the combat routine support configuration.
virtual CapabilityFlags	SupportedCapabilities [get]
	Gets the currently supported capabilities ORed together. This should use the current dynamic state of the capabilities but not the state returned by GetCapabilityState

Detailed Description

Represents an abstract base class for creating combat routines in the bot.

This class provides a framework for defining behaviors and capabilities for combat routines, including combat, healing, pulling, and other related actions. It also supports configuration and initialization of routines.

See also

ff14bot.Interfaces.ICombatRoutine, System.MarshalByRefObject

Member Function Documentation

Dispose()

void ff14bot.AClasses.CombatRoutine.Dispose

(

)

GetCapabilityState()

CapabilityState ff14bot.AClasses.CombatRoutine.GetCapabilityState ( CapabilityFlags capability )

protected

Returns the state of a capability. This can only be used by the combat routine.

Parameters

capability

The capability.

Returns

The state of a capability.

See RoutineManager.GetCapabilityState.

HasCapability()

bool ff14bot.AClasses.CombatRoutine.HasCapability

(

CapabilityFlags

capability

)

Determines whether the Combat Routine has the given capability/capabilities. It is assumed that capabilities can be toggled if available.

Parameters

capability

The capability.

Returns

true if CombatRoutine supports the capability/capabilities. If multiple capabilities are ORed together then true is returned only if CombatRoutine supports ALL of them; otherwise false is returned.

Initialize()

virtual void ff14bot.AClasses.CombatRoutine.Initialize ( )

virtual

Function that gets called when the routine is started.

Implements ff14bot.Interfaces.ICombatRoutine.

Reimplemented in ff14bot.Managers.InvalidRoutineWrapper.

OnButtonPress()

virtual void ff14bot.AClasses.CombatRoutine.OnButtonPress ( )

virtual

Called when the gui button is pressed.

Implements ff14bot.Interfaces.ICombatRoutine.

Pulse()

virtual void ff14bot.AClasses.CombatRoutine.Pulse ( )

virtual

Called every tick of the bot.

Implements ff14bot.Interfaces.ICombatRoutine.

ShutDown()

virtual void ff14bot.AClasses.CombatRoutine.ShutDown ( )

virtual

Called when the routine is being switched out.

Implements ff14bot.Interfaces.ICombatRoutine.

ToString()

override string ff14bot.AClasses.CombatRoutine.ToString

(

)

Property Documentation

ButtonText

string ff14bot.AClasses.CombatRoutine.ButtonText

get

Text of the button in the gui.

Implements ff14bot.Interfaces.ICombatRoutine.

Class

ClassJobType [] ff14bot.AClasses.CombatRoutine.Class

getabstract

Which classes the routine supports.

Implements ff14bot.Interfaces.ICombatRoutine.

CombatBehavior

virtual Composite ff14bot.AClasses.CombatRoutine.CombatBehavior

getset

Gets the combat behavior composite that handles the main combat rotation.

Implements ff14bot.Interfaces.IBehaviors.

CombatBuffBehavior

virtual Composite ff14bot.AClasses.CombatRoutine.CombatBuffBehavior

getset

Gets the combat buff behavior composite that handles buff application during combat.

Implements ff14bot.Interfaces.IBehaviors.

DeathBehavior

virtual Composite ff14bot.AClasses.CombatRoutine.DeathBehavior

getset

Gets the death behavior composite that handles actions when the character dies.

Implements ff14bot.Interfaces.IBehaviors.

HealBehavior

virtual Composite ff14bot.AClasses.CombatRoutine.HealBehavior

getset

Gets the heal behavior composite that handles healing actions.

Implements ff14bot.Interfaces.IBehaviors.

Name

string ff14bot.AClasses.CombatRoutine.Name

getabstract

Name of the routine.

Implements ff14bot.Interfaces.ICombatRoutine.

PreCombatBuffBehavior

virtual Composite ff14bot.AClasses.CombatRoutine.PreCombatBuffBehavior

getset

Gets the pre-combat buff behavior composite that handles buff application before entering combat.

Implements ff14bot.Interfaces.IBehaviors.

PullBehavior

virtual Composite ff14bot.AClasses.CombatRoutine.PullBehavior

get

Gets the pull behavior composite that handles pulling enemies into combat.

Implements ff14bot.Interfaces.IBehaviors.

PullBuffBehavior

virtual Composite ff14bot.AClasses.CombatRoutine.PullBuffBehavior

getset

Gets the pull buff behavior composite that handles buff application during the pull phase.

Implements ff14bot.Interfaces.IBehaviors.

PullRange

float ff14bot.AClasses.CombatRoutine.PullRange

getabstract

Pull range for the routine.

Implements ff14bot.Interfaces.ICombatRoutine.

RestBehavior

virtual Composite ff14bot.AClasses.CombatRoutine.RestBehavior

getset

Gets the rest behavior composite that handles actions during rest periods.

Implements ff14bot.Interfaces.IBehaviors.

SupportedCapabilities

virtual CapabilityFlags ff14bot.AClasses.CombatRoutine.SupportedCapabilities

get

Gets the currently supported capabilities ORed together. This should use the current dynamic state of the capabilities but not the state returned by GetCapabilityState

// Example of how to indicate that the Combat Routine supports all capabilities except summoning pet.

public virtual CombatRoutineCapability SupportedCapabilities
{
    get
    {
        return CombatRoutineCapability.All & ~CombatRoutineCapability.PetSummoning; 
    }
}

WantButton

virtual bool ff14bot.AClasses.CombatRoutine.WantButton

get

Does the combat routine support configuration.

Implements ff14bot.Interfaces.ICombatRoutine.