Scheduled Event

type

The Scheduled Event entity and its Skript syntaxes.

13 syntaxesnet.dv8tion.jda.api.entities.ScheduledEvent

13 / 13

Properties

propertyTextsince 5.0.0-a1

[the] description of %scheduledevent%

%scheduledevent%'s description

The description of a scheduled event, or null if it has none.

Helpful?

propertyTextsince 5.0.0-a1

[the] event type of %scheduledevent%

%scheduledevent%'s event type

The type of a scheduled event (stage instance, voice or external).

Helpful?

propertyText since 5.0.0-a1

[the] event status of %scheduledevent%

%scheduledevent%'s event status

The status of a scheduled event (scheduled, active, completed or cancelled).

Settable to transition the event (e.g. set to "active" to start it).

change modes set

Helpful?

propertyText since 5.0.0-a1

[the] discord location of %scheduledevent%

%scheduledevent%'s discord location

The location of a scheduled event: a channel id for channel-bound events, or the external place.

change modes set

Helpful?

propertyDatesince 5.0.0-a1

[the] start date of %scheduledevent%

%scheduledevent%'s start date

The start date of a scheduled event.

Helpful?

propertyDate since 5.0.0-a1

[the] end date of %scheduledevent%

%scheduledevent%'s end date

The end date of a scheduled event, or null for channel-bound events.

Settable for external events.

change modes set

Helpful?

propertyText since 5.0.0-a1

[the] cover of %scheduledevent%

%scheduledevent%'s cover

The cover image URL of a scheduled event, or null if no cover is set.

Settable to a URL or local file path.

change modes set

Helpful?

propertyGuildchannelsince 5.0.0-a1

[the] event channel of %scheduledevent%

%scheduledevent%'s event channel

The guild channel a scheduled event is bound to, or null for external events.

Helpful?

propertyUsersince 5.0.0-a1

[the] creator of %scheduledevent%

%scheduledevent%'s creator

The user who created a scheduled event, or null if unknown.

Helpful?

propertylist of Member since 5.0.0-a1

[the] interested members of %scheduledevent%

%scheduledevent%'s interested members

The members interested in a scheduled event. Fetched online, so it requires 'await'.

Only the first page (up to 100 members) is returned.

mentioned inCache and await

Helpful?

propertyText since 5.0.0-a1

[the] name of %scheduledevent%

%scheduledevent%'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".

Helpful?

propertyGuild since 5.0.0-a1

[the] guild of %scheduledevent%

%scheduledevent%'s guild

The guild a Discord entity belongs to: a member's, message's, role's, channel's, webhook's, sticker's, emoji's or scheduled event's guild. Co-owned across every such type, so "guild of %x%" works on any of them (null when the entity is not tied to a guild, e.g. a message from DMs).

Helpful?

Getters

getterScheduledeventsince 5.0.0-a1

scheduled event with id %string% (in|from) [the] [guild] %guild%

The scheduled event with the given id, from cache.

mentioned inGetting entities by id

Helpful?

Returned by

Syntaxes elsewhere in DiSky that return Scheduled Event.

[the] scheduled events of %guild%Guild scheduled event with id %string% (in|from) [the] [guild] %guild%Scheduled Event [the] (build|built) result of [the] %scheduledeventaction%Scheduled Event Builder

Documentation

Hand-written guides that cover Scheduled Event.

Cache and awaitWhat the cache holds, the three rules that decide when a line needs await, and the reads that always do.Docs Getting entities by idLook a guild, role, user, member, channel or message up from its Discord id, from the cache or from Discord.Docs