Bot

type

Your Discord bot: guilds, gateway ping, self user and lifecycle.

20 syntaxesnet.itsthesky.disky5.core.Bot

20 / 20

Properties

propertyTextsince 5.0.0-a1

[the] token of %bot%

%bot%'s token

The bot's login token. Build-time only.

change modes set

Helpful?

propertyTextsince 5.0.0-a1

Feeling lost? This is covered in the guide Bot options

[the] intents of %bot%

%bot%'s intents

The gateway intents, comma-separated by name (or "default intents" / "all"). Build-time only.

change modes set

Helpful?

propertyTextsince 5.0.0-a1

Feeling lost? This is covered in the guide Bot options

[the] member cache policy of %bot%

%bot%'s member cache policy

all / default / none / online / owner / voice. Build-time only.

change modes set

Helpful?

propertyTextsince 5.0.0-a1

Feeling lost? This is covered in the guide Bot options

[the] cache flags of %bot%

%bot%'s cache flags

The enabled cache flags, comma-separated by name (or "all" / "default" / "none"). Build-time only.

change modes set

Helpful?

propertyTextsince 5.0.0-a1

Feeling lost? This is covered in the guide Bot options

[the] compression of %bot%

%bot%'s compression

zlib / none. Build-time only.

change modes set

Helpful?

propertyNumbersince 5.0.0-a1

Feeling lost? This is covered in the guide Bot options

[the] shard count of %bot%

%bot%'s shard count

The number of shards. -1 (default) = Discord's recommended count, 1 = single shard, N>=2 = N shards. Build-time only; once running, returns the real shard total.

change modes set

Helpful?

propertyTextsince 5.0.0-a1

[the] activity of %bot%

%bot%'s activity

The bot's activity text (e.g. "playing"). Live-updatable.

change modes set

mentioned inBot options

Helpful?

propertyNumbersince 5.0.0-a1

Feeling lost? This is covered in the guide Multiple bots

[the] gateway ping of %bot%

%bot%'s gateway ping

Average gateway ping across shards, in ms (-1 if not running).

Helpful?

propertyNumbersince 5.0.0-a1

Feeling lost? This is covered in the guide Multiple bots

[the] guild count of %bot%

%bot%'s guild count

Number of guilds the bot is in (0 if not running).

Helpful?

propertyNumbersince 5.0.0-a1

Feeling lost? This is covered in the guide Multiple bots

[the] running shards of %bot%

%bot%'s running shards

Number of currently-connected shards (0 if not running).

mentioned inBot options

Helpful?

propertylist of Guildsince 5.0.0-a1

[the] guilds of %bot%

%bot%'s guilds

All guilds the bot is a member of (empty if not running).

mentioned inMultiple bots

Helpful?

propertyUsersince 5.0.0-a1

[the] self user of %bot%

%bot%'s self user

The bot's own user account (none if not running).

mentioned inMultiple bots

Helpful?

propertyApplicationinfo since 5.0.0-a1

[the] application info of %bot%

%bot%'s application info

The application (developer portal) info of the bot. Fetched online, so it requires 'await'.

mentioned inCache and await

Helpful?

propertyText since 5.0.0-a1

[the] name of %bot%

%bot%'s name

The name of a Discord entity: a user's or member's account name, a guild's name, a role/channel name, a bot's define-name. Registered on Skript's native Property.NAME, so the idiomatic "name of %x%" works without colliding. For a member's server nickname or display name, use "effective name".

mentioned inMultiple bots

Helpful?

propertyOnlineStatus since 5.0.0-a1

[the] online status of %bot%

%bot%'s online status

The online status of a Discord entity. Read-only on a member (the presence Discord reports: online, idle, do not disturb, offline...). On a bot it is the live presence and can be set (online / idle / dnd / invisible). One syntax, dispatched per type — "online status of %member/bot%".

change modes set

mentioned inBot options Multiple bots

Helpful?

propertyText since 5.0.0-a1

[the] avatar url of %bot%

%bot%'s avatar url

The avatar/icon URL of a Discord entity: a user/member's avatar, a guild's icon, a sticker's image, an application's icon... Co-owned across every type that has one, so "avatar url of %x%" works on any of them. Always a string (the image URL).

mentioned inMultiple bots

Helpful?

Effects

effectsince 5.0.0-a1

[discord] connect [the] [bot] %bot% to [the] [(audio|voice)] [channel] %audiochannel%

Connects a bot to an audio (voice or stage) channel.

The bot needs the Connect permission on that channel.

Helpful?

effectsince 5.0.0-a1

disconnect [[the] [bot] %-bot%] from [the] [guild] %guild%

Closes a bot's audio connection in a guild.

Without a bot, the one owning the given guild is used.

Helpful?

effect since 5.0.0-a1

make [the] %bot% leave [the] [guild] %guild%

Makes a bot leave a guild. It loses every access to that server until re-invited.

Helpful?

Conditions

conditionsince 5.0.0-a1

%bots% (is|are) connected

Whether the bot is logged in and running (its shards have been built).

mentioned inMultiple bots

Helpful?

Returned by

Syntaxes elsewhere in DiSky that return Bot.

[all] [the] botsCore · Expressions [a] new discord botCore · Expressions

Documentation

Hand-written guides that cover Bot.

Starting a botCreate a bot, give it a token, log in, and shut it down cleanly.Docs Bot optionsEvery connection option you can set on a bot before login, and the two presence options you can change at any time.Docs Multiple botsRunning several bots on one server, filtering events per bot, and reading a bot's state.Docs Cache and awaitWhat the cache holds, the three rules that decide when a line needs await, and the reads that always do.Docs