Skip to content

Commit 833acf3

Browse files
atlasfyberatlasfyber
authored
6.10 update changes (#236)
Co-authored-by: atlasfyber <[email protected]>
1 parent 7ad75a6 commit 833acf3

12 files changed

+296
-61
lines changed

‎src/content/docs/functions/allApplicationCommands.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: $allApplicationCommands
3+
description: $allApplicationCommands will return all slash command names registered in the bot's application.
4+
id: allApplicationCommands
5+
---
6+
7+
`$allApplicationCommands` will return all slash command names registered in the bot's application.
8+
9+
## Usage
10+
11+
```aoi
12+
$allApplicationCommands[sep?]
13+
```
14+
15+
## Parameters
16+
17+
| Field | Type | Description | Required |
18+
| --------- | --------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | :------: |
19+
| sep? | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Separator used between command names. Default is `,`. | false |
20+
21+
## Example(s)
22+
23+
This will return all slash commands separated by a comma and a space:
24+
25+
```javascript
26+
client.command({
27+
name: "allApplicationCommands",
28+
code: `
29+
$allApplicationCommands[, ]
30+
`
31+
});
32+
```

‎src/content/docs/functions/attachment.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,17 @@ id: attachment
99
## Usage
1010

1111
```aoi
12-
$attachment[attachment;name;type?]
12+
$attachment[attachment;name;type?;encoding?]
1313
```
1414

1515
## Parameters
1616

17-
| Field | Type | Description | Required |
18-
| ---------- | ------------------------------------------------------------------------------------------------- | -------------------------------------------- | :------: |
19-
| attachment | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Content of the attachment, preferably a URL. | true |
20-
| name | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Attachment name. | true |
21-
| type? | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Attachment type. <br /> 1. **URL** (default) | false |
17+
| Field | Type | Description | Required |
18+
| ---------- | ------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | :------: |
19+
| attachment | string (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Content of the attachment, preferably a URL. | true |
20+
| name | string (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Attachment name. | true |
21+
| type? | string (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Attachment type. 1. **URL** (default) | false |
22+
| encoding? | string (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Encoding to use if type is `buffer` (e.g., "utf-8", "base64"). | false |
2223

2324
## Example(s)
2425

‎src/content/docs/functions/clientPrefixes.md‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,25 @@ id: clientPrefixes
99
## Usage
1010

1111
```aoi
12-
$clientPrefixes
12+
$clientPrefixes[sep?]
1313
```
1414

15+
## Parameters
16+
17+
| Field | Type | Description | Required |
18+
| --------- | --------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | :------: |
19+
| sep? | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Separator used between prefixes. Default is `,`. | false |
20+
21+
1522
## Example(s)
1623

17-
This will return all your prefixes separated by a comma (`,`):
24+
This will return all your prefix(es) separated by a comma and a space:
1825

1926
```javascript
2027
client.command({
2128
name: "clientPrefixes",
2229
code: `
23-
$clientPrefixes
30+
$clientPrefixes[, ]
2431
`
2532
});
2633
```

‎src/content/docs/functions/cloneEmbed.md‎

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,44 @@ id: cloneEmbed
88

99
## Usage
1010

11-
```aoi
12-
$cloneEmbed[index;messageID;channelID?]
11+
```aoi
12+
$cloneEmbed[index;messageID;channelID?;returnJSON?]
1313
```
1414

1515
## Parameters
1616

17-
| Field | Type | Description | Required |
18-
| ---------- | --------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | :------: |
19-
| index | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | The index of the embed which you want to clone. <br /> 1. **all** <br /> 2. **number** | true |
20-
| messageID | [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | The ID of the embed message that will be cloned. | true |
21-
| channelID? | [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | The ID of the channel that you sent the embed message. | false |
22-
17+
| Field | Type | Description | Required |
18+
|-------------|-----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|:--------:|
19+
| index | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | The index of the embed to clone. <br /> 1. **all** <br /> 2. **number** | true |
20+
| messageID | [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | The ID of the message containing the embed to be cloned. | true |
21+
| channelID? | [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | The ID of the channel where the message is located. Defaults to the current channel. | false |
22+
| returnJSON? | [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) | Whether to return the embed(s) as raw JSON instead of attaching them. | false |
2323

2424
## Example(s)
2525

2626
This will clone the previous embed and edit the title after 15 seconds:
2727

28-
```javascript
29-
client.command({
30-
name: "cloneEmbed",
31-
code: `
32-
$title[Bye!]
33-
$cloneEmbed[all;$get[messageID];$channelID]
34-
35-
$wait[15s]
36-
$let[messageID;$sendMessage[{newEmbed: {title:Hello!} {description:I'll edit this message in 15 seconds.}};true]]
37-
`
38-
});
39-
```
28+
```javascript
29+
client.command({
30+
name: "cloneEmbed",
31+
code: `
32+
$title[Bye!]
33+
$cloneEmbed[all;$get[messageID];$channelID]
34+
35+
$wait[15s]
36+
$let[messageID;$sendMessage[{newEmbed: {title:Hello!} {description:I'll edit this message in 15 seconds.}};true]]
37+
`
38+
});
39+
```
40+
41+
This will return the cloned embed as raw JSON instead of displaying it:
42+
43+
```javascript
44+
client.command({
45+
name: "cloneEmbed",
46+
code: `
47+
$cloneEmbed[all;$get[messageID];$channelID;true]
48+
$let[messageID;$sendMessage[{newEmbed: {title:Data Collected} {description:Storing raw embed JSON.}};true]]
49+
`
50+
});
51+
```

‎src/content/docs/functions/getAttachments.md‎

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,19 @@ id: getAttachments
88

99
## Usage
1010

11-
```aoi
12-
$getAttachments[channelID;messageID;index?;option?]
11+
```aoi
12+
$getAttachments[channelID;messageID;index?;option?;sep?]
1313
```
1414

1515
## Parameters
1616

17-
| Field | Type | Description | Required |
18-
| --------- | ------------------------------------------------------------------------------------------------- | ----------------------------------------------- | :------: |
19-
| channelID | [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | The channel of where the message is present in. | true |
20-
| messageID | [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | The message ID. | true |
21-
| index? | [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | Attachment index. | false |
22-
| option? | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | The option to retrieve. | false |
17+
| Field | Type | Description | Required |
18+
| --------- | --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | :------: |
19+
| channelID | [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | The channel of where the message is present in. | true |
20+
| messageID | [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | The message ID. | true |
21+
| index? | [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | Attachment index. | false |
22+
| option? | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | The option to retrieve. | false |
23+
| sep? | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Separator used to join multiple values. Defaults to `", "`. | false |
2324

2425
### Options
2526

@@ -41,11 +42,11 @@ $getAttachments[channelID;messageID;index?;option?]
4142

4243
This will return the name of the first attachment from the message that executed the command:
4344

44-
```javascript
45-
client.command({
46-
name: "getAttachments",
47-
code: `
48-
$getAttachments[$channelID;$messageID;1;name]
49-
`
50-
});
51-
```
45+
```javascript
46+
client.command({
47+
name: "getAttachments",
48+
code: `
49+
$getAttachments[$channelID;$messageID;1;name]
50+
`
51+
});
52+
```

‎src/content/docs/functions/getMessageReactions.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: $getMessageReactions
3+
description: $getMessageReactions returns a list of reactions from a specified message in a channel.
4+
id: getMessageReactions
5+
---
6+
7+
`$getMessageReactions` returns a list of reactions (emojis) on a specified message from a specific channel.
8+
9+
## Usage
10+
11+
```aoi
12+
$getMessageReactions[channelID?;messageID;type?;sep?]
13+
```
14+
15+
## Parameters
16+
17+
| Field | Type | Description | Required |
18+
|------------|---------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|:--------:|
19+
| channelID? | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | The ID of the channel where the message is located. Defaults to the current channel if not provided. | false |
20+
| messageID | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | The ID of the message to get reactions from. | true |
21+
| type? | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | The type of data to return: <br /> 1. **emoji** (default) – emoji format <br /> 2. **name** <br /> 3. **id** | false |
22+
| sep? | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Separator to separate multiple returned values. Default is `, `. | false |
23+
24+
## Example(s)
25+
26+
This command returns the list of emoji reactions (formatted) on a specific message:
27+
28+
```javascript
29+
client.command({
30+
name: "getMessageReactions",
31+
code: `
32+
$getMessageReactions[$channelID;112233445566778899;emoji;, ] $comment[Example message ID provided.]
33+
`
34+
});
35+
```
36+
37+
This command returns only the names of the emoji reactions:
38+
39+
```javascript
40+
client.command({
41+
name: "getMessageReactions",
42+
code: `
43+
$getMessageReactions[$channelID;112233445566778899;name] $comment[Example message ID provided.]
44+
`
45+
});
46+
```

‎src/content/docs/functions/globalUserLeaderBoard.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ $globalUserLeaderBoard[variable;type?;custom?;list?;page?;table?]
2727
| ---------------- | ------------------------------------------------------------------------------------------------- | --------------------------------------- |
2828
| **\{top\}** | [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | Returns the position of the user. |
2929
| **\{username\}** | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Returns the username. |
30+
| **\{nickname\}** | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Returns the nickname. |
3031
| **\{tag}** | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Returns the username and discriminator. |
3132
| **\{id\}** | [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | Returns the user ID. |
3233
| **\{value\}** | [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | Returns the variable value. |

‎src/content/docs/functions/guildRoles.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ id: guildRoles
88

99
## Usage
1010

11-
```aoi
12-
$guildRoles[guildID?;type?;sep?;removeManagedRoles?;fetch?]
11+
```aoi
12+
$guildRoles[guildID?;type?;sep?;removeManagedRoles?;removeBotRoles?;fetch?]
1313
```
1414

1515
## Parameters
@@ -20,17 +20,18 @@ $guildRoles[guildID?;type?;sep?;removeManagedRoles?;fetch?]
2020
| type? | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | The option on how to return the roles <br /> 1. **name** (default) <br /> 2. **id** <br /> 3. **mention** | false |
2121
| sep? | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Separator to separate multiple returned values. | false |
2222
| removeManagedRoles? | [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) | Remove Managed Roles from the result. | false |
23+
| removeBotRoles? | [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) | Remove roles associated with bots from the result. | false |
2324
| fetch? | [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) | Fetch all roles of the guild. | false |
2425

2526
## Example(s)
2627

27-
This will return all roles of your guild:
28+
This will return all roles of your guild by name, separated by commas, excluding managed and bot roles:
2829

2930
```javascript
3031
client.command({
3132
name: "guildRoles",
3233
code: `
33-
$description[$guildRoles[$guildID;name;, ]]
34+
$guildRoles[$guildID;name;, ;true;true]
3435
`
3536
});
3637
```

‎src/content/docs/functions/guildVanityURL.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,25 @@ id: guildVanityURL
99
## Usage
1010

1111
```aoi
12-
$guildVanityURL[guildID?]
12+
$guildVanityURL[guildID?;fetchFirst?]
1313
```
1414

1515
## Parameters
1616

17-
| Field | Type | Description | Required |
18-
| -------- | ------------------------------------------------------------------------------------------------- | ------------- | :------: |
19-
| guildID? | [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | The guild ID. | false |
17+
| Field | Type | Description | Required |
18+
| ---------- | --------------------------------------------------------------------------------------------------- | ------------------------------------------------- | :------: |
19+
| guildID? | [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | The guild ID. | false |
20+
| fetchFirst?| [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) | Whether to fetch fresh vanity URL data from API. | false |
2021

2122
## Example(s)
2223

23-
This will return the vanity URL of your guild, if you have one:
24+
This will return the vanity URL of your guild, fetching fresh data:
2425

2526
```javascript
2627
client.command({
2728
name: "guildVanityURL",
2829
code: `
29-
$guildVanityURL[$guildID]
30+
$guildVanityURL[$guildID;true]
3031
`
3132
});
3233
```

‎src/content/docs/functions/guildVanityUses.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,25 @@ id: guildVanityUses
99
## Usage
1010

1111
```aoi
12-
$guildVanityUses[guildID?]
12+
$guildVanityUses[guildID?;fetchFirst?]
1313
```
1414

1515
## Parameters
1616

17-
| Field | Type | Description | Required |
18-
| -------- | ------------------------------------------------------------------------------------------------- | ------------- | :------: |
19-
| guildID? | [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | The guild ID. | false |
17+
| Field | Type | Description | Required |
18+
| ---------- | --------------------------------------------------------------------------------------------------- | ------------------------------------------------- | :------: |
19+
| guildID? | [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | The guild ID. | false |
20+
| fetchFirst?| [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) | Whether to fetch fresh vanity URL data from API. | false |
2021

2122
## Example(s)
2223

23-
This will return the uses of your guild's vanity URL, if you have one:
24+
This will return the uses of your guild's vanity URL, fetching fresh data:
2425

2526
```javascript
2627
client.command({
2728
name: "guildVanityUses",
2829
code: `
29-
$guildVanityUses[$guildID]
30+
$guildVanityUses[$guildID;true]
3031
`
3132
});
3233
```

0 commit comments

Comments
 (0)