Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/DiscordLuau/docs
Browse files Browse the repository at this point in the history
  • Loading branch information
4x8Matrix committed Jul 6, 2024
2 parents 20a35dc + 1ec793c commit 1aa7676
Show file tree
Hide file tree
Showing 45 changed files with 288 additions and 839 deletions.
2 changes: 1 addition & 1 deletion discord-luau
Submodule discord-luau updated 36 files
+2 −2 Package/Classes/Builders/GuildBuilder.luau
+71 −58 Package/Classes/DiscordClient.luau
+11 −9 Package/Classes/Objects/BaseDiscordChannel.luau
+31 −29 Package/Classes/Objects/BaseDiscordGuildChannel.luau
+11 −9 Package/Classes/Objects/BaseGuildTextChannel.luau
+41 −39 Package/Classes/Objects/BaseGuildThread.luau
+36 −34 Package/Classes/Objects/BaseGuildVoiceChannel.luau
+11 −10 Package/Classes/Objects/BaseUserChannel.luau
+12 −12 Package/Classes/Objects/DiscordApplication.luau
+50 −50 Package/Classes/Objects/DiscordAutomoderationRule.luau
+6 −5 Package/Classes/Objects/DiscordCache.luau
+38 −36 Package/Classes/Objects/DiscordEmoji.luau
+225 −219 Package/Classes/Objects/DiscordGuild.luau
+11 −10 Package/Classes/Objects/DiscordGuildBan.luau
+11 −10 Package/Classes/Objects/DiscordGuildMember.luau
+46 −45 Package/Classes/Objects/DiscordGuildRole.luau
+86 −85 Package/Classes/Objects/DiscordIntegration.luau
+76 −75 Package/Classes/Objects/DiscordInteraction.luau
+36 −35 Package/Classes/Objects/DiscordInvite.luau
+76 −74 Package/Classes/Objects/DiscordMessage.luau
+8 −5 Package/Classes/Objects/DiscordPermission.luau
+57 −55 Package/Classes/Objects/DiscordSticker.luau
+41 −40 Package/Classes/Objects/DiscordUser.luau
+6 −5 Package/Classes/Objects/EndpointCache.luau
+98 −97 Package/Classes/Objects/EventManager.luau
+6 −5 Package/Classes/Objects/GuildForumChannel.luau
+6 −5 Package/Classes/Objects/GuildMediaChannel.luau
+26 −25 Package/Classes/Objects/GuildOnboarding.luau
+36 −35 Package/Classes/Objects/GuildOnboardingPrompt.luau
+26 −25 Package/Classes/Objects/GuildOnboardingPromptOption.luau
+56 −55 Package/Classes/Objects/GuildPreview.luau
+11 −10 Package/Classes/Objects/GuildWelcomeScreen.luau
+31 −30 Package/Classes/Objects/GuildWidget.luau
+21 −20 Package/Classes/Objects/UserGroupChannel.luau
+1 −0 Package/Data/DiscordEndpoints.luau
+1 −1 Package/Enums/WebsocketOperationCodes.luau
4 changes: 1 addition & 3 deletions src/content/docs/classes/Builders/DiscordPermission.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import LuaProperty from '$/components/LuaProperty.astro';

[//]: # (----- DOCUMENT DESCRIPTION ----- )


Represents a set of Discord permissions.

[//]: # (----- DOCUMENT PROPERTIES ----- )

Expand All @@ -26,8 +26,6 @@ import LuaProperty from '$/components/LuaProperty.astro';
### permissions

<LuaProperty name="DiscordPermission.permissions" type="{ number }" />
---


[//]: # (----- DOCUMENT METHODS ----- )

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/classes/Builders/GuildBuilder.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ An enumeration of guild features.
- PreviewEnabled: "PREVIEW_ENABLED"
- RaidAlertsDisabled: "RAID_ALERTS_DISABLED"
- RoleIcons: "ROLE_ICONS"
- RoleSubscriptionsAvaliableForPurchase: "ROLE_SUBSCRIPTIONS_AVAILABLE_FOR_PURCHASE"
- RoleSubscriptionsAvailableForPurchase: "ROLE_SUBSCRIPTIONS_AVAILABLE_FOR_PURCHASE"
- RoleSubscriptionsEnabled: "ROLE_SUBSCRIPTIONS_ENABLED"
- TicketedEventsEnabled: "TICKETED_EVENTS_ENABLED"
- VanityUrl: "VANITY_URL"
Expand Down
52 changes: 39 additions & 13 deletions src/content/docs/classes/DiscordClient.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,42 @@ local DiscordClient = DiscordLuau.DiscordClient.new(SettingsBuilder)

## Properties

### eventManager

<LuaProperty name="DiscordClient.eventManager" type="Objects.EventManager" />
### discordGateway

<LuaProperty name="DiscordClient.discordGateway" type="Objects.DiscordGateway" />
### onEvent

<LuaProperty name="DiscordClient.onEvent" type="Vendor.Signal<string, { [any]: any }?>" />
### discordSettings

<LuaProperty name="DiscordClient.discordSettings" type="SettingsBuilder" />
### discordCache

<LuaProperty name="DiscordClient.discordCache" type="DiscordCache" />
### reporter

<LuaProperty name="DiscordClient.reporter" type="Vendor.Reporter" />
### websocketUrl

<LuaProperty name="DiscordClient.websocketUrl" type="string" />
### shardCount

<LuaProperty name="DiscordClient.shardCount" type="number" />
### maxConcurrency

<LuaProperty name="DiscordClient.maxConcurrency" type="number" />
### discordShards

<LuaProperty name="DiscordClient.discordShards" type="{ Network.DiscordShard }" />
### discordUser

<LuaProperty name="DiscordClient.discordUser" type="Objects.DiscordUser?" />
### discordApplication

<LuaProperty name="DiscordClient.discordApplication" type="Objects.discordApplication" />
### discordUser

<LuaProperty name="DiscordClient.discordUser" type="DiscordUser" />
Expand All @@ -40,16 +76,6 @@ local DiscordClient = DiscordLuau.DiscordClient.new(SettingsBuilder)
<LuaProperty name="DiscordClient.discordApplication" type="DiscordApplication" />
---

### discordGateway

<LuaProperty name="DiscordClient.discordGateway" type="Objects.DiscordGateway" />
---

### eventManager

<LuaProperty name="DiscordClient.eventManager" type="Objects.EventManager" />
---


[//]: # (----- DOCUMENT METHODS ----- )

Expand All @@ -69,15 +95,15 @@ end)
```
### fetchGuildAsync

> <LuaDeclaration name="fetchGuildAsync" className="DiscordClient" args={[ { name: "guildId", type: "string" } ]} returnType="Vendor.Future<DiscordGuild>" isMethod />
> <LuaDeclaration name="fetchGuildAsync" className="DiscordClient" args={[ { name: "guildId", type: "string" } ]} returnType="Vendor.Future<Objects.DiscordGuild>" isMethod />
Fetches a guild by its ID.
### fetchChannelAsync

> <LuaDeclaration name="fetchChannelAsync" className="DiscordClient" args={[ { name: "channelId", type: "string" } ]} returnType="Vendor.Future<Objects.DiscordChannel>" isMethod />
Fetches a channel by its ID.
### updatePresenceAsync

> <LuaDeclaration name="updatePresenceAsync" className="DiscordClient" args={[ { name: "discordPresence", type: "table" } ]} returnType="Vendor.Future<boolean>" isMethod />
> <LuaDeclaration name="updatePresenceAsync" className="DiscordClient" args={[ { name: "discordPresence", type: "Builders.PresenceBuilder" } ]} returnType="Vendor.Future<boolean>" isMethod />
Updates the client's presence.
### createGuildAsync

Expand All @@ -94,7 +120,7 @@ Sets the verbosity level for logging.

### new

> <LuaDeclaration name="new" className="DiscordClient" args={[ { name: "discordSettings", type: "SettingsBuilder" } ]} />
> <LuaDeclaration name="new" className="DiscordClient" args={[ { name: "discordSettings", type: "Builders.SettingsBuilder" } ]} />
Constructor function for the Discord Client, used to instantiate a Discord Client object.


Expand Down
4 changes: 0 additions & 4 deletions src/content/docs/classes/Objects/BaseDiscordChannel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,9 @@ Represents a base discord channel, every discord channel object will extend from
### id

<LuaProperty name="BaseDiscordChannel.id" type="string" />
---

### type

<LuaProperty name="BaseDiscordChannel.type" type="number" />
---


[//]: # (----- DOCUMENT METHODS ----- )

Expand Down
22 changes: 18 additions & 4 deletions src/content/docs/classes/Objects/BaseDiscordGuildChannel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,32 @@ Represents a base object for any/all guild channels.

## Properties

### guildId

<LuaProperty name="BaseDiscordGuildChannel.guildId" type="string" />
### topic

<LuaProperty name="BaseDiscordGuildChannel.topic" type="string" />
### nsfw

<LuaProperty name="BaseDiscordGuildChannel.nsfw" type="boolean" />
### rateLimitPerUser

<LuaProperty name="BaseDiscordGuildChannel.rateLimitPerUser" type="number" />
### parentId

<LuaProperty name="BaseDiscordGuildChannel.parentId" type="string" />
### flags

<LuaProperty name="BaseDiscordGuildChannel.flags" type="number" />
### id

<LuaProperty name="BaseDiscordGuildChannel.id" type="string" />
---


> This property was inherited from [Objects.BaseDiscordChannel](Objects.BaseDiscordChannel)
### type

<LuaProperty name="BaseDiscordGuildChannel.type" type="number" />
---


> This property was inherited from [Objects.BaseDiscordChannel](Objects.BaseDiscordChannel)
Expand Down
38 changes: 17 additions & 21 deletions src/content/docs/classes/Objects/BaseGuildTextChannel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,46 +23,42 @@ A base guild text channel, where any/all text channels extend from.

## Properties

### lastPinTimestamp

<LuaProperty name="BaseGuildTextChannel.lastPinTimestamp" type="string" />
### lastMessageId

<LuaProperty name="BaseGuildTextChannel.lastMessageId" type="string?" />
### guildId

<LuaProperty name="BaseGuildTextChannel.guildId" type="string" />
---

> This property was inherited from [Objects.BaseDiscordGuildChannel](Objects.BaseDiscordGuildChannel)
### topic

<LuaProperty name="BaseGuildTextChannel.topic" type="string" />
---

> This property was inherited from [Objects.BaseDiscordGuildChannel](Objects.BaseDiscordGuildChannel)
### nsfw

<LuaProperty name="BaseGuildTextChannel.nsfw" type="boolean" />
---

> This property was inherited from [Objects.BaseDiscordGuildChannel](Objects.BaseDiscordGuildChannel)
### rateLimitPerUser

<LuaProperty name="BaseGuildTextChannel.rateLimitPerUser" type="number" />
---

> This property was inherited from [Objects.BaseDiscordGuildChannel](Objects.BaseDiscordGuildChannel)
### parentId

<LuaProperty name="BaseGuildTextChannel.parentId" type="string" />
---

> This property was inherited from [Objects.BaseDiscordGuildChannel](Objects.BaseDiscordGuildChannel)
### flags

<LuaProperty name="BaseGuildTextChannel.flags" type="number" />
---

### lastPinTimestamp

<LuaProperty name="BaseGuildTextChannel.lastPinTimestamp" type="string" />
---

### lastMessageId

<LuaProperty name="BaseGuildTextChannel.lastMessageId" type="string?" />
---

> This property was inherited from [Objects.BaseDiscordGuildChannel](Objects.BaseDiscordGuildChannel)
[//]: # (----- DOCUMENT METHODS ----- )

Expand Down
62 changes: 0 additions & 62 deletions src/content/docs/classes/Objects/BaseGuildThread.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,97 +26,35 @@ A base discord Thread channel, all discord threads extend from.
### ownerId

<LuaProperty name="BaseGuildThread.ownerId" type="string" />
---

### messageCount

<LuaProperty name="BaseGuildThread.messageCount" type="number" />
---

### memberCount

<LuaProperty name="BaseGuildThread.memberCount" type="number" />
---

### totalMessageSent

<LuaProperty name="BaseGuildThread.totalMessageSent" type="number" />
---

### threadMetadata

<LuaProperty name="BaseGuildThread.threadMetadata" type="{ archived: boolean, autoArchiveDuration: number, archiveTimestamp: string, locked: boolean, invitable: boolean?, createTimestamp: string? }," />
---

### availableTags

<LuaProperty name="BaseGuildThread.availableTags" type="{ { id: string, name: string, moderated: boolean, emojiId: string?, emojiName: string? } }," />
---

### appliedTags

<LuaProperty name="BaseGuildThread.appliedTags" type="{ string }" />
---

### defaultReactionEmoji

<LuaProperty name="BaseGuildThread.defaultReactionEmoji" type="Objects.DiscordEmoji" />
---

### guildId

<LuaProperty name="BaseGuildThread.guildId" type="string" />
---


> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel)
### topic

<LuaProperty name="BaseGuildThread.topic" type="string" />
---


> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel)
### nsfw

<LuaProperty name="BaseGuildThread.nsfw" type="boolean" />
---


> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel)
### rateLimitPerUser

<LuaProperty name="BaseGuildThread.rateLimitPerUser" type="number" />
---


> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel)
### parentId

<LuaProperty name="BaseGuildThread.parentId" type="string" />
---


> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel)
### flags

<LuaProperty name="BaseGuildThread.flags" type="number" />
---


> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel)
### lastPinTimestamp

<LuaProperty name="BaseGuildThread.lastPinTimestamp" type="string" />
---


> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel)
### lastMessageId

<LuaProperty name="BaseGuildThread.lastMessageId" type="string?" />
---


> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel)
Expand Down
52 changes: 51 additions & 1 deletion src/content/docs/classes/Objects/BaseGuildVoiceChannel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,57 @@ A base discord voice channel, every Guild Voice channel extends from.

## Properties

The BaseGuildVoiceChannel instance has no set properties!
### id

<LuaProperty name="BaseGuildVoiceChannel.id" type="string" />
### guildId

<LuaProperty name="BaseGuildVoiceChannel.guildId" type="string" />
### voiceConnection

<LuaProperty name="BaseGuildVoiceChannel.voiceConnection" type="Network.DiscordVoiceConnection?" />
### bitrate

<LuaProperty name="BaseGuildVoiceChannel.bitrate" type="number" />
### userLimit

<LuaProperty name="BaseGuildVoiceChannel.userLimit" type="number" />
### rtcRegion

<LuaProperty name="BaseGuildVoiceChannel.rtcRegion" type="string" />
### videoQualityMode

<LuaProperty name="BaseGuildVoiceChannel.videoQualityMode" type="number" />
### guildId

<LuaProperty name="BaseGuildVoiceChannel.guildId" type="string" />

> This property was inherited from [Objects.BaseDiscordGuildChannel](Objects.BaseDiscordGuildChannel)
### topic

<LuaProperty name="BaseGuildVoiceChannel.topic" type="string" />

> This property was inherited from [Objects.BaseDiscordGuildChannel](Objects.BaseDiscordGuildChannel)
### nsfw

<LuaProperty name="BaseGuildVoiceChannel.nsfw" type="boolean" />

> This property was inherited from [Objects.BaseDiscordGuildChannel](Objects.BaseDiscordGuildChannel)
### rateLimitPerUser

<LuaProperty name="BaseGuildVoiceChannel.rateLimitPerUser" type="number" />

> This property was inherited from [Objects.BaseDiscordGuildChannel](Objects.BaseDiscordGuildChannel)
### parentId

<LuaProperty name="BaseGuildVoiceChannel.parentId" type="string" />

> This property was inherited from [Objects.BaseDiscordGuildChannel](Objects.BaseDiscordGuildChannel)
### flags

<LuaProperty name="BaseGuildVoiceChannel.flags" type="number" />

> This property was inherited from [Objects.BaseDiscordGuildChannel](Objects.BaseDiscordGuildChannel)
[//]: # (----- DOCUMENT METHODS ----- )

Expand Down
Loading

0 comments on commit 1aa7676

Please sign in to comment.