[align=center]Top Base A B C D E F G H I J K L M N O P Q R S T U V W X Y Z Variables[/align]
CastSpell
Cast a spell by name or ID. The character must have a casting device equipped and be in spell casting stance. The spell does not need to be on any spell bars but it does need to be in the characters spellbook. No check is made to determine if the character has the proper spell components, has a sufficient skill level, or whether the spell can be cast on the Target.
When the CastSpellDelay value is greater than 0, AC Tool will wait until spell casting is complete (_SpellReady is set to 1) or until the CastSpellTimeout value has been reached.
Syntax
CastSpell Spell, Target
- Spell - (Required) - Spell name or ID.
- Target - (Optional - Default: Selected Object) - Name, Partial Name, or GUID of the target.
Returns
- {PluginResult}
- OK = Successful
- INVALID STANCE = The character is not in spellcasting stance
- INVALID SPELL = The spell is not known by the character
- INVALID TARGET = Target could not be located
Example
Code: Select all
CastSpell Strength Other I, Phinius
CastSpell Strength Other I
CastSpell 1, Phin*
CastSpellEx
Cast a spell by name or ID. The character must have a casting device equipped and be in spell casting stance. The spell does not need to be on any spell bars but it does need to be in the characters spellbook. No check is made to determine if the character has the proper spell components, has a sufficient skill level, or whether the spell can be cast on the Target.
When the CastSpellDelay value is greater than 0, AC Tool will wait until spell casting is complete (_PointerState is Idle) or until the CastSpellTimeout value has been reached.
Syntax
CastSpellEx Spell, Target
- Spell - (Required) - Spell name or ID.
- Target - (Optional - Default: Selected Object) - Name, Partial Name, or GUID of the target.
Returns
- {PluginResult}
- OK = Successful
- INVALID STANCE = The character is not in spellcasting stance
- INVALID SPELL = The spell is not known by the character
- INVALID TARGET = Target could not be located
Example
Code: Select all
CastSpellEx Strength Other I, Phinius
CastSpellEx Strength Other I
CastSpellEx 1, Phin*
CastSpellRaw
Cast a spell by name or ID. The character must have a casting device equipped and be in spell casting stance. The spell does not need to be on any spell bars but it does need to be in the characters spellbook. No check is made to determine if the character has the proper spell components, has a sufficient skill level, or whether the spell can be cast on the Target.
AC Tool does not wait for spell casting to complete and the CastSpellDelay and CastSpellTimeout values are ignored.
Syntax
CastSpellRaw Spell, Target
- Spell - (Required) - Spell name or ID.
- Target - (Optional - Default: Selected Object) - Name, Partial Name, or GUID of the target.
Returns
- {PluginResult}
- OK = Successful
- INVALID STANCE = The character is not in spellcasting stance
- INVALID SPELL = The spell is not known by the character
- INVALID TARGET = Target could not be located
Example
Code: Select all
CastSpellRaw Strength Other I, Phinius
CastSpellRaw Strength Other I
CastSpellRaw 1, Phin*
CastSpellRoot
Cast a spell by root name and spell level. The character must have a casting device equipped and be in spell casting stance. The spell does not need to be on any spell bars but it does need to be in the characters spellbook. No check is made to determine if the character has the proper spell components, has a sufficient skill level, or whether the spell can be cast on the Target.
Syntax
CastSpellRoot Root, Level, Target
- Root - (Required) - Spell root name.
- Level - (Required) - Spell level.
- Target - (Optional - Default: Selected Object) - Name, Partial Name, or GUID of the target.
Returns
- {PluginResult}
- OK = Successful
- INVALID STANCE = The character is not in spellcasting stance
- INVALID SPELL = The spell is not known by the character
- INVALID TARGET = Target could not be located
Example
Code: Select all
CastSpellRoot Strength Other, 1, Phinius
CastSpellRoot Strength Other, 1
CastSpellRoot Strength Other, 1, Phin*
CastSpellDelay
Set the amount of time that AC Tool will wait after casting a spell. When a non-zero value is specified, AC Tool will wait until spellcasting is complete and for an additional amount of time specified by this command. Not all CastSpell commands are affected by this value. This value is set to 0 when the macro is started.
Syntax
CastSpellDelay Time
- Time - (Required) - Amount of time (in milliseconds) that AC Tool should wait once spellcasting is complete.
Example
CastSpellTimeout
Set the amount of time that AC Tool will wait for spellcasting to complete. When this timeout value has been reached AC Tool continues macro execution even if spellcasting has not completed. This value is set to 5000 when the macro is started.
Syntax
CastSpellTimeout Time
- Time - (Required) - Amount of time (in milliseconds) that AC Tool should wait for spellcasting to complete.
Example
ClearPluginVar
Clear a Companion Variable and reset it to a default value. Not all Companion Variables can be cleared. Some variables represent realtime values which will populate whenever they are referenced.
The default value is based upon the data type that the variable normally contains. String variables are reset to an empty string and numeric variables are reset to 0.
Syntax
ClearPluginVar Variable
- Variable - (Required) - Name of the variable. Include the underscore (_) character.
Example
CmdAdd
Add a custom command that can be used from the game chat box.
Custom commands function in a similar manner to the /actcmd plugin command but do not require /actcmd to be entered each time. Custom commands generate an ACTCmd macro event with a command name of CustomCommand. {ActCmdCmd} contains the command entered and {ActCmdParam} contains any parameters entered after the command.
Syntax
CmdAdd Command
- Command - (Required) - Command to add. Include any prefix characters such as /, !, @, #, etc.
Returns
- {PluginResult}
- OK = Successful
- ALREADY EXISTS = The command already exists
- INVALID COMMAND = The command was not specified
Example
Code: Select all
CmdAdd /buff
// This procedure is executed whenever a custom command is entered in the game.
// Enter /buff in the game chat box.
Procedure CustomCommands on ACTCMD CUSTOMCOMMAND
SendText 13, Command= {ActCmdCmd}
SendText 13, Params= {ActCmdParam}
End
CmdClear
Remove all custom commands defined with the CmdAdd command.
Syntax
CmdClear
CmdRemove
Remove a specific custom command defined with the CmdAdd command.
Syntax
CmdRemove Command
- Command - (Required) - Command to remove. Include any prefix characters such as /, !, @, #, etc.
Returns
- {PluginResult}
- OK = Successful
- INVALID COMMAND = Command is not defined or was not specified
Example
CommandText
Read a command from the game chat box. AC Tool will wait for the command to be entered.
Syntax
CommandText
Returns
- _Commandtext
- Text entered in the game chat box
Example
Code: Select all
CommandText
SendText 13, Text= _CommandText