CommandLock

Class to be used by a command that should prevent others from using it when in use by anyone else. CommandLocks can define sibling commands by name that will also be locked when the command is locked.

To use this (or your own extension class) on a Command, create a new instance and assign it to your Command's lock field in your Command constructor.

By default a command will be locked for a maximum of 30 seconds if something goes wrong and a command fails to finish. This can be changed by setting lockTimeout in your CommandInfo to a desired time in ms, or 0 to disable the lock timeout entirely.

NOTE: Command locks only apply within a guild context. You must declare set guildOnly to true to be able to utilize a CommandLock for that command.

By extending this class and overriding lock(), isLocked(), free(), and getError() with your own definitions you can effectively define your own lock behavior. These methods will be passed the same Message context and arguments as your Command so you can define any behavior you desire, like locking multiple commands that operate on a given user while one of the commands is in use.

Constructor

new CommandLock(siblings: string)

Parameters:
Name Type Attributes Description
siblings
string
 		<repeatable>

Associated commands to lock
Source:

Methods

.free(message: Message, args: any[]) → void

Frees this lock. Called automatically when the command finishes, or when the lockTimeout fires

Parameters:
Name Type Description
message
Message

Message that triggered the command
args
any[]

Arguments passed to the command
Source:
Returns:
void

.getError(lang: string, message: Message, args: any[]) → string

Get an error string describing the effects of this lock. Defaults to 'This command is currently in use. for en_us.

When defining your own lock behavior, consider using details related to the conditions under which your commands are locked.

Parameters:
Name Type Description
lang
string

The language to use for the error string
message
Message

Message that triggered the command
args
any[]

Arguments passed to the command
Source:
Returns:
string

.isLocked(message: Message, args: any[]) → boolean

Returns whether or not this lock is active

Parameters:
Name Type Description
message
Message

Message that triggered the command
args
any[]

Arguments passed to the command
Source:
Returns:
boolean

.lock(message: Message, args: any[]) → void

Sets the lock

Parameters:
Name Type Description
message
Message

Message that triggered the command
args
any[]

Arguments passed to the command
Source:
Returns:
void