diff --git a/discord-luau b/discord-luau index 359282c..8935045 160000 --- a/discord-luau +++ b/discord-luau @@ -1 +1 @@ -Subproject commit 359282c51bc59e4499ce8e3957533671755835f3 +Subproject commit 8935045308863ea5c554217ac7699d52d5cebf7a diff --git a/src/content/docs/classes/Builders/GuildBuilder.mdx b/src/content/docs/classes/Builders/GuildBuilder.mdx new file mode 100644 index 0000000..d2b8e92 --- /dev/null +++ b/src/content/docs/classes/Builders/GuildBuilder.mdx @@ -0,0 +1,196 @@ +--- +title: GuildBuilder +description: DiscordLuau docs for GuildBuilder. +--- +[//]: # (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 ----- ) + + + +[//]: # (----- DOCUMENT PROPERTIES ----- ) + +## Properties + +### VerificationLevel + + +--- +An enumeration of filter levels. + +- None: 0 +- Low: 1 +- Medium: 2 +- High: 2 +- VeryHigh: 2 +### NotificationLevel + + +--- +An enumeration of filter levels. + +- AllMessages: 0 +- OnlyMentions: 1 +### ExplicitContentFilterLevel + + +--- +An enumeration of filter levels. + +- Disabled: 0 +- MembersWithoutRoles: 1 +- AllMembers: 2 +### GuildFeature + + +--- +An enumeration of guild features. + +- AnimatedBanner: "ANIMATED_BANNER" +- AnimatedIcon: "ANIMATED_ICON" +- ApplicationCommandPermissionsV2: "APPLICATION_COMMAND_PERMISSIONS_V2" +- AutoModeration: "AUTO_MODERATION" +- Banner: "BANNER" +- Community: "COMMUNITY" +- CreatorMonetizableProvisional: "CREATOR_MONETIZABLE_PROVISIONAL" +- CreatorStorePage: "CREATOR_STORE_PAGE" +- DeveloperSupportServer: "DEVELOPER_SUPPORT_SERVER" +- Discoverable: "DISCOVERABLE" +- Featurable: "FEATURABLE" +- InvitesDisabled: "INVITES_DISABLED" +- InviteSplash: "INVITE_SPLASH" +- MemberVerificationGateEnabled: "MEMBER_VERIFICATION_GATE_ENABLED" +- MoreStickers: "MORE_STICKERS" +- News: "NEWS" +- Partnered: "PARTNERED" +- PreviewEnabled: "PREVIEW_ENABLED" +- RaidAlertsDisabled: "RAID_ALERTS_DISABLED" +- RoleIcons: "ROLE_ICONS" +- RoleSubscriptionsAvaliableForPurchase: "ROLE_SUBSCRIPTIONS_AVAILABLE_FOR_PURCHASE" +- RoleSubscriptionsEnabled: "ROLE_SUBSCRIPTIONS_ENABLED" +- TicketedEventsEnabled: "TICKETED_EVENTS_ENABLED" +- VanityUrl: "VANITY_URL" +- Verified: "VERIFIED" +- VipRegions: "VIP_REGIONS" +- WelcomeScreenEnabled: "WELCOME_SCREEN_ENABLED" + +[//]: # (----- DOCUMENT METHODS ----- ) + +## Methods + +### setName + +> +Sets the name of this discord guild. +### setVerificationLevel + +> +Sets the verification level for this guild. +### setDefaultMessageNotificationLevel + +> +Sets the default message notification level for this guild. +### setExplicitContentFilterLevel + +> +Sets the explicit content filter level for this guild. +### setAfkChannelId + +> +Sets the discord Afk Voice Channel for this guild. +### setAfkTimeout + +> +Sets the timeout for members in discord voice channels. Valid inputs are: + +- 60 +- 300 +- 900 +- 1800 +- 3600 +### setIcon + +> +Sets the icon of this guild. imageData must be a base64, 1024x1024, encoded binary data for either a png/jpeg/gif +### setOwnerId + +> +Sets the owner of this guild. +### setSplash + +> +Sets the splash for this guild. imageData must be a 16:9, base64, encoded binary data for either a png/jpeg +### setDiscoverySplash + +> +Sets the discovery splash for this guild. imageData must be a 16:9, base64, encoded binary data for either a png/jpeg +### setSysetBannerstemChannelId + +> +Sets the banner for this guild. imageData must be a 16:9, base64, encoded binary data for either a png/jpeg +### setSystemChannelId + +> +Sets the System Channel for this guild. +### setSystemChannelFlags + +> +Sets the flags for the System Channel in this guild. +### setRulesChannelId + +> +Sets the rules channel for this guild. +### setPublicUpdateChannelId + +> +Sets the public update channel for this guild +### setPreferredLocale + +> +Sets the preferred locale of this guild +### addFeature + +> +Enables developers to specify features that are apart of this guild. +### setDescription + +> +Sets the description of this guild +### setPremiumProgressBarEnabled + +> +Sets if the Premium Progress bar is enabled +### setSafetyAlertsChannelId + +> +Sets the Safety Alert channel id +### addRole + +> +Enables developers to add a Role to a discord Guild channel upon creation. +### addChannel + +> +Enables developers to add a Channel to a discord Guild channel upon creation. +### toPayloadObject + +> +Converts the guild to a JSON object that can be sent to the Discord API. + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) + +## Functions + +### new + +> +Creates a new instance of GuildBuilder. + diff --git a/src/content/docs/classes/Builders/GuildRoleBuilder.mdx b/src/content/docs/classes/Builders/GuildRoleBuilder.mdx new file mode 100644 index 0000000..6875e24 --- /dev/null +++ b/src/content/docs/classes/Builders/GuildRoleBuilder.mdx @@ -0,0 +1,82 @@ +--- +title: GuildRoleBuilder +description: DiscordLuau docs for GuildRoleBuilder. +--- +[//]: # (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 ----- ) + +Allows a developer to build a Guild Role + +```lua +local DiscordGuild = GuildRoleBuilder.new() + :setName("my-discord-role") + :setColor(0xFF0000) + :setHoisted(true) + :setMentionable(false) +``` + +[//]: # (----- DOCUMENT PROPERTIES ----- ) + +## Properties + +The GuildRoleBuilder instance has no set properties! + +[//]: # (----- DOCUMENT METHODS ----- ) + +## Methods + +### setName + +> +Sets the name of the Role +### setColor + +> +Sets the color of the Role. +### setHoisted + +> +Sets weather this role will split users in the roles hierarchy in the guild. +### setIcon + +> +Sets the Icon for this role, the imageData should be a base64 encoded, 128x128 jpg file. +### setUnicodeEmoji + +> +Sets the Emoji for this Role +### setPosition + +> +Set the position of this Role, this will update the roles hierarchy in the guild. +### setMentionable + +> +Set if discord members can mention this Role. +### setFlags + +> +Set the flags for the Guild +### toPayloadObject + +> +Converts the role to a JSON object that can be sent to the Discord API. + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) + +## Functions + +### new + +> +Creates a new instance of GuildRoleBuilder. +