Vocality Documentation

Vocality Documentation › Globals

Index

Classes

Interfaces

Variables

Functions

Object literals

Variables

Const seperator

• seperator: " " = " "

Defined in packages/vocality-core/src/utils/ArgumentParser.ts:4

Functions

Const addCustomListener

▸ addCustomListener(event: string, callback: Function): void

Defined in packages/vocality-core/src/utils/addListener.ts:8

Method for adds a custom, discord related event for the bot to listen on e.g. 'channelCreate'

Parameters:

NameTypeDescription
eventstring-
callbackFunction

Returns: void

applyDefaults

▸ applyDefaults(o?: ClientOptions): ClientOptions

Defined in packages/vocality-core/src/bot.ts:61

Parameters:

NameType
o?ClientOptions

Returns: ClientOptions

Const emitCustomEvent

▸ emitCustomEvent(event: string, ...args: any[]): void

Defined in packages/vocality-core/src/utils/emitEvent.ts:3

Parameters:

NameType
eventstring
...argsany[]

Returns: void

Const findGuild

▸ findGuild(guildId: string): undefined | Guild‹›

Defined in packages/vocality-core/src/utils/findGuild.ts:3

Parameters:

NameType
guildIdstring

Returns: undefined | Guild‹›

loadCommands

▸ loadCommands(imports: any): Command[]

Defined in packages/vocality-core/src/utils/loadCommands.ts:6

Tries to convert imported module to an array of commands

Parameters:

NameType
importsany

Returns: Command[]

Object literals

Const BOT

▪ BOT: object

Defined in packages/vocality-core/src/config.ts:1

NAME

• NAME: string = ""

Defined in packages/vocality-core/src/config.ts:5

PREFIX

• PREFIX: string = "?"

Defined in packages/vocality-core/src/config.ts:2

SERVERPREFIXES

• SERVERPREFIXES: GuildPrefixMap = {} as GuildPrefixMap

Defined in packages/vocality-core/src/config.ts:3

SHARDS

• SHARDS: number = 1

Defined in packages/vocality-core/src/config.ts:4

Const COLOR

▪ COLOR: object

Defined in packages/vocality-core/src/config.ts:14

Colors for Embeds

CYAN

• CYAN: string = "#29abe2"

Defined in packages/vocality-core/src/config.ts:15

GREY

• GREY: string = "#121212"

Defined in packages/vocality-core/src/config.ts:17

PINK

• PINK: string = "#ff3f60"

Defined in packages/vocality-core/src/config.ts:16

Const DEFAULT_OPTIONS

▪ DEFAULT_OPTIONS: object

Defined in packages/vocality-core/src/bot.ts:4

disabledEvents

• disabledEvents: any[] = ['TYPING_START'] as any[]

Defined in packages/vocality-core/src/bot.ts:6

messageCacheMaxSize

• messageCacheMaxSize: number = 1000

Defined in packages/vocality-core/src/bot.ts:5

Const EMOJI

▪ EMOJI: object

Defined in packages/vocality-core/src/config.ts:24

Mappings for Emojis https://www.webfx.com/tools/emoji-cheat-sheet/

ARROW_BACKWARD

• ARROW_BACKWARD: string = "◀"

Defined in packages/vocality-core/src/config.ts:25

ARROW_FORWARD

• ARROW_FORWARD: string = "▶"

Defined in packages/vocality-core/src/config.ts:26

DIGITS

• DIGITS: string[] = [ '0️⃣', '1️⃣', '2️⃣', '3️⃣', '4️⃣', '5️⃣', '6️⃣', '7️⃣', '8️⃣', '9️⃣', ]

Defined in packages/vocality-core/src/config.ts:31

LIST_ITEM_POINT

• LIST_ITEM_POINT: string = "•"

Defined in packages/vocality-core/src/config.ts:30

RED_X

• RED_X: string = "❌"

Defined in packages/vocality-core/src/config.ts:29

WARNING

• WARNING: string = "⚠"

Defined in packages/vocality-core/src/config.ts:27

WHITE_CHECK_MARK

• WHITE_CHECK_MARK: string = "✅"

Defined in packages/vocality-core/src/config.ts:28