RuntimePlugin

RuntimePlugin extends PluginCommon<T, CommandKitPluginRuntime>

new RuntimePlugin(options)

Parameter	Type	Optional
options	T	❌

Properties

public name: any

• Source

public options: any

• Source

Methods

public activate(ctx): Promise<void>

Called when this plugin is activated

Parameter	Type	Optional
ctx	CommandKitPluginRuntime	❌

• Source

public deactivate(ctx): Promise<void>

Called when this plugin is deactivated

Parameter	Type	Optional
ctx	CommandKitPluginRuntime	❌

• Source

public executeCommand(ctx, env, source, command, execute): Promise<boolean>

Called before command is executed. This method can execute the command itself.

Parameter	Type	Optional	Description
ctx	CommandKitPluginRuntime	❌	N/A
env	CommandKitEnvironment	❌	N/A
source	Interaction	Message	❌
command	PreparedAppCommandExecution	❌	The command
execute	( ...args	unknown[	] ) => Promise<any>

• Source

public onAfterClientLogin(ctx): Promise<void>

Called after the client logs in

Parameter	Type	Optional
ctx	CommandKitPluginRuntime	❌

• Source

public onAfterCommand(ctx, env): Promise<void>

Called after command and all of its deferred functions are executed.

Parameter	Type	Optional	Description
ctx	CommandKitPluginRuntime	❌	The context
env	CommandKitEnvironment	❌	The environment of the command. This environment contains the command execution data such as command context and more.

• Source

public onAfterCommandsLoad(ctx): Promise<void>

Called after commands are loaded

Parameter	Type	Optional
ctx	CommandKitPluginRuntime	❌

• Source

public onAfterEventsLoad(ctx): Promise<void>

Called after events are loaded

Parameter	Type	Optional
ctx	CommandKitPluginRuntime	❌

• Source

public onBeforeClientLogin(ctx): Promise<void>

Called before the client logs in

Parameter	Type	Optional
ctx	CommandKitPluginRuntime	❌

• Source

public onBeforeCommandsLoad(ctx): Promise<void>

Called before commands are loaded

Parameter	Type	Optional
ctx	CommandKitPluginRuntime	❌

• Source

public onBeforeEventsLoad(ctx): Promise<void>

Called before events are loaded

Parameter	Type	Optional
ctx	CommandKitPluginRuntime	❌

• Source

public onBeforeInteraction(ctx, interaction): Promise<void>

Called before interaction is handled

Parameter	Type	Optional	Description
ctx	CommandKitPluginRuntime	❌	N/A
interaction	Interaction	❌	The interaction

• Source

public onBeforeMessageCommand(ctx, message): Promise<void>

Called before message command is processed

Parameter	Type	Optional	Description
ctx	CommandKitPluginRuntime	❌	N/A
message	Message	❌	The message

• Source

public onBeforePrepareGuildCommandsRegistration(ctx, event): Promise<void>

Called before guild commands registration. This method can cancel the registration of the command and handle it manually. This method is called before guilds of the command are resolved. It is called after onBeforeRegisterCommands if that stage was not handled.

Parameter	Type	Optional	Description
ctx	CommandKitPluginRuntime	❌	The context
event	PreRegisterCommandsEvent	❌	The command registration data

• Source

public onBeforeRegisterCommands(ctx, event): Promise<void>

Called before command is registered to discord. This method can cancel the registration of the command and handle it manually.

Parameter	Type	Optional	Description
ctx	CommandKitPluginRuntime	❌	The context
event	PreRegisterCommandsEvent	❌	N/A

• Source

public onBeforeRegisterGlobalCommands(ctx, event): Promise<void>

Called before global commands registration. This method can cancel the registration of the command and handle it manually. This method is called after onBeforeRegisterCommands if that stage was not handled.

Parameter	Type	Optional	Description
ctx	CommandKitPluginRuntime	❌	The context
event	PreRegisterCommandsEvent	❌	The command registration data

• Source

public onBeforeRegisterGuildCommands(ctx, event): Promise<void>

Called before guild commands registration. This method can cancel the registration of the command and handle it manually. This method is called after guilds of the command are resolved. It is called after onBeforePrepareGuildCommandsRegistration if that stage was not handled.

Parameter	Type	Optional	Description
ctx	CommandKitPluginRuntime	❌	The context
event	PreRegisterCommandsEvent	❌	The command registration data

• Source

public onCommandsRouterInit(ctx): Promise<void>

Called after commands router is initialized

Parameter	Type	Optional	Description
ctx	CommandKitPluginRuntime	❌	The context

• Source

public onEventsRouterInit(ctx): Promise<void>

Called after events router is initialized

Parameter	Type	Optional	Description
ctx	CommandKitPluginRuntime	❌	The context

• Source

public performHMR(ctx, event): Promise<void>

Called when HMR event is received

Parameter	Type	Optional	Description
ctx	CommandKitPluginRuntime	❌	The context
event	CommandKitHMREvent	❌	The event

• Source

public prepareCommand(ctx, commands): Promise<null | CommandBuilderLike>

Called before command is loaded for registration. This method can be used to modify the command data before it is loaded.

Parameter	Type	Optional	Description
ctx	CommandKitPluginRuntime	❌	The context
commands	CommandBuilderLike	❌	The command that is being loaded. This is a CommandBuilderLike object which represents Discord's command

• Source