-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update refs for DiscordLuau/discord-luau@e89e4bf
- Loading branch information
1 parent
01c8ef0
commit 8689606
Showing
7 changed files
with
186 additions
and
4 deletions.
There are no files selected for viewing
Submodule discord-luau
updated
10 files
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
--- | ||
title: MemberBuilder | ||
description: DiscordLuau docs for MemberBuilder. | ||
--- | ||
[//]: # (This file was automatically compiled through the Generator luau code under this repository) | ||
[//]: # (if you want to edit the documentation of discord-luau, please write changes) | ||
[//]: # (to the discord-luau repository itself, we extract the comments from discord-luau and translate) | ||
[//]: # (them into markdown files that Nextra can interpret!) | ||
|
||
[//]: # (----- DOCUMENT IMPORTS ----- ) | ||
|
||
import LuaDeclaration from '$/components/LuaDeclaration.astro'; | ||
import LuaProperty from '$/components/LuaProperty.astro'; | ||
|
||
[//]: # (----- DOCUMENT DESCRIPTION ----- ) | ||
|
||
MemberBuilder is used to update a member object for a guild, | ||
|
||
Usage: | ||
```lua | ||
local member = MemberBuilder.new() | ||
:setNickname("Discordian #0!") | ||
``` | ||
|
||
[//]: # (----- DOCUMENT PROPERTIES ----- ) | ||
|
||
## Properties | ||
|
||
The MemberBuilder instance has no set properties! | ||
|
||
[//]: # (----- DOCUMENT METHODS ----- ) | ||
|
||
## Methods | ||
|
||
### setNickname | ||
|
||
> <LuaDeclaration name="setNickname" className="MemberBuilder" args={[ { name: "nickname", type: "string" } ]} returnType="Builders.MemberBuilder" isMethod /> | ||
Sets the nickname of a discord member | ||
### addRole | ||
|
||
> <LuaDeclaration name="addRole" className="MemberBuilder" args={[ { name: "roleId", type: "string" } ]} returnType="Builders.MemberBuilder" isMethod /> | ||
Adds a role to a member | ||
### setMuted | ||
|
||
> <LuaDeclaration name="setMuted" className="MemberBuilder" args={[ { name: "muted", type: "boolean" } ]} returnType="Builders.MemberBuilder" isMethod /> | ||
Sets the muted state for this member | ||
### setDeafened | ||
|
||
> <LuaDeclaration name="setDeafened" className="MemberBuilder" args={[ { name: "deafened", type: "boolean" } ]} returnType="Builders.MemberBuilder" isMethod /> | ||
Sets the deafened state for this member | ||
### setActiveVoiceChannel | ||
|
||
> <LuaDeclaration name="setActiveVoiceChannel" className="MemberBuilder" args={[ { name: "voiceChannelId", type: "string" } ]} returnType="Builders.MemberBuilder" isMethod /> | ||
Allows you to specify the voice channel to move the member too. | ||
### setTimeoutFor | ||
|
||
> <LuaDeclaration name="setTimeoutFor" className="MemberBuilder" args={[ { name: "epoch", type: "number" } ]} returnType="Builders.MemberBuilder" isMethod /> | ||
Allows you to timeout a members communication. | ||
### setFlags | ||
|
||
> <LuaDeclaration name="setFlags" className="MemberBuilder" args={[ { name: "flags", type: "number" } ]} returnType="Builders.MemberBuilder" isMethod /> | ||
Sets the bitflags for this Member | ||
### toPayloadObject | ||
|
||
> <LuaDeclaration name="toPayloadObject" className="MemberBuilder" args={[ ]} returnType="Network.Resolvable" isMethod /> | ||
Converts the member to a JSON object that can be sent to the Discord API. | ||
|
||
[//]: # (----- DOCUMENT FUNCTIONS ----- ) | ||
|
||
## Functions | ||
|
||
### new | ||
|
||
> <LuaDeclaration name="new" className="MemberBuilder" args={[ ]} /> | ||
Creates a new instance of MemberBuilder. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
--- | ||
title: DiscordSticker | ||
description: DiscordLuau docs for DiscordSticker. | ||
--- | ||
[//]: # (This file was automatically compiled through the Generator luau code under this repository) | ||
[//]: # (if you want to edit the documentation of discord-luau, please write changes) | ||
[//]: # (to the discord-luau repository itself, we extract the comments from discord-luau and translate) | ||
[//]: # (them into markdown files that Nextra can interpret!) | ||
|
||
[//]: # (----- DOCUMENT IMPORTS ----- ) | ||
|
||
import LuaDeclaration from '$/components/LuaDeclaration.astro'; | ||
import LuaProperty from '$/components/LuaProperty.astro'; | ||
|
||
[//]: # (----- DOCUMENT DESCRIPTION ----- ) | ||
|
||
The `DiscordSticker` class represents a Discord sticker and provides a structure for sticker data. | ||
|
||
[//]: # (----- DOCUMENT PROPERTIES ----- ) | ||
|
||
## Properties | ||
|
||
### type | ||
|
||
<LuaProperty name="DiscordSticker.type" type="string" /> | ||
--- | ||
The type of the DiscordSticker. Default is "DiscordSticker". | ||
|
||
[//]: # (----- DOCUMENT METHODS ----- ) | ||
|
||
## Methods | ||
|
||
The DiscordSticker instance has no set methods! | ||
|
||
[//]: # (----- DOCUMENT FUNCTIONS ----- ) | ||
|
||
## Functions | ||
|
||
### new | ||
|
||
> <LuaDeclaration name="new" className="DiscordSticker" args={[ { name: "discordClient", type: "any" }, { name: "emojiData", type: "table" } ]} /> | ||
Creates a new DiscordSticker instance. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
--- | ||
title: GuildPreview | ||
description: DiscordLuau docs for GuildPreview. | ||
--- | ||
[//]: # (This file was automatically compiled through the Generator luau code under this repository) | ||
[//]: # (if you want to edit the documentation of discord-luau, please write changes) | ||
[//]: # (to the discord-luau repository itself, we extract the comments from discord-luau and translate) | ||
[//]: # (them into markdown files that Nextra can interpret!) | ||
|
||
[//]: # (----- DOCUMENT IMPORTS ----- ) | ||
|
||
import LuaDeclaration from '$/components/LuaDeclaration.astro'; | ||
import LuaProperty from '$/components/LuaProperty.astro'; | ||
|
||
[//]: # (----- DOCUMENT DESCRIPTION ----- ) | ||
|
||
GuildPreview represents a user on Discord, encapsulating user data such as username, avatar, and various flags. | ||
|
||
[//]: # (----- DOCUMENT PROPERTIES ----- ) | ||
|
||
## Properties | ||
|
||
The GuildPreview instance has no set properties! | ||
|
||
[//]: # (----- DOCUMENT METHODS ----- ) | ||
|
||
## Methods | ||
|
||
The GuildPreview instance has no set methods! | ||
|
||
[//]: # (----- DOCUMENT FUNCTIONS ----- ) | ||
|
||
## Functions | ||
|
||
### new | ||
|
||
> <LuaDeclaration name="new" className="GuildPreview" args={[ { name: "discordClient", type: "any" }, { name: "guildPreview", type: "{ ... }" } ]} /> | ||
Creates a new instance of GuildPreview. | ||
|