From 86896062f89ef033c8bc910584b8c047cd8a3b77 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 8 Jun 2024 18:14:37 +0000 Subject: [PATCH] docs: update refs for https://github.com/DiscordLuau/discord-luau/commit/e89e4bfa1835624d855ff6c5dd665bd97bfd1acb --- discord-luau | 2 +- .../docs/classes/Builders/MemberBuilder.mdx | 76 +++++++++++++++++++ src/content/docs/classes/DiscordClient.mdx | 6 +- .../docs/classes/Objects/DiscordGuild.mdx | 22 +++++- .../classes/Objects/DiscordGuildMember.mdx | 2 +- .../docs/classes/Objects/DiscordSticker.mdx | 43 +++++++++++ .../docs/classes/Objects/GuildPreview.mdx | 39 ++++++++++ 7 files changed, 186 insertions(+), 4 deletions(-) create mode 100644 src/content/docs/classes/Builders/MemberBuilder.mdx create mode 100644 src/content/docs/classes/Objects/DiscordSticker.mdx create mode 100644 src/content/docs/classes/Objects/GuildPreview.mdx diff --git a/discord-luau b/discord-luau index 8935045..e89e4bf 160000 --- a/discord-luau +++ b/discord-luau @@ -1 +1 @@ -Subproject commit 8935045308863ea5c554217ac7699d52d5cebf7a +Subproject commit e89e4bfa1835624d855ff6c5dd665bd97bfd1acb diff --git a/src/content/docs/classes/Builders/MemberBuilder.mdx b/src/content/docs/classes/Builders/MemberBuilder.mdx new file mode 100644 index 0000000..dfda832 --- /dev/null +++ b/src/content/docs/classes/Builders/MemberBuilder.mdx @@ -0,0 +1,76 @@ +--- +title: MemberBuilder +description: DiscordLuau docs for MemberBuilder. +--- +[//]: # (This file was automatically compiled through the Generator luau code under this repository) +[//]: # (if you want to edit the documentation of discord-luau, please write changes) +[//]: # (to the discord-luau repository itself, we extract the comments from discord-luau and translate) +[//]: # (them into markdown files that Nextra can interpret!) + +[//]: # (----- DOCUMENT IMPORTS ----- ) + +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; + +[//]: # (----- DOCUMENT DESCRIPTION ----- ) + +MemberBuilder is used to update a member object for a guild, + +Usage: +```lua +local member = MemberBuilder.new() + :setNickname("Discordian #0!") +``` + +[//]: # (----- DOCUMENT PROPERTIES ----- ) + +## Properties + +The MemberBuilder instance has no set properties! + +[//]: # (----- DOCUMENT METHODS ----- ) + +## Methods + +### setNickname + +> +Sets the nickname of a discord member +### addRole + +> +Adds a role to a member +### setMuted + +> +Sets the muted state for this member +### setDeafened + +> +Sets the deafened state for this member +### setActiveVoiceChannel + +> +Allows you to specify the voice channel to move the member too. +### setTimeoutFor + +> +Allows you to timeout a members communication. +### setFlags + +> +Sets the bitflags for this Member +### toPayloadObject + +> +Converts the member to a JSON object that can be sent to the Discord API. + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) + +## Functions + +### new + +> +Creates a new instance of MemberBuilder. + diff --git a/src/content/docs/classes/DiscordClient.mdx b/src/content/docs/classes/DiscordClient.mdx index ce4878f..50e131e 100644 --- a/src/content/docs/classes/DiscordClient.mdx +++ b/src/content/docs/classes/DiscordClient.mdx @@ -70,12 +70,16 @@ end) Fetches a guild by its ID. ### fetchChannelAsync -> +> Fetches a channel by its ID. ### updatePresenceAsync > Updates the client's presence. +### createGuildAsync + +> +Creates a Guild, owned by the application. ### setVerbose > diff --git a/src/content/docs/classes/Objects/DiscordGuild.mdx b/src/content/docs/classes/Objects/DiscordGuild.mdx index b72d4e7..1a690c0 100644 --- a/src/content/docs/classes/Objects/DiscordGuild.mdx +++ b/src/content/docs/classes/Objects/DiscordGuild.mdx @@ -60,8 +60,12 @@ Sets multiple slash commands in the guild asynchronously. Gets the audit logs of the guild asynchronously. ### modifyAsync -> +> Modifies the guild settings asynchronously. +### modifyCurrentMemberAsync + +> +Modifies the current member of the discord guild ### deleteAsync > @@ -94,6 +98,22 @@ Gets a specific automoderation rule in the guild asynchronously. > Creates an automoderation rule in the guild asynchronously. +### getPreviewAsync + +> +Get the preview of the current Guild +### createChannelAsync + +> +Creates a Guild Channel under a Guild. +### getActiveGuildThreads + +> +Fetches all active guild threads. +### addMemberAsync + +> +Adds a discordian to a guild. [//]: # (----- DOCUMENT FUNCTIONS ----- ) diff --git a/src/content/docs/classes/Objects/DiscordGuildMember.mdx b/src/content/docs/classes/Objects/DiscordGuildMember.mdx index 7c724b9..a2e1482 100644 --- a/src/content/docs/classes/Objects/DiscordGuildMember.mdx +++ b/src/content/docs/classes/Objects/DiscordGuildMember.mdx @@ -76,7 +76,7 @@ Undeafens the guild member asynchronously. Sets the nickname of the guild member asynchronously. ### modifyAsync -> +> Modifies the guild member asynchronously. [//]: # (----- DOCUMENT FUNCTIONS ----- ) diff --git a/src/content/docs/classes/Objects/DiscordSticker.mdx b/src/content/docs/classes/Objects/DiscordSticker.mdx new file mode 100644 index 0000000..4b16abb --- /dev/null +++ b/src/content/docs/classes/Objects/DiscordSticker.mdx @@ -0,0 +1,43 @@ +--- +title: DiscordSticker +description: DiscordLuau docs for DiscordSticker. +--- +[//]: # (This file was automatically compiled through the Generator luau code under this repository) +[//]: # (if you want to edit the documentation of discord-luau, please write changes) +[//]: # (to the discord-luau repository itself, we extract the comments from discord-luau and translate) +[//]: # (them into markdown files that Nextra can interpret!) + +[//]: # (----- DOCUMENT IMPORTS ----- ) + +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; + +[//]: # (----- DOCUMENT DESCRIPTION ----- ) + +The `DiscordSticker` class represents a Discord sticker and provides a structure for sticker data. + +[//]: # (----- DOCUMENT PROPERTIES ----- ) + +## Properties + +### type + + +--- +The type of the DiscordSticker. Default is "DiscordSticker". + +[//]: # (----- DOCUMENT METHODS ----- ) + +## Methods + +The DiscordSticker instance has no set methods! + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) + +## Functions + +### new + +> +Creates a new DiscordSticker instance. + diff --git a/src/content/docs/classes/Objects/GuildPreview.mdx b/src/content/docs/classes/Objects/GuildPreview.mdx new file mode 100644 index 0000000..6bf493a --- /dev/null +++ b/src/content/docs/classes/Objects/GuildPreview.mdx @@ -0,0 +1,39 @@ +--- +title: GuildPreview +description: DiscordLuau docs for GuildPreview. +--- +[//]: # (This file was automatically compiled through the Generator luau code under this repository) +[//]: # (if you want to edit the documentation of discord-luau, please write changes) +[//]: # (to the discord-luau repository itself, we extract the comments from discord-luau and translate) +[//]: # (them into markdown files that Nextra can interpret!) + +[//]: # (----- DOCUMENT IMPORTS ----- ) + +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; + +[//]: # (----- DOCUMENT DESCRIPTION ----- ) + +GuildPreview represents a user on Discord, encapsulating user data such as username, avatar, and various flags. + +[//]: # (----- DOCUMENT PROPERTIES ----- ) + +## Properties + +The GuildPreview instance has no set properties! + +[//]: # (----- DOCUMENT METHODS ----- ) + +## Methods + +The GuildPreview instance has no set methods! + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) + +## Functions + +### new + +> +Creates a new instance of GuildPreview. +