Click or drag to resize
CombatRoutine Class
A combat routine.
Inheritance Hierarchy

Namespace: Styx.CommonBot.Routines
Assembly: Styx (in Styx.dll) Version: 3.0.1160.0 (3.0.1160)
Syntax
C#
public abstract class CombatRoutine

The CombatRoutine type exposes the following members.

Constructors
  NameDescription
Protected methodCombatRoutine
Initializes a new instance of the CombatRoutine class
Top
Properties
  NameDescription
Public propertyButtonText
The text to appear on the button in the form. [Default: "CC Configuration"].
Public propertyClass
The WoWClass to be used with this routine.
Public propertyCombatBehavior
Behavior used in combat.
Public propertyCombatBuffBehavior
Behavior used for combat buffs. eg; 'Horn of Winter', 'Power Infusion' etc..
Public propertyDeathBehavior
Behavior used when death. This should be used to handle things like Soulstones etc. This will block the execution of DeathBehavior of the bot when it returns RunStatus.Success
Public propertyHealBehavior
Behavior used when healing.
Public propertyMoveToTargetBehavior
Behavior used for moving to targets.
Public propertyName
The name of this CombatRoutine.
Public propertyNeedCombatBuffs
Property indicating if you need combat buffs.
Public propertyNeedDeath
Whether or not to handle being dead. For casting special abilities (Soulstone, Ankh, etc)
Public propertyNeedHeal
Property indicating if you to heal.
Public propertyNeedPreCombatBuffs
Property indicating if you need PreCombatBuffs.
Public propertyNeedPullBuffs
Property indicating if you need Pull Buffs.
Public propertyNeedRest
Property indicating if you need to rest.
Public propertyPreCombatBuffBehavior
Behavior used for buffing, regular buffs like 'Power Word: Fortitude', 'MotW' etc..
Public propertyPullBehavior
Behavior used when engaging mobs in combat.
Public propertyPullBuffBehavior
Behavior used when buffing prior to pulling.
Public propertyPullDistance
Gets the pull distance. This is the range at which the combat routine is able to pull a mob.
Public propertyRestBehavior
Behavior used when resting.
Public propertyCode exampleSupportedCapabilities
Gets the currently supported capabilities ORed together. This should use the current dynamic state of the capabilities but not the state returned by GetCapabilityState(CapabilityFlags)
Public propertyWantButton
Whether this CC want the button on the form to be enabled.
Top
Methods
  NameDescription
Public methodCombat
Combat actions.
Public methodCombatBuff
Combat buff actions.
Public methodDeath
Death actions.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetCapabilityState
Returns the state of a capability. This can only be used by the combat routine
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasCapability
Determines whether the Combat Routine has the given capability/capabilities. It is assumed that capabilities can be toggled if available.
Public methodHeal
Heal actions.
Public methodInitialize
Called when this CC is selected as the current CC.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodOnButtonPress
Called when the button for this CC is pressed.
Public methodPreCombatBuff
PreCombatBuff actions.
Public methodPull
Pull actions.
Public methodPullBuff
Pull Buff actions.
Public methodPulse
Called in every pulse of the bot. This way you can maintain stuff per-pulse like a plugin.
Public methodRest
Rest actions.
Public methodShutDown
Called when this routine is disposed.
Public methodToString
Returns a String that represents the current Object.
(Overrides ObjectToString.)
Top
See Also