Class Script

The script class is the main way you interact with botloader and discord.

Properties

`Readonly` description

description: string

`Readonly` name

name: string

`Readonly` pluginId

pluginId: null | string

`Readonly` scriptId

scriptId: number

settings

settings: SettingsManager

Methods

createCommand

createCommand(command): void
Creates or updates a command

See Commands.slashCommand, Commands.messageCommand and Commands.userCommand for more info on defining the commands themselves
Parameters
- command: Command
Returns void
- Defined in src/ts/script.ts:55

createGuildStorageJson

createGuildStorageJson<T>(namespace): JsonBucket<T>
Type Parameters
- T
Parameters
- namespace: string
Returns JsonBucket<T>
Deprecated
use createStorageJson
- Defined in src/ts/script.ts:96

createGuildStorageNumber

createGuildStorageNumber(namespace): NumberBucket
Parameters
- namespace: string
Returns NumberBucket
Deprecated
use {@łink createStorageNumber}
- Defined in src/ts/script.ts:128

createMessageCommand

createMessageCommand(name): MessageCommandBuilder
Parameters
- name: string
Returns MessageCommandBuilder
- Defined in src/ts/script.ts:74

createSlashCommand

createSlashCommand(name, description): SlashCommandBuilder<{}>
Parameters
- name: string
- description: string
Returns SlashCommandBuilder<{}>
- Defined in src/ts/script.ts:60

createStorageJson

createStorageJson<T>(namespace): JsonBucket<T>
Create new json storage buckets for persistent storage
Type Parameters
- T
Parameters
- namespace: string
  a "name" or "id" for the bucket. This is not script scoped and the same storage bucket can be registered in multiple scripts to have access to the same data, this is perfectly safe.
Returns JsonBucket<T>
Example
```
interface Data{
    key: string,
}
let funStorage = script.createStorageJson(new Storage.JsonBucket<Data>("fun-data"));
```
- Defined in src/ts/script.ts:118

createStorageNumber

createStorageNumber(namespace): NumberBucket
Creates a new number storage bucket for persistent storage.

This is the same as createStorageJson except that this bucket can only store number values, the upside of this is that it can be sorted.

An example use case could be storing the scores of users in a leveling system with the key being their user ID and the value being their score this way you can use Storage.NumberBucket.sortedList to get a sorted list of entries.

See createStorageJson for more general info on storage buckets
Parameters
- namespace: string
Returns NumberBucket
- Defined in src/ts/script.ts:145

createStorageVarJson

createStorageVarJson<T>(key, options?): JsonVar<T>
Create a new persistent variable.

This is built on top of storage buckets so you can think of it as a single entry inside a storage bucket.
Type Parameters
- T
Parameters
- key: string
  Key for the variable inside the storage bucket, the same key in another script will refer to the same entry
- Optional options: StorageVarExtraOptions
  Additional options
Returns JsonVar<T>
- Defined in src/ts/script.ts:161

createStorageVarNumber

createStorageVarNumber(key, options?): NumberVar
Create a new persistent variable.

This is built on top of storage buckets so you can think of it as a single entry inside a storage bucket.
Parameters
- key: string
  Key for the variable inside the storage bucket, the same key in another script will refer to the same entry
- Optional options: StorageVarExtraOptions
  Additional options
Returns NumberVar
- Defined in src/ts/script.ts:175

createTaskBucket

createTaskBucket<T>(options, cb): TaskBucket<T>
Type Parameters
- T = undefined
Parameters
- options: {
  customScope?: CustomScope;
  name: string;
  }
  - Optional customScope?: CustomScope
  - name: string
- cb: ((task) => any)
  - - (task): any
    - Parameters
      task: Task<T>
      Returns any
Returns TaskBucket<T>
- Defined in src/ts/script.ts:218

createUserCommand

createUserCommand(name): UserCommandBuilder
Parameters
- name: string
Returns UserCommandBuilder
- Defined in src/ts/script.ts:67

on

on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "MESSAGE_DELETE"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: EventMessageDelete
      Returns void
Returns void
- Defined in src/ts/script.ts:335
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "MESSAGE_UPDATE"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: EventMessageUpdate
      Returns void
Returns void
- Defined in src/ts/script.ts:336
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "MESSAGE_CREATE"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: Message
      Returns void
Returns void
- Defined in src/ts/script.ts:337
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "MEMBER_ADD"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: Member
      Returns void
Returns void
- Defined in src/ts/script.ts:338
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "MEMBER_UPDATE"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: Member
      Returns void
Returns void
- Defined in src/ts/script.ts:339
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "MEMBER_REMOVE"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: EventMemberRemove
      Returns void
Returns void
- Defined in src/ts/script.ts:340
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "VOICE_STATE_UPDATE"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: EventVoiceStateUpdate
      Returns void
Returns void
- Defined in src/ts/script.ts:341
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "MESSAGE_REACTION_ADD"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: EventMessageReactionAdd
      Returns void
Returns void
- Defined in src/ts/script.ts:342
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "MESSAGE_REACTION_REMOVE"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: EventMessageReactionRemove
      Returns void
Returns void
- Defined in src/ts/script.ts:343
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "MESSAGE_REACTION_REMOVE_ALL"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: EventMessageReactionRemoveAll
      Returns void
Returns void
- Defined in src/ts/script.ts:344
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "MESSAGE_REACTION_REMOVE_ALL_EMOJI"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: EventMessageReactionRemoveAllEmoji
      Returns void
Returns void
- Defined in src/ts/script.ts:345
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "CHANNEL_CREATE"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: GuildChannel
      Returns void
Returns void
- Defined in src/ts/script.ts:346
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "CHANNEL_UPDATE"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: GuildChannel
      Returns void
Returns void
- Defined in src/ts/script.ts:347
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "CHANNEL_DELETE"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: GuildChannel
      Returns void
Returns void
- Defined in src/ts/script.ts:348
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "THREAD_CREATE"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: Thread
      Returns void
Returns void
- Defined in src/ts/script.ts:349
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "THREAD_UPDATE"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: Thread
      Returns void
Returns void
- Defined in src/ts/script.ts:350
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "THREAD_DELETE"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: IEventThreadDelete
      Returns void
Returns void
- Defined in src/ts/script.ts:351
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "ROLE_CREATE"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: Role
      Returns void
Returns void
- Defined in src/ts/script.ts:352
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "ROLE_UPDATE"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: Role
      Returns void
Returns void
- Defined in src/ts/script.ts:353
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "ROLE_DELETE"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: EventRoleDelete
      Returns void
Returns void
- Defined in src/ts/script.ts:354
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "THREAD_LIST_SYNC"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: EventThreadListSync
      Returns void
Returns void
- Defined in src/ts/script.ts:355
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "THREAD_MEMBER_UPDATE"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: ThreadMember
      Returns void
Returns void
- Defined in src/ts/script.ts:356
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "THREAD_MEMBERS_UPDATE"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: EventThreadMembersUpdate
      Returns void
Returns void
- Defined in src/ts/script.ts:357
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "INVITE_CREATE"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: EventInviteCreate
      Returns void
Returns void
- Defined in src/ts/script.ts:358
on(eventType, cb): void
Register a general event handler such as for arbitrary discord events like when a new message is sent in the server (MESSAGE_CREATE)
Parameters
- eventType: "INVITE_DELETE"
- cb: ((evt) => void)
  - - (evt): void
    - Parameters
      evt: EventInviteDelete
      Returns void
Returns void
- Defined in src/ts/script.ts:359

onInteractionButton

onInteractionButton<T>(name, cb): void
Register a handler for button interactions
Type Parameters
- T
Parameters
- name: string
- cb: ((interaction, extraData) => any)
  - - (interaction, extraData): any
    - Parameters
      interaction: ComponentInteraction
      extraData: T
      Returns any
Returns void
- Defined in src/ts/script.ts:255

onInteractionChannelSelectMenu

onInteractionChannelSelectMenu<T>(name, cb): void
Register a handler for channel select menu interactions
Type Parameters
- T
Parameters
- name: string
- cb: ((interaction, extraData) => any)
  - - (interaction, extraData): any
    - Parameters
      interaction: ChannelSelectMenuInteraction
      extraData: T
      Returns any
Returns void
- Defined in src/ts/script.ts:283

onInteractionMentionableSelectMenu

onInteractionMentionableSelectMenu<T>(name, cb): void
Register a handler for mentionable select menu interactions
Type Parameters
- T
Parameters
- name: string
- cb: ((interaction, extraData) => any)
  - - (interaction, extraData): any
    - Parameters
      interaction: MentionableSelectMenuInteraction
      extraData: T
      Returns any
Returns void
- Defined in src/ts/script.ts:290

onInteractionModalSubmit

onInteractionModalSubmit<T>(name, cb): void
Register a handler for when people submit modals
Type Parameters
- T
Parameters
- name: string
- cb: ((interaction, customData) => any)
  - - (interaction, customData): any
    - Parameters
      interaction: ModalSubmitInteraction
      customData: T
      Returns any
Returns void
- Defined in src/ts/script.ts:297

onInteractionRoleSelectMenu

onInteractionRoleSelectMenu<T>(name, cb): void
Register a handler for role select menu interactions
Type Parameters
- T
Parameters
- name: string
- cb: ((interaction, extraData) => any)
  - - (interaction, extraData): any
    - Parameters
      interaction: RoleSelectMenuInteraction
      extraData: T
      Returns any
Returns void
- Defined in src/ts/script.ts:276

onInteractionSelectMenu

onInteractionSelectMenu<T>(name, cb): void
Register a handler for text select menu interactions
Type Parameters
- T
Parameters
- name: string
- cb: ((interaction, extraData) => any)
  - - (interaction, extraData): any
    - Parameters
      interaction: SelectMenuInteraction
      extraData: T
      Returns any
Returns void
- Defined in src/ts/script.ts:262

onInteractionUserSelectMenu

onInteractionUserSelectMenu<T>(name, cb): void
Register a handler for user select menu interactions
Type Parameters
- T
Parameters
- name: string
- cb: ((interaction, extraData) => any)
  - - (interaction, extraData): any
    - Parameters
      interaction: UserSelectMenuInteraction
      extraData: T
      Returns any
Returns void
- Defined in src/ts/script.ts:269

onInterval

onInterval(name, interval, callback): void
Creates or resumes a interval timer.
Parameters
- name: string
  The name of the timer, this is not namespaced to the current script. You could overwrite a timer from another script with the same name.
- interval: string | number
  The interval, either in minutes for running the callback at every x minutes, or a cron style timer.
  
  https://crontab.guru/ is a neat helper for making cron intervals
- callback: (() => any)
  Callback to run at every interval
  - - (): any
    - Returns any
Returns void
Example
```
 script.onInterval("gaming", "*/5 * * * *", () => {
    // do stuff here
});
```
- Defined in src/ts/script.ts:318

onTask

onTask<T>(namespace, cb): Promise<void>
Register a scheduled task handler for the provided namespace.

See Tasks for more info about scheduled tasks and how to schedule a new one.
Type Parameters
- T
Parameters
- namespace: string
  The task namespace to handle tasks from
- cb: ((task) => any)
  The callback function to run, with the type of the data passed to the task when scheduled
  - - (task): any
    - Parameters
      task: Task<T>
      Returns any
Returns Promise<void>
Deprecated
Use createTaskBucket instead.

Example
```
interface Data{
    key: string,
}
script.onTask<Data>("fun-tasks", (task) => {
     console.log("hello world");
});
```
- Defined in src/ts/script.ts:201

setCustomStorageScope

setCustomStorageScope(scope): void
Parameters
- scope: CustomScope
Returns void
- Defined in src/ts/script.ts:45

Class Script

Index

Properties

Methods

Properties

Readonly description

Readonly name

Readonly pluginId

Readonly scriptId

settings

Methods

createCommand

Parameters

command: Command

Returns void

createGuildStorageJson

Type Parameters

T

Parameters

namespace: string

Returns JsonBucket<T>

Deprecated

createGuildStorageNumber

Parameters

namespace: string

Returns NumberBucket

Deprecated

createMessageCommand

Parameters

name: string

Returns MessageCommandBuilder

createSlashCommand

Parameters

name: string

description: string

Returns SlashCommandBuilder<{}>

createStorageJson

Type Parameters

T

Parameters

namespace: string

Returns JsonBucket<T>

Example

createStorageNumber

Parameters

namespace: string

Returns NumberBucket

createStorageVarJson

Type Parameters

T

Parameters

key: string

Optional options: StorageVarExtraOptions

Returns JsonVar<T>

createStorageVarNumber

Parameters

key: string

Optional options: StorageVarExtraOptions

Returns NumberVar

createTaskBucket

Type Parameters

T = undefined

Parameters

options: { customScope?: CustomScope; name: string; }

Optional customScope?: CustomScope

name: string

cb: ((task) => any)

Parameters

task: Task<T>

Returns any

Returns TaskBucket<T>

createUserCommand

Parameters

name: string

Returns UserCommandBuilder

on

Parameters

eventType: "MESSAGE_DELETE"

cb: ((evt) => void)

Parameters

`Readonly` description

`Readonly` name

`Readonly` pluginId

`Readonly` scriptId

`Optional` options: StorageVarExtraOptions

`Optional` options: StorageVarExtraOptions

options: {
customScope?: CustomScope;
name: string;
}

`Optional` customScope?: CustomScope