Wiki Update 11 (#338)

* Update banComplex.md * Update banIDComplex.md * Update blackListIDs.md * Update blackListRoles.md * Update blackListRolesIDs.md * Update blackListRolesIDs.md * Update blackListServers.md * Update blackListUsers.md * Update boostCountComplex.md * Update boostCount.md * Update botCommands.md * Update botLeaveComplex.md * Update botListDescription.md * Update c.md * Update calculate.md * Update categoryChannels.md * Update categoryCountComplex.md * Update categoryID.md * Update changeCooldownTime.md * Update changeUsername.md * Update channelExists.md * Update channelIDComplex.md * Update categoryID.md * Update src/bdscript/botLeaveComplex.md Co-authored-by: Bartłomiej Skoczeń <bartek_skoczen@protonmail.com> --------- Co-authored-by: Bartłomiej Skoczeń <bartek_skoczen@protonmail.com>
NilPointer-Software · Jul 23, 2023 · 078008d · 078008d
1 parent bcc9578
commit 078008d
Show file tree

Hide file tree

Showing 21 changed files with 73 additions and 92 deletions.
diff --git a/src/bdscript/banComplex.md b/src/bdscript/banComplex.md
@@ -3,11 +3,11 @@ Bans the mentioned user with a reason.
 
 ## Syntax
 ```
-$ban[reason]
+$ban[Reason]
 ```
 
 ### Parameters
-- `reason` `(Type: String || Flag: Emptiable)`: The reason for this action, which will be saved in the audit-log.
+- `Reason` `(Type: String || Flag: Emptiable)`: The reason for the ban, which will be saved in the audit-log.
 
 ## Example
 ```

diff --git a/src/bdscript/banIDComplex.md b/src/bdscript/banIDComplex.md
@@ -3,13 +3,13 @@ Bans a user using their ID.
 
 ## Syntax
 ```
-$banID[reason;(user ID)]
+$banID[Reason;(User ID)]
 ```
 
 ### Parameters
-- `reason` `(Type: String || Flag: Emptiable)`: The reason for this action, which will be saved in the audit-log.
+- `Reason` `(Type: String || Flag: Emptiable)`: The reason for the ban, which will be saved in the audit-log.
    > Use [`$getBanReason[]`](./getBanReason.md) to get the ban reason.
-- `user ID` `(Type: Snowflake || Flag: Vacantable)`: The user to ban. If empty, the ID will be taken from the last part of the author's message.
+- `User ID` `(Type: Snowflake || Flag: Vacantable)`: The user to ban. If empty, the ID will be taken from the last part of the author's message.
 
 ## Example
 ```

diff --git a/src/bdscript/blackListIDs.md b/src/bdscript/blackListIDs.md
@@ -3,19 +3,18 @@ Blocks certain users from using the command.
 
 ## Syntax
 ```
-$blackListIDs[user IDs;...;error message]
+$blackListIDs[User IDs;...;Error message]
 ```
 
 ### Parameters
-- `user IDs` `(Type: Snowflake || Flag: Emptiable)`: The users to blacklist from using the command. Separate user IDs with `;`.
+- `User IDs` `(Type: Snowflake || Flag: Emptiable)`: The user(s) to blacklist from using the command. Use semicolons `;` as a separator to separate multiple user IDs.
   > [How to get user ID?](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-)
-- `error message` `(Type: String || Flag: Emptiable)`: The message that will be sent when the user running the command is blacklisted.
+- `Error message` `(Type: String || Flag: Emptiable)`: The message that will be sent when the user running the command is blacklisted.
 
 ## Example
 ```
 $nomention
 $blackListIDs[566613317972394004;437154602626973697;❌ You can't use this command!]
 Pong! $ping ms
 ```
-
 ![example](https://user-images.githubusercontent.com/113303649/210045834-d83964d7-6d5f-4cba-b549-2373c1336e49.png)
diff --git a/src/bdscript/blackListRoles.md b/src/bdscript/blackListRoles.md
@@ -3,18 +3,17 @@ Blocks users with certain role(s) from using the command. If the user has any ro
 
 ## Syntax
 ```
-$blackListRoles[role names;...;error message]
+$blackListRoles[Role names;...;Error message]
 ```
 
 ### Parameters
-- `role names` `(Type: String || Flag: Emptiable)`: The name(s) of the role(s) to blacklist. Separate role names using `;`.
-- `error message` `(Type: String || Flag: Emptiable)`: The message that will be sent if the user has a role from the blacklist.
+- `Role names` `(Type: String || Flag: Emptiable)`: The name(s) of the role(s) to blacklist. Use semicolons `;` as a separator to separate multiple role names.
+- `Error message` `(Type: String || Flag: Emptiable)`: The message that will be sent if the user has a role from the blacklist.
 
 ## Example
 ```
 $nomention
 $blackListRoles[Owner;Bot;❌ You can't use this command!]
 Pong! $ping ms
 ```
-
 ![example](https://user-images.githubusercontent.com/113303649/210046896-9e45b0c5-68f1-49b8-9bf0-90694df688cf.png)
diff --git a/src/bdscript/blackListRolesIDs.md b/src/bdscript/blackListRolesIDs.md
@@ -1,20 +1,19 @@
 # $blackListRolesIDs
-Block users with certain roles from using the command. If the user has any role in the blacklist, they will not be able to run the command.
+Blocks users with certain roles from using the command. If the user has any role in the blacklist, they will not be able to run the command.
 
 ## Syntax
 ```
-$blackListRolesIDs[role IDs;...;error message]
+$blackListRolesIDs[Role IDs;...;Error message]
 ```
 
 ### Parameters
-- `role IDs` `(Type: Snowflake || Flag: Emptiable)`: The roles that will be blacklisted. Separate role IDs using `;`.
-- `error message` `(Type: String || Flag: Emptiable)`: The message that will be sent if the user has a role from the blacklist.
+- `Role IDs` `(Type: Snowflake || Flag: Emptiable)`: The role(s) that will be blacklisted. Use semicolons `;` as a separator to separate multiple role IDs.
+- `Error message` `(Type: String || Flag: Emptiable)`: The message that will be sent if the user has a role from the blacklist.
 
 ## Example
 ```
 $nomention
 $blackListRolesIDs[1009019299987476540;1014547313957539901;❌ You can't use this command!]
 Pong! $ping ms
 ```
-
 ![example](https://user-images.githubusercontent.com/113303649/210046896-9e45b0c5-68f1-49b8-9bf0-90694df688cf.png)
diff --git a/src/bdscript/blackListServers.md b/src/bdscript/blackListServers.md
@@ -1,15 +1,16 @@
 # $blackListServers
- Disables this command for the provided servers.
+Blocks certain servers from using the command.
 
 ## Syntax
 ```
-$blackListServers[guild IDs;..;error message]
+$blackListServers[Guild IDs;...;Error message]
 ```
 
 ### Parameters
-- `guild IDs` `(Type: Snowflake || Flag: Emptiable)`: The servers to blacklist. Separate server IDs using `;`.
+- `Guild IDs` `(Type: Snowflake || Flag: Emptiable)`: The server(s) to blacklist from using a command. Use semicolons `;` as a separator to separate multiple server IDs.
    > [Where do I find server IDs? (click-me)](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-)
-- `error message` `(Type: String || Flag: Emptiable)`: The error to display when the server is blacklisted.
+- `Error message` `(Type: String || Flag: Emptiable)`: The message that will be sent if the command is run in a blacklisted server.
+
 
 ## Example
 ```
@@ -18,6 +19,5 @@ $blackListServers[1009018669982031912;❌ You can't use this command!]
 **Hello $username!**
 *Guild ID: $guildID*
 ```
-![example](https://user-images.githubusercontent.com/113303649/211995843-0d9eba33-e36a-484f-ad97-eb6e67391af1.png)
-
+![example](https://user-images.githubusercontent.com/113303649/211995843-0d9eba33-e36a-484f-ad97-eb6e67391af1.png)\
 ![example](https://user-images.githubusercontent.com/113303649/211996168-47ba94ff-e03d-40f9-8b33-5758454f5ce9.png)
diff --git a/src/bdscript/blackListUsers.md b/src/bdscript/blackListUsers.md
@@ -1,20 +1,19 @@
 # $blackListUsers
-Disables the command for users with usernames matching the ones provided.
+Blocks certain users from using the command. Uses usernames instead of user IDs.
 
 ## Syntax
 ```
-$blackListUsers[usernames;...;error message]
+$blackListUsers[Usernames;...;Error message]
 ```
 
 ### Parameters
-- `usernames` `(Type: String || Flag: Emptiable)`: The usernames to blacklist. Separate names using `;`.
-- `error message` `(Type: String || Flag: Emptiable)`: Message when user's name is in the blacklist.
+- `Usernames` `(Type: String || Flag: Emptiable)`: The username(s) to blacklist. Use semicolons `;` as a separator to separate multiple usernames.
+- `Error message` `(Type: String || Flag: Emptiable)`: The message that will be sent when the username of the user running the command is blacklisted.
 
 ## Example
 ```
 $nomention
 $blackListUsers[RainbowKey;❌ You can't use this command!]
 Hello $username!
 ```
-
 ![example](https://user-images.githubusercontent.com/113303649/211997181-4ad65536-9b54-4f15-bd1f-07eb0df92686.png)
diff --git a/src/bdscript/boostCount.md b/src/bdscript/boostCount.md
@@ -1,5 +1,5 @@
 # $boostCount
-Returns the guild's number of nitro boosts.
+Returns the current guild's number of nitro boosts.
 
 ## Syntax
 ```

diff --git a/src/bdscript/boostCountComplex.md b/src/bdscript/boostCountComplex.md
@@ -1,13 +1,13 @@
 # $boostCount[]
-Returns the guild's number of nitro boosts.
+Returns a guild's number of nitro boosts.
 
 ## Syntax
 ```
-$boostCount[guild ID]
+$boostCount[Guild ID]
 ```
 
 ### Parameters
-- `guild ID` `(Type: Snowflake || Flag: Required)`: The guild to get the number of boosts for.
+- `Guild ID` `(Type: Snowflake || Flag: Required)`: The guild to get the number of boosts for.
 
 ## Example
 ```

diff --git a/src/bdscript/botCommands.md b/src/bdscript/botCommands.md
@@ -3,11 +3,11 @@ Returns a list of the bot's commands.
 
 ## Syntax
 ```
-$botCommands[separator]
+$botCommands[Separator]
 ```
 
 ### Parameters
-- `separator` `(Type: String || Flag: Required)`: Will be used to separate each command.
+- `Separator` `(Type: String || Flag: Required)`: Will be used to separate each command.
 
 ## Example
 ```

diff --git a/src/bdscript/botLeaveComplex.md b/src/bdscript/botLeaveComplex.md
@@ -1,23 +1,21 @@
 # $botLeave[]
- Makes the bot leave the server matching the provided [server ID](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID).
+Forces the bot to leave the server matching the provided [server ID](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID).
 
 ## Syntax
 ```
-$botLeave[guild ID]
+$botLeave[Guild ID]
 ````
 
 ### Parameters
-- `guild ID` `(Type: Snowflake || Flag: Required)`: The ID of a guild to leave.
+- `Guild ID` `(Type: Snowflake || Flag: Required)`: The ID of the guild to leave.
 
 ## Example
 ```
 $nomention
 $sendMessage[I left out `$serverName[$message]` server]
 $botLeave[$message]
 ```
-
-![example](https://user-images.githubusercontent.com/113303649/210335691-9d23cfd6-f7e8-4924-8afc-dd3b523ca071.png)
-
+![example](https://user-images.githubusercontent.com/113303649/210335691-9d23cfd6-f7e8-4924-8afc-dd3b523ca071.png)\
 ![example](https://user-images.githubusercontent.com/113303649/210337078-dbdb0539-6f4a-4271-8574-afc43551d0e8.png)
 
 > If you are using **BDScript 2**, put `$botLeave[]` at the very bottom of the code so that the code works correctly i.e:

diff --git a/src/bdscript/botListDescription.md b/src/bdscript/botListDescription.md
@@ -3,19 +3,17 @@ Sets the description of this command, for the BDL command list (if the bot is on
 
 ## Syntax
 ```
-$botListDescription[text]
+$botListDescription[Text]
 ```
 
 ### Parameters
-- `text` `(Type: String || Flag: Required)`: The text that the description will be set to.
+- `Text` `(Type: String || Flag: Required)`: The text that the description will be set to.
 
 ## Example
 ```
 $nomention
 Pong!
 $botListDescription[Ping? Pong!]
 ```
-
-![example](https://user-images.githubusercontent.com/113303649/210341764-10cf97fe-5a0e-429b-8e8f-dbfcb4819c93.png)
-
+![example](https://user-images.githubusercontent.com/113303649/210341764-10cf97fe-5a0e-429b-8e8f-dbfcb4819c93.png)\
 ![example](https://user-images.githubusercontent.com/113303649/210341495-bbda340a-3f30-4c6d-af7c-4445233ede37.png)
diff --git a/src/bdscript/c.md b/src/bdscript/c.md
@@ -3,17 +3,16 @@ Adds a comment to the code. Comments do not appear in the bot's response.
 
 ## Syntax
 ```
-$c[comment]
+$c[Comment]
 ```
 
 ### Parameters 
-- `comment` `(Type: String || Flag: Emptiable)`: Any text. This text will not be taken into account during processing. Commonly used to add notes to the code.
+- `Comment` `(Type: String || Flag: Emptiable)`: Any text. This text will not be taken into account during processing. Commonly used to add notes to the code.
 
 ## Example
 ```
 $nomention
 $noMentionMessage
 $c[This is a say command. You are reading a comment!]
 ```
-
 ![example](https://user-images.githubusercontent.com/69215413/127033510-b61a5806-c1b5-45f3-99d3-c4f932497322.png)
diff --git a/src/bdscript/calculate.md b/src/bdscript/calculate.md
@@ -3,13 +3,13 @@ Calculates a math expression.
 
 ## Syntax
 ```
-$calculate[expression]
+$calculate[Expression]
 ```
 
 ### Parameters
-- `expression` `(Type: String || Flag: Required)`: The math expression to solve.
+- `Expression` `(Type: String || Flag: Required)`: The math expression to solve.
 
-## Signs
+### Signs
 - `+` - Addition.
 - `-` - Subtraction.
 - `/` - Division.
@@ -28,4 +28,3 @@ $calculate[$message] 🧠
 
 
 > [How `$enableDecimals[]` works?](./bdscript/enableDecimals.md)
-
diff --git a/src/bdscript/categoryChannels.md b/src/bdscript/categoryChannels.md
@@ -1,20 +1,22 @@
 # $categoryChannels
-List channel property under given category.
+Lists all channels of the given category.
 
 ## Syntax
 ```
-$categoryChannels[category ID;separator;(option)]
+$categoryChannels[Category ID;Separator;(Option)]
 ```
+
 ### Parameters
-- `category ID` `(Type: Snowflake || Flag: Required)`: The category from which to take the channels. 
-- `seperator` `(Type: String || Flag: Emptiable)`: The separator to use when separating channel properties.
-- `option` `(Type: Enum || Flag: Optional)`: Which property to get from category channels. _(Default  is `name`)_
+- `Category ID` `(Type: Snowflake || Flag: Required)`: The category from which to list the channels. 
+- `Seperator` `(Type: String || Flag: Emptiable)`: The separator to use when separating channel properties.
+- `Option` `(Type: Enum || Flag: Optional)`: Which property to get from category channels. Default  is `name`. See [below](#options) for more information.
 
 ### Options
-- `name`: The name of the channels.
-- `id`: The id of the channels.
-- `mention`: The channel mentions.
-- `count`: The amount of channels in the category.
+- `name` - The names of the channels.
+- `id` - The IDs of the channels.
+- `mention` - The mentions of the channels.
+- `count` - The amount of channels in the category.
+
 > The `count` option does not list anything, instead it will return the number of channels under the given category.
 
 ## Example
@@ -26,4 +28,3 @@ $nomention
 ![example](https://user-images.githubusercontent.com/113303649/212550851-a3a87e0e-9393-4e38-9f87-921034ea69a7.png)
 
 > [How `$categoryID[]` works?](./categoryID.md)
-
diff --git a/src/bdscript/categoryCountComplex.md b/src/bdscript/categoryCountComplex.md
@@ -3,16 +3,15 @@ Returns the category count of the provided guild.
 
 ## Syntax
 ```
-$categoryCount[guild ID]
+$categoryCount[Guild ID]
 ```
 
 ### Parameters
-- `guild ID` `(Type: Snowflake || Flag: Required)`: The guild to get its category count.
+- `Guild ID` `(Type: Snowflake || Flag: Required)`: The guild to get its category count.
 
 ## Example
 ```
 $nomention
 There are $categoryCount[$message[1]] categories in the server!
 ```
-
 ![example](https://user-images.githubusercontent.com/94063167/198900619-c3a3b71e-2d6e-4d6c-b1e0-d4b4449d6198.png)
diff --git a/src/bdscript/categoryID.md b/src/bdscript/categoryID.md
@@ -1,13 +1,13 @@
 # $categoryID
-Returns category ID for given category name.
+Returns the category ID of the given category name.
 
 ## Syntax
 ```
-$categoryID[category name]
+$categoryID[Category name]
 ```
 
 ### Parameters
-- `category name` `(Type: String || Flag: Required)`: The name of the category from which to return the ID.
+- `Category name` `(Type: String || Flag: Required)`: The name of the category from which to return the ID.
 
 ## Example
 ```
@@ -16,6 +16,4 @@ Category ID: $categoryID[$message]
 ```
 ![example](https://user-images.githubusercontent.com/94063167/198906454-b8ba28dd-909c-4411-b726-863ec5ceb146.png)
 
-
 > To get the category ID from a *channel ID* use [`$parentID`](./parentID.md).
-
diff --git a/src/bdscript/changeCooldownTime.md b/src/bdscript/changeCooldownTime.md
@@ -3,14 +3,14 @@ Changes the cooldown metrics. These can be used in cooldown error messages. It c
 
 ## Syntax
 ```
-$changeCooldownTime[days;hours;minutes;seconds]
+$changeCooldownTime[Days;Hours;Minutes;Seconds]
 ```
 
 ### Parameters
-- `days` `(Type: String || Flag: Required)`: The text to replace 'Days' with.
-- `hours` `(Type: String || Flag: Required)`: The text to replace 'Hours' with.
-- `minutes` `(Type: String || Flag: Required)`: The text to replace 'Minutes' with.
-- `seconds` `(Type: String || Flag: Required)`: The text to replace 'Seconds' with.
+- `Days` `(Type: String || Flag: Required)`: The text to replace 'Days' with.
+- `Hours` `(Type: String || Flag: Required)`: The text to replace 'Hours' with.
+- `Minutes` `(Type: String || Flag: Required)`: The text to replace 'Minutes' with.
+- `Seconds` `(Type: String || Flag: Required)`: The text to replace 'Seconds' with.
 
  ### Sub-functions
 
@@ -28,6 +28,4 @@ Hello $username!
 $changeCooldownTime[Days⏰;Hours⏰;Mins🕧;Secs🕧]
 $cooldown[10m;Please wait %time-m%!]
 ```
-
 ![example](https://user-images.githubusercontent.com/113303649/212069278-c045a1e8-4dba-4a16-a1a5-732bcb5211f1.png)
-