Skip to content

Commit

Permalink
Merge pull request #11 from dassjosh/develop
Browse files Browse the repository at this point in the history
3.1.0
  • Loading branch information
dassjosh authored Oct 21, 2024
2 parents 1a022c2 + eae23fe commit 556f72b
Show file tree
Hide file tree
Showing 893 changed files with 55,768 additions and 51,212 deletions.
51 changes: 39 additions & 12 deletions Docs/Generated/Oxide.Ext.Discord.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ public ApplicationCommandOptionBuilder AutoComplete(bool autoComplete = true)

| parameter | description |
| --- | --- |
| autoComplete | If the option support auto complete (Default: true) |
| autoComplete | If the option supports auto complete (Default: true) |

## Return Value

Expand Down Expand Up @@ -366,7 +366,7 @@ This

| exception | condition |
| --- | --- |
| Exception | Thrown if option type is not double |
| Exception | Thrown if the option type is not double |

## See Also

Expand Down Expand Up @@ -399,7 +399,7 @@ This

| exception | condition |
| --- | --- |
| Exception | Thrown if option type is not int |
| Exception | Thrown if the option type is not int |

## See Also

Expand Down Expand Up @@ -432,7 +432,7 @@ This

| exception | condition |
| --- | --- |
| Exception | Thrown if option type is not string |
| Exception | Thrown if the option type is not string |

## See Also

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@ Adds an attachment to the message

```csharp
public virtual TBuilder AddAttachment(string filename, byte[] data, string contentType,
string description = null)
string description = null, string title = null)
```

| parameter | description |
Expand All @@ -294,6 +294,7 @@ public virtual TBuilder AddAttachment(string filename, byte[] data, string conte
| data | byte[] of the attachment |
| contentType | Attachment content type |
| description | Description for the attachment |
| title | Title of the attachment |

## See Also

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
| class [MessageComponentBuilder](./MessageComponentBuilder.md) | Builder for Message Components |
| [Flags] enum [PlayerDisplayNameMode](./PlayerDisplayNameMode.md) | Player Name Formatting options for [`PlayerNameFormatter`](./Oxide.Ext.Discord/Builders/PlayerNameFormatter.md) |
| class [PlayerNameFormatter](./PlayerNameFormatter.md) | Formatter for player names |
| class [QueryStringBuilder](./QueryStringBuilder.md) | Builder used to build query strings for urls |
| struct [QueryStringBuilder](./QueryStringBuilder.md) | Builder used to build query strings for urls |
| class [SelectMenuComponentBuilder](./SelectMenuComponentBuilder.md) | Builder for Select Menus |
| class [WebhookMessageBuilder](./WebhookMessageBuilder.md) | Represents a builder for [`WebhookMessageBuilder`](./Oxide.Ext.Discord/Builders/WebhookMessageBuilder.md) |

Expand Down
36 changes: 18 additions & 18 deletions Docs/Generated/Oxide.Ext.Discord/Builders/DiscordEmbedBuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ public class DiscordEmbedBuilder
| [DiscordEmbedBuilder](#discordembedbuilder-constructor)() | Constructor for the builder creating a new embed |
| [DiscordEmbedBuilder](#discordembedbuilder-constructor)(…) | Constructor for the builder using an existing embed |
| [AddAuthor](#addauthor-method)(…) | Adds an author to the embed message. The author will appear above the title |
| [AddBlankField](#addblankfield-method)(…) | Adds a blank field. If inline it will add a blank column. If not inline will add a blank row |
| [AddBlankField](#addblankfield-method)(…) | Adds a blank field. If inline, it will add a blank column. If not, inline will add a blank row |
| [AddColor](#addcolor-method-1-of-7)(…) | Adds a Discord Color to the embed (7 methods) |
| [AddDescription](#adddescription-method)(…) | Adds a description to the embed message |
| [AddField](#addfield-method)(…) | Adds a new field with the name as the title and value as the value. If inline will add a new column. If row will add in a new row. |
| [AddField](#addfield-method)(…) | Adds a new field with the name as the title and value as the value. If inline add a new column. If row adds in a new row. |
| [AddFooter](#addfooter-method)(…) | Adds a footer to the embed message |
| [AddImage](#addimage-method)(…) | Adds an image to the embed. The url should point to the url of the image. If using attachment image you can make the url: "attachment://{image name}.{image extension} |
| [AddImage](#addimage-method)(…) | Adds an image to the embed. The url should point to the url of the image. If using attachment image, you can make the url: "attachment://{image name}.{image extension} |
| [AddNowTimestamp](#addnowtimestamp-method)() | Adds a timestamp to an embed with the current time |
| [AddProvider](#addprovider-method)(…) | Adds a provider to the embed |
| [AddThumbnail](#addthumbnail-method)(…) | Adds a thumbnail in the top right corner of the embed If using attachment image you can make the url: "attachment://{image name}.{image extension} |
| [AddThumbnail](#addthumbnail-method)(…) | Adds a thumbnail in the top right corner of the embed, If using attachment image, you can make the url: "attachment://{image name}.{image extension} |
| [AddTimestamp](#addtimestamp-method)(…) | Adds a timestamp to an embed with the given time |
| [AddTitle](#addtitle-method)(…) | Adds a title to the embed message |
| [AddUrl](#addurl-method)(…) | Adds a url to the embed message |
Expand Down Expand Up @@ -117,7 +117,7 @@ public DiscordEmbedBuilder AddAuthor(string name, string url = null, string icon
| parameter | description |
| --- | --- |
| name | Name of the author |
| url | Url to go to when the authors name is clicked on |
| url | Url to go to when the author's name is clicked on |
| iconUrl | Icon Url to use for the author |
| proxyIconUrl | Backup icon url. Can be left null if you only have one icon url |

Expand Down Expand Up @@ -272,9 +272,9 @@ public DiscordEmbedBuilder AddColor(double red, double green, double blue)

| parameter | description |
| --- | --- |
| red | Red value between 0 - 1 |
| green | Green value between 0 - 1 |
| blue | Blue value between 0 - 1 |
| red | Red value between 0-1 |
| green | Green value between 0-1 |
| blue | Blue value between 0-1 |

## Return Value

Expand Down Expand Up @@ -304,9 +304,9 @@ public DiscordEmbedBuilder AddColor(float red, float green, float blue)

| parameter | description |
| --- | --- |
| red | Red value between 0 - 1 |
| green | Green value between 0 - 1 |
| blue | Blue value between 0 - 1 |
| red | Red value between 0-1 |
| green | Green value between 0-1 |
| blue | Blue value between 0-1 |

## Return Value

Expand Down Expand Up @@ -336,9 +336,9 @@ public DiscordEmbedBuilder AddColor(int red, int green, int blue)

| parameter | description |
| --- | --- |
| red | Red value between 0 - 255 |
| green | Green value between 0 - 255 |
| blue | Blue value between 0 - 255 |
| red | Red value between 0-255 |
| green | Green value between 0-255 |
| blue | Blue value between 0-255 |

## Return Value

Expand Down Expand Up @@ -401,7 +401,7 @@ This

# AddBlankField method

Adds a blank field. If inline it will add a blank column. If not inline will add a blank row
Adds a blank field. If inline, it will add a blank column. If not, inline will add a blank row

```csharp
public DiscordEmbedBuilder AddBlankField(bool inline)
Expand All @@ -424,7 +424,7 @@ This

# AddField method

Adds a new field with the name as the title and value as the value. If inline will add a new column. If row will add in a new row.
Adds a new field with the name as the title and value as the value. If inline add a new column. If row adds in a new row.

```csharp
public DiscordEmbedBuilder AddField(string name, string value, bool inline)
Expand All @@ -449,7 +449,7 @@ This

# AddImage method

Adds an image to the embed. The url should point to the url of the image. If using attachment image you can make the url: "attachment://{image name}.{image extension}
Adds an image to the embed. The url should point to the url of the image. If using attachment image, you can make the url: "attachment://{image name}.{image extension}
```csharp
public DiscordEmbedBuilder AddImage(string url, int? width = null, int? height = null,
Expand All @@ -476,7 +476,7 @@ This

# AddThumbnail method

Adds a thumbnail in the top right corner of the embed If using attachment image you can make the url: "attachment://{image name}.{image extension}
Adds a thumbnail in the top right corner of the embed, If using attachment image, you can make the url: "attachment://{image name}.{image extension}
```csharp
public DiscordEmbedBuilder AddThumbnail(string url, int? width = null, int? height = null,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ public class DiscordMessageBuilder : BaseChannelMessageBuilder<MessageCreate, Di
| name | description |
| --- | --- |
| [DiscordMessageBuilder](#discordmessagebuilder-constructor)() | Constructor creating a new message |
| [DiscordMessageBuilder](#discordmessagebuilder-constructor)(…) | Constructor to use existing message |
| [DiscordMessageBuilder](#discordmessagebuilder-constructor)(…) | Constructor to use an existing message |

## See Also

Expand Down Expand Up @@ -40,7 +40,7 @@ public DiscordMessageBuilder()

# DiscordMessageBuilder constructor (2 of 2)

Constructor to use existing message
Constructor to use an existing message

```csharp
public DiscordMessageBuilder(MessageCreate message)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public class InteractionAutoCompleteBuilder
| [Count](#count-property) { get; } | Number of added choices |
| [AddAllOnlineFirstPlayers](#addallonlinefirstplayers-method)(…) | Adds Online Players to the list first If there is still space add Offline Players |
| [AddAllPlayers](#addallplayers-method)(…) | Adds Any Player to the list |
| [AddByPlayerId](#addbyplayerid-method)(…) | Adds a player by player Id to the list |
| [AddByPlayerId](#addbyplayerid-method)(…) | Adds a player by player ID to the list |
| [AddChoice](#addchoice-method-1-of-3)(…) | Adds a [`CommandOptionChoice`](../Entities/CommandOptionChoice.md) to the response (3 methods) |
| [AddChoices](#addchoices-method)(…) | Adds a collection of [`CommandOptionChoice`](../Entities/CommandOptionChoice.md) to the response |
| [AddGroups](#addgroups-method)(…) | Adds Oxide Groups to the AutoComplete |
Expand Down Expand Up @@ -563,7 +563,7 @@ public void AddPlayerList(string filter, IEnumerable<IPlayer> list, PlayerNameFo

# AddByPlayerId method

Adds a player by player Id to the list
Adds a player by player ID to the list

```csharp
public void AddByPlayerId(string playerId, PlayerNameFormatter formatter = null)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public MessageComponentBuilder AddActionButton(ButtonStyle style, string label,

| exception | condition |
| --- | --- |
| Exception | Throw if the button style is link or if the button goes outside the max number of action rows |
| Exception | Throw if the button style is a link or if the button goes outside the max number of action rows |

## See Also

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public class PlayerNameFormatter
| static readonly [All](#all-field) | Include all name options in the player name |
| static readonly [ClanName](#clanname-field) | Include clan name in the player name |
| static readonly [Default](#default-field) | Default Player Name Formatter |
| static readonly [PlayerId](#playerid-field) | Include Player Id in the player name |
| static readonly [PlayerId](#playerid-field) | Include Player ID in the player name |
| static [Create](#create-method)(…) | Create a new Player Name formatter with the given Custom Name Function |
| [Format](#format-method)(…) | Formats the player name |

Expand Down Expand Up @@ -102,7 +102,7 @@ public static readonly PlayerNameFormatter ClanName;

# PlayerId field

Include Player Id in the player name
Include Player ID in the player name

```csharp
public static readonly PlayerNameFormatter PlayerId;
Expand Down
84 changes: 7 additions & 77 deletions Docs/Generated/Oxide.Ext.Discord/Builders/QueryStringBuilder.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,28 @@
# QueryStringBuilder class
# QueryStringBuilder structure

Builder used to build query strings for urls

```csharp
public class QueryStringBuilder : BasePoolable
[Obsolete("Types with embedded references are not supported in this version of your compiler.")]
public struct QueryStringBuilder
```

## Public Members

| name | description |
| --- | --- |
| [QueryStringBuilder](#querystringbuilder-constructor)() | The default constructor. |
| static [Create](#create-method)(…) | Creates a pooled [`QueryStringBuilder`](./QueryStringBuilder.md) |
| [Add](#add-method)(…) | Add a key value pair to the query string |
| [AddList&lt;T&gt;](#addlist&amp;lt;t&amp;gt;-method)(…) | Add a list of values with the specified separator |
| override [ToString](#tostring-method)() | Returns the query string as a string. |
| [ToStringAndFree](#tostringandfree-method)() | Returns the query string and returns the builder back to the pool |

## Protected Members

| name | description |
| --- | --- |
| override [EnterPool](#enterpool-method)() | |
| override [LeavePool](#leavepool-method)() | |

## See Also

* class [BasePoolable](../Types/BasePoolable.md)
* namespace [Oxide.Ext.Discord.Builders](./BuildersNamespace.md)
* assembly [Oxide.Ext.Discord](../../Oxide.Ext.Discord.md)
* [QueryStringBuilder.cs](../../../../Oxide.Ext.Discord/Builders/QueryStringBuilder.cs)


# Create method

Creates a pooled [`QueryStringBuilder`](./QueryStringBuilder.md)

```csharp
public static QueryStringBuilder Create(DiscordPluginPool pool)
```

## Return Value

[`QueryStringBuilder`](./QueryStringBuilder.md)

## See Also

* class [DiscordPluginPool](../Types/DiscordPluginPool.md)
* class [QueryStringBuilder](./QueryStringBuilder.md)
* namespace [Oxide.Ext.Discord.Builders](./BuildersNamespace.md)
* assembly [Oxide.Ext.Discord](../../Oxide.Ext.Discord.md)


# Add method

Add a key value pair to the query string
Expand All @@ -67,7 +38,7 @@ public void Add(string key, string value)

## See Also

* class [QueryStringBuilder](./QueryStringBuilder.md)
* struct [QueryStringBuilder](./QueryStringBuilder.md)
* namespace [Oxide.Ext.Discord.Builders](./BuildersNamespace.md)
* assembly [Oxide.Ext.Discord](../../Oxide.Ext.Discord.md)

Expand All @@ -89,7 +60,7 @@ public void AddList<T>(string key, List<T> list, string separator)

## See Also

* class [QueryStringBuilder](./QueryStringBuilder.md)
* struct [QueryStringBuilder](./QueryStringBuilder.md)
* namespace [Oxide.Ext.Discord.Builders](./BuildersNamespace.md)
* assembly [Oxide.Ext.Discord](../../Oxide.Ext.Discord.md)

Expand All @@ -104,48 +75,7 @@ public override string ToString()

## See Also

* class [QueryStringBuilder](./QueryStringBuilder.md)
* namespace [Oxide.Ext.Discord.Builders](./BuildersNamespace.md)
* assembly [Oxide.Ext.Discord](../../Oxide.Ext.Discord.md)


# ToStringAndFree method

Returns the query string and returns the builder back to the pool

```csharp
public string ToStringAndFree()
```

## See Also

* class [QueryStringBuilder](./QueryStringBuilder.md)
* namespace [Oxide.Ext.Discord.Builders](./BuildersNamespace.md)
* assembly [Oxide.Ext.Discord](../../Oxide.Ext.Discord.md)


# EnterPool method

```csharp
protected override void EnterPool()
```

## See Also

* class [QueryStringBuilder](./QueryStringBuilder.md)
* namespace [Oxide.Ext.Discord.Builders](./BuildersNamespace.md)
* assembly [Oxide.Ext.Discord](../../Oxide.Ext.Discord.md)


# LeavePool method

```csharp
protected override void LeavePool()
```

## See Also

* class [QueryStringBuilder](./QueryStringBuilder.md)
* struct [QueryStringBuilder](./QueryStringBuilder.md)
* namespace [Oxide.Ext.Discord.Builders](./BuildersNamespace.md)
* assembly [Oxide.Ext.Discord](../../Oxide.Ext.Discord.md)

Expand All @@ -160,7 +90,7 @@ public QueryStringBuilder()

## See Also

* class [QueryStringBuilder](./QueryStringBuilder.md)
* struct [QueryStringBuilder](./QueryStringBuilder.md)
* namespace [Oxide.Ext.Discord.Builders](./BuildersNamespace.md)
* assembly [Oxide.Ext.Discord](../../Oxide.Ext.Discord.md)

Expand Down
16 changes: 16 additions & 0 deletions Docs/Generated/Oxide.Ext.Discord/Cache/DiscordPluginCache.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ public sealed class DiscordPluginCache : Singleton<DiscordPluginCache>

| name | description |
| --- | --- |
| [GetAllPlugins](#getallplugins-method)() | Returns a list of all plugins in the plugin folder |
| [GetLoadablePlugins](#getloadableplugins-method)() | Returns a list of plugins that can be loaded by oxide Already loaded plugins are excluded from the list |
| [GetLoadedPlugins](#getloadedplugins-method)() | Returns a list of plugins loaded by oxide |

Expand Down Expand Up @@ -46,6 +47,21 @@ public IReadOnlyList<string> GetLoadablePlugins()

## See Also

* class [DiscordPluginCache](./DiscordPluginCache.md)
* namespace [Oxide.Ext.Discord.Cache](./CacheNamespace.md)
* assembly [Oxide.Ext.Discord](../../Oxide.Ext.Discord.md)


# GetAllPlugins method

Returns a list of all plugins in the plugin folder

```csharp
public IReadOnlyList<string> GetAllPlugins()
```

## See Also

* class [DiscordPluginCache](./DiscordPluginCache.md)
* namespace [Oxide.Ext.Discord.Cache](./CacheNamespace.md)
* assembly [Oxide.Ext.Discord](../../Oxide.Ext.Discord.md)
Expand Down
Loading

0 comments on commit 556f72b

Please sign in to comment.