Skip to content

Commit

Permalink
docs: update refs for DiscordLuau/discord-luau@6510ce2
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jun 11, 2024
1 parent 8689606 commit 14c9aa3
Show file tree
Hide file tree
Showing 15 changed files with 670 additions and 1 deletion.
2 changes: 1 addition & 1 deletion discord-luau
Submodule discord-luau updated 92 files
+0 −3 .gitattributes
+10 −1 .luaurc
+10 −1 .vscode/settings.json
+2 −1 Examples/Components.luau
+1 −1 Examples/Development.luau
+8 −2 Examples/Files.luau
+1 −1 Examples/Modal.luau
+5 −4 Package/Classes/Builders/ActivityBuilder.luau
+4 −3 Package/Classes/Builders/AttachmentBuilder.luau
+5 −4 Package/Classes/Builders/AutomoderationRuleBuilder.luau
+5 −5 Package/Classes/Builders/ChannelBuilder.luau
+7 −6 Package/Classes/Builders/CommandBuilder.luau
+5 −4 Package/Classes/Builders/CommandOptionBuilder.luau
+6 −5 Package/Classes/Builders/EmbedBuilder.luau
+21 −7 Package/Classes/Builders/GuildBuilder.luau
+5 −5 Package/Classes/Builders/GuildRoleBuilder.luau
+3 −3 Package/Classes/Builders/IntentsBuilder.luau
+7 −6 Package/Classes/Builders/Interface/ActionRowBuilder.luau
+5 −4 Package/Classes/Builders/Interface/ButtonBuilder.luau
+5 −4 Package/Classes/Builders/Interface/SelectionBuilder.luau
+5 −4 Package/Classes/Builders/Interface/TextInputBuilder.luau
+5 −5 Package/Classes/Builders/MemberBuilder.luau
+10 −9 Package/Classes/Builders/MessageBuilder.luau
+8 −7 Package/Classes/Builders/ModalBuilder.luau
+154 −0 Package/Classes/Builders/OnboardingBuilder.luau
+186 −0 Package/Classes/Builders/OnboardingPromptBuilder.luau
+160 −0 Package/Classes/Builders/OnboardingPromptOptionBuilder.luau
+2 −2 Package/Classes/Builders/PermissionsBuilder.luau
+6 −5 Package/Classes/Builders/PresenceBuilder.luau
+2 −2 Package/Classes/Builders/SettingsBuilder.luau
+125 −0 Package/Classes/Builders/WelcomeScreenBuilder.luau
+26 −28 Package/Classes/DiscordClient.luau
+13 −14 Package/Classes/Network/DiscordGateway.luau
+11 −12 Package/Classes/Network/DiscordShard.luau
+6 −6 Package/Classes/Network/DiscordUDP.luau
+12 −13 Package/Classes/Network/DiscordVoiceConnection.luau
+12 −12 Package/Classes/Network/DiscordWebsocket.luau
+2 −2 Package/Classes/Network/HTTPRatelimit.luau
+3 −3 Package/Classes/Network/HTTPScheduler.luau
+1 −1 Package/Classes/Network/Middleware/EventIn.luau
+1 −1 Package/Classes/Network/Middleware/EventOut.luau
+5 −5 Package/Classes/Network/Resolvable.luau
+1 −1 Package/Classes/Network/WebsocketBuffer.luau
+3 −3 Package/Classes/Objects/BaseDiscordChannel.luau
+12 −11 Package/Classes/Objects/BaseDiscordGuildChannel.luau
+9 −9 Package/Classes/Objects/BaseGuildTextChannel.luau
+7 −8 Package/Classes/Objects/BaseGuildThread.luau
+5 −5 Package/Classes/Objects/BaseGuildVoiceChannel.luau
+11 −10 Package/Classes/Objects/BaseUserChannel.luau
+7 −6 Package/Classes/Objects/DiscordApplication.luau
+4 −4 Package/Classes/Objects/DiscordAutomoderationRule.luau
+1 −1 Package/Classes/Objects/DiscordCache.luau
+14 −14 Package/Classes/Objects/DiscordChannel.luau
+2 −2 Package/Classes/Objects/DiscordEmoji.luau
+442 −26 Package/Classes/Objects/DiscordGuild.luau
+50 −0 Package/Classes/Objects/DiscordGuildBan.luau
+7 −9 Package/Classes/Objects/DiscordGuildMember.luau
+74 −2 Package/Classes/Objects/DiscordGuildRole.luau
+106 −0 Package/Classes/Objects/DiscordIntegration.luau
+12 −12 Package/Classes/Objects/DiscordInteraction.luau
+4 −4 Package/Classes/Objects/DiscordInvite.luau
+14 −13 Package/Classes/Objects/DiscordMessage.luau
+2 −2 Package/Classes/Objects/DiscordPermission.luau
+3 −4 Package/Classes/Objects/DiscordSticker.luau
+2 −2 Package/Classes/Objects/DiscordUser.luau
+2 −2 Package/Classes/Objects/EndpointCache.luau
+9 −9 Package/Classes/Objects/EventManager.luau
+4 −4 Package/Classes/Objects/GuildAnnouncementChannel.luau
+4 −4 Package/Classes/Objects/GuildAnnouncementThreadChannel.luau
+4 −4 Package/Classes/Objects/GuildCategoryChannel.luau
+4 −4 Package/Classes/Objects/GuildDirectoryChannel.luau
+4 −4 Package/Classes/Objects/GuildForumChannel.luau
+4 −4 Package/Classes/Objects/GuildMediaChannel.luau
+70 −0 Package/Classes/Objects/GuildOnboarding.luau
+72 −0 Package/Classes/Objects/GuildOnboardingPrompt.luau
+73 −0 Package/Classes/Objects/GuildOnboardingPromptOption.luau
+4 −4 Package/Classes/Objects/GuildPreview.luau
+4 −4 Package/Classes/Objects/GuildPrivateThreadChannel.luau
+4 −4 Package/Classes/Objects/GuildPublicThreadChannel.luau
+4 −4 Package/Classes/Objects/GuildStageVoiceChannel.luau
+4 −4 Package/Classes/Objects/GuildTextChannel.luau
+4 −4 Package/Classes/Objects/GuildVoiceChannel.luau
+67 −0 Package/Classes/Objects/GuildWelcomeScreen.luau
+80 −0 Package/Classes/Objects/GuildWidget.luau
+4 −4 Package/Classes/Objects/UserDMChannel.luau
+7 −7 Package/Classes/Objects/UserGroupChannel.luau
+46 −23 Package/Data/DiscordEndpoints.luau
+15 −1 Package/Enums/CacheType.luau
+3 −3 Package/Enums/ResolvableType.luau
+4 −4 Package/Utils/Extend.luau
+75 −43 Package/init.luau
+1 −1 aftman.toml
8 changes: 8 additions & 0 deletions src/content/docs/classes/Builders/GuildBuilder.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ import LuaProperty from '$/components/LuaProperty.astro';

## Properties

### MFALevel

<LuaProperty name="GuildBuilder.MFALevel" type="table" />
---
An enumeration of MFA levels.

- None: 0
- Elevated: 1
### VerificationLevel

<LuaProperty name="GuildBuilder.VerificationLevel" type="table" />
Expand Down
79 changes: 79 additions & 0 deletions src/content/docs/classes/Builders/OnboardingBuilder.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
title: OnboardingBuilder
description: DiscordLuau docs for OnboardingBuilder.
---
[//]: # (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 ----- )

OnboardingBuilder allows you to build onboarding for discord guilds.

Usage:
```lua
local DiscordLuau = require("../Submodules/DiscordLuau")

local OnboardingBuilder = DiscordLuau.OnboardingBuilder.new()
:setMode(DiscordLuau.OnboardingBuilder.Mode.Default)
:setEnabled(true)
:addChannelId("1048686561685946489")
```

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

## Properties

### Mode

<LuaProperty name="OnboardingBuilder.Mode" type="table" />
---
An enumeration of onboarding modes

- Default: 0
- Advanced: 1

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

## Methods

### toPayloadObject

> <LuaDeclaration name="toPayloadObject" className="OnboardingBuilder" args={[ ]} returnType="Network.Resolvable" isMethod />
Converts the message to a JSON object that can be sent to the Discord API.
### setMode

> <LuaDeclaration name="setMode" className="OnboardingBuilder" args={[ { name: "mode", type: "number" } ]} returnType="Builders.OnboardingBuilder" isMethod />
Sets the mode of the Guild onbaording object
### setEnabled

> <LuaDeclaration name="setEnabled" className="OnboardingBuilder" args={[ { name: "isEnabled", type: "boolean" } ]} returnType="Builders.OnboardingBuilder" isMethod />
Sets if the guild onboarding is enabled or not
### addChannelId

> <LuaDeclaration name="addChannelId" className="OnboardingBuilder" args={[ { name: "channelId", type: "string" } ]} returnType="Builders.OnboardingBuilder" isMethod />
Channel IDs that members get opted into automatically
### addOnboardingPrompt

> <LuaDeclaration name="addOnboardingPrompt" className="OnboardingBuilder" args={[ { name: "prompt", type: "Objects.OnboardingPromptBuilder" } ]} returnType="Builders.OnboardingBuilder" isMethod />
Channel IDs that members get opted into automatically
### toPayloadObject

> <LuaDeclaration name="toPayloadObject" className="OnboardingBuilder" args={[ ]} returnType="Network.Resolvable" isMethod />
Converts the message to a JSON object that can be sent to the Discord API.

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

## Functions

### new

> <LuaDeclaration name="new" className="OnboardingBuilder" args={[ ]} />
Creates a new instance of OnboardingBuilder.

86 changes: 86 additions & 0 deletions src/content/docs/classes/Builders/OnboardingPromptBuilder.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
---
title: OnboardingPromptBuilder
description: DiscordLuau docs for OnboardingPromptBuilder.
---
[//]: # (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 ----- )

OnboardingPromptBuilder allows you to build onboarding for discord guilds.

Usage:
```lua
local DiscordLuau = require("../Submodules/DiscordLuau")

local OnboardingPromptBuilder = DiscordLuau.OnboardingPromptBuilder.new()
:setType(DiscordLuau.OnboardingPromptBuilder.Type.Dropdown)
:addOption(
DiscordLuau.OnboardingPromptOptionBuilder.new()
:setTitle("option-name")
:setDescription("Option Description!")
)
```

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

## Properties

### Type

<LuaProperty name="OnboardingPromptBuilder.Type" type="table" />
---
An enumeration of prompt types

- MultipleChoice: 0
- Dropdown: 1

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

## Methods

### setType

> <LuaDeclaration name="setType" className="OnboardingPromptBuilder" args={[ { name: "type", type: "number" } ]} returnType="Builders.OnboardingPromptBuilder" isMethod />
Set the type of the Onboarding Prompt builder
### addOption

> <LuaDeclaration name="addOption" className="OnboardingPromptBuilder" args={[ { name: "option", type: "Builders.OnboardingPromptOptionBuilder" } ]} returnType="Builders.OnboardingPromptBuilder" isMethod />
Adds an option to the Onboarding prompt builder.
### setTitle

> <LuaDeclaration name="setTitle" className="OnboardingPromptBuilder" args={[ { name: "title", type: "string" } ]} returnType="Builders.OnboardingPromptBuilder" isMethod />
Sets the title of the onboarding prompt builder
### setSingleSelection

> <LuaDeclaration name="setSingleSelection" className="OnboardingPromptBuilder" args={[ { name: "isSingleSelection", type: "boolean" } ]} returnType="Builders.OnboardingPromptBuilder" isMethod />
Indicates whether users are limited to selecting one option for the prompt
### setRequired

> <LuaDeclaration name="setRequired" className="OnboardingPromptBuilder" args={[ { name: "isRequired", type: "boolean" } ]} returnType="Builders.OnboardingPromptBuilder" isMethod />
Indicates whether the prompt is required before a user completes the onboarding flow
### setIsOnboarding

> <LuaDeclaration name="setIsOnboarding" className="OnboardingPromptBuilder" args={[ { name: "isInOnboarding", type: "boolean" } ]} returnType="Builders.OnboardingPromptBuilder" isMethod />
Indicates whether the prompt is present in the onboarding flow. If false, the prompt will only appear in the Channels & Roles tab
### toPayloadObject

> <LuaDeclaration name="toPayloadObject" className="OnboardingPromptBuilder" args={[ ]} returnType="Network.Resolvable" isMethod />
Converts the message to a JSON object that can be sent to the Discord API.

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

## Functions

### new

> <LuaDeclaration name="new" className="OnboardingPromptBuilder" args={[ ]} />
Creates a new instance of OnboardingPromptBuilder.

Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
title: OnboardingPromptOptionBuilder
description: DiscordLuau docs for OnboardingPromptOptionBuilder.
---
[//]: # (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 ----- )

OnboardingPromptOptionBuilder allows you to build onboarding for discord guilds.

Usage:
```lua
local DiscordLuau = require("../Submodules/DiscordLuau")

local OnboardingPromptOptionBuilder = DiscordLuau.OnboardingPromptOptionBuilder.new()
:setTitle("option-name")
:setDescription("Option Description!")
```

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

## Properties

The OnboardingPromptOptionBuilder instance has no set properties!

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

## Methods

### setTitle

> <LuaDeclaration name="setTitle" className="OnboardingPromptOptionBuilder" args={[ { name: "title", type: "string" } ]} returnType="Builders.OnboardingPromptOptionBuilder" isMethod />
Sets the title of the Prompt Option builder
### setDescription

> <LuaDeclaration name="setDescription" className="OnboardingPromptOptionBuilder" args={[ { name: "description", type: "string" } ]} returnType="Builders.OnboardingPromptOptionBuilder" isMethod />
Sets the description of the Prompt Option builder
### addChannelId

> <LuaDeclaration name="addChannelId" className="OnboardingPromptOptionBuilder" args={[ { name: "channelId", type: "string" } ]} returnType="Builders.OnboardingPromptOptionBuilder" isMethod />
Add a channel id to the prompt option builder
### addRoleId

> <LuaDeclaration name="addRoleId" className="OnboardingPromptOptionBuilder" args={[ { name: "roleId", type: "string" } ]} returnType="Builders.OnboardingPromptOptionBuilder" isMethod />
Add a role id to the prompt option builder
### setEmoji

> <LuaDeclaration name="setEmoji" className="OnboardingPromptOptionBuilder" args={[ { name: "emojiId", type: "string" }, { name: "emojiName", type: "string" }, { name: "emojiAnimated", type: "boolean?" } ]} returnType="Builders.OnboardingPromptOptionBuilder" isMethod />
Sets the emoji of the Onboarding Prompt Option Builder

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

## Functions

### new

> <LuaDeclaration name="new" className="OnboardingPromptOptionBuilder" args={[ { name: "intentList", type: "{ string }" } ]} />
Creates a new instance of OnboardingPromptOptionBuilder with the specified intents.

59 changes: 59 additions & 0 deletions src/content/docs/classes/Builders/WelcomeScreenBuilder.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: WelcomeScreenBuilder
description: DiscordLuau docs for WelcomeScreenBuilder.
---
[//]: # (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 ----- )

WelcomeScreenBuilder allows you to build welcome screens for discord guilds.

Usage:
```lua
local DiscordLuau = require("../Submodules/DiscordLuau")

local WelcomeScreenBuilder = DiscordLuau.WelcomeScreenBuilder.new()
:addChannel("1048686561685946489", "Super cool discord channel")
:setDescription("Yeah, a super awesome dsicord channel!")
```

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

## Properties

The WelcomeScreenBuilder instance has no set properties!

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

## Methods

### addChannel

> <LuaDeclaration name="addChannel" className="WelcomeScreenBuilder" args={[ { name: "channelId", type: "string" }, { name: "description", type: "string" }, { name: "emojiId", type: "string" }, { name: "emojiName", type: "string" } ]} returnType="Builders.WelcomeScreenBuilder" isMethod />
Adds a channel object to the guilds Welcome Screen
### setDescription

> <LuaDeclaration name="setDescription" className="WelcomeScreenBuilder" args={[ { name: "description", type: "string" } ]} returnType="Builders.WelcomeScreenBuilder" isMethod />
Adds a channel object to the guilds Welcome Screen
### toPayloadObject

> <LuaDeclaration name="toPayloadObject" className="WelcomeScreenBuilder" args={[ ]} returnType="Network.Resolvable" isMethod />
Converts the message to a JSON object that can be sent to the Discord API.

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

## Functions

### new

> <LuaDeclaration name="new" className="WelcomeScreenBuilder" args={[ ]} />
Creates a new instance of WelcomeScreenBuilder.

12 changes: 12 additions & 0 deletions src/content/docs/classes/DiscordLuau.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,18 @@ A Discord API wrapper written in Luau, expected to run under the Lune runtime.
### TextInputBuilder

<LuaProperty name="DiscordLuau.TextInputBuilder" type="Builders.Interface.TextInputBuilder" />
### OnboardingBuilder

<LuaProperty name="DiscordLuau.OnboardingBuilder" type="Builders.OnboardingBuilder" />
### OnboardingPromptBuilder

<LuaProperty name="DiscordLuau.OnboardingPromptBuilder" type="Builders.OnboardingPromptBuilder" />
### OnboardingPromptOptionBuilder

<LuaProperty name="DiscordLuau.OnboardingPromptOptionBuilder" type="Builders.OnboardingPromptOptionBuilder" />
### WelcomeScreenBuilder

<LuaProperty name="DiscordLuau.WelcomeScreenBuilder" type="Builders.WelcomeScreenBuilder" />
### MessageBuilder

<LuaProperty name="DiscordLuau.MessageBuilder" type="Builders.MessageBuilder" />
Expand Down
Loading

0 comments on commit 14c9aa3

Please sign in to comment.