Misc commands

cmd.beep

Beeps the specified number of times.

Parameter	Type	Description
times	number?	How many times to beep.

cmd.buff

Buffs by casting the first 3 skills, or the provided skill set.

Parameter	Type	Optional	Default	Description
skillList	number[]	✓	...	The optional skill set to use for buffing. Set to null to use the default skill set (1, 2, 3).
wait	boolean	✓	false	Whether to wait for a skill to be ready before going to the next one.

cmd.buy_lifesteal

Buys the specified quantity of Scroll of Life Steal.

Parameter	Type	Description
qty	number	The quantity to buy.

cmd.buy_scroll_of_enrage

Parameter	Type	Description
qty	number

cmd.close_window

Closes the window.

cmd.delay

Delays command execution for a specified amount of time.

Parameter	Type	Description
ms	number	The delay in milliseconds.

cmd.disable_anticounter

Disables the anti-counter attack setting.

cmd.disable_autorelogin

Disables Auto Relogin.

cmd.disable_collisions

Disables the “Disable collisions” setting.

cmd.disable_death_ads

Enables the “Disable death ads” setting.

cmd.disable_enemymagnet

Disables the “Enemy magnet” setting.

cmd.disable_fx

Disables the “Disable FX” setting.

cmd.disable_hideplayers

Disables the “Hide players” setting.

cmd.disable_infiniterange

Disables the “Infinite range” setting.

cmd.disable_lagkiller

Disables the “Lag killer” setting.

cmd.disable_provokecell

Disables the “Provoke cell” setting.

cmd.disable_skipcutscenes

Disables the “Skip cutscenes” setting.

cmd.do_looptaunt

Performs loop taunt based on one or more strategies. See looptaunt guide for more details.

Parameter	Type	Description
strategies	[string, number, number, string?][]	An array of strategies. Each strategy is an array of [target, playerIndex, maxPlayers, (msg)]. msg is optional if using Simple mode.

cmd.do_wheelofdoom

Does the Wheel of Doom spin (non-members).

Parameter	Type	Optional	Default	Description
to_bank	boolean	✓	false	Whether to put the reward in the bank.

cmd.drink_consumables

Drinks consumable items.

Parameter	Type	Description
items	string | string[]	The name(s) of the items.
equipAfter	string?	The name of the item to equip after drinking consumables.

cmd.enable_anticounter

Enables the anti-counter attack setting.

cmd.enable_collisions

Enables the “Disable collisions” setting.

cmd.enable_death_ads

Disables the “Disable death ads” setting.

cmd.enable_enemymagnet

Enables the “Enemy magnet” setting.

cmd.enable_fx

Enables the “Disable FX” setting.

cmd.enable_hideplayers

Enables the “Hide players” setting.

cmd.enable_infiniterange

Enables the “Infinite range” setting.

cmd.enable_lagkiller

Enables the “Lag killer” setting.

cmd.enable_provokecell

Enables the “Provoke cell” setting.

cmd.enable_skipcutscenes

Enables the “Skip cutscenes” setting.

cmd.goto_house

Goes to a player’s house.

Parameter	Type	Description
player	string?	The name of the player.

cmd.goto_label

Goes to a label in the script.

Parameter	Type	Description
label	string	The name of the label.

cmd.goto_player

Goes to a player.

Parameter	Type	Description
player	string	The name of the player.

cmd.label

Defines a label in the script.

Parameter	Type	Description
label	string	The name of the label.

cmd.log

Logs a message ingame.

Parameter	Type	Description
msg	string	The message to log.

cmd.logout

Logs out of the game.

cmd.register_command

Parameter	Type	Description
name	string
cmdFactory	(CommandClass: typeof Command) => typeof Command

cmd.register_handler

Registers a packet handler.

Parameter	Type	Description
type	"packetFromClient" | "packetFromServer" | "pext"	”packetFromClient"
name	string	The name of the handler.
handler	((packet: Record<string, unknown>) => void | Promise<void>) | ((packet: string) => void | Promise<void>)	The handler function. For “pext”, the function receives a parsed object. For “packetFromClient” and “packetFromServer”, the function receives a raw string.

cmd.register_task

Registers a task (a.k.a background job) to be executed alongside commands. The task function is bound to an object containing the bot instance and the context instance.

Parameter	Type	Description
name	string	The name of the task.
taskFn	() => Promise<void>	The async function to run as the task.

cmd.register_task('walkToPoint', function () {
let intervalId = setInterval(() => {
  if (!this.ctx.isRunning()) {
    clearInterval(intervalId)
    return
  }
  if (this.bot.world.name !== 'ultraspeaker') return
  this.bot.player.walkTo(28, 235) // top left
}, 100)
})

cmd.set_auto_register_requirements

Sets the auto register requirements flag for the Environment.

Parameter	Type	Description
val	boolean	The value to set.

cmd.set_auto_register_rewards

Sets the auto register rewards flag for the Environment.

Parameter	Type	Description
val	boolean	The value to set.

cmd.set_delay

Sets the delay between commands.

Parameter	Type	Description
delay	number	The delay in milliseconds.

cmd.set_fps

Sets the target FPS for the game.

Parameter	Type	Description
fps	number	The desired value.

cmd.set_guild

Sets the client’s locally visible guild name.

Parameter	Type	Description
guild	string	The name of the guild.

cmd.set_name

Sets the client’s locally visible name.

Parameter	Type	Description
name	string	The name of the player.

cmd.set_reject_else

Sets the rejectElse flag for the Environment.

Parameter	Type	Description
val	boolean	The value to set.

cmd.set_walk_speed

Sets the walk speed of the player.

Parameter	Type	Description
speed	number	The walk speed (0-100).

cmd.stop_bot

Stops the bot.

cmd.unregister_command

Parameter	Type	Description
name	string

cmd.unregister_handler

Parameter	Type	Description
type	"packetFromClient" | "packetFromServer" | "pext"
name	string

cmd.unregister_task

Unregisters a previously registered task.

Parameter	Type	Description
name	string	The name of the task to unregister.

cmd.use_autorelogin

Enables Auto Relogin with the current session’s credentials.

Parameter	Type	Description
server	string?	The server to log into.

cmd.use_autorelogin('Twig') // relogin to Twig server
cmd.use_autorelogin() // relogin to the fallback server OR the current server otherwise

cmd.use_autozone_astralshrine

Enables auto-zoning for astralshrine map.

cmd.use_autozone_darkcarnax

Enables auto-zoning for darkcarnax map.

cmd.use_autozone_ledgermayne

Enables auto-zoning for ledgermayne map.

cmd.use_autozone_moreskulls

Enables auto-zoning for moreskulls map.

cmd.use_autozone_queeniona

Enables auto-zoning for queeniona map.

cmd.use_autozone_ultradage

Enables auto-zoning for ultradage map.

cmd.wait_for_player_count

Waits for a specific number of players to be in the map.

Parameter	Type	Optional	Default	Description
count	number			The number of players to wait for.
exact	boolean	✓	false	Whether to wait for the exact number of players.