Class Macro

BALLS macro builder for direct submission to KoL. Create a new macro with new Macro() and add steps using the instance methods. Uses a fluent interface, so each step returns the object for easy chaining of steps. Each method is also defined as a static method that creates a new Macro with only that step. For example, you can do Macro.skill('Saucestorm').attack().

Hierarchy (View Summary)

Macro
- StrictMacro

Constructors

constructor

new Macro(): Macro
Returns Macro

Properties

components

components: string[] = []

name

name: string = MACRO_NAME

`Static`cachedAutoAttacks

cachedAutoAttacks: Map<string, string> = ...

`Static`cachedMacroIds

cachedMacroIds: Map<string, number> = ...

`Static`SAVED_MACRO_PROPERTY

SAVED_MACRO_PROPERTY: string = "libram_savedMacro"

Methods

abort

abort(): this
Add an "abort" step to this macro.

Returns this
This object itself.
- Defined in src/combat.ts:357

abortWithWarning

abortWithWarning(warning: string): this
Adds an "abort" step to this macro, with a warning message to print
Parameters
- warning: string
  The warning message to print
Returns this
This object itself.
- Defined in src/combat.ts:376

attack

attack(): this
Add an attack step to the macro.

Returns this
This object itself.
- Defined in src/combat.ts:797

externalIf

externalIf(
    condition: boolean,
    ifTrue: string | Macro,
    ifFalse?: string | Macro,
): this
Conditionally add a step to a macro based on a condition evaluated at the time of building the macro.
Parameters
- condition: boolean
  The JS condition.
- ifTrue: string | Macro
  Continuation to add if the condition is true.
- OptionalifFalse: string | Macro
  Optional input to turn this into an if...else statement.
Returns this
This object itself.
- Defined in src/combat.ts:556

funkslingItem

funkslingItem(...items: ItemOrName[]): this
Add one or more item steps to the macro, and automatically attempting to funksling as many of the items as possible. This function does not check if you can funksling or not.
Parameters
- ...items: ItemOrName[]
  Items to use.
Returns this
This object itself.
- Defined in src/combat.ts:747

if_

if_(condition: PreBALLSPredicate, ifTrue: string | Macro): this
Add an "if" statement to this macro.
Parameters
- condition: PreBALLSPredicate
  The BALLS condition for the if statement.
- ifTrue: string | Macro
  Continuation if the condition is true.
Returns this
This object itself.
- Defined in src/combat.ts:474

ifHolidayWanderer

ifHolidayWanderer(macro: Macro): this
Create an if_ statement based on what holiday of loathing it currently is. On non-holidays, returns the original macro, unmutated.
Parameters
- macro: Macro
  The macro to place in the if_ statement
Returns this
This macro with supplied macro wapped in if statement matching holiday wanderers
- Defined in src/combat.ts:816

ifNot

ifNot(condition: PreBALLSPredicate, ifTrue: string | Macro): this
Add an "if" statement to this macro, inverting the condition.
Parameters
- condition: PreBALLSPredicate
  The BALLS condition for the if statement.
- ifTrue: string | Macro
  Continuation if the condition is true.
Returns this
This object itself.
- Defined in src/combat.ts:502

ifNotHolidayWanderer

ifNotHolidayWanderer(macro: Macro): this
Create an if_ statement based on what holiday of loathing it currently is. On non-holidays, returns the original macro, with the input macro appended.
Parameters
- macro: Macro
  The macro to place in the if_ statement.
Returns this
This macro with supplied macro wrapped in if statement matching monsters that are not holiday wanderers
- Defined in src/combat.ts:843

item

item(...items: (ItemOrName | [ItemOrName, ItemOrName])[]): this
Add one or more item steps to the macro.
Parameters
- ...items: (ItemOrName | [ItemOrName, ItemOrName])[]
  Items to use. Pass a tuple [item1, item2] to funksling.
Returns this
This object itself.
- Defined in src/combat.ts:689

rename

rename(name: string): this
Gives your macro a new name to be used when saving an autoattack.
Parameters
- name: string
  The name to be used when saving as an autoattack.
Returns this
The macro in question
- Defined in src/combat.ts:219

repeat

repeat(condition?: PreBALLSPredicate): this
Add a repeat step to the macro.
Parameters
- Optionalcondition: PreBALLSPredicate
  The BALLS condition for the repeat statement, optional.
Returns this
This object itself.
- Defined in src/combat.ts:589

runaway

runaway(): this
Add a "runaway" step to this macro.

Returns this
This object itself.
- Defined in src/combat.ts:398

save

save(): void
Save a macro to a Mafia property for use in a consult script.

Returns void
- Defined in src/combat.ts:237

setAutoAttack

setAutoAttack(): void
Set this macro as a KoL native autoattack.

Returns void
- Defined in src/combat.ts:301

setAutoAttackAs

setAutoAttackAs(name: string): void
Renames the macro, then sets it as an autoattack.
Parameters
- name: string
  The name to save the macro under as an autoattack.
Returns void
- Defined in src/combat.ts:333

skill

skill(...skills: SkillOrName[]): this
Add one or more skill cast steps to the macro.
Parameters
- ...skills: SkillOrName[]
  Skills to cast.
Returns this
This object itself.
- Defined in src/combat.ts:601

step

step(...nextSteps: (string | Macro)[]): this
Statefully add one or several steps to a macro.
Parameters
- ...nextSteps: (string | Macro)[]
  The steps to add to the macro.
Returns this
This object itself.
- Defined in src/combat.ts:263

submit

submit(): string
Submit the built macro to KoL. Only works inside combat.

Returns string
Contents of the fight page after macro submission
- Defined in src/combat.ts:289

toString

toString(): string
Convert macro to string.

Returns string
BALLS macro
- Defined in src/combat.ts:209

tryFunkslingItem

tryFunkslingItem(...items: ItemOrName[]): this
Add one or more item steps to the macro, where each step checks to see if you have the item first, and automatically attempting to funksling as many of the items as possible. This function does not check if you can funksling or not.
Parameters
- ...items: ItemOrName[]
  Items to use.
Returns this
This object itself.
- Defined in src/combat.ts:773

tryItem

tryItem(...items: (ItemOrName | [ItemOrName, ItemOrName])[]): this
Add one or more item steps to the macro, where each step checks to see if you have the item first.
Parameters
- ...items: (ItemOrName | [ItemOrName, ItemOrName])[]
  Items to try using. Pass a tuple [item1, item2] to funksling.
Returns this
This object itself.
- Defined in src/combat.ts:716

trySkill

trySkill(...skills: SkillOrName[]): this
Add one or more skill cast steps to the macro, where each step checks if you have the skill first.
Parameters
- ...skills: SkillOrName[]
  Skills to try casting.
Returns this
This object itself.
- Defined in src/combat.ts:628

trySkillRepeat

trySkillRepeat(...skills: SkillOrName[]): this
Add one or more skill-cast-and-repeat steps to the macro, where each step checks if you have the skill first.
Parameters
- ...skills: SkillOrName[]
  Skills to try repeatedly casting.
Returns this
This object itself.
- Defined in src/combat.ts:657

while_

while_(condition: PreBALLSPredicate, contents: string | Macro): this
Add a "while" statement to this macro.
Parameters
- condition: PreBALLSPredicate
  The BALLS condition for the while statement.
- contents: string | Macro
  Loop to repeat while the condition is true.
Returns this
This object itself.
- Defined in src/combat.ts:527

`Static`abort

abort<T extends Macro>(this: Constructor<T>): T
Create a new macro with an "abort" step.
Type Parameters
- T extends Macro
Parameters
- this: Constructor<T>
Returns T
This object itself.
- Defined in src/combat.ts:366

`Static`abortWithWarning

abortWithWarning<T extends Macro>(this: Constructor<T>, warning: string): T
Create a new macro with an "abort" step to this macro, with a warning message to print
Type Parameters
- T extends Macro
Parameters
- this: Constructor<T>
- warning: string
  The warning message to print
Returns T
This object itself.
- Defined in src/combat.ts:386

`Static`attack

attack<T extends Macro>(this: Constructor<T>): T
Create a new macro with an attack step.
Type Parameters
- T extends Macro
Parameters
- this: Constructor<T>
Returns T
This object itself.
- Defined in src/combat.ts:806

`Static`clearAutoAttackMacros

clearAutoAttackMacros(): void
Clear all cached autoattacks, and delete all stored macros server-side.

Returns void
- Defined in src/combat.ts:341

`Static`clearSaved

clearSaved(): void
Clear the saved macro in the Mafia property.

Returns void
- Defined in src/combat.ts:253

`Static`externalIf

externalIf<T extends Macro>(
    this: Constructor<T>,
    condition: boolean,
    ifTrue: string | Macro,
    ifFalse?: string | Macro,
): T
Create a new macro with a condition evaluated at the time of building the macro.
Type Parameters
- T extends Macro
Parameters
- this: Constructor<T>
- condition: boolean
  The JS condition.
- ifTrue: string | Macro
  Continuation to add if the condition is true.
- OptionalifFalse: string | Macro
  Optional input to turn this into an if...else statement.
Returns T
This object itself.
- Defined in src/combat.ts:574

`Static`funkslingItem

funkslingItem<T extends Macro>(this: Constructor<T>, ...items: ItemOrName[]): T
Create a new macro with one or more item steps, and automatically attempting to funksling as many of the items as possible. This function does not check if you can funksling or not.
Type Parameters
- T extends Macro
Parameters
- this: Constructor<T>
- ...items: ItemOrName[]
  Items to use.
Returns T
This object itself.
- Defined in src/combat.ts:758

`Static`if_

if_<T extends Macro>(
    this: Constructor<T>,
    condition: PreBALLSPredicate,
    ifTrue: string | Macro,
): T
Create a new macro with an "if" statement.
Type Parameters
- T extends Macro
Parameters
- this: Constructor<T>
- condition: PreBALLSPredicate
  The BALLS condition for the if statement.
- ifTrue: string | Macro
  Continuation if the condition is true.
Returns T
This object itself.
- Defined in src/combat.ts:487

`Static`ifHolidayWanderer

ifHolidayWanderer<T extends Macro>(this: Constructor<T>, macro: Macro): T
Create a new macro starting with an ifHolidayWanderer step.
Type Parameters
- T extends Macro
Parameters
- this: Constructor<T>
- macro: Macro
  The macro to place inside the if_ statement
Returns T
New macro with supplied macro wrapped in if statement matching holiday wanderers
- Defined in src/combat.ts:830

`Static`ifNot

ifNot<T extends Macro>(
    this: Constructor<T>,
    condition: PreBALLSPredicate,
    ifTrue: string | Macro,
): T
Create a new macro with an "if" statement, inverting the condition.
Type Parameters
- T extends Macro
Parameters
- this: Constructor<T>
- condition: PreBALLSPredicate
  The BALLS condition for the if statement.
- ifTrue: string | Macro
  Continuation if the condition is true.
Returns T
This object itself.
- Defined in src/combat.ts:512

`Static`ifNotHolidayWanderer

ifNotHolidayWanderer<T extends Macro>(this: Constructor<T>, macro: Macro): T
Create a new macro starting with an ifNotHolidayWanderer step.
Type Parameters
- T extends Macro
Parameters
- this: Constructor<T>
- macro: Macro
  The macro to place inside the if_ statement
Returns T
New macro with supplied macro wrapped in if statement matching monsters that are not holiday wanderers
- Defined in src/combat.ts:857

`Static`item

item<T extends Macro>(
this: Constructor<T>,
...items: (ItemOrName | [ItemOrName, ItemOrName])[],
): T
Create a new macro with one or more item steps.
Type Parameters
- T extends Macro
Parameters
- this: Constructor<T>
- ...items: (ItemOrName | [ItemOrName, ItemOrName])[]
  Items to use. Pass a tuple [item1, item2] to funksling.
Returns T
This object itself.
- Defined in src/combat.ts:703

`Static`load

load<T extends Macro>(this: Constructor<T>): T
Load a saved macro from the Mafia property.
Type Parameters
- T extends Macro
Parameters
- this: Constructor<T>
Returns T
Loaded macro text
- Defined in src/combat.ts:246

`Static`makeBALLSPredicate

makeBALLSPredicate(condition: PreBALLSPredicate): string
Parameters
- condition: PreBALLSPredicate
  The BALLS condition or a type to make a condition for (Monster, Item, Skill, etc.)
Returns string
The BALLS condition string
- Defined in src/combat.ts:416

`Static`rename

rename<T extends Macro>(this: Constructor<T>, name: string): T
Creates a new Macro with a name other than the default name.
Type Parameters
- T extends Macro
Parameters
- this: Constructor<T>
- name: string
  The name to assign this macro.
Returns T
A new Macro with the assigned name.
- Defined in src/combat.ts:230

`Static`runaway

runaway<T extends Macro>(this: Constructor<T>): T
Create a new macro with an "runaway" step.
Type Parameters
- T extends Macro
Parameters
- this: Constructor<T>
Returns T
This object itself.
- Defined in src/combat.ts:407

`Static`skill

skill<T extends Macro>(this: Constructor<T>, ...skills: SkillOrName[]): T
Create a new macro with one or more skill cast steps.
Type Parameters
- T extends Macro
Parameters
- this: Constructor<T>
- ...skills: SkillOrName[]
  Skills to cast.
Returns T
This object itself.
- Defined in src/combat.ts:615

`Static`step

step<T extends Macro>(this: Constructor<T>, ...nextSteps: (string | Macro)[]): T
Statefully add one or several steps to a macro.
Type Parameters
- T extends Macro
Parameters
- this: Constructor<T>
- ...nextSteps: (string | Macro)[]
  The steps to add to the macro.
Returns T
This object itself.
- Defined in src/combat.ts:277

`Static`tryFunkslingItem

tryFunkslingItem<T extends Macro>(
this: Constructor<T>,
...items: ItemOrName[],
): T
Create a new macro with one or more item steps, where each step checks to see if you have the item first, and automatically attempting to funksling as many of the items as possible. This function does not check if you can funksling or not.
Type Parameters
- T extends Macro
Parameters
- this: Constructor<T>
- ...items: ItemOrName[]
  Items to use.
Returns T
This object itself.
- Defined in src/combat.ts:785

`Static`tryItem

tryItem<T extends Macro>(
this: Constructor<T>,
...items: (ItemOrName | [ItemOrName, ItemOrName])[],
): T
Create a new macro with one or more item steps, where each step checks to see if you have the item first.
Type Parameters
- T extends Macro
Parameters
- this: Constructor<T>
- ...items: (ItemOrName | [ItemOrName, ItemOrName])[]
  Items to try using. Pass a tuple [item1, item2] to funksling.
Returns T
This object itself.
- Defined in src/combat.ts:733

`Static`trySkill

trySkill<T extends Macro>(this: Constructor<T>, ...skills: SkillOrName[]): T
Create a new macro with one or more skill cast steps, where each step checks if you have the skill first.
Type Parameters
- T extends Macro
Parameters
- this: Constructor<T>
- ...skills: SkillOrName[]
  Skills to try casting.
Returns T
This object itself.
- Defined in src/combat.ts:644

`Static`trySkillRepeat

trySkillRepeat<T extends Macro>(
this: Constructor<T>,
...skills: SkillOrName[],
): T
Create a new macro with one or more skill-cast-and-repeat steps, where each step checks if you have the skill first.
Type Parameters
- T extends Macro
Parameters
- this: Constructor<T>
- ...skills: SkillOrName[]
  Skills to try repeatedly casting.
Returns T
This object itself.
- Defined in src/combat.ts:676

`Static`while_

while_<T extends Macro>(
    this: Constructor<T>,
    condition: PreBALLSPredicate,
    contents: string | Macro,
): T
Create a new macro with a "while" statement.
Type Parameters
- T extends Macro
Parameters
- this: Constructor<T>
- condition: PreBALLSPredicate
  The BALLS condition for the while statement.
- contents: string | Macro
  Loop to repeat while the condition is true.
Returns T
This object itself.
- Defined in src/combat.ts:540

Class Macro

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Macro

Properties

components

name

StaticcachedAutoAttacks

StaticcachedMacroIds

StaticSAVED_MACRO_PROPERTY

Methods

abort

Returns this

abortWithWarning

Parameters

Returns this

attack

Returns this

externalIf

Parameters

Returns this

funkslingItem

Parameters

Returns this

if_

Parameters

Returns this

ifHolidayWanderer

Parameters

Returns this

ifNot

Parameters

Returns this

ifNotHolidayWanderer

Parameters

Returns this

item

Parameters

Returns this

rename

Parameters

Returns this

repeat

Parameters

Returns this

runaway

Returns this

save

Returns void

setAutoAttack

Returns void

setAutoAttackAs

Parameters

Returns void

skill

Parameters

Returns this

step

Parameters

Returns this

submit

Returns string

toString

Returns string

tryFunkslingItem

Parameters

Returns this

tryItem

Parameters

Returns this

trySkill

Parameters

Returns this

trySkillRepeat

Parameters

`Static`cachedAutoAttacks

`Static`cachedMacroIds

`Static`SAVED_MACRO_PROPERTY

`Static`abort

`Static`abortWithWarning

`Static`attack

`Static`clearAutoAttackMacros

`Static`clearSaved

`Static`externalIf

`Static`funkslingItem

`Static`if_

`Static`ifHolidayWanderer

`Static`ifNot

`Static`ifNotHolidayWanderer

`Static`item

`Static`load

`Static`makeBALLSPredicate

`Static`rename

`Static`runaway

`Static`skill

`Static`step