diff --git a/discord-luau b/discord-luau index 9b06ad7..b7f2ec0 160000 --- a/discord-luau +++ b/discord-luau @@ -1 +1 @@ -Subproject commit 9b06ad76c1e504e004c16c2a38015fab28ac7a6b +Subproject commit b7f2ec0cd02f7d3aed8f4c9c566a8515f88e360d diff --git a/src/content/docs/classes/Builders/ActivityBuilder.mdx b/src/content/docs/classes/Builders/ActivityBuilder.mdx index a9d504e..4123e1f 100644 --- a/src/content/docs/classes/Builders/ActivityBuilder.mdx +++ b/src/content/docs/classes/Builders/ActivityBuilder.mdx @@ -2,22 +2,21 @@ title: ActivityBuilder description: DiscordLuau docs for ActivityBuilder. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) ActivityBuilder is used to construct an activity object for a Discord bot - including name, type, and streaming URL. Usage: - ```lua local activity = ActivityBuilder.new() :setActivityName("Playing a game") @@ -25,14 +24,14 @@ local activity = ActivityBuilder.new() :setStreamingURL("https://twitch.tv/example") ``` -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties ### Type -## - + +--- An enumeration of activity types. - Game: 0 @@ -41,59 +40,33 @@ An enumeration of activity types. - Watching: 3 - Competing: 5 -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### setActivityName -> name="setActivityName" -> className="ActivityBuilder" -> args={[{ name: "activityName", type: "string" }]} -> returnType="Builders.ActivityBuilder" -> isMethod -> /> -> Sets the name of the activity. - +> +Sets the name of the activity. ### setActivityType -> name="setActivityType" -> className="ActivityBuilder" -> args={[{ name: "activityType", type: "number" }]} -> returnType="Builders.ActivityBuilder" -> isMethod -> /> -> Sets the type of the activity. - +> +Sets the type of the activity. ### setStreamingURL -> name="setStreamingURL" -> className="ActivityBuilder" -> args={[{ name: "streamURL", type: "string" }]} -> returnType="Builders.ActivityBuilder" -> isMethod -> /> -> Sets the streaming URL of the activity. Only YouTube and Twitch URLs are allowed. - +> +Sets the streaming URL of the activity. Only YouTube and Twitch URLs are allowed. ### toPayloadObject -> name="toPayloadObject" -> className="ActivityBuilder" -> args={[]} -> returnType="Network.Resolvable" -> isMethod -> /> -> Converts the activity to a JSON object that can be sent to the Discord API. +> +Converts the activity to a JSON object that can be sent to the Discord API. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> -> Creates a new instance of ActivityBuilder. +> +Creates a new instance of ActivityBuilder. + diff --git a/src/content/docs/classes/Builders/AttachmentBuilder.mdx b/src/content/docs/classes/Builders/AttachmentBuilder.mdx new file mode 100644 index 0000000..29029e8 --- /dev/null +++ b/src/content/docs/classes/Builders/AttachmentBuilder.mdx @@ -0,0 +1,59 @@ +--- +title: AttachmentBuilder +description: DiscordLuau docs for AttachmentBuilder. +--- +[//]: # (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 ----- ) + +AttachmentBuilder allows you to build attachments that you can send files through to the discord API. + +Usage: +```lua +local DiscordLuau = require("../Submodules/DiscordLuau") + +local AttachmentBuilder = DiscordLuau.AttachmentBuilder.new() + :setName("Example.txt") + :setData("My Text Document!") +``` + +[//]: # (----- DOCUMENT PROPERTIES ----- ) + +## Properties + +The AttachmentBuilder instance has no set properties! + +[//]: # (----- DOCUMENT METHODS ----- ) + +## Methods + +### setName + +> +Set the name for this Attachment +### setDescription + +> +Set the description for this Attachment +### setData + +> +Set the data for this Attachment + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) + +## Functions + +### new + +> +Creates a new instance of AttachmentBuilder with the specified intents. + diff --git a/src/content/docs/classes/Builders/AutomoderationRuleBuilder.mdx b/src/content/docs/classes/Builders/AutomoderationRuleBuilder.mdx index d055368..3d863a6 100644 --- a/src/content/docs/classes/Builders/AutomoderationRuleBuilder.mdx +++ b/src/content/docs/classes/Builders/AutomoderationRuleBuilder.mdx @@ -2,22 +2,21 @@ title: AutomoderationRuleBuilder description: DiscordLuau docs for AutomoderationRuleBuilder. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) AutomoderationRuleBuilder is used to construct an auto-moderation rule for a Discord guild, including trigger types, actions, and exempt roles or channels. Usage: - ```lua local rule = AutomoderationRuleBuilder.new() :setName("No Profanity") @@ -28,160 +27,93 @@ local rule = AutomoderationRuleBuilder.new() :setEnabled(true) ``` -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties ### EventType -## - + +--- An enumeration of event types. - MessageSend: 1 - ### TriggerType -## - + +--- An enumeration of trigger types. - Keyword: 1 - Spam: 3 - KeywordPreset: 4 - MentionSpam: 5 - ### KeywordPresets -## - + +--- An enumeration of keyword presets. - Profanity: 1 - SexualContent: 2 - Slurs: 3 - ### ActionType -## - + +--- An enumeration of action types. - BlockMessage: 1 - SendAlertMessage: 2 - Timeout: 3 -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### setName -> name="setName" -> className="AutomoderationRuleBuilder" -> args={[{ name: "name", type: "string" }]} -> returnType="Builders.AutomoderationRuleBuilder" -> isMethod -> /> -> Sets the name of the rule. - +> +Sets the name of the rule. ### setEventType -> name="setEventType" -> className="AutomoderationRuleBuilder" -> args={[{ name: "eventType", type: "number" }]} -> returnType="Builders.AutomoderationRuleBuilder" -> isMethod -> /> -> Sets the event type for the rule. - +> +Sets the event type for the rule. ### setTriggerType -> name="setTriggerType" -> className="AutomoderationRuleBuilder" -> args={[{ name: "triggerType", type: "number" }]} -> returnType="Builders.AutomoderationRuleBuilder" -> isMethod -> /> -> Sets the trigger type for the rule. - +> +Sets the trigger type for the rule. ### setTriggerMetadata -> name="setTriggerMetadata" -> className="AutomoderationRuleBuilder" -> args={[{ name: "triggerMetadata", type: "table" }]} -> returnType="Builders.AutomoderationRuleBuilder" -> isMethod -> /> -> Sets the trigger metadata for the rule. - +> +Sets the trigger metadata for the rule. ### addAction -> name="addAction" -> className="AutomoderationRuleBuilder" -> args={[ -> { name: "actionType", type: "number" }, -> { name: "actionMetadata", type: "table" }, -> ]} -> returnType="Builders.AutomoderationRuleBuilder" -> isMethod -> /> -> Adds an action to the rule. - +> +Adds an action to the rule. ### setEnabled -> name="setEnabled" -> className="AutomoderationRuleBuilder" -> args={[{ name: "enabled", type: "boolean" }]} -> returnType="Builders.AutomoderationRuleBuilder" -> isMethod -> /> -> Sets whether the rule is enabled. - +> +Sets whether the rule is enabled. ### addExemptRole -> name="addExemptRole" -> className="AutomoderationRuleBuilder" -> args={[{ name: "roleId", type: "string" }]} -> returnType="Builders.AutomoderationRuleBuilder" -> isMethod -> /> -> Adds an exempt role to the rule. - +> +Adds an exempt role to the rule. ### addExemptChannel -> name="addExemptChannel" -> className="AutomoderationRuleBuilder" -> args={[{ name: "channelId", type: "string" }]} -> returnType="Builders.AutomoderationRuleBuilder" -> isMethod -> /> -> Adds an exempt channel to the rule. - +> +Adds an exempt channel to the rule. ### toPayloadObject -> name="toPayloadObject" -> className="AutomoderationRuleBuilder" -> args={[]} -> returnType="Network.Resolvable" -> isMethod -> /> -> Converts the rule to a JSON object that can be sent to the Discord API. +> +Converts the rule to a JSON object that can be sent to the Discord API. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> -> Creates a new instance of AutomoderationRuleBuilder. +> +Creates a new instance of AutomoderationRuleBuilder. + diff --git a/src/content/docs/classes/Builders/CommandBuilder.mdx b/src/content/docs/classes/Builders/CommandBuilder.mdx index d84871e..1a493fa 100644 --- a/src/content/docs/classes/Builders/CommandBuilder.mdx +++ b/src/content/docs/classes/Builders/CommandBuilder.mdx @@ -2,22 +2,21 @@ title: CommandBuilder description: DiscordLuau docs for CommandBuilder. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) CommandBuilder is used to construct a command for a Discord application, including type, name, description, and options. Usage: - ```lua local command = CommandBuilder.new() :setType(CommandBuilder.Type.ChatInput) @@ -29,160 +28,84 @@ local command = CommandBuilder.new() :addOption(CommandOptionBuilder.new():setType(CommandOptionBuilder.Type.String):setName("option1"):setDescription("An option")) ``` -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties ### Type -## - + +--- An enumeration of command types. - ChatInput: 1 - UserInput: 2 - MessageInput: 3 - ### Context -## - + +--- An enumeration of command contexts. - Guild: 0 - BotDM: 1 - PrivateChannel: 2 -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### setType -> name="setType" -> className="CommandBuilder" -> args={[{ name: "commandType", type: "number" }]} -> returnType="Builders.CommandBuilder" -> isMethod -> /> -> Sets the type of the command. - +> +Sets the type of the command. ### setLocalization -> name="setLocalization" -> className="CommandBuilder" -> args={[{ name: "localizationCode", type: "string" }]} -> returnType="Builders.CommandBuilder" -> isMethod -> /> -> Sets the localization code for the command. - +> +Sets the localization code for the command. ### setDescription -> name="setDescription" -> className="CommandBuilder" -> args={[{ name: "description", type: "string" }]} -> returnType="Builders.CommandBuilder" -> isMethod -> /> -> Sets the description of the command. - +> +Sets the description of the command. ### setName -> name="setName" -> className="CommandBuilder" -> args={[{ name: "name", type: "string" }]} -> returnType="Builders.CommandBuilder" -> isMethod -> /> -> Sets the name of the command. - +> +Sets the name of the command. ### setNSFW -> name="setNSFW" -> className="CommandBuilder" -> args={[{ name: "isNSFW", type: "boolean" }]} -> returnType="Builders.CommandBuilder" -> isMethod -> /> -> Sets whether the command is NSFW. - +> +Sets whether the command is NSFW. ### setDMPermission -> name="setDMPermission" -> className="CommandBuilder" -> args={[{ name: "canDM", type: "boolean" }]} -> returnType="Builders.CommandBuilder" -> isMethod -> /> -> Sets whether the command can be used in DMs. - +> +Sets whether the command can be used in DMs. ### setGuildPermissions -> name="setGuildPermissions" -> className="CommandBuilder" -> args={[{ name: "permissionObject", type: "PermissionsBuilder" }]} -> returnType="Builders.CommandBuilder" -> isMethod -> /> -> Sets the required permissions for the command in a guild. - +> +Sets the required permissions for the command in a guild. ### addOption -> name="addOption" -> className="CommandBuilder" -> args={[{ name: "commandObject", type: "CommandOptionBuilder" }]} -> returnType="Builders.CommandBuilder" -> isMethod -> /> -> Adds an option to the command. - +> +Adds an option to the command. ### setDefaultPermissionEnabled -> name="setDefaultPermissionEnabled" -> className="CommandBuilder" -> args={[{ name: "enabled", type: "boolean" }]} -> returnType="Builders.CommandBuilder" -> isMethod -> /> -> Sets whether the command has default permission enabled. - +> +Sets whether the command has default permission enabled. ### addContext -> name="addContext" -> className="CommandBuilder" -> args={[{ name: "context", type: "number" }]} -> returnType="Builders.CommandBuilder" -> isMethod -> /> -> Adds a context to the command. - +> +Adds a context to the command. ### toPayloadObject -> name="toPayloadObject" -> className="CommandBuilder" -> args={[]} -> returnType="Network.Resolvable" -> isMethod -> /> -> Converts the command to a JSON object that can be sent to the Discord API. +> +Converts the command to a JSON object that can be sent to the Discord API. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> -> Creates a new instance of CommandBuilder. +> +Creates a new instance of CommandBuilder. + diff --git a/src/content/docs/classes/Builders/CommandOptionBuilder.mdx b/src/content/docs/classes/Builders/CommandOptionBuilder.mdx index 8776a3f..9e0b62f 100644 --- a/src/content/docs/classes/Builders/CommandOptionBuilder.mdx +++ b/src/content/docs/classes/Builders/CommandOptionBuilder.mdx @@ -2,22 +2,21 @@ title: CommandOptionBuilder description: DiscordLuau docs for CommandOptionBuilder. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) CommandOptionBuilder is used to construct options for a Discord application command, including type, name, description, and choices. Usage: - ```lua local option = CommandOptionBuilder.new() :setType(CommandOptionBuilder.Type.String) @@ -28,14 +27,14 @@ local option = CommandOptionBuilder.new() :addChoice("Choice 2", "value2") ``` -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties ### Type -## - + +--- An enumeration of option types. - SubCommand: 1 @@ -49,11 +48,10 @@ An enumeration of option types. - Mentionable: 9 - Number: 10 - Attachment: 11 - ### ChannelType -## - + +--- An enumeration of channel types. - GuildText: 0 @@ -69,172 +67,73 @@ An enumeration of channel types. - GuildDirectory: 14 - GuildForum: 15 -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### setType -> name="setType" -> className="CommandOptionBuilder" -> args={[{ name: "optionType", type: "number" }]} -> returnType="Builders.CommandOptionBuilder" -> isMethod -> /> -> Sets the type of the option. - +> +Sets the type of the option. ### setName -> name="setName" -> className="CommandOptionBuilder" -> args={[{ name: "optionName", type: "string" }]} -> returnType="Builders.CommandOptionBuilder" -> isMethod -> /> -> Sets the name of the option. - +> +Sets the name of the option. ### setLocalization -> name="setLocalization" -> className="CommandOptionBuilder" -> args={[{ name: "localizationCode", type: "string" }]} -> returnType="Builders.CommandOptionBuilder" -> isMethod -> /> -> Sets the localization code for the option. - +> +Sets the localization code for the option. ### setDescription -> name="setDescription" -> className="CommandOptionBuilder" -> args={[{ name: "optionDescription", type: "string" }]} -> returnType="Builders.CommandOptionBuilder" -> isMethod -> /> -> Sets the description of the option. - +> +Sets the description of the option. ### setRequired -> name="setRequired" -> className="CommandOptionBuilder" -> args={[{ name: "isRequired", type: "boolean" }]} -> returnType="Builders.CommandOptionBuilder" -> isMethod -> /> -> Sets whether the option is required. - +> +Sets whether the option is required. ### setChannelTypes -> name="setChannelTypes" -> className="CommandOptionBuilder" -> args={[{ name: "channelTypes", type: "..." }]} -> returnType="Builders.CommandOptionBuilder" -> isMethod -> /> -> Sets the channel types for the option. - +> +Sets the channel types for the option. ### setMinValue -> name="setMinValue" -> className="CommandOptionBuilder" -> args={[{ name: "minValue", type: "number" }]} -> returnType="Builders.CommandOptionBuilder" -> isMethod -> /> -> Sets the minimum value for the option. - +> +Sets the minimum value for the option. ### setMaxValue -> name="setMaxValue" -> className="CommandOptionBuilder" -> args={[{ name: "maxValue", type: "number" }]} -> returnType="Builders.CommandOptionBuilder" -> isMethod -> /> -> Sets the maximum value for the option. - +> +Sets the maximum value for the option. ### setMinLength -> name="setMinLength" -> className="CommandOptionBuilder" -> args={[{ name: "minLength", type: "number" }]} -> returnType="Builders.CommandOptionBuilder" -> isMethod -> /> -> Sets the minimum length for the option. - +> +Sets the minimum length for the option. ### setMaxLength -> name="setMaxLength" -> className="CommandOptionBuilder" -> args={[{ name: "maxLength", type: "number" }]} -> returnType="Builders.CommandOptionBuilder" -> isMethod -> /> -> Sets the maximum length for the option. - +> +Sets the maximum length for the option. ### setAutocompleteEnabled -> name="setAutocompleteEnabled" -> className="CommandOptionBuilder" -> args={[{ name: "autocomplete", type: "boolean" }]} -> returnType="Builders.CommandOptionBuilder" -> isMethod -> /> -> Sets whether autocomplete is enabled for the option. - +> +Sets whether autocomplete is enabled for the option. ### addOption -> name="addOption" -> className="CommandOptionBuilder" -> args={[{ name: "commandOption", type: "CommandOptionBuilder" }]} -> returnType="Builders.CommandOptionBuilder" -> isMethod -> /> -> Adds a sub-option to the option. - +> +Adds a sub-option to the option. ### addChoice -> name="addChoice" -> className="CommandOptionBuilder" -> args={[ -> { name: "choiceName", type: "string" }, -> { name: "choiceValue", type: "any" }, -> ]} -> returnType="Builders.CommandOptionBuilder" -> isMethod -> /> -> Adds a choice to the option. - +> +Adds a choice to the option. ### toPayloadObject -> name="toPayloadObject" -> className="CommandOptionBuilder" -> args={[]} -> returnType="Network.Resolvable" -> isMethod -> /> -> Converts the option to a JSON object that can be sent to the Discord API. +> +Converts the option to a JSON object that can be sent to the Discord API. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> -> Creates a new instance of CommandOptionBuilder. +> +Creates a new instance of CommandOptionBuilder. + diff --git a/src/content/docs/classes/Builders/EmbedBuilder.mdx b/src/content/docs/classes/Builders/EmbedBuilder.mdx index da03748..c8fd6c4 100644 --- a/src/content/docs/classes/Builders/EmbedBuilder.mdx +++ b/src/content/docs/classes/Builders/EmbedBuilder.mdx @@ -2,22 +2,21 @@ title: EmbedBuilder description: DiscordLuau docs for EmbedBuilder. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) EmbedBuilder is used to construct an embed object for a Discord message. Usage: - ```lua local embed = EmbedBuilder.new() :setTitle("Embed Title") @@ -26,14 +25,14 @@ local embed = EmbedBuilder.new() :addField({name = "Field 1", value = "Value 1", inline = true}) ``` -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties ### Type -## - + +--- An enumeration of embed types. - Rich: "rich" @@ -43,194 +42,73 @@ An enumeration of embed types. - Article: "article" - Link: "link" -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### setTitle -> name="setTitle" -> className="EmbedBuilder" -> args={[{ name: "title", type: "string" }]} -> returnType="Builders.EmbedBuilder" -> isMethod -> /> -> Sets the title of the embed. - +> +Sets the title of the embed. ### setType -> name="setType" -> className="EmbedBuilder" -> args={[{ name: "type", type: "string" }]} -> returnType="Builders.EmbedBuilder" -> isMethod -> /> -> Sets the type of the embed. - +> +Sets the type of the embed. ### setDescription -> name="setDescription" -> className="EmbedBuilder" -> args={[{ name: "description", type: "string" }]} -> returnType="Builders.EmbedBuilder" -> isMethod -> /> -> Sets the description of the embed. - +> +Sets the description of the embed. ### setUrl -> name="setUrl" -> className="EmbedBuilder" -> args={[{ name: "url", type: "string" }]} -> returnType="Builders.EmbedBuilder" -> isMethod -> /> -> Sets the URL of the embed. - +> +Sets the URL of the embed. ### setTimestamp -> name="setTimestamp" -> className="EmbedBuilder" -> args={[{ name: "epoch", type: "number" }]} -> returnType="Builders.EmbedBuilder" -> isMethod -> /> -> Sets the timestamp of the embed. - +> +Sets the timestamp of the embed. ### setColor -> name="setColor" -> className="EmbedBuilder" -> args={[{ name: "colorHex", type: "HexLike | RGB" }]} -> returnType="Builders.EmbedBuilder" -> isMethod -> /> -> Sets the color of the embed. - +> +Sets the color of the embed. ### setFooter -> name="setFooter" -> className="EmbedBuilder" -> args={[{ name: "footerSettings", type: "{ text: string, icon: string }" }]} -> returnType="Builders.EmbedBuilder" -> isMethod -> /> -> Sets the footer of the embed. - +> +Sets the footer of the embed. ### setImage -> name="setImage" -> className="EmbedBuilder" -> args={[ -> { -> name: "imageSettings", -> type: "{ imageUrl: string, height: number, width: number }", -> }, -> ]} -> returnType="Builders.EmbedBuilder" -> isMethod -> /> -> Sets the image of the embed. - +> +Sets the image of the embed. ### setThumbnail -> name="setThumbnail" -> className="EmbedBuilder" -> args={[ -> { -> name: "thumbnailSettings", -> type: "{ thumbnailUrl: string, height: number, width: number }", -> }, -> ]} -> returnType="Builders.EmbedBuilder" -> isMethod -> /> -> Sets the thumbnail of the embed. - +> +Sets the thumbnail of the embed. ### setVideo -> name="setVideo" -> className="EmbedBuilder" -> args={[ -> { -> name: "videoSettings", -> type: "{ videoUrl: string, height: number, width: number }", -> }, -> ]} -> returnType="Builders.EmbedBuilder" -> isMethod -> /> -> Sets the video of the embed. - +> +Sets the video of the embed. ### setProvider -> name="setProvider" -> className="EmbedBuilder" -> args={[{ name: "providerSettings", type: "{ name: string, url: string }" }]} -> returnType="Builders.EmbedBuilder" -> isMethod -> /> -> Sets the provider of the embed. - +> +Sets the provider of the embed. ### setAuthor -> name="setAuthor" -> className="EmbedBuilder" -> args={[ -> { -> name: "authorSettings", -> type: "{ name: string, url: string, iconUrl: string }", -> }, -> ]} -> returnType="Builders.EmbedBuilder" -> isMethod -> /> -> Sets the author of the embed. - +> +Sets the author of the embed. ### addField -> name="addField" -> className="EmbedBuilder" -> args={[ -> { -> name: "fieldSettings", -> type: "{ name: string, value: string, inline: boolean? }", -> }, -> ]} -> returnType="Builders.EmbedBuilder" -> isMethod -> /> -> Adds a field to the embed. - +> +Adds a field to the embed. ### toPayloadObject -> name="toPayloadObject" -> className="EmbedBuilder" -> args={[]} -> returnType="Network.Resolvable" -> isMethod -> /> -> Converts the embed to a JSON object that can be sent to the Discord API. +> +Converts the embed to a JSON object that can be sent to the Discord API. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> -> Creates a new instance of EmbedBuilder. +> +Creates a new instance of EmbedBuilder. + diff --git a/src/content/docs/classes/Builders/IntentsBuilder.mdx b/src/content/docs/classes/Builders/IntentsBuilder.mdx index c32459a..69612d9 100644 --- a/src/content/docs/classes/Builders/IntentsBuilder.mdx +++ b/src/content/docs/classes/Builders/IntentsBuilder.mdx @@ -2,22 +2,21 @@ title: IntentsBuilder description: DiscordLuau docs for IntentsBuilder. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) IntentsBuilder is used to construct intents for a Discord bot, specifying which events the bot will receive. Usage: - ```lua local DiscordLuau = require("../Submodules/DiscordLuau") @@ -25,37 +24,32 @@ local IntentsBuilder = DiscordLuau.IntentsBuilder.fromAll() local DiscordSettings = DiscordLuau.DiscordSettings.new("BOT TOKEN", IntentsBuilder) ``` -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The IntentsBuilder instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods The IntentsBuilder instance has no set methods! -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="IntentsBuilder" -> args={[{ name: "intentList", type: "{ string }" }]} -> /> -> Creates a new instance of IntentsBuilder with the specified intents. - +> +Creates a new instance of IntentsBuilder with the specified intents. ### fromDefault -> -> Creates a new instance of IntentsBuilder with the default intents. - +> +Creates a new instance of IntentsBuilder with the default intents. ### fromAll -> -> Creates a new instance of IntentsBuilder with all available intents. +> +Creates a new instance of IntentsBuilder with all available intents. + diff --git a/src/content/docs/classes/Builders/Interface/ActionRowBuilder.mdx b/src/content/docs/classes/Builders/Interface/ActionRowBuilder.mdx index 6137893..31942ec 100644 --- a/src/content/docs/classes/Builders/Interface/ActionRowBuilder.mdx +++ b/src/content/docs/classes/Builders/Interface/ActionRowBuilder.mdx @@ -2,62 +2,45 @@ title: ActionRowBuilder description: DiscordLuau docs for ActionRowBuilder. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) ActionRowBuilder is used to construct an action row, which can contain up to five components like buttons, selections, or text inputs. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The ActionRowBuilder instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### addComponent -> name="addComponent" -> className="ActionRowBuilder" -> args={[ -> { -> name: "componentObject", -> type: "ActionRowBuilder | ButtonBuilder | SelectionBuilder | TextInputBuilder", -> }, -> ]} -> returnType="Builders.Interface.ActionRowBuilder" -> isMethod -> /> -> Adds a component to the action row. The action row can contain up to five components. - +> +Adds a component to the action row. The action row can contain up to five components. ### toPayloadObject -> name="toPayloadObject" -> className="ActionRowBuilder" -> args={[]} -> returnType="Network.Resolvable" -> isMethod -> /> -> Converts the action row to a JSON object that can be sent to the Discord API. +> +Converts the action row to a JSON object that can be sent to the Discord API. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> -> Creates a new instance of ActionRowBuilder. +> +Creates a new instance of ActionRowBuilder. + diff --git a/src/content/docs/classes/Builders/Interface/ButtonBuilder.mdx b/src/content/docs/classes/Builders/Interface/ButtonBuilder.mdx index 5129c40..9b5aa31 100644 --- a/src/content/docs/classes/Builders/Interface/ButtonBuilder.mdx +++ b/src/content/docs/classes/Builders/Interface/ButtonBuilder.mdx @@ -2,28 +2,28 @@ title: ButtonBuilder description: DiscordLuau docs for ButtonBuilder. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) ButtonBuilder is used to construct a button component for a Discord message. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties ### Style -## - + +--- An enumeration of button styles. - Blurple: 1 @@ -32,89 +32,41 @@ An enumeration of button styles. - Red: 4 - Link: 5 -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### setStyle -> name="setStyle" -> className="ButtonBuilder" -> args={[{ name: "buttonStyle", type: "number" }]} -> returnType="Builders.Interface.ButtonBuilder" -> isMethod -> /> -> Sets the style of the button. - +> +Sets the style of the button. ### setLabel -> name="setLabel" -> className="ButtonBuilder" -> args={[{ name: "buttonLabel", type: "string" }]} -> returnType="Builders.Interface.ButtonBuilder" -> isMethod -> /> -> Sets the label of the button. - +> +Sets the label of the button. ### setEmoji -> name="setEmoji" -> className="ButtonBuilder" -> args={[ -> { name: "emojiId", type: "string" }, -> { name: "emojiName", type: "string" }, -> ]} -> returnType="Builders.Interface.ButtonBuilder" -> isMethod -> /> -> Sets the emoji for the button. - +> +Sets the emoji for the button. ### setLinkUrl -> name="setLinkUrl" -> className="ButtonBuilder" -> args={[{ name: "url", type: "string" }]} -> returnType="Builders.Interface.ButtonBuilder" -> isMethod -> /> -> Sets the URL for the button. This should only be used if the button style is set -> to `Link`. - +> +Sets the URL for the button. This should only be used if the button style is set to `Link`. ### setDisabled -> name="setDisabled" -> className="ButtonBuilder" -> args={[{ name: "isDisabled", type: "boolean" }]} -> returnType="Builders.Interface.ButtonBuilder" -> isMethod -> /> -> Sets whether the button is disabled. - +> +Sets whether the button is disabled. ### toPayloadObject -> name="toPayloadObject" -> className="ButtonBuilder" -> args={[]} -> returnType="Network.Resolvable" -> isMethod -> /> -> Converts the button to a JSON object that can be sent to the Discord API. +> +Converts the button to a JSON object that can be sent to the Discord API. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="ButtonBuilder" -> args={[{ name: "buttonId", type: "string" }]} -> /> -> Creates a new instance of ButtonBuilder. +> +Creates a new instance of ButtonBuilder. + diff --git a/src/content/docs/classes/Builders/Interface/SelectionBuilder.mdx b/src/content/docs/classes/Builders/Interface/SelectionBuilder.mdx index 554055f..8301179 100644 --- a/src/content/docs/classes/Builders/Interface/SelectionBuilder.mdx +++ b/src/content/docs/classes/Builders/Interface/SelectionBuilder.mdx @@ -2,28 +2,28 @@ title: SelectionBuilder description: DiscordLuau docs for SelectionBuilder. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) SelectionBuilder is used to construct a selection (dropdown) component for a Discord message. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties ### Type -## - + +--- An enumeration of selection types. - TextSelection: 3 @@ -31,11 +31,10 @@ An enumeration of selection types. - RoleSelection: 6 - MentionableSelection: 7 - ChannelSelection: 8 - ### ChannelType -## - + +--- An enumeration of channel types. - GuildText: 0 @@ -51,125 +50,53 @@ An enumeration of channel types. - GuildDirectory: 14 - GuildForum: 15 -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### setType -> name="setType" -> className="SelectionBuilder" -> args={[{ name: "selectionType", type: "number" }]} -> returnType="Builders.Interface.SelectionBuilder" -> isMethod -> /> -> Sets the type of the selection. - +> +Sets the type of the selection. ### setChannelTypes -> name="setChannelTypes" -> className="SelectionBuilder" -> args={[{ name: "...", type: "number" }]} -> returnType="Builders.Interface.SelectionBuilder" -> isMethod -> /> -> Sets the channel types for the selection. - +> +Sets the channel types for the selection. ### setPlaceholder -> name="setPlaceholder" -> className="SelectionBuilder" -> args={[{ name: "placeholderText", type: "string" }]} -> returnType="Builders.Interface.SelectionBuilder" -> isMethod -> /> -> Sets the placeholder text for the selection. - +> +Sets the placeholder text for the selection. ### setDisabled -> name="setDisabled" -> className="SelectionBuilder" -> args={[{ name: "isDisabled", type: "boolean" }]} -> returnType="Builders.Interface.SelectionBuilder" -> isMethod -> /> -> Sets whether the selection is disabled. - +> +Sets whether the selection is disabled. ### setMinValues -> name="setMinValues" -> className="SelectionBuilder" -> args={[{ name: "minValue", type: "number" }]} -> returnType="Builders.Interface.SelectionBuilder" -> isMethod -> /> -> Sets the minimum number of values that must be selected. - +> +Sets the minimum number of values that must be selected. ### setMaxValues -> name="setMaxValues" -> className="SelectionBuilder" -> args={[{ name: "maxValue", type: "number" }]} -> returnType="Builders.Interface.SelectionBuilder" -> isMethod -> /> -> Sets the maximum number of values that can be selected. - +> +Sets the maximum number of values that can be selected. ### addChoice -> name="addChoice" -> className="SelectionBuilder" -> args={[ -> { name: "choiceName", type: "string" }, -> { name: "choiceValue", type: "string" }, -> { name: "choiceDescription", type: "string" }, -> { name: "isDefault", type: "boolean" }, -> { name: "emojiId", type: "string?" }, -> { name: "emojiName", type: "string?" }, -> ]} -> returnType="Builders.Interface.SelectionBuilder" -> isMethod -> /> -> Adds a choice to the selection. - +> +Adds a choice to the selection. ### destroyChoice -> name="destroyChoice" -> className="SelectionBuilder" -> args={[{ name: "choiceName", type: "string" }]} -> returnType="Builders.Interface.SelectionBuilder" -> isMethod -> /> -> Removes a choice from the selection. - +> +Removes a choice from the selection. ### toPayloadObject -> name="toPayloadObject" -> className="SelectionBuilder" -> args={[]} -> returnType="Network.Resolvable" -> isMethod -> /> -> Converts the selection to a JSON object that can be sent to the Discord API. +> +Converts the selection to a JSON object that can be sent to the Discord API. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="SelectionBuilder" -> args={[{ name: "selectionId", type: "string" }]} -> /> -> Creates a new instance of SelectionBuilder. +> +Creates a new instance of SelectionBuilder. + diff --git a/src/content/docs/classes/Builders/Interface/TextInputBuilder.mdx b/src/content/docs/classes/Builders/Interface/TextInputBuilder.mdx index c6c5cef..79c3056 100644 --- a/src/content/docs/classes/Builders/Interface/TextInputBuilder.mdx +++ b/src/content/docs/classes/Builders/Interface/TextInputBuilder.mdx @@ -2,134 +2,76 @@ title: TextInputBuilder description: DiscordLuau docs for TextInputBuilder. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) TextInputBuilder is used to construct a text input component for a Discord message. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties ### Style -## - + +--- An enumeration of text input styles. - Short: 1 - Paragraph: 2 -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### setStyle -> name="setStyle" -> className="TextInputBuilder" -> args={[{ name: "inputStyle", type: "number" }]} -> returnType="Builders.Interface.TextInputBuilder" -> isMethod -> /> -> Sets the style of the text input. - +> +Sets the style of the text input. ### setLabel -> name="setLabel" -> className="TextInputBuilder" -> args={[{ name: "label", type: "string" }]} -> returnType="Builders.Interface.TextInputBuilder" -> isMethod -> /> -> Sets the label of the text input. - +> +Sets the label of the text input. ### setMinLength -> name="setMinLength" -> className="TextInputBuilder" -> args={[{ name: "length", type: "number" }]} -> returnType="Builders.Interface.TextInputBuilder" -> isMethod -> /> -> Sets the minimum length of the text input. - +> +Sets the minimum length of the text input. ### setMaxLength -> name="setMaxLength" -> className="TextInputBuilder" -> args={[{ name: "length", type: "number" }]} -> returnType="Builders.Interface.TextInputBuilder" -> isMethod -> /> -> Sets the maximum length of the text input. - +> +Sets the maximum length of the text input. ### setRequired -> name="setRequired" -> className="TextInputBuilder" -> args={[{ name: "isRequired", type: "boolean" }]} -> returnType="Builders.Interface.TextInputBuilder" -> isMethod -> /> -> Sets whether the text input is required. - +> +Sets whether the text input is required. ### setDefaultValue -> name="setDefaultValue" -> className="TextInputBuilder" -> args={[{ name: "value", type: "string" }]} -> returnType="Builders.Interface.TextInputBuilder" -> isMethod -> /> -> Sets the default value of the text input. - +> +Sets the default value of the text input. ### setPlaceholder -> name="setPlaceholder" -> className="TextInputBuilder" -> args={[{ name: "value", type: "string" }]} -> returnType="Builders.Interface.TextInputBuilder" -> isMethod -> /> -> Sets the placeholder value of the text input. - +> +Sets the placeholder value of the text input. ### toPayloadObject -> name="toPayloadObject" -> className="TextInputBuilder" -> args={[]} -> returnType="Network.Resolvable" -> isMethod -> /> -> Converts the text input to a JSON object that can be sent to the Discord API. +> +Converts the text input to a JSON object that can be sent to the Discord API. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="TextInputBuilder" -> args={[{ name: "textInputId", type: "string" }]} -> /> -> Creates a new instance of TextInputBuilder. +> +Creates a new instance of TextInputBuilder. + diff --git a/src/content/docs/classes/Builders/MessageBuilder.mdx b/src/content/docs/classes/Builders/MessageBuilder.mdx index 9792eda..15440d1 100644 --- a/src/content/docs/classes/Builders/MessageBuilder.mdx +++ b/src/content/docs/classes/Builders/MessageBuilder.mdx @@ -2,22 +2,21 @@ title: MessageBuilder description: DiscordLuau docs for MessageBuilder. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) MessageBuilder is used to construct a message that can be sent to a Discord channel, including content, embeds, components, and stickers. Usage: - ```lua local message = MessageBuilder.new() :setContent("Hello, world!") @@ -27,145 +26,67 @@ local message = MessageBuilder.new() :setTTSEnabled(true) ``` -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The MessageBuilder instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### setContent -> name="setContent" -> className="MessageBuilder" -> args={[{ name: "content", type: "string" }]} -> returnType="Builders.MessageBuilder" -> isMethod -> /> -> Sets the content of the message. - +> +Sets the content of the message. ### setNonce -> name="setNonce" -> className="MessageBuilder" -> args={[{ name: "nonce", type: "string" }]} -> returnType="Builders.MessageBuilder" -> isMethod -> /> -> Sets the nonce of the message. - +> +Sets the nonce of the message. ### setTTSEnabled -> name="setTTSEnabled" -> className="MessageBuilder" -> args={[{ name: "ttsEnabled", type: "boolean" }]} -> returnType="Builders.MessageBuilder" -> isMethod -> /> -> Sets whether text-to-speech (TTS) is enabled for the message. - +> +Sets whether text-to-speech (TTS) is enabled for the message. ### addEmbed -> name="addEmbed" -> className="MessageBuilder" -> args={[{ name: "embedBuilder", type: "EmbedBuilder" }]} -> returnType="Builders.MessageBuilder" -> isMethod -> /> -> Adds an embed to the message. - +> +Adds an embed to the message. ### addComponent -> name="addComponent" -> className="MessageBuilder" -> args={[{ name: "discordComponent", type: "InterfaceBuilder" }]} -> returnType="Builders.MessageBuilder" -> isMethod -> /> -> Adds a component to the message. - +> +Adds a component to the message. ### addStickerId -> name="addStickerId" -> className="MessageBuilder" -> args={[{ name: "stickerId", type: "string" }]} -> returnType="Builders.MessageBuilder" -> isMethod -> /> -> Adds a sticker ID to the message. - +> +Adds a sticker ID to the message. ### setFlags -> name="setFlags" -> className="MessageBuilder" -> args={[{ name: "flags", type: "number" }]} -> returnType="Builders.MessageBuilder" -> isMethod -> /> -> Sets the flags for the message. - +> +Sets the flags for the message. ### addFile -> name="addFile" -> className="MessageBuilder" -> args={[ -> { name: "fileContent", type: "string" }, -> { name: "fileName", type: "string" }, -> ]} -> returnType="Builders.MessageBuilder" -> isMethod -> /> -> Add a file to the Message object - +> +Add a file to the Message object ### toJsonObject -> name="toJsonObject" -> className="MessageBuilder" -> args={[]} -> returnType="table" -> isMethod -> /> -> Converts the message to a JSON object that can be sent to the Discord API. - -### toFormdataObject - -> name="toFormdataObject" -> className="MessageBuilder" -> args={[]} -> returnType="string" -> isMethod -> /> -> Converts the message to a Formdata object that can be sent to the Discord API. +> +Converts the message to a JSON object that can be sent to the Discord API. +### toPayloadObject +> +Converts the message to a JSON object that can be sent to the Discord API. ### toPayloadObject -> name="toPayloadObject" -> className="MessageBuilder" -> args={[]} -> returnType="Network.Resolvable" -> isMethod -> /> -> Converts the message to a JSON object that can be sent to the Discord API. +> +Converts the message to a JSON object that can be sent to the Discord API. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> -> Creates a new instance of MessageBuilder. +> +Creates a new instance of MessageBuilder. + diff --git a/src/content/docs/classes/Builders/ModalBuilder.mdx b/src/content/docs/classes/Builders/ModalBuilder.mdx index 57b9eec..d612e4f 100644 --- a/src/content/docs/classes/Builders/ModalBuilder.mdx +++ b/src/content/docs/classes/Builders/ModalBuilder.mdx @@ -2,85 +2,56 @@ title: ModalBuilder description: DiscordLuau docs for ModalBuilder. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) ModalBuilder is used to construct a modal dialog for a Discord interaction, including title and components. Usage: - ```lua local modal = ModalBuilder.new("modal_id") :setTitle("Example Modal") :addComponent(ButtonBuilder.new("button_id")) ``` -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The ModalBuilder instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### setTitle -> name="setTitle" -> className="ModalBuilder" -> args={[{ name: "title", type: "string" }]} -> returnType="Builders.ModalBuilder" -> isMethod -> /> -> Sets the title of the modal. - +> +Sets the title of the modal. ### addComponent -> name="addComponent" -> className="ModalBuilder" -> args={[ -> { -> name: "componentObject", -> type: "DiscordComponentTypes.DiscordComponent", -> }, -> ]} -> returnType="Builders.ModalBuilder" -> isMethod -> /> -> Adds a component to the modal. The modal can contain up to five components. - +> +Adds a component to the modal. The modal can contain up to five components. ### toPayloadObject -> name="toPayloadObject" -> className="ModalBuilder" -> args={[]} -> returnType="Network.Resolvable" -> isMethod -> /> -> Converts the modal to a JSON object that can be sent to the Discord API. +> +Converts the modal to a JSON object that can be sent to the Discord API. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="ModalBuilder" -> args={[{ name: "modalId", type: "string" }]} -> /> -> Creates a new instance of ModalBuilder. +> +Creates a new instance of ModalBuilder. + diff --git a/src/content/docs/classes/Builders/PermissionsBuilder.mdx b/src/content/docs/classes/Builders/PermissionsBuilder.mdx index 04a6b31..5eca06d 100644 --- a/src/content/docs/classes/Builders/PermissionsBuilder.mdx +++ b/src/content/docs/classes/Builders/PermissionsBuilder.mdx @@ -2,22 +2,21 @@ title: PermissionsBuilder description: DiscordLuau docs for PermissionsBuilder. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) PermissionsBuilder is used to construct and manage permissions for a Discord bot. Usage: - ```lua local permissions = PermissionsBuilder.new() :addPermission(PermissionsBuilder.Permissions.Administrator) @@ -26,14 +25,14 @@ local permissions = PermissionsBuilder.new() print(permissions:getValue()) ``` -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties ### Permissions -## - + +--- An enumeration of permissions. - CreateInstantInvite: 0 @@ -82,78 +81,45 @@ An enumeration of permissions. - UseExternalSounds: 45 - SendVoiceMessages: 46 -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### addPermission -> name="addPermission" -> className="PermissionsBuilder" -> args={[{ name: "permission", type: "number" }]} -> returnType="Builders.PermissionsBuilder" -> isMethod -> /> -> Adds a permission to the builder. - +> +Adds a permission to the builder. ### deletePermission -> name="deletePermission" -> className="PermissionsBuilder" -> args={[{ name: "permission", type: "number" }]} -> returnType="Builders.PermissionsBuilder" -> isMethod -> /> -> Removes a permission from the builder. - +> +Removes a permission from the builder. ### hasPermission -> name="hasPermission" -> className="PermissionsBuilder" -> args={[{ name: "permission", type: "number" }]} -> returnType="boolean" -> isMethod -> /> -> Checks if a permission is in the builder. - +> +Checks if a permission is in the builder. ### getValue -> name="getValue" -> className="PermissionsBuilder" -> args={[]} -> returnType="string" -> isMethod -> /> -> Gets the bitfield value of the permissions. +> +Gets the bitfield value of the permissions. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> -> Creates a new instance of PermissionsBuilder. - +> +Creates a new instance of PermissionsBuilder. ### none -> -> Creates a new instance of PermissionsBuilder with no permissions. - +> +Creates a new instance of PermissionsBuilder with no permissions. ### all -> -> Creates a new instance of PermissionsBuilder with all permissions. - +> +Creates a new instance of PermissionsBuilder with all permissions. ### from -> name="from" -> className="PermissionsBuilder" -> args={[{ name: "bitfield", type: "string" }]} -> /> -> Creates a new instance of PermissionsBuilder from a bitfield. +> +Creates a new instance of PermissionsBuilder from a bitfield. + diff --git a/src/content/docs/classes/Builders/PresenceBuilder.mdx b/src/content/docs/classes/Builders/PresenceBuilder.mdx index cf27861..a478495 100644 --- a/src/content/docs/classes/Builders/PresenceBuilder.mdx +++ b/src/content/docs/classes/Builders/PresenceBuilder.mdx @@ -2,22 +2,21 @@ title: PresenceBuilder description: DiscordLuau docs for PresenceBuilder. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) PresenceBuilder is used to construct a presence object for a Discord bot, including activities, status, and AFK state. Usage: - ```lua local presence = PresenceBuilder.new() :addActivity(ActivityBuilder.new():setName("Playing a game")) @@ -26,14 +25,14 @@ local presence = PresenceBuilder.new() :setSince(os.time()) ``` -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties ### Status -## - + +--- An enumeration of presence statuses. - Online: "online" @@ -42,70 +41,37 @@ An enumeration of presence statuses. - Invisible: "invisible" - Offline: "offline" -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### addActivity -> name="addActivity" -> className="PresenceBuilder" -> args={[{ name: "activity", type: "ActivityBuilder" }]} -> returnType="Builders.PresenceBuilder" -> isMethod -> /> -> Adds an activity to the presence. - +> +Adds an activity to the presence. ### setStatus -> name="setStatus" -> className="PresenceBuilder" -> args={[{ name: "status", type: "string" }]} -> returnType="Builders.PresenceBuilder" -> isMethod -> /> -> Sets the status of the presence. - +> +Sets the status of the presence. ### setAfk -> name="setAfk" -> className="PresenceBuilder" -> args={[{ name: "isAfk", type: "boolean" }]} -> returnType="Builders.PresenceBuilder" -> isMethod -> /> -> Sets whether the presence is AFK. - +> +Sets whether the presence is AFK. ### setSince -> name="setSince" -> className="PresenceBuilder" -> args={[{ name: "delta", type: "number" }]} -> returnType="Builders.PresenceBuilder" -> isMethod -> /> -> Sets the time since the presence was last updated. - +> +Sets the time since the presence was last updated. ### toPayloadObject -> name="toPayloadObject" -> className="PresenceBuilder" -> args={[]} -> returnType="Network.Resolvable" -> isMethod -> /> -> Converts the presence to a JSON object that can be sent to the Discord API. +> +Converts the presence to a JSON object that can be sent to the Discord API. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> -> Creates a new instance of PresenceBuilder. +> +Creates a new instance of PresenceBuilder. + diff --git a/src/content/docs/classes/Builders/SettingsBuilder.mdx b/src/content/docs/classes/Builders/SettingsBuilder.mdx index 6482889..358f361 100644 --- a/src/content/docs/classes/Builders/SettingsBuilder.mdx +++ b/src/content/docs/classes/Builders/SettingsBuilder.mdx @@ -2,17 +2,17 @@ title: SettingsBuilder description: DiscordLuau docs for SettingsBuilder. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) A simple class to retain some generic data before a Discord Client can be started, for instance: @@ -20,7 +20,6 @@ A simple class to retain some generic data before a Discord Client can be starte - The Discord bot intents Usage: - ```lua local DiscordLuau = require("../Submodules/DiscordLuau") @@ -28,50 +27,31 @@ local IntentsBuilder = DiscordLuau.IntentsBuilder.fromAll() local SettingsBuilder = DiscordLuau.SettingsBuilder.new("BOT TOKEN", IntentsBuilder) ``` -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The SettingsBuilder instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### setDiscordToken -> name="setDiscordToken" -> className="SettingsBuilder" -> args={[{ name: "discordToken", type: "string" }]} -> returnType="Builders.SettingsBuilder" -> isMethod -> /> -> Sets the Discord bot token. - +> +Sets the Discord bot token. ### setIntents -> name="setIntents" -> className="SettingsBuilder" -> args={[{ name: "discordIntents", type: "IntentsBuilder" }]} -> returnType="Builders.SettingsBuilder" -> isMethod -> /> -> Sets the Discord bot intents. +> +Sets the Discord bot intents. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="SettingsBuilder" -> args={[ -> { name: "discordToken", type: "string" }, -> { name: "discordIntents", type: "IntentsBuilder?" }, -> ]} -> /> -> Constructs a new instance of SettingsBuilder. +> +Constructs a new instance of SettingsBuilder. + diff --git a/src/content/docs/classes/DiscordClient.mdx b/src/content/docs/classes/DiscordClient.mdx index 3c92adc..ce4878f 100644 --- a/src/content/docs/classes/DiscordClient.mdx +++ b/src/content/docs/classes/DiscordClient.mdx @@ -2,17 +2,17 @@ title: DiscordClient description: DiscordLuau docs for DiscordClient. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The base class that implements the various properties, methods, and events that developers can use to interact with the Discord API. @@ -23,40 +23,39 @@ local SettingsBuilder = DiscordLuau.SettingsBuilder.new("BOT TOKEN") local DiscordClient = DiscordLuau.DiscordClient.new(SettingsBuilder) ``` -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties ### discordUser -## - + +--- + ### discordApplication -## - + +--- + ### discordGateway -## - + +--- + ### eventManager -## + +--- + -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### connectAsync -> name="connectAsync" -> className="DiscordClient" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Connects the current DiscordClient to the Discord API. +> +Connects the current DiscordClient to the Discord API. ```lua local DiscordClient = DiscordLuau.DiscordClient.new(SettingsBuilder) @@ -65,63 +64,32 @@ DiscordClient:connectAsync():after(function() print("Connected to the Discord API!") end) ``` - ### fetchGuildAsync -> name="fetchGuildAsync" -> className="DiscordClient" -> args={[{ name: "guildId", type: "string" }]} -> returnType="Future" -> isMethod -> /> -> Fetches a guild by its ID. - +> +Fetches a guild by its ID. ### fetchChannelAsync -> name="fetchChannelAsync" -> className="DiscordClient" -> args={[{ name: "channelId", type: "string" }]} -> returnType="Future" -> isMethod -> /> -> Fetches a channel by its ID. - +> +Fetches a channel by its ID. ### updatePresenceAsync -> name="updatePresenceAsync" -> className="DiscordClient" -> args={[{ name: "discordPresence", type: "table" }]} -> returnType="Future" -> isMethod -> /> -> Updates the client's presence. - +> +Updates the client's presence. ### setVerbose -> name="setVerbose" -> className="DiscordClient" -> args={[{ name: "verbose", type: "boolean" }]} -> isMethod -> /> -> Sets the verbosity level for logging. +> +Sets the verbosity level for logging. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="DiscordClient" -> args={[{ name: "discordSettings", type: "SettingsBuilder" }]} -> /> -> Constructor function for the Discord Client, used to instantiate a Discord Client -> object. +> +Constructor function for the Discord Client, used to instantiate a Discord Client object. + ```lua local DiscordClient = DiscordLuau.DiscordClient.new(SettingsBuilder) @@ -130,3 +98,4 @@ DiscordClient:connectAsync():after(function() print("Connected to the Discord API!") end) ``` + diff --git a/src/content/docs/classes/DiscordLuau.mdx b/src/content/docs/classes/DiscordLuau.mdx index 2977f14..e2633df 100644 --- a/src/content/docs/classes/DiscordLuau.mdx +++ b/src/content/docs/classes/DiscordLuau.mdx @@ -2,72 +2,54 @@ title: DiscordLuau description: DiscordLuau docs for DiscordLuau. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) A Discord API wrapper written in Luau, expected to run under the Lune runtime. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties ### ActionRowBuilder - + ### ButtonBuilder - + ### SelectionBuilder - + ### TextInputBuilder - + ### MessageBuilder +### AttachmentBuilder + + ### CommandBuilder ### CommandOptionBuilder - + ### ActivityBuilder - + ### AutomoderationRuleBuilder - + ### EmbedBuilder @@ -79,34 +61,26 @@ A Discord API wrapper written in Luau, expected to run under the Lune runtime. ### PermissionsBuilder - + ### PresenceBuilder - + ### SettingsBuilder - + ### DiscordClient -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods The DiscordLuau instance has no set methods! -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions The DiscordLuau instance has no set functions! + diff --git a/src/content/docs/classes/Network/DiscordGateway.mdx b/src/content/docs/classes/Network/DiscordGateway.mdx index 08e889c..07ae143 100644 --- a/src/content/docs/classes/Network/DiscordGateway.mdx +++ b/src/content/docs/classes/Network/DiscordGateway.mdx @@ -2,17 +2,17 @@ title: DiscordGateway description: DiscordLuau docs for DiscordGateway. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) DiscordGateway is an internal class responsible for managing communication with the Discord API. This class handles rate limiting, scheduling HTTP requests, and processing events. @@ -20,178 +20,67 @@ DiscordGateway is an internal class responsible for managing communication with This class is internal and should not be used directly by developers. ::: -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The DiscordGateway instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### parseErrors -> name="parseErrors" -> className="DiscordGateway" -> args={[ -> { name: "errorTable", type: "table" }, -> { name: "source", type: "string?" }, -> { name: "depth", type: "number?" }, -> ]} -> returnType="string" -> isMethod -> /> -> Parses error messages from the Discord API response. - +> +Parses error messages from the Discord API response. ### parseDiscordAPIErrors -> name="parseDiscordAPIErrors" -> className="DiscordGateway" -> args={[ -> { name: "api", type: "string" }, -> { name: "networkResponse", type: "Net.FetchResponse" }, -> ]} -> returnType="string" -> isMethod -> /> -> Parses errors from a Discord API response. - +> +Parses errors from a Discord API response. ### requestAsync -> name="requestAsync" -> className="DiscordGateway" -> args={[ -> { name: "api", type: "string" }, -> { name: "method", type: "string" }, -> { name: "data", type: "table?" }, -> ]} -> returnType="Future" -> isMethod -> /> -> Sends an asynchronous request to the Discord API. - +> +Sends an asynchronous request to the Discord API. ### getAsync -> name="getAsync" -> className="DiscordGateway" -> args={[ -> { name: "api", type: "string" }, -> { name: "headers", type: "{ [string]: string }" }, -> ]} -> returnType="Future" -> isMethod -> /> -> Sends an asynchronous GET request to the Discord API. - +> +Sends an asynchronous GET request to the Discord API. ### postAsync -> name="postAsync" -> className="DiscordGateway" -> args={[ -> { name: "api", type: "string" }, -> { name: "data", type: "table" }, -> { name: "headers", type: "{ [string]: string }" }, -> ]} -> returnType="Future" -> isMethod -> /> -> Sends an asynchronous POST request to the Discord API. - +> +Sends an asynchronous POST request to the Discord API. ### putAsync -> name="putAsync" -> className="DiscordGateway" -> args={[ -> { name: "api", type: "string" }, -> { name: "data", type: "table" }, -> { name: "headers", type: "{ [string]: string }" }, -> ]} -> returnType="Future" -> isMethod -> /> -> Sends an asynchronous PUT request to the Discord API. - +> +Sends an asynchronous PUT request to the Discord API. ### deleteAsync -> name="deleteAsync" -> className="DiscordGateway" -> args={[ -> { name: "api", type: "string" }, -> { name: "data", type: "table?" }, -> { name: "headers", type: "{ [string]: string }" }, -> ]} -> returnType="Future" -> isMethod -> /> -> Sends an asynchronous DELETE request to the Discord API. - +> +Sends an asynchronous DELETE request to the Discord API. ### patchAsync -> name="patchAsync" -> className="DiscordGateway" -> args={[ -> { name: "api", type: "string" }, -> { name: "data", type: "table" }, -> { name: "headers", type: "{ [string]: string }" }, -> ]} -> returnType="Future" -> isMethod -> /> -> Sends an asynchronous PATCH request to the Discord API. - +> +Sends an asynchronous PATCH request to the Discord API. ### setEndpointCache -> name="setEndpointCache" -> className="DiscordGateway" -> args={[ -> { name: "endpoint", type: "string" }, -> { name: "cache", type: "table" }, -> ]} -> isMethod -> /> -> Sets the cache for a specific API endpoint. - +> +Sets the cache for a specific API endpoint. ### getEndpointCache -> name="getEndpointCache" -> className="DiscordGateway" -> args={[{ name: "endpoint", type: "string" }]} -> returnType="table" -> isMethod -> /> -> Gets the cache for a specific API endpoint. - +> +Gets the cache for a specific API endpoint. ### getApiVersion -> name="getApiVersion" -> className="DiscordGateway" -> args={[]} -> returnType="number" -> isMethod -> /> -> Gets the current Discord API version. +> +Gets the current Discord API version. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="DiscordGateway" -> args={[{ name: "discordClient", type: "any" }]} -> /> -> Creates a new instance of DiscordGateway. +> +Creates a new instance of DiscordGateway. + diff --git a/src/content/docs/classes/Network/DiscordShard.mdx b/src/content/docs/classes/Network/DiscordShard.mdx index 4c61cd7..6fa70d8 100644 --- a/src/content/docs/classes/Network/DiscordShard.mdx +++ b/src/content/docs/classes/Network/DiscordShard.mdx @@ -2,17 +2,17 @@ title: DiscordShard description: DiscordLuau docs for DiscordShard. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) DiscordShard is an internal class responsible for managing the connection and communication with a specific shard of the Discord WebSocket. This class handles events, errors, and operations specific to a shard. @@ -20,133 +20,63 @@ DiscordShard is an internal class responsible for managing the connection and co This class is internal and should not be used directly by developers. ::: -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The DiscordShard instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### observeWebsocketErrors -> name="observeWebsocketErrors" -> className="DiscordShard" -> args={[]} -> isMethod -> /> -> Observes and handles WebSocket errors. - +> +Observes and handles WebSocket errors. ### observeWebsocketEvents -> name="observeWebsocketEvents" -> className="DiscordShard" -> args={[]} -> isMethod -> /> -> Observes and handles WebSocket events. - +> +Observes and handles WebSocket events. ### observeWebsocketOperations -> name="observeWebsocketOperations" -> className="DiscordShard" -> args={[]} -> isMethod -> /> -> Observes and handles WebSocket operations. - +> +Observes and handles WebSocket operations. ### initiateWebsocket -> name="initiateWebsocket" -> className="DiscordShard" -> args={[]} -> isMethod -> /> -> Initiates the WebSocket connection. - +> +Initiates the WebSocket connection. ### heartbeatAsync -> name="heartbeatAsync" -> className="DiscordShard" -> args={[{ name: "ignoreHeartbeatAck", type: "boolean?" }]} -> returnType="Future" -> isMethod -> /> -> Sends a heartbeat to the Discord WebSocket. - +> +Sends a heartbeat to the Discord WebSocket. ### heartbeatIn -> name="heartbeatIn" -> className="DiscordShard" -> args={[{ name: "milliseconds", type: "number" }]} -> isMethod -> /> -> Schedules the next heartbeat. - +> +Schedules the next heartbeat. ### identifyAsync -> name="identifyAsync" -> className="DiscordShard" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Identifies the Discord client with the Discord WebSocket. - +> +Identifies the Discord client with the Discord WebSocket. ### connectAsync -> name="connectAsync" -> className="DiscordShard" -> args={[{ name: "websocketUrl", type: "string" }]} -> returnType="Future" -> isMethod -> /> -> Connects the DiscordShard to the Discord WebSocket. - +> +Connects the DiscordShard to the Discord WebSocket. ### resumeAsync -> name="resumeAsync" -> className="DiscordShard" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Resumes a previous session with the Discord WebSocket. - +> +Resumes a previous session with the Discord WebSocket. ### reconnectAsync -> name="reconnectAsync" -> className="DiscordShard" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Attempts to reconnect the DiscordShard to the Discord WebSocket. +> +Attempts to reconnect the DiscordShard to the Discord WebSocket. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="DiscordShard" -> args={[ -> { name: "discordClient", type: "any" }, -> { name: "shardId", type: "number" }, -> ]} -> /> -> Creates a new instance of DiscordShard. +> +Creates a new instance of DiscordShard. + diff --git a/src/content/docs/classes/Network/DiscordUDP.mdx b/src/content/docs/classes/Network/DiscordUDP.mdx index 7c31691..ecbef1b 100644 --- a/src/content/docs/classes/Network/DiscordUDP.mdx +++ b/src/content/docs/classes/Network/DiscordUDP.mdx @@ -2,17 +2,17 @@ title: DiscordUDP description: DiscordLuau docs for DiscordUDP. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) DiscordUDP is an internal class responsible for managing UDP communication with the Discord API. This class handles sending and receiving UDP packets. @@ -20,58 +20,35 @@ DiscordUDP is an internal class responsible for managing UDP communication with This class is internal and should not be used directly by developers. ::: -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The DiscordUDP instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### sendAsync -> name="sendAsync" -> className="DiscordUDP" -> args={[{ name: "dataPacket", type: "string" }]} -> returnType="Future" -> isMethod -> /> -> Sends a UDP packet asynchronously. - +> +Sends a UDP packet asynchronously. ### connectAsync -> name="connectAsync" -> className="DiscordUDP" -> args={[{ name: "discordUdp", type: "string" }]} -> returnType="Future" -> isMethod -> /> -> Connects to a UDP socket asynchronously. - +> +Connects to a UDP socket asynchronously. ### disconnectAsync -> name="disconnectAsync" -> className="DiscordUDP" -> args={[{ name: "closingCode", type: "string" }]} -> returnType="Future" -> isMethod -> /> -> Disconnects from the UDP socket asynchronously. +> +Disconnects from the UDP socket asynchronously. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="DiscordUDP" -> args={[{ name: "publicUdp", type: "string" }]} -> /> -> Creates a new instance of DiscordUDP. +> +Creates a new instance of DiscordUDP. + diff --git a/src/content/docs/classes/Network/DiscordVoiceConnection.mdx b/src/content/docs/classes/Network/DiscordVoiceConnection.mdx index 9e639ff..a47460b 100644 --- a/src/content/docs/classes/Network/DiscordVoiceConnection.mdx +++ b/src/content/docs/classes/Network/DiscordVoiceConnection.mdx @@ -2,17 +2,17 @@ title: DiscordVoiceConnection description: DiscordLuau docs for DiscordVoiceConnection. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The `DiscordVoiceConnection` class handles the voice connection functionalities for Discord-Luau. This class is responsible for managing the lifecycle of a voice connection, handling websocket operations, and ensuring proper communication with Discord's voice servers. @@ -20,123 +20,55 @@ The `DiscordVoiceConnection` class handles the voice connection functionalities This class is internal and should not be used directly by developers. Instead, use the provided public interfaces and methods to interact with voice connections. ::: -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The DiscordVoiceConnection instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### observeWebsocketErrors -> name="observeWebsocketErrors" -> className="DiscordVoiceConnection" -> args={[{ name: "self", type: "DiscordVoiceConnection" }]} -> isMethod -> /> -> Observes and handles errors from the voice websocket. - +> +Observes and handles errors from the voice websocket. ### observeWebsocketOperations -> name="observeWebsocketOperations" -> className="DiscordVoiceConnection" -> args={[{ name: "self", type: "DiscordVoiceConnection" }]} -> isMethod -> /> -> Observes and handles operations received from the voice websocket. - +> +Observes and handles operations received from the voice websocket. ### heartbeatAsync -> name="heartbeatAsync" -> className="DiscordVoiceConnection" -> args={[ -> { name: "self", type: "DiscordVoiceConnection" }, -> { name: "ignoreHeartbeatAck", type: "boolean?" }, -> ]} -> returnType="Future" -> isMethod -> /> -> Sends a heartbeat to the voice websocket and manages the heartbeat acknowledgements. - +> +Sends a heartbeat to the voice websocket and manages the heartbeat acknowledgements. ### heartbeatIn -> name="heartbeatIn" -> className="DiscordVoiceConnection" -> args={[ -> { name: "self", type: "DiscordVoiceConnection" }, -> { name: "milliseconds", type: "number" }, -> ]} -> isMethod -> /> -> Schedules the next heartbeat to be sent after a specified interval. - +> +Schedules the next heartbeat to be sent after a specified interval. ### connectAsync -> name="connectAsync" -> className="DiscordVoiceConnection" -> args={[ -> { name: "self", type: "DiscordVoiceConnection" }, -> { name: "guildId", type: "string" }, -> { name: "channelId", type: "string" }, -> ]} -> returnType="Future" -> isMethod -> /> -> Connects to a voice channel asynchronously. - +> +Connects to a voice channel asynchronously. ### resumeAsync -> name="resumeAsync" -> className="DiscordVoiceConnection" -> args={[{ name: "self", type: "DiscordVoiceConnection" }]} -> returnType="Future" -> isMethod -> /> -> Resumes a voice connection asynchronously. - +> +Resumes a voice connection asynchronously. ### reconnectAsync -> name="reconnectAsync" -> className="DiscordVoiceConnection" -> args={[{ name: "self", type: "DiscordVoiceConnection" }]} -> returnType="Future" -> isMethod -> /> -> Reconnects to the voice websocket asynchronously. - +> +Reconnects to the voice websocket asynchronously. ### disconnectAsync -> name="disconnectAsync" -> className="DiscordVoiceConnection" -> args={[{ name: "self", type: "DiscordVoiceConnection" }]} -> returnType="Future" -> isMethod -> /> -> Disconnects from the voice websocket asynchronously. +> +Disconnects from the voice websocket asynchronously. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="DiscordVoiceConnection" -> args={[ -> { name: "discordClient", type: "any" }, -> { name: "id", type: "string" }, -> ]} -> /> -> Creates a new instance of `DiscordVoiceConnection`. +> +Creates a new instance of `DiscordVoiceConnection`. + diff --git a/src/content/docs/classes/Network/DiscordWebsocket.mdx b/src/content/docs/classes/Network/DiscordWebsocket.mdx index cd6ef94..42b16f8 100644 --- a/src/content/docs/classes/Network/DiscordWebsocket.mdx +++ b/src/content/docs/classes/Network/DiscordWebsocket.mdx @@ -2,17 +2,17 @@ title: DiscordWebsocket description: DiscordLuau docs for DiscordWebsocket. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The `DiscordWebsocket` class manages the websocket connection to Discord. It handles sending and receiving messages, managing the connection state, and processing incoming and outgoing events. @@ -20,63 +20,35 @@ The `DiscordWebsocket` class manages the websocket connection to Discord. It han This class is internal and should not be used directly by developers. Instead, use the provided public interfaces and methods to interact with the Discord websocket. ::: -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The DiscordWebsocket instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### sendAsync -> name="sendAsync" -> className="DiscordWebsocket" -> args={[ -> { name: "self", type: "DiscordWebsocket" }, -> { name: "dataPacket", type: "table" }, -> ]} -> returnType="Future" -> isMethod -> /> -> Sends a data packet asynchronously through the websocket. - +> +Sends a data packet asynchronously through the websocket. ### connectAsync -> name="connectAsync" -> className="DiscordWebsocket" -> args={[ -> { name: "self", type: "DiscordWebsocket" }, -> { name: "websocketUrl", type: "string" }, -> ]} -> returnType="Future" -> isMethod -> /> -> Connects to a websocket URL asynchronously. - +> +Connects to a websocket URL asynchronously. ### disconnectAsync -> name="disconnectAsync" -> className="DiscordWebsocket" -> args={[ -> { name: "self", type: "DiscordWebsocket" }, -> { name: "closingCode", type: "string" }, -> ]} -> returnType="Future" -> isMethod -> /> -> Disconnects from the websocket asynchronously. +> +Disconnects from the websocket asynchronously. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> -> Creates a new instance of `DiscordWebsocket`. +> +Creates a new instance of `DiscordWebsocket`. + diff --git a/src/content/docs/classes/Network/HTTPRatelimit.mdx b/src/content/docs/classes/Network/HTTPRatelimit.mdx index 44c4dfd..f461eea 100644 --- a/src/content/docs/classes/Network/HTTPRatelimit.mdx +++ b/src/content/docs/classes/Network/HTTPRatelimit.mdx @@ -2,17 +2,17 @@ title: HTTPRatelimit description: DiscordLuau docs for HTTPRatelimit. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The `HTTPRatelimit` class manages the rate limiting for HTTP requests. It tracks the remaining requests that can be made and handles the reset of these limits after a specified duration. @@ -20,78 +20,39 @@ The `HTTPRatelimit` class manages the rate limiting for HTTP requests. It tracks This class is internal and should not be used directly by developers. Instead, use the provided public interfaces and methods to manage rate limits. ::: -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The HTTPRatelimit instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### setRemaining -> name="setRemaining" -> className="HTTPRatelimit" -> args={[ -> { name: "self", type: "HTTPRatelimit" }, -> { name: "remaining", type: "number" }, -> ]} -> isMethod -> /> -> Sets the remaining number of requests that can be made. - +> +Sets the remaining number of requests that can be made. ### resetAfter -> name="resetAfter" -> className="HTTPRatelimit" -> args={[ -> { name: "self", type: "HTTPRatelimit" }, -> { name: "seconds", type: "number" }, -> ]} -> isMethod -> /> -> Resets the remaining requests after a specified number of seconds. - +> +Resets the remaining requests after a specified number of seconds. ### setLimit -> name="setLimit" -> className="HTTPRatelimit" -> args={[ -> { name: "self", type: "HTTPRatelimit" }, -> { name: "limit", type: "number" }, -> ]} -> isMethod -> /> -> Sets the maximum number of requests that can be made. - +> +Sets the maximum number of requests that can be made. ### isConsumed -> name="isConsumed" -> className="HTTPRatelimit" -> args={[{ name: "self", type: "HTTPRatelimit" }]} -> returnType="boolean" -> isMethod -> /> -> Checks if the rate limit has been consumed. +> +Checks if the rate limit has been consumed. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="HTTPRatelimit" -> args={[ -> { name: "remaining", type: "number?" }, -> { name: "limit", type: "number?" }, -> ]} -> /> -> Creates a new instance of `HTTPRatelimit`. +> +Creates a new instance of `HTTPRatelimit`. + diff --git a/src/content/docs/classes/Network/HTTPScheduler.mdx b/src/content/docs/classes/Network/HTTPScheduler.mdx index f9d95ea..dfd0474 100644 --- a/src/content/docs/classes/Network/HTTPScheduler.mdx +++ b/src/content/docs/classes/Network/HTTPScheduler.mdx @@ -2,17 +2,17 @@ title: HTTPScheduler description: DiscordLuau docs for HTTPScheduler. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The `HTTPScheduler` class manages the scheduling of HTTP tasks. It allows for the addition, removal, and execution of tasks at a specified frequency. @@ -20,119 +20,55 @@ The `HTTPScheduler` class manages the scheduling of HTTP tasks. It allows for th This class is internal and should not be used directly by developers. Instead, use the provided public interfaces and methods to manage HTTP scheduling. ::: -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The HTTPScheduler instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### spawnWorker -> name="spawnWorker" -> className="HTTPScheduler" -> args={[{ name: "self", type: "HTTPScheduler" }]} -> isMethod -> /> -> Spawns a new worker task that cycles through scheduled tasks at the specified frequency. - +> +Spawns a new worker task that cycles through scheduled tasks at the specified frequency. ### stopWorker -> name="stopWorker" -> className="HTTPScheduler" -> args={[{ name: "self", type: "HTTPScheduler" }]} -> isMethod -> /> -> Stops and removes a worker task. - +> +Stops and removes a worker task. ### setFrequency -> name="setFrequency" -> className="HTTPScheduler" -> args={[ -> { name: "self", type: "HTTPScheduler" }, -> { name: "frequency", type: "number" }, -> ]} -> isMethod -> /> -> Sets the frequency at which tasks are cycled. - +> +Sets the frequency at which tasks are cycled. ### cycle -> name="cycle" -> className="HTTPScheduler" -> args={[{ name: "self", type: "HTTPScheduler" }]} -> isMethod -> /> -> Processes the next task in the stack. - +> +Processes the next task in the stack. ### isActive -> name="isActive" -> className="HTTPScheduler" -> args={[{ name: "self", type: "HTTPScheduler" }]} -> returnType="boolean" -> isMethod -> /> -> Checks if there are any tasks currently being processed. - +> +Checks if there are any tasks currently being processed. ### setLimit -> name="setLimit" -> className="HTTPScheduler" -> args={[ -> { name: "self", type: "HTTPScheduler" }, -> { name: "limit", type: "number" }, -> ]} -> isMethod -> /> -> Sets the limit for the number of tasks that can be scheduled. - +> +Sets the limit for the number of tasks that can be scheduled. ### removeTask -> name="removeTask" -> className="HTTPScheduler" -> args={[ -> { name: "self", type: "HTTPScheduler" }, -> { name: "object", type: "function" }, -> ]} -> isMethod -> /> -> Removes a task from the scheduler. - +> +Removes a task from the scheduler. ### addTask -> name="addTask" -> className="HTTPScheduler" -> args={[ -> { name: "self", type: "HTTPScheduler" }, -> { name: "object", type: "function" }, -> ]} -> returnType="any" -> isMethod -> /> -> Adds a task to the scheduler. +> +Adds a task to the scheduler. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="HTTPScheduler" -> args={[{ name: "threadCount", type: "number?" }]} -> /> -> Creates a new instance of `HTTPScheduler`. +> +Creates a new instance of `HTTPScheduler`. + diff --git a/src/content/docs/classes/Network/Middleware/EventIn.mdx b/src/content/docs/classes/Network/Middleware/EventIn.mdx index e94eba4..db1791c 100644 --- a/src/content/docs/classes/Network/Middleware/EventIn.mdx +++ b/src/content/docs/classes/Network/Middleware/EventIn.mdx @@ -2,17 +2,17 @@ title: EventIn description: DiscordLuau docs for EventIn. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The `EventIn` class processes incoming events, converting JSON keys to camelCase format for consistency within the application. @@ -20,49 +20,31 @@ The `EventIn` class processes incoming events, converting JSON keys to camelCase This class is internal and should not be used directly by developers. Instead, use the provided public interfaces and methods to handle incoming events. ::: -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The EventIn instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### toCamelCase -> name="toCamelCase" -> className="EventIn" -> args={[ -> { name: "self", type: "EventIn" }, -> { name: "json", type: "table" }, -> ]} -> returnType="table" -> isMethod -> /> -> Converts JSON keys from snake_case to camelCase. - +> +Converts JSON keys from snake_case to camelCase. ### processJSON -> name="processJSON" -> className="EventIn" -> args={[ -> { name: "self", type: "EventIn" }, -> { name: "data", type: "any" }, -> ]} -> returnType="any" -> isMethod -> /> -> Processes incoming JSON data, converting keys to camelCase if the data is a table. +> +Processes incoming JSON data, converting keys to camelCase if the data is a table. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> -> Creates a new instance of `EventIn`. +> +Creates a new instance of `EventIn`. + diff --git a/src/content/docs/classes/Network/Middleware/EventOut.mdx b/src/content/docs/classes/Network/Middleware/EventOut.mdx index 05f4ece..0c1a7be 100644 --- a/src/content/docs/classes/Network/Middleware/EventOut.mdx +++ b/src/content/docs/classes/Network/Middleware/EventOut.mdx @@ -2,17 +2,17 @@ title: EventOut description: DiscordLuau docs for EventOut. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The `EventOut` class processes outgoing events. Currently, it acts as a placeholder for any future processing that may be required for outgoing JSON data. @@ -20,35 +20,27 @@ The `EventOut` class processes outgoing events. Currently, it acts as a placehol This class is internal and should not be used directly by developers. Instead, use the provided public interfaces and methods to handle outgoing events. ::: -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The EventOut instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### processJSON -> name="processJSON" -> className="EventOut" -> args={[ -> { name: "self", type: "EventOut" }, -> { name: "data", type: "any" }, -> ]} -> returnType="any" -> isMethod -> /> -> Processes outgoing JSON data. Currently, this method returns the data unchanged. +> +Processes outgoing JSON data. Currently, this method returns the data unchanged. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> -> Creates a new instance of `EventOut`. +> +Creates a new instance of `EventOut`. + diff --git a/src/content/docs/classes/Network/Resolvable.mdx b/src/content/docs/classes/Network/Resolvable.mdx index 67f605e..bcd9146 100644 --- a/src/content/docs/classes/Network/Resolvable.mdx +++ b/src/content/docs/classes/Network/Resolvable.mdx @@ -2,17 +2,17 @@ title: Resolvable description: DiscordLuau docs for Resolvable. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The `Resolvable` class manages the scheduling of HTTP tasks. It allows for the addition, removal, and execution of tasks at a specified frequency. @@ -20,49 +20,35 @@ The `Resolvable` class manages the scheduling of HTTP tasks. It allows for the a This class is internal and should not be used directly by developers. Instead, use the provided public interfaces and methods to manage HTTP scheduling. ::: -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The Resolvable instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### headers -> name="headers" -> className="Resolvable" -> args={[]} -> returnType="{ [string]: string }" -> isMethod -> /> -> Returns a dictionary of headers this resolvable requires in order to successfuly -> be processed by the Discord API - +> +Returns a dictionary of headers this resolvable requires in order to successfuly be processed by the Discord API ### resolve -> name="resolve" -> className="Resolvable" -> args={[]} -> returnType="any" -> isMethod -> /> -> Resolves the data that this Resolvable has, for instance - if this data is JSON, -> it will be thrown through the EventIn pre-processor. +> +Resolves the data that this Resolvable has, for instance - if this data is JSON, it will be thrown through the EventIn pre-processor. +### update + +> +Allows mutation of the data held in the resolvable -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="Resolvable" -> args={[{ name: "threadCount", type: "number?" }]} -> /> -> Creates a new instance of `Resolvable`. +> +Creates a new instance of `Resolvable`. + diff --git a/src/content/docs/classes/Network/WebsocketBuffer.mdx b/src/content/docs/classes/Network/WebsocketBuffer.mdx index ea2496d..5e2dc1d 100644 --- a/src/content/docs/classes/Network/WebsocketBuffer.mdx +++ b/src/content/docs/classes/Network/WebsocketBuffer.mdx @@ -2,17 +2,17 @@ title: WebsocketBuffer description: DiscordLuau docs for WebsocketBuffer. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The `WebsocketBuffer` class manages a buffer for websocket data, allowing for data to be added incrementally and flushed when needed. @@ -20,45 +20,31 @@ The `WebsocketBuffer` class manages a buffer for websocket data, allowing for da This class is internal and should not be used directly by developers. Instead, use the provided public interfaces and methods to manage websocket buffering. ::: -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The WebsocketBuffer instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### flush -> name="flush" -> className="WebsocketBuffer" -> args={[{ name: "self", type: "WebsocketBuffer" }]} -> returnType="string" -> isMethod -> /> -> Flushes the buffer, returning all accumulated data and resetting the buffer. - +> +Flushes the buffer, returning all accumulated data and resetting the buffer. ### add -> name="add" -> className="WebsocketBuffer" -> args={[ -> { name: "self", type: "WebsocketBuffer" }, -> { name: "data", type: "string" }, -> ]} -> isMethod -> /> -> Adds data to the buffer. +> +Adds data to the buffer. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> -> Creates a new instance of `WebsocketBuffer`. +> +Creates a new instance of `WebsocketBuffer`. + diff --git a/src/content/docs/classes/Objects/DiscordAnnouncementChannel.mdx b/src/content/docs/classes/Objects/DiscordAnnouncementChannel.mdx new file mode 100644 index 0000000..32ada34 --- /dev/null +++ b/src/content/docs/classes/Objects/DiscordAnnouncementChannel.mdx @@ -0,0 +1,50 @@ +--- +title: DiscordAnnouncementChannel +description: DiscordLuau docs for DiscordAnnouncementChannel. +--- +[//]: # (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 ----- ) + +DiscordAnnouncementChannel represents a text channel in a Discord server, providing methods to modify the channel and interact with pinned messages. + +[//]: # (----- DOCUMENT PROPERTIES ----- ) + +## Properties + +The DiscordAnnouncementChannel instance has no set properties! + +[//]: # (----- DOCUMENT METHODS ----- ) + +## Methods + +### modifyAsync + +> +Modifies the text channel settings asynchronously. +### getPinnedMessagesAsync + +> +Retrieves the pinned messages in the text channel asynchronously. +### followChannelAsync + +> +allows this channel object to follow another announcement channel. + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) + +## Functions + +### new + +> +Creates a new instance of DiscordAnnouncementChannel. + diff --git a/src/content/docs/classes/Objects/DiscordApplication.mdx b/src/content/docs/classes/Objects/DiscordApplication.mdx index 481fd9c..f9e7ac5 100644 --- a/src/content/docs/classes/Objects/DiscordApplication.mdx +++ b/src/content/docs/classes/Objects/DiscordApplication.mdx @@ -2,130 +2,62 @@ title: DiscordApplication description: DiscordLuau docs for DiscordApplication. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The `DiscordApplication` class provides methods to interact with Discord application commands such as creating, deleting, editing, fetching, and setting global application commands. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties ### id - + ### flags - + -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### createSlashCommandAsync -> name="createSlashCommandAsync" -> className="DiscordApplication" -> args={[ -> { -> name: "command", -> type: "CommandBuilder.CommandBuilder The command to create.", -> }, -> ]} -> returnType="Future" -> isMethod -> /> -> Creates a new slash command for the Discord application. - +> +Creates a new slash command for the Discord application. ### deleteSlashCommandAsync -> name="deleteSlashCommandAsync" -> className="DiscordApplication" -> args={[ -> { name: "commandId", type: "string The ID of the command to delete." }, -> ]} -> returnType="Future" -> isMethod -> /> -> Deletes an existing slash command from the Discord application. - +> +Deletes an existing slash command from the Discord application. ### editSlashCommandAsync -> name="editSlashCommandAsync" -> className="DiscordApplication" -> args={[ -> { name: "commandId", type: "string The ID of the command to edit." }, -> { -> name: "command", -> type: "CommandBuilder.CommandBuilder The updated command data.", -> }, -> ]} -> returnType="Future" -> isMethod -> /> -> Edits an existing slash command for the Discord application. - +> +Edits an existing slash command for the Discord application. ### fetchSlashCommandsAsync -> name="fetchSlashCommandsAsync" -> className="DiscordApplication" -> args={[]} -> returnType="Future<{ApplicationCommand}>" -> isMethod -> /> -> Fetches all existing slash commands for the Discord application. - +> +Fetches all existing slash commands for the Discord application. ### setSlashCommandsAsync -> name="setSlashCommandsAsync" -> className="DiscordApplication" -> args={[ -> { -> name: "commands", -> type: "{CommandBuilder.CommandBuilder} The list of commands to set.", -> }, -> ]} -> returnType="Future" -> isMethod -> /> -> Sets the slash commands for the Discord application, updating existing ones and -> creating or deleting as necessary. - -[//]: # "----- DOCUMENT FUNCTIONS ----- " +> +Sets the slash commands for the Discord application, updating existing ones and creating or deleting as necessary. + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="DiscordApplication" -> args={[ -> { name: "discordClient", type: "any The Discord client instance." }, -> { -> name: "applicationData", -> type: "{id: string, flags: number} The application data.", -> }, -> ]} -> /> -> Creates a new instance of the DiscordApplication. +> +Creates a new instance of the DiscordApplication. + diff --git a/src/content/docs/classes/Objects/DiscordAutomoderationRule.mdx b/src/content/docs/classes/Objects/DiscordAutomoderationRule.mdx index 49dc311..9422934 100644 --- a/src/content/docs/classes/Objects/DiscordAutomoderationRule.mdx +++ b/src/content/docs/classes/Objects/DiscordAutomoderationRule.mdx @@ -2,21 +2,21 @@ title: DiscordAutomoderationRule description: DiscordLuau docs for DiscordAutomoderationRule. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The `DiscordAutomoderationRule` class provides methods to interact with Discord auto-moderation rules, including modifying and deleting rules. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties @@ -43,66 +43,33 @@ The `DiscordAutomoderationRule` class provides methods to interact with Discord ### exemptChannels - + ### triggerMetadata - + ### actions -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### modifyAsync -> name="modifyAsync" -> className="DiscordAutomoderationRule" -> args={[ -> { -> name: "moderationRoleBuilder", -> type: "DiscordAutomoderationRule.DiscordAutomoderationRule The builder for the modified rule.", -> }, -> ]} -> returnType="Future" -> isMethod -> /> -> Modifies an existing auto-moderation rule. - +> +Modifies an existing auto-moderation rule. ### deleteAsync -> name="deleteAsync" -> className="DiscordAutomoderationRule" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Deletes an existing auto-moderation rule. +> +Deletes an existing auto-moderation rule. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="DiscordAutomoderationRule" -> args={[ -> { name: "discordClient", type: "any The Discord client instance." }, -> { -> name: "automoderationData", -> type: "table The data for the auto-moderation rule.", -> }, -> ]} -> /> -> Creates a new instance of the DiscordAutomoderationRule. +> +Creates a new instance of the DiscordAutomoderationRule. + diff --git a/src/content/docs/classes/Objects/DiscordCache.mdx b/src/content/docs/classes/Objects/DiscordCache.mdx index 70699c8..ed2f2b2 100644 --- a/src/content/docs/classes/Objects/DiscordCache.mdx +++ b/src/content/docs/classes/Objects/DiscordCache.mdx @@ -2,83 +2,53 @@ title: DiscordCache description: DiscordLuau docs for DiscordCache. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The `DiscordCache` class provides a caching mechanism for storing and retrieving data associated with Discord objects. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties ### type -## - + +--- The type of the DiscordCache. Default is "DiscordCache". -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### setData -> name="setData" -> className="DiscordCache" -> args={[ -> { name: "cacheType", type: "string" }, -> { name: "uuid", type: "string" }, -> { name: "data", type: "any" }, -> ]} -> isMethod -> /> -> Sets data in the cache. - +> +Sets data in the cache. ### getData -> name="getData" -> className="DiscordCache" -> args={[ -> { name: "cacheType", type: "string" }, -> { name: "uuid", type: "string" }, -> ]} -> returnType="any" -> isMethod -> /> -> Gets data from the cache. - +> +Gets data from the cache. ### getDataOr -> name="getDataOr" -> className="DiscordCache" -> args={[ -> { name: "cacheType", type: "string" }, -> { name: "uuid", type: "string" }, -> { name: "callback", type: "function" }, -> ]} -> returnType="any" -> isMethod -> /> -> Gets data from the cache, or calls a callback to generate and cache the data if -> not found. - -[//]: # "----- DOCUMENT FUNCTIONS ----- " +> +Gets data from the cache, or calls a callback to generate and cache the data if not found. + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> -> Creates a new DiscordCache instance. +> +Creates a new DiscordCache instance. + diff --git a/src/content/docs/classes/Objects/DiscordChannel.mdx b/src/content/docs/classes/Objects/DiscordChannel.mdx index 1489779..0983c5f 100644 --- a/src/content/docs/classes/Objects/DiscordChannel.mdx +++ b/src/content/docs/classes/Objects/DiscordChannel.mdx @@ -2,153 +2,89 @@ title: DiscordChannel description: DiscordLuau docs for DiscordChannel. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The `DiscordChannel` class represents a generic Discord channel and provides various methods to interact with and manage the channel. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties ### type -## - + +--- The type of the Discord channel. Default is "DiscordChannel". -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### triggerTypingIndicator -> name="triggerTypingIndicator" -> className="DiscordChannel" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Triggers the typing indicator in the channel. +> +Triggers the typing indicator in the channel. +### overwriteRolePermissionsAsync -### deleteAsync +> +set overwrites for a specific role permissions for this channel in a discord guild. +### overwriteMemberPermissionssync -> name="deleteAsync" -> className="DiscordChannel" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Deletes the channel asynchronously. +> +set overwrites for a specific members permissions for this channel in a discord guild. +### overwriteMemberPermissionssync -### getMessagesAsync +> +deletes overwritten permissions for the given id, the given id must be either a role id or a user id +### deleteAsync -> name="getMessagesAsync" -> className="DiscordChannel" -> args={[{ name: "limit", type: "number?" }]} -> returnType="Future" -> isMethod -> /> -> Gets messages from the channel asynchronously. +> +Deletes the channel asynchronously. +### getMessagesAsync +> +Gets messages from the channel asynchronously. ### getMessageAsync -> name="getMessageAsync" -> className="DiscordChannel" -> args={[{ name: "messageId", type: "string" }]} -> returnType="Future" -> isMethod -> /> -> Gets a specific message from the channel asynchronously. - +> +Gets a specific message from the channel asynchronously. ### bulkDeleteMessagesAsync -> name="bulkDeleteMessagesAsync" -> className="DiscordChannel" -> args={[{ name: "messageIds", type: "{string}" }]} -> returnType="Future" -> isMethod -> /> -> Deletes multiple messages from the channel asynchronously. - +> +Deletes multiple messages from the channel asynchronously. ### sendMessageAsync -> name="sendMessageAsync" -> className="DiscordChannel" -> args={[{ name: "messageBuilder", type: "MessageBuilder" }]} -> returnType="Future" -> isMethod -> /> -> Sends a message to the channel asynchronously. - +> +Sends a message to the channel asynchronously. ### getInvitesAsync -> name="getInvitesAsync" -> className="DiscordChannel" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Gets the invites for the channel asynchronously. - +> +Gets the invites for the channel asynchronously. ### createInviteAsync -> name="createInviteAsync" -> className="DiscordChannel" -> args={[ -> { name: "maxAge", type: "number?" }, -> { name: "maxUses", type: "number?" }, -> { name: "temporary", type: "boolean?" }, -> ]} -> returnType="Future" -> isMethod -> /> -> Creates an invite for the channel asynchronously. - +> +Creates an invite for the channel asynchronously. ### setPositionAsync -> name="setPositionAsync" -> className="DiscordChannel" -> args={[ -> { name: "position", type: "number" }, -> { name: "parentId", type: "string?" }, -> { name: "syncPermissions", type: "boolean?" }, -> ]} -> returnType="Future" -> isMethod -> /> -> Sets the position of the channel asynchronously. - -[//]: # "----- DOCUMENT FUNCTIONS ----- " +> +Sets the position of the channel asynchronously. + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="DiscordChannel" -> args={[ -> { name: "discordClient", type: "any" }, -> { name: "rawChannelData", type: "any" }, -> ]} -> /> -> Creates a new DiscordChannel instance. +> +Creates a new DiscordChannel instance. + diff --git a/src/content/docs/classes/Objects/DiscordEmoji.mdx b/src/content/docs/classes/Objects/DiscordEmoji.mdx index 3dbadb3..e72e26a 100644 --- a/src/content/docs/classes/Objects/DiscordEmoji.mdx +++ b/src/content/docs/classes/Objects/DiscordEmoji.mdx @@ -2,48 +2,42 @@ title: DiscordEmoji description: DiscordLuau docs for DiscordEmoji. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The `DiscordEmoji` class represents a Discord emoji and provides a structure for emoji data. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties ### type -## - + +--- The type of the DiscordEmoji. Default is "DiscordEmoji". -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods The DiscordEmoji instance has no set methods! -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="DiscordEmoji" -> args={[ -> { name: "discordClient", type: "any" }, -> { name: "emojiData", type: "table" }, -> ]} -> /> -> Creates a new DiscordEmoji instance. +> +Creates a new DiscordEmoji instance. + diff --git a/src/content/docs/classes/Objects/DiscordForumChannel.mdx b/src/content/docs/classes/Objects/DiscordForumChannel.mdx new file mode 100644 index 0000000..0a0b7f6 --- /dev/null +++ b/src/content/docs/classes/Objects/DiscordForumChannel.mdx @@ -0,0 +1,50 @@ +--- +title: DiscordForumChannel +description: DiscordLuau docs for DiscordForumChannel. +--- +[//]: # (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 ----- ) + +DiscordForumChannel represents a thread channel in a Discord server, providing methods to modify the channel and interact with pinned messages. + +[//]: # (----- DOCUMENT PROPERTIES ----- ) + +## Properties + +The DiscordForumChannel instance has no set properties! + +[//]: # (----- DOCUMENT METHODS ----- ) + +## Methods + +### createThreadAsync + +> +Create a new thread inside of a Forum channel. +### modifyAsync + +> +Modifies the thread channel settings asynchronously. +### getPinnedMessagesAsync + +> +Retrieves the pinned messages in the thread channel asynchronously. + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) + +## Functions + +### new + +> +Creates a new instance of DiscordForumChannel. + diff --git a/src/content/docs/classes/Objects/DiscordGuild.mdx b/src/content/docs/classes/Objects/DiscordGuild.mdx index c0d2c95..b72d4e7 100644 --- a/src/content/docs/classes/Objects/DiscordGuild.mdx +++ b/src/content/docs/classes/Objects/DiscordGuild.mdx @@ -2,236 +2,105 @@ title: DiscordGuild description: DiscordLuau docs for DiscordGuild. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The `DiscordGuild` class represents a Discord guild (server) and provides methods to interact with and manage the guild. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties ### type -## - + +--- The type of the DiscordGuild. Default is "DiscordGuild". -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### createSlashCommandAsync -> name="createSlashCommandAsync" -> className="DiscordGuild" -> args={[{ name: "command", type: "CommandBuilder" }]} -> returnType="Future" -> isMethod -> /> -> Creates a new slash command in the guild asynchronously. - +> +Creates a new slash command in the guild asynchronously. ### deleteSlashCommandAsync -> name="deleteSlashCommandAsync" -> className="DiscordGuild" -> args={[{ name: "commandId", type: "string" }]} -> returnType="Future" -> isMethod -> /> -> Deletes a slash command in the guild asynchronously. - +> +Deletes a slash command in the guild asynchronously. ### editSlashCommandAsync -> name="editSlashCommandAsync" -> className="DiscordGuild" -> args={[ -> { name: "commandId", type: "string" }, -> { name: "command", type: "CommandBuilder" }, -> ]} -> returnType="Future" -> isMethod -> /> -> Edits a slash command in the guild asynchronously. - +> +Edits a slash command in the guild asynchronously. ### fetchSlashCommandsAsync -> name="fetchSlashCommandsAsync" -> className="DiscordGuild" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Fetches all slash commands in the guild asynchronously. - +> +Fetches all slash commands in the guild asynchronously. ### fetchGuildChannels -> name="fetchGuildChannels" -> className="DiscordGuild" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Fetches all channels in the guild asynchronously. - +> +Fetches all channels in the guild asynchronously. ### setSlashCommandsAsync -> name="setSlashCommandsAsync" -> className="DiscordGuild" -> args={[{ name: "commands", type: "{CommandBuilder}" }]} -> returnType="Future" -> isMethod -> /> -> Sets multiple slash commands in the guild asynchronously. - +> +Sets multiple slash commands in the guild asynchronously. ### getGuildAuditLogs -> name="getGuildAuditLogs" -> className="DiscordGuild" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Gets the audit logs of the guild asynchronously. - +> +Gets the audit logs of the guild asynchronously. ### modifyAsync -> name="modifyAsync" -> className="DiscordGuild" -> args={[{ name: "guildSchema", type: "DiscordGuildSchema" }]} -> returnType="Future" -> isMethod -> /> -> Modifies the guild settings asynchronously. - +> +Modifies the guild settings asynchronously. ### deleteAsync -> name="deleteAsync" -> className="DiscordGuild" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Deletes the guild asynchronously. - +> +Deletes the guild asynchronously. ### getChannelsAsync -> name="getChannelsAsync" -> className="DiscordGuild" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Gets all channels in the guild asynchronously. - +> +Gets all channels in the guild asynchronously. ### getMemberAsync -> name="getMemberAsync" -> className="DiscordGuild" -> args={[{ name: "userId", type: "string" }]} -> returnType="Future" -> isMethod -> /> -> Gets a specific member of the guild asynchronously. - +> +Gets a specific member of the guild asynchronously. ### fetchGuildMembersAsync -> name="fetchGuildMembersAsync" -> className="DiscordGuild" -> args={[ -> { name: "limit", type: "number" }, -> { name: "lastUserId", type: "number?" }, -> ]} -> returnType="Future" -> isMethod -> /> -> Fetches members of the guild asynchronously. - +> +Fetches members of the guild asynchronously. ### searchGuildMembersAsync -> name="searchGuildMembersAsync" -> className="DiscordGuild" -> args={[ -> { name: "query", type: "string" }, -> { name: "limit", type: "number?" }, -> ]} -> returnType="Future" -> isMethod -> /> -> Searches for members in the guild asynchronously. - +> +Searches for members in the guild asynchronously. ### listAutomoderationRulesAsync -> name="listAutomoderationRulesAsync" -> className="DiscordGuild" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Lists all automoderation rules in the guild asynchronously. - +> +Lists all automoderation rules in the guild asynchronously. ### getAutomoderationRuleAsync -> name="getAutomoderationRuleAsync" -> className="DiscordGuild" -> args={[{ name: "ruleId", type: "string" }]} -> returnType="Future" -> isMethod -> /> -> Gets a specific automoderation rule in the guild asynchronously. - +> +Gets a specific automoderation rule in the guild asynchronously. ### createAutomoderationRuleAsync -> name="createAutomoderationRuleAsync" -> className="DiscordGuild" -> args={[ -> { -> name: "getAutomoderationRuleBuilder", -> type: "AutomoderationRuleBuilder", -> }, -> ]} -> returnType="Future" -> isMethod -> /> -> Creates an automoderation rule in the guild asynchronously. - -[//]: # "----- DOCUMENT FUNCTIONS ----- " +> +Creates an automoderation rule in the guild asynchronously. + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="DiscordGuild" -> args={[ -> { name: "discordClient", type: "any" }, -> { name: "guildData", type: "table" }, -> ]} -> /> -> Creates a new DiscordGuild instance. +> +Creates a new DiscordGuild instance. + diff --git a/src/content/docs/classes/Objects/DiscordGuildMember.mdx b/src/content/docs/classes/Objects/DiscordGuildMember.mdx index 460a85a..7c724b9 100644 --- a/src/content/docs/classes/Objects/DiscordGuildMember.mdx +++ b/src/content/docs/classes/Objects/DiscordGuildMember.mdx @@ -2,180 +2,89 @@ title: DiscordGuildMember description: DiscordLuau docs for DiscordGuildMember. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The `DiscordGuildMember` class represents a member of a Discord guild (server) and provides methods to interact with and manage the guild member. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties ### type -## - + +--- The type of the DiscordGuildMember. Default is "DiscordGuildMember". -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### kickAsync -> name="kickAsync" -> className="DiscordGuildMember" -> args={[{ name: "deleteMessagesSeconds", type: "number?" }]} -> returnType="Future" -> isMethod -> /> -> Kicks the guild member asynchronously. - +> +Kicks the guild member asynchronously. ### banAsync -> name="banAsync" -> className="DiscordGuildMember" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Bans the guild member asynchronously. - +> +Bans the guild member asynchronously. ### unbanAsync -> name="unbanAsync" -> className="DiscordGuildMember" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Unbans the guild member asynchronously. - +> +Unbans the guild member asynchronously. ### addRoleAsync -> name="addRoleAsync" -> className="DiscordGuildMember" -> args={[{ name: "roleId", type: "string" }]} -> returnType="Future" -> isMethod -> /> -> Adds a role to the guild member asynchronously. - +> +Adds a role to the guild member asynchronously. ### removeRoleAsync -> name="removeRoleAsync" -> className="DiscordGuildMember" -> args={[{ name: "roleId", type: "string" }]} -> returnType="Future" -> isMethod -> /> -> Removes a role from the guild member asynchronously. - +> +Removes a role from the guild member asynchronously. ### timeoutAsync -> name="timeoutAsync" -> className="DiscordGuildMember" -> args={[{ name: "seconds", type: "number" }]} -> returnType="Future" -> isMethod -> /> -> Times out the guild member asynchronously. - +> +Times out the guild member asynchronously. ### muteAsync -> name="muteAsync" -> className="DiscordGuildMember" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Mutes the guild member asynchronously. - +> +Mutes the guild member asynchronously. ### unmuteAsync -> name="unmuteAsync" -> className="DiscordGuildMember" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Unmutes the guild member asynchronously. - +> +Unmutes the guild member asynchronously. ### deafenAsync -> name="deafenAsync" -> className="DiscordGuildMember" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Deafens the guild member asynchronously. - +> +Deafens the guild member asynchronously. ### undeafenAsync -> name="undeafenAsync" -> className="DiscordGuildMember" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Undeafens the guild member asynchronously. - +> +Undeafens the guild member asynchronously. ### setNicknameAsync -> name="setNicknameAsync" -> className="DiscordGuildMember" -> args={[{ name: "nickname", type: "string" }]} -> returnType="Future" -> isMethod -> /> -> Sets the nickname of the guild member asynchronously. - +> +Sets the nickname of the guild member asynchronously. ### modifyAsync -> name="modifyAsync" -> className="DiscordGuildMember" -> args={[{ name: "modificationsTable", type: "table" }]} -> returnType="Future" -> isMethod -> /> -> Modifies the guild member asynchronously. +> +Modifies the guild member asynchronously. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="DiscordGuildMember" -> args={[ -> { name: "discordClient", type: "any" }, -> { name: "userId", type: "string" }, -> { name: "guildId", type: "string" }, -> { name: "memberData", type: "table" }, -> ]} -> /> -> Creates a new DiscordGuildMember instance. +> +Creates a new DiscordGuildMember instance. + diff --git a/src/content/docs/classes/Objects/DiscordGuildRole.mdx b/src/content/docs/classes/Objects/DiscordGuildRole.mdx index ec88c15..18dba0c 100644 --- a/src/content/docs/classes/Objects/DiscordGuildRole.mdx +++ b/src/content/docs/classes/Objects/DiscordGuildRole.mdx @@ -2,48 +2,42 @@ title: DiscordGuildRole description: DiscordLuau docs for DiscordGuildRole. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The `DiscordGuildRole` class represents a role in a Discord guild (server) and provides a structure for role data. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties ### type -## - + +--- The type of the DiscordGuildRole. Default is "DiscordGuildRole". -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods The DiscordGuildRole instance has no set methods! -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="DiscordGuildRole" -> args={[ -> { name: "discordClient", type: "any" }, -> { name: "roleData", type: "table" }, -> ]} -> /> -> Creates a new DiscordGuildRole instance. +> +Creates a new DiscordGuildRole instance. + diff --git a/src/content/docs/classes/Objects/DiscordInteraction.mdx b/src/content/docs/classes/Objects/DiscordInteraction.mdx index ff8f72e..315143a 100644 --- a/src/content/docs/classes/Objects/DiscordInteraction.mdx +++ b/src/content/docs/classes/Objects/DiscordInteraction.mdx @@ -2,94 +2,61 @@ title: DiscordInteraction description: DiscordLuau docs for DiscordInteraction. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The `DiscordInteraction` class represents an interaction with the Discord API, such as a message interaction, a command, or a modal submission. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties ### type -## - + +--- The type of the DiscordInteraction. Default is "DiscordInteraction". -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### editMessageAsync -> name="editMessageAsync" -> className="DiscordInteraction" -> args={[{ name: "messageBuilder", type: "MessageBuilder" }]} -> returnType="Future" -> isMethod -> /> -> Edits the original interaction response message asynchronously. - +> +Edits the original interaction response message asynchronously. ### sendModalAsync -> name="sendModalAsync" -> className="DiscordInteraction" -> args={[{ name: "modalObject", type: "ModalBuilder" }]} -> returnType="Future" -> isMethod -> /> -> Sends a modal in response to the interaction asynchronously. - +> +Sends a modal in response to the interaction asynchronously. ### sendMessageAsync -> name="sendMessageAsync" -> className="DiscordInteraction" -> args={[{ name: "messageBuilder", type: "MessageBuilder" }]} -> returnType="Future" -> isMethod -> /> -> Sends a message in response to the interaction asynchronously. +> +Sends a message in response to the interaction asynchronously. :::caution MessageBuilder cannot support Attachments UNLESS deffered, so if you're wanting to send attachments, please call `deferAsync` first! ::: - ### deferAsync -> name="deferAsync" -> className="DiscordInteraction" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Defers the interaction response asynchronously. +> +Defers the interaction response asynchronously. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="DiscordInteraction" -> args={[ -> { name: "discordClient", type: "any" }, -> { name: "jsonData", type: "table" }, -> ]} -> /> -> Creates a new DiscordInteraction instance. +> +Creates a new DiscordInteraction instance. + diff --git a/src/content/docs/classes/Objects/DiscordInvite.mdx b/src/content/docs/classes/Objects/DiscordInvite.mdx index a5898ad..8bc77eb 100644 --- a/src/content/docs/classes/Objects/DiscordInvite.mdx +++ b/src/content/docs/classes/Objects/DiscordInvite.mdx @@ -2,53 +2,41 @@ title: DiscordInvite description: DiscordLuau docs for DiscordInvite. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) DiscordInvite represents an invite link to a Discord server, providing methods to delete the invite. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The DiscordInvite instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### deleteAsync -> name="deleteAsync" -> className="DiscordInvite" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Deletes the invite asynchronously. +> +Deletes the invite asynchronously. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="DiscordInvite" -> args={[ -> { name: "discordClient", type: "any" }, -> { name: "inviteData", type: "table" }, -> ]} -> /> -> Creates a new instance of DiscordInvite. +> +Creates a new instance of DiscordInvite. + diff --git a/src/content/docs/classes/Objects/DiscordMediaChannel.mdx b/src/content/docs/classes/Objects/DiscordMediaChannel.mdx new file mode 100644 index 0000000..fb52f1d --- /dev/null +++ b/src/content/docs/classes/Objects/DiscordMediaChannel.mdx @@ -0,0 +1,50 @@ +--- +title: DiscordMediaChannel +description: DiscordLuau docs for DiscordMediaChannel. +--- +[//]: # (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 ----- ) + +DiscordMediaChannel represents a thread channel in a Discord server, providing methods to modify the channel and interact with pinned messages. + +[//]: # (----- DOCUMENT PROPERTIES ----- ) + +## Properties + +The DiscordMediaChannel instance has no set properties! + +[//]: # (----- DOCUMENT METHODS ----- ) + +## Methods + +### createThreadAsync + +> +Create a new thread inside of a Media channel. +### modifyAsync + +> +Modifies the thread channel settings asynchronously. +### getPinnedMessagesAsync + +> +Retrieves the pinned messages in the thread channel asynchronously. + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) + +## Functions + +### new + +> +Creates a new instance of DiscordMediaChannel. + diff --git a/src/content/docs/classes/Objects/DiscordMessage.mdx b/src/content/docs/classes/Objects/DiscordMessage.mdx index ea6ad63..f2413f7 100644 --- a/src/content/docs/classes/Objects/DiscordMessage.mdx +++ b/src/content/docs/classes/Objects/DiscordMessage.mdx @@ -2,166 +2,89 @@ title: DiscordMessage description: DiscordLuau docs for DiscordMessage. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) DiscordMessage represents a message in a Discord channel, providing methods to reply, delete, pin, unpin, edit, and manage reactions. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The DiscordMessage instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods +### crosspostAsync + +> +Crossposts the message in an Announcement Channel to all following channels. ### replyAsync -> name="replyAsync" -> className="DiscordMessage" -> args={[{ name: "messageBuilder", type: "MessageBuilder" }]} -> returnType="Future" -> isMethod -> /> -> Replies to the message asynchronously. +> +Replies to the message asynchronously. +### startThreadAsync +> +Start a thread from the current message object. ### deleteAsync -> name="deleteAsync" -> className="DiscordMessage" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Deletes the message asynchronously. - +> +Deletes the message asynchronously. ### pinAsync -> name="pinAsync" -> className="DiscordMessage" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Pins the message asynchronously. - +> +Pins the message asynchronously. ### unpinAsync -> name="unpinAsync" -> className="DiscordMessage" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Unpins the message asynchronously. - +> +Unpins the message asynchronously. ### editAsync -> name="editAsync" -> className="DiscordMessage" -> args={[{ name: "messageBuilder", type: "MessageBuilder" }]} -> returnType="Future" -> isMethod -> /> -> Edits the message asynchronously. - +> +Edits the message asynchronously. ### addReactionAsync -> name="addReactionAsync" -> className="DiscordMessage" -> args={[{ name: "reaction", type: "string" }]} -> returnType="Future" -> isMethod -> /> -> Adds a reaction to the message asynchronously. - +> +Adds a reaction to the message asynchronously. ### removeReactionAsync -> name="removeReactionAsync" -> className="DiscordMessage" -> args={[{ name: "reaction", type: "string" }]} -> returnType="Future" -> isMethod -> /> -> Removes a reaction from the message asynchronously. - +> +Removes a reaction from the message asynchronously. ### removeUserReactionAsync -> name="removeUserReactionAsync" -> className="DiscordMessage" -> args={[ -> { name: "userId", type: "string" }, -> { name: "reaction", type: "string" }, -> ]} -> returnType="Future" -> isMethod -> /> -> Removes a reaction from a specific user on the message asynchronously. - +> +Removes a reaction from a specific user on the message asynchronously. ### getReactionsAsync -> name="getReactionsAsync" -> className="DiscordMessage" -> args={[{ name: "reaction", type: "string" }]} -> returnType="Future" -> isMethod -> /> -> Gets the reactions on the message asynchronously. - +> +Gets the reactions on the message asynchronously. ### removeAllReactionsAsync -> name="removeAllReactionsAsync" -> className="DiscordMessage" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Removes all reactions from the message asynchronously. - +> +Removes all reactions from the message asynchronously. ### removeAllReactionsForEmojiAsync -> name="removeAllReactionsForEmojiAsync" -> className="DiscordMessage" -> args={[{ name: "reaction", type: "string" }]} -> returnType="Future" -> isMethod -> /> -> Removes all reactions for a specific emoji from the message asynchronously. +> +Removes all reactions for a specific emoji from the message asynchronously. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="DiscordMessage" -> args={[ -> { name: "discordClient", type: "any" }, -> { name: "messageData", type: "table" }, -> ]} -> /> -> Creates a new instance of DiscordMessage. +> +Creates a new instance of DiscordMessage. + diff --git a/src/content/docs/classes/Objects/DiscordTextChannel.mdx b/src/content/docs/classes/Objects/DiscordTextChannel.mdx index 5d7cdcb..da829a5 100644 --- a/src/content/docs/classes/Objects/DiscordTextChannel.mdx +++ b/src/content/docs/classes/Objects/DiscordTextChannel.mdx @@ -2,64 +2,49 @@ title: DiscordTextChannel description: DiscordLuau docs for DiscordTextChannel. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) DiscordTextChannel represents a text channel in a Discord server, providing methods to modify the channel and interact with pinned messages. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The DiscordTextChannel instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods -### modifyAsync +### createThreadAsync -> name="modifyAsync" -> className="DiscordTextChannel" -> args={[{ name: "channelSchema", type: "DiscordTextChannelSchema" }]} -> returnType="Future" -> isMethod -> /> -> Modifies the text channel settings asynchronously. +> +Creates a thread in the current channel +### modifyAsync +> +Modifies the text channel settings asynchronously. ### getPinnedMessagesAsync -> name="getPinnedMessagesAsync" -> className="DiscordTextChannel" -> args={[]} -> returnType="Future<{[number]: DiscordMessage}>" -> isMethod -> /> -> Retrieves the pinned messages in the text channel asynchronously. +> +Retrieves the pinned messages in the text channel asynchronously. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="DiscordTextChannel" -> args={[ -> { name: "discordClient", type: "any" }, -> { name: "channelData", type: "table" }, -> ]} -> /> -> Creates a new instance of DiscordTextChannel. +> +Creates a new instance of DiscordTextChannel. + diff --git a/src/content/docs/classes/Objects/DiscordThreadChannel.mdx b/src/content/docs/classes/Objects/DiscordThreadChannel.mdx index 8003834..7d2ffbc 100644 --- a/src/content/docs/classes/Objects/DiscordThreadChannel.mdx +++ b/src/content/docs/classes/Objects/DiscordThreadChannel.mdx @@ -2,119 +2,65 @@ title: DiscordThreadChannel description: DiscordLuau docs for DiscordThreadChannel. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) DiscordThreadChannel represents a thread channel in a Discord server, providing methods to modify the channel and interact with pinned messages. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The DiscordThreadChannel instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### joinThreadAsync -> name="joinThreadAsync" -> className="DiscordThreadChannel" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Joins the current discord bot into the thread - +> +Joins the current discord bot into the thread ### addMemberToThreadAsync -> name="addMemberToThreadAsync" -> className="DiscordThreadChannel" -> args={[{ name: "userId", type: "string" }]} -> returnType="Future" -> isMethod -> /> -> Adds the passed member to the thread channel - +> +Adds the passed member to the thread channel ### leaveThreadAsync -> name="leaveThreadAsync" -> className="DiscordThreadChannel" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Leaves the thread channel if the discord bot is in the channel. - +> +Leaves the thread channel if the discord bot is in the channel. ### removeMemberFromThreadAsync -> name="removeMemberFromThreadAsync" -> className="DiscordThreadChannel" -> args={[{ name: "userId", type: "string" }]} -> returnType="Future" -> isMethod -> /> -> Removes the passed user id from the current thread channel - +> +Removes the passed user id from the current thread channel ### removeMemberFromThreadAsync -> name="removeMemberFromThreadAsync" -> className="DiscordThreadChannel" -> args={[{ name: "userId", type: "string" }]} -> returnType="Future<{ DiscordGuildMember }>" -> isMethod -> /> -> Returns a list of members that are active in the current thread channel - +> +Returns a list of members that are active in the current thread channel ### modifyAsync -> name="modifyAsync" -> className="DiscordThreadChannel" -> args={[{ name: "channelSchema", type: "DiscordTextChannelSchema" }]} -> returnType="Future" -> isMethod -> /> -> Modifies the thread channel settings asynchronously. - +> +Modifies the thread channel settings asynchronously. ### getPinnedMessagesAsync -> name="getPinnedMessagesAsync" -> className="DiscordThreadChannel" -> args={[]} -> returnType="Future<{[number]: DiscordMessage}>" -> isMethod -> /> -> Retrieves the pinned messages in the thread channel asynchronously. +> +Retrieves the pinned messages in the thread channel asynchronously. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="DiscordThreadChannel" -> args={[ -> { name: "discordClient", type: "any" }, -> { name: "channelData", type: "table" }, -> ]} -> /> -> Creates a new instance of DiscordThreadChannel. +> +Creates a new instance of DiscordThreadChannel. + diff --git a/src/content/docs/classes/Objects/DiscordUser.mdx b/src/content/docs/classes/Objects/DiscordUser.mdx index 111ea09..bc3840d 100644 --- a/src/content/docs/classes/Objects/DiscordUser.mdx +++ b/src/content/docs/classes/Objects/DiscordUser.mdx @@ -2,44 +2,38 @@ title: DiscordUser description: DiscordLuau docs for DiscordUser. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) DiscordUser represents a user on Discord, encapsulating user data such as username, avatar, and various flags. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The DiscordUser instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods The DiscordUser instance has no set methods! -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="DiscordUser" -> args={[ -> { name: "discordClient", type: "any" }, -> { name: "partialUserData", type: "table" }, -> ]} -> /> -> Creates a new instance of DiscordUser. +> +Creates a new instance of DiscordUser. + diff --git a/src/content/docs/classes/Objects/DiscordVoiceChannel.mdx b/src/content/docs/classes/Objects/DiscordVoiceChannel.mdx index 87dc6a8..a185d41 100644 --- a/src/content/docs/classes/Objects/DiscordVoiceChannel.mdx +++ b/src/content/docs/classes/Objects/DiscordVoiceChannel.mdx @@ -2,75 +2,49 @@ title: DiscordVoiceChannel description: DiscordLuau docs for DiscordVoiceChannel. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) DiscordVoiceChannel represents a voice channel in a Discord server, providing methods to connect, disconnect, and modify the channel. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The DiscordVoiceChannel instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### connectAsync -> name="connectAsync" -> className="DiscordVoiceChannel" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Connects to the voice channel asynchronously. - +> +Connects to the voice channel asynchronously. ### disconnectAsync -> name="disconnectAsync" -> className="DiscordVoiceChannel" -> args={[]} -> returnType="Future" -> isMethod -> /> -> Disconnects from the voice channel asynchronously. - +> +Disconnects from the voice channel asynchronously. ### modifyAsync -> name="modifyAsync" -> className="DiscordVoiceChannel" -> args={[{ name: "channelSchema", type: "DiscordVoiceChannelSchema" }]} -> returnType="Future" -> isMethod -> /> -> Modifies the voice channel settings asynchronously. +> +Modifies the voice channel settings asynchronously. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="DiscordVoiceChannel" -> args={[ -> { name: "discordClient", type: "any" }, -> { name: "channelData", type: "table" }, -> ]} -> /> -> Creates a new instance of DiscordVoiceChannel. +> +Creates a new instance of DiscordVoiceChannel. + diff --git a/src/content/docs/classes/Objects/EndpointCache.mdx b/src/content/docs/classes/Objects/EndpointCache.mdx index d77f7d8..678657c 100644 --- a/src/content/docs/classes/Objects/EndpointCache.mdx +++ b/src/content/docs/classes/Objects/EndpointCache.mdx @@ -2,70 +2,49 @@ title: EndpointCache description: DiscordLuau docs for EndpointCache. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) EndpointCache is a caching mechanism designed to store data temporarily with an expiration time. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The EndpointCache instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods ### setExpiry -> name="setExpiry" -> className="EndpointCache" -> args={[{ name: "seconds", type: "number" }]} -> isMethod -> /> -> Sets the expiry time for the cache. - +> +Sets the expiry time for the cache. ### set -> name="set" -> className="EndpointCache" -> args={[{ name: "value", type: "any" }]} -> isMethod -> /> -> Sets the value in the cache and starts the expiry timer. - +> +Sets the value in the cache and starts the expiry timer. ### get -> name="get" -> className="EndpointCache" -> args={[]} -> returnType="any" -> isMethod -> /> -> Gets the current value from the cache. +> +Gets the current value from the cache. -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="EndpointCache" -> args={[{ name: "expiryTime", type: "number?" }]} -> /> -> Creates a new instance of EndpointCache. +> +Creates a new instance of EndpointCache. + diff --git a/src/content/docs/classes/Objects/EventManager.mdx b/src/content/docs/classes/Objects/EventManager.mdx index 8019236..99065a0 100644 --- a/src/content/docs/classes/Objects/EventManager.mdx +++ b/src/content/docs/classes/Objects/EventManager.mdx @@ -2,44 +2,40 @@ title: EventManager description: DiscordLuau docs for EventManager. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) -EventManager is responsible for handling Discord events and emitting signals -for various Discord activities such as message events, channel events, user updates, +EventManager is responsible for handling Discord events and emitting signals +for various Discord activities such as message events, channel events, user updates, guild events, and interactions. -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The EventManager instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods The EventManager instance has no set methods! -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions ### new -> name="new" -> className="EventManager" -> args={[{ name: "discordClient", type: "any" }]} -> /> -> Creates a new instance of EventManager and connects it to the provided Discord -> client. +> +Creates a new instance of EventManager and connects it to the provided Discord client. + diff --git a/src/content/docs/classes/Vendor/Console.mdx b/src/content/docs/classes/Vendor/Console.mdx index 33d05e8..28c377d 100644 --- a/src/content/docs/classes/Vendor/Console.mdx +++ b/src/content/docs/classes/Vendor/Console.mdx @@ -2,36 +2,37 @@ title: Console description: DiscordLuau docs for Console. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The `Vendor.Console` module is a third-party library used within Discord-Luau for logging and debugging purposes. This module may contain modifications to better integrate with the Discord-Luau framework. Original module can be found at: https://docs.asyncmatrix.dev/Packages/Console -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The Console instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods The Console instance has no set methods! -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions The Console instance has no set functions! + diff --git a/src/content/docs/classes/Vendor/Future.mdx b/src/content/docs/classes/Vendor/Future.mdx index 258fdad..f28f643 100644 --- a/src/content/docs/classes/Vendor/Future.mdx +++ b/src/content/docs/classes/Vendor/Future.mdx @@ -2,36 +2,37 @@ title: Future description: DiscordLuau docs for Future. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The `Vendor.Future` module is a third-party library used within Discord-Luau for handling asynchronous operations. This module may contain modifications to better integrate with the Discord-Luau framework. Original module can be found at: https://util.redblox.dev/future.html -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The Future instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods The Future instance has no set methods! -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions The Future instance has no set functions! + diff --git a/src/content/docs/classes/Vendor/Signal.mdx b/src/content/docs/classes/Vendor/Signal.mdx index d1cd806..90d912c 100644 --- a/src/content/docs/classes/Vendor/Signal.mdx +++ b/src/content/docs/classes/Vendor/Signal.mdx @@ -2,36 +2,37 @@ title: Signal description: DiscordLuau docs for Signal. --- +[//]: # (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!) -[//]: # "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 ----- " +[//]: # (----- DOCUMENT IMPORTS ----- ) -import LuaDeclaration from "$/components/LuaDeclaration.astro"; -import LuaProperty from "$/components/LuaProperty.astro"; +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; -[//]: # "----- DOCUMENT DESCRIPTION ----- " +[//]: # (----- DOCUMENT DESCRIPTION ----- ) The `Vendor.Signal` module is a third-party library used within Discord-Luau for creating and managing events and connections. This module may contain modifications to better integrate with the Discord-Luau framework. Original module can be found at: https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal -[//]: # "----- DOCUMENT PROPERTIES ----- " +[//]: # (----- DOCUMENT PROPERTIES ----- ) ## Properties The Signal instance has no set properties! -[//]: # "----- DOCUMENT METHODS ----- " +[//]: # (----- DOCUMENT METHODS ----- ) ## Methods The Signal instance has no set methods! -[//]: # "----- DOCUMENT FUNCTIONS ----- " +[//]: # (----- DOCUMENT FUNCTIONS ----- ) ## Functions The Signal instance has no set functions! +