mirror of
https://github.com/Myxelium/Lunaris2.0.git
synced 2026-04-13 16:10:36 +00:00
Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 56eee11fc9 | |||
| e01746a343 |
@@ -136,4 +136,104 @@ sequenceDiagram
|
|||||||
end
|
end
|
||||||
```
|
```
|
||||||
|
|
||||||
This README provides an overview of the handlers and their responsibilities, along with class and sequence diagrams to illustrate the interactions and relationships between the components.
|
## Extensions.cs
|
||||||
|
|
||||||
|
#### Namespaces
|
||||||
|
- **Discord**: Provides classes for interacting with Discord.
|
||||||
|
- **Discord.WebSocket**: Provides WebSocket-specific classes for Discord.
|
||||||
|
- **Lavalink4NET**: Provides classes for interacting with Lavalink.
|
||||||
|
- **Lavalink4NET.Players**: Provides player-related classes for Lavalink.
|
||||||
|
- **Lavalink4NET.Players.Queued**: Provides queued player-related classes for Lavalink.
|
||||||
|
- **Microsoft.Extensions.Options**: Provides classes for handling options and configurations.
|
||||||
|
|
||||||
|
#### Class: `Extensions`
|
||||||
|
This static class contains extension methods for various Discord and Lavalink operations.
|
||||||
|
|
||||||
|
##### Method: `GetPlayerAsync`
|
||||||
|
- **Parameters**:
|
||||||
|
- `IAudioService audioService`: The audio service to retrieve the player from.
|
||||||
|
- `DiscordSocketClient client`: The Discord client.
|
||||||
|
- `SocketSlashCommand context`: The context of the slash command.
|
||||||
|
- `bool connectToVoiceChannel`: Whether to connect to the voice channel (default is true).
|
||||||
|
- **Returns**: `ValueTask<QueuedLavalinkPlayer?>`
|
||||||
|
- **Description**: Retrieves a `QueuedLavalinkPlayer` for the given context. If the retrieval fails, it returns null and sends an appropriate error message.
|
||||||
|
|
||||||
|
##### Method: `GetGuild`
|
||||||
|
- **Parameters**:
|
||||||
|
- `SocketSlashCommand message`: The slash command message.
|
||||||
|
- `DiscordSocketClient client`: The Discord client.
|
||||||
|
- **Returns**: `SocketGuild`
|
||||||
|
- **Description**: Retrieves the guild associated with the given slash command message. Throws an exception if the guild ID is null.
|
||||||
|
|
||||||
|
##### Method: `GetVoiceState`
|
||||||
|
- **Parameters**:
|
||||||
|
- `SocketSlashCommand message`: The slash command message.
|
||||||
|
- **Returns**: `IVoiceState`
|
||||||
|
- **Description**: Retrieves the voice state of the user who issued the slash command. Throws an exception if the user is not connected to a voice channel.
|
||||||
|
|
||||||
|
##### Method: `RespondAsync`
|
||||||
|
- **Parameters**:
|
||||||
|
- `SocketSlashCommand message`: The slash command message.
|
||||||
|
- `string content`: The content of the response.
|
||||||
|
- **Returns**: `Task`
|
||||||
|
- **Description**: Sends an ephemeral response to the slash command.
|
||||||
|
|
||||||
|
##### Method: `GetOptionValueByName`
|
||||||
|
- **Parameters**:
|
||||||
|
- `SocketSlashCommand command`: The slash command.
|
||||||
|
- `string optionName`: The name of the option to retrieve the value for.
|
||||||
|
- **Returns**: `string`
|
||||||
|
- **Description**: Retrieves the value of the specified option from the slash command. Returns an empty string if the option is not found.
|
||||||
|
|
||||||
|
# MessageModule
|
||||||
|
|
||||||
|
The `MessageModule` class provides utility methods for sending and removing messages in a Discord guild using the Discord.Net library. It maintains a dictionary to keep track of message IDs for each guild, allowing for easy removal of messages when needed.
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### `SendMessageAsync(SocketSlashCommand context, string message, DiscordSocketClient client)`
|
||||||
|
|
||||||
|
Sends a follow-up message with the specified text content in response to a slash command.
|
||||||
|
|
||||||
|
- **Parameters:**
|
||||||
|
- `context`: The `SocketSlashCommand` context in which the command was executed.
|
||||||
|
- `message`: The text content of the message to be sent.
|
||||||
|
- `client`: The `DiscordSocketClient` instance.
|
||||||
|
|
||||||
|
### `SendMessageAsync(SocketSlashCommand context, Embed message, DiscordSocketClient client)`
|
||||||
|
|
||||||
|
Sends a follow-up message with the specified embed content in response to a slash command.
|
||||||
|
|
||||||
|
- **Parameters:**
|
||||||
|
- `context`: The `SocketSlashCommand` context in which the command was executed.
|
||||||
|
- `message`: The `Embed` content of the message to be sent.
|
||||||
|
- `client`: The `DiscordSocketClient` instance.
|
||||||
|
|
||||||
|
### `RemoveMessages(SocketSlashCommand context, DiscordSocketClient client)`
|
||||||
|
|
||||||
|
Removes all tracked messages for the guild in which the command was executed.
|
||||||
|
|
||||||
|
- **Parameters:**
|
||||||
|
- `context`: The `SocketSlashCommand` context in which the command was executed.
|
||||||
|
- `client`: The `DiscordSocketClient` instance.
|
||||||
|
|
||||||
|
### `StoreForRemoval(SocketSlashCommand context, DiscordSocketClient client)`
|
||||||
|
|
||||||
|
Stores the message ID for removal and deletes any previously tracked messages for the guild.
|
||||||
|
|
||||||
|
- **Parameters:**
|
||||||
|
- `context`: The `SocketSlashCommand` context in which the command was executed.
|
||||||
|
- `client`: The `DiscordSocketClient` instance.
|
||||||
|
|
||||||
|
- **Returns:**
|
||||||
|
- The guild ID as a `ulong`.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
To use the `MessageModule` class, simply call the appropriate method from your command handling logic. For example:
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
await context.SendMessageAsync("Hello, world!", client);
|
||||||
|
```
|
||||||
|
|
||||||
|
This will send a follow-up message with the text "Hello, world!" in response to the slash command.
|
||||||
|
|||||||
Reference in New Issue
Block a user