Merge branch 'master' of https://github.com/DiscordLuau/docs

DiscordLuau · Jun 20, 2024 · 1a099a5 · 1a099a5
2 parents e66188b + feaea85
commit 1a099a5
Show file tree

Hide file tree

Showing 17 changed files with 195 additions and 196 deletions.
diff --git a/src/content/docs/classes/Network/DiscordShard.mdx b/src/content/docs/classes/Network/DiscordShard.mdx
@@ -27,7 +27,86 @@ This class is internal and should not be used directly by developers.
 
 ## Properties
 
-The DiscordShard instance has no set properties!
+### discordWebsocket
+
+<LuaProperty name="DiscordShard.discordWebsocket" type="Network.DiscordWebsocket" />
+---
+
+### websocketUrl
+
+<LuaProperty name="DiscordShard.websocketUrl" type="string" />
+---
+
+### reporter
+
+<LuaProperty name="DiscordShard.reporter" type="Vendor.Console" />
+---
+
+### heartbeatTask
+
+<LuaProperty name="DiscordShard.heartbeatTask" type="thread?" />
+---
+
+### resumeSessionId
+
+<LuaProperty name="DiscordShard.resumeSessionId" type="string" />
+---
+
+### dispatchSequence
+
+<LuaProperty name="DiscordShard.dispatchSequence" type="number" />
+---
+
+### heartbeatInterval
+
+<LuaProperty name="DiscordShard.heartbeatInterval" type="number" />
+---
+
+### heartbeatClockTime
+
+<LuaProperty name="DiscordShard.heartbeatClockTime" type="number" />
+---
+
+### heartbeatPing
+
+<LuaProperty name="DiscordShard.heartbeatPing" type="number" />
+---
+
+### identified
+
+<LuaProperty name="DiscordShard.identified" type="boolean?" />
+---
+
+### resumeGatewayUrl
+
+<LuaProperty name="DiscordShard.resumeGatewayUrl" type="string" />
+---
+
+### heartbeatAck
+
+<LuaProperty name="DiscordShard.heartbeatAck" type="boolean?" />
+---
+
+### activeConnections
+
+<LuaProperty name="DiscordShard.activeConnections" type="{ unknown }" />
+---
+
+### onEvent
+
+<LuaProperty name="DiscordShard.onEvent" type="Vendor.Signal<string, { [any]: any }>" />
+---
+
+### onIdentified
+
+<LuaProperty name="DiscordShard.onIdentified" type="Vendor.Signal" />
+---
+
+### shardId
+
+<LuaProperty name="DiscordShard.shardId" type="number" />
+---
+
 
 [//]: # (----- DOCUMENT METHODS ----- )
 

diff --git a/src/content/docs/classes/Network/DiscordUDP.mdx b/src/content/docs/classes/Network/DiscordUDP.mdx
@@ -27,86 +27,6 @@ This class is internal and should not be used directly by developers.
 
 ## Properties
 
-### discordWebsocket
-
-<LuaProperty name="DiscordUDP.discordWebsocket" type="Network.DiscordWebsocket" />
----
-
-### websocketUrl
-
-<LuaProperty name="DiscordUDP.websocketUrl" type="string" />
----
-
-### reporter
-
-<LuaProperty name="DiscordUDP.reporter" type="Vendor.Console" />
----
-
-### heartbeatTask
-
-<LuaProperty name="DiscordUDP.heartbeatTask" type="thread?" />
----
-
-### resumeSessionId
-
-<LuaProperty name="DiscordUDP.resumeSessionId" type="string" />
----
-
-### dispatchSequence
-
-<LuaProperty name="DiscordUDP.dispatchSequence" type="number" />
----
-
-### heartbeatInterval
-
-<LuaProperty name="DiscordUDP.heartbeatInterval" type="number" />
----
-
-### heartbeatClockTime
-
-<LuaProperty name="DiscordUDP.heartbeatClockTime" type="number" />
----
-
-### heartbeatPing
-
-<LuaProperty name="DiscordUDP.heartbeatPing" type="number" />
----
-
-### identified
-
-<LuaProperty name="DiscordUDP.identified" type="boolean?" />
----
-
-### resumeGatewayUrl
-
-<LuaProperty name="DiscordUDP.resumeGatewayUrl" type="string" />
----
-
-### heartbeatAck
-
-<LuaProperty name="DiscordUDP.heartbeatAck" type="boolean?" />
----
-
-### activeConnections
-
-<LuaProperty name="DiscordUDP.activeConnections" type="{ unknown }" />
----
-
-### onEvent
-
-<LuaProperty name="DiscordUDP.onEvent" type="Vendor.Signal<string, { [any]: any }>" />
----
-
-### onIdentified
-
-<LuaProperty name="DiscordUDP.onIdentified" type="Vendor.Signal" />
----
-
-### shardId
-
-<LuaProperty name="DiscordUDP.shardId" type="number" />
----
-
 ### udpActive
 
 <LuaProperty name="DiscordUDP.udpActive" type="boolean" />

diff --git a/src/content/docs/classes/Network/DiscordVoiceConnection.mdx b/src/content/docs/classes/Network/DiscordVoiceConnection.mdx
@@ -99,12 +99,12 @@ This class is internal and should not be used directly by developers. Instead, u
 
 ### voiceServerUpdate
 
-<LuaProperty name="DiscordVoiceConnection.voiceServerUpdate" type="{ endpoint: string, token: string, guildId: string, }" />
+<LuaProperty name="DiscordVoiceConnection.voiceServerUpdate" type="{ endpoint: string, token: string, guildId: string }" />
 ---
 
 ### voiceStateUpdate
 
-<LuaProperty name="DiscordVoiceConnection.voiceStateUpdate" type="{ sessionId: string, }" />
+<LuaProperty name="DiscordVoiceConnection.voiceStateUpdate" type="{ sessionId: string }" />
 ---
 
 ### onEvent

diff --git a/src/content/docs/classes/Network/WebsocketBuffer.mdx b/src/content/docs/classes/Network/WebsocketBuffer.mdx
@@ -29,11 +29,6 @@ This class is internal and should not be used directly by developers. Instead, u
 
 ### data
 
-<LuaProperty name="WebsocketBuffer.data" type="string" />
----
-
-### data
-
 <LuaProperty name="WebsocketBuffer.data" type="any" />
 ---
 
@@ -54,7 +49,12 @@ This class is internal and should not be used directly by developers. Instead, u
 
 ### metadata
 
-<LuaProperty name="WebsocketBuffer.metadata" type="{ headers: { [string]: string }, attachments: { any }, }," />
+<LuaProperty name="WebsocketBuffer.metadata" type="{ headers: { [string]: string }, attachments: { any } }," />
+---
+
+### data
+
+<LuaProperty name="WebsocketBuffer.data" type="string" />
 ---
 
 

diff --git a/src/content/docs/classes/Objects/BaseGuildTextChannel.mdx b/src/content/docs/classes/Objects/BaseGuildTextChannel.mdx
@@ -23,16 +23,6 @@ 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" />
@@ -63,6 +53,16 @@ A base guild text channel, where any/all text channels extend from.
 <LuaProperty name="BaseGuildTextChannel.flags" type="number" />
 ---
 
+### lastPinTimestamp
+
+<LuaProperty name="BaseGuildTextChannel.lastPinTimestamp" type="string" />
+---
+
+### lastMessageId
+
+<LuaProperty name="BaseGuildTextChannel.lastMessageId" type="string?" />
+---
+
 
 [//]: # (----- DOCUMENT METHODS ----- )
 

diff --git a/src/content/docs/classes/Objects/BaseGuildThread.mdx b/src/content/docs/classes/Objects/BaseGuildThread.mdx
@@ -45,12 +45,12 @@ A base discord Thread channel, all discord threads extend from.
 
 ### threadMetadata
 
-<LuaProperty name="BaseGuildThread.threadMetadata" type="{ archived: boolean, autoArchiveDuration: number, archiveTimestamp: string, locked: boolean, invitable: boolean?, createTimestamp: string?, }," />
+<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?, }, }," />
+<LuaProperty name="BaseGuildThread.availableTags" type="{ { id: string, name: string, moderated: boolean, emojiId: string?, emojiName: string? } }," />
 ---
 
 ### appliedTags
@@ -63,20 +63,6 @@ A base discord Thread channel, all discord threads extend from.
 <LuaProperty name="BaseGuildThread.defaultReactionEmoji" type="Objects.DiscordEmoji" />
 ---
 
-### 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)
 ### guildId
 
 <LuaProperty name="BaseGuildThread.guildId" type="string" />
@@ -118,6 +104,20 @@ A base discord Thread channel, all discord threads extend from.
 ---
 
 
+> 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)
 
 [//]: # (----- DOCUMENT METHODS ----- )

diff --git a/src/content/docs/classes/Objects/DiscordApplication.mdx b/src/content/docs/classes/Objects/DiscordApplication.mdx
@@ -28,32 +28,6 @@ The `DiscordApplication` class provides methods to interact with Discord applica
 <LuaProperty name="DiscordApplication.id" type="string" />
 ---
 
-### recipients
-
-<LuaProperty name="DiscordApplication.recipients" type="{ Objects.DiscordUser }" />
----
-
-### id
-
-<LuaProperty name="DiscordApplication.id" type="string The unique identifier of the Discord application." />
-### flags
-
-<LuaProperty name="DiscordApplication.flags" type="number The flags associated with the Discord application." />
-### id
-
-<LuaProperty name="DiscordApplication.id" type="string" />
----
-
-### flags
-
-<LuaProperty name="DiscordApplication.flags" type="number" />
----
-
-### id
-
-<LuaProperty name="DiscordApplication.id" type="string" />
----
-
 ### guildId
 
 <LuaProperty name="DiscordApplication.guildId" type="string" />
@@ -84,6 +58,32 @@ The `DiscordApplication` class provides methods to interact with Discord applica
 <LuaProperty name="DiscordApplication.videoQualityMode" type="number" />
 ---
 
+### id
+
+<LuaProperty name="DiscordApplication.id" type="string" />
+---
+
+### recipients
+
+<LuaProperty name="DiscordApplication.recipients" type="{ Objects.DiscordUser }" />
+---
+
+### id
+
+<LuaProperty name="DiscordApplication.id" type="string The unique identifier of the Discord application." />
+### flags
+
+<LuaProperty name="DiscordApplication.flags" type="number The flags associated with the Discord application." />
+### id
+
+<LuaProperty name="DiscordApplication.id" type="string" />
+---
+
+### flags
+
+<LuaProperty name="DiscordApplication.flags" type="number" />
+---
+
 
 [//]: # (----- DOCUMENT METHODS ----- )
 

diff --git a/src/content/docs/classes/Objects/DiscordAutomoderationRule.mdx b/src/content/docs/classes/Objects/DiscordAutomoderationRule.mdx
@@ -65,12 +65,12 @@ The `DiscordAutomoderationRule` class provides methods to interact with Discord
 
 ### triggerMetadata
 
-<LuaProperty name="DiscordAutomoderationRule.triggerMetadata" type="{ keywordFilter: { string }, regexPatterns: { string }, presets: { number }, allowList: { string }, mentionTotalLimit: number, mentionRaidProtectionEnabled: boolean, }" />
+<LuaProperty name="DiscordAutomoderationRule.triggerMetadata" type="{ keywordFilter: { string }, regexPatterns: { string }, presets: { number }, allowList: { string }, mentionTotalLimit: number, mentionRaidProtectionEnabled: boolean }" />
 ---
 
 ### actions
 
-<LuaProperty name="DiscordAutomoderationRule.actions" type="{ type: number, metadata: { channelId: string, durationSeconds: number, customMessage: string?, }?, }," />
+<LuaProperty name="DiscordAutomoderationRule.actions" type="{ type: number, metadata: { channelId: string, durationSeconds: number, customMessage: string? }? }," />
 ---
 
 

diff --git a/src/content/docs/classes/Objects/DiscordGuild.mdx b/src/content/docs/classes/Objects/DiscordGuild.mdx
@@ -183,7 +183,7 @@ Gets the vanity url for this guild.
 Gets the guild welcome screen for this guild.
 ### getGuildWidgetImageAsync
 
-> <LuaDeclaration name="getGuildWidgetImageAsync" className="DiscordGuild" args={[ { name: "style", type: ""shield" | "banner1" | "banner2" | "banner3" | "banner4"" } ]} returnType="Vendor.Future<string>" isMethod />
+> <LuaDeclaration name="getGuildWidgetImageAsync" className="DiscordGuild" args={[ { name: "style", type: "'shield' | 'banner1' | 'banner2' | 'banner3' | 'banner4'" } ]} returnType="Vendor.Future<string>" isMethod />
 Gets the binary PNG image for a server widget
 ### modifyGuildWelcomeScreenAsync