Discord/CommandBot
Archived
1
0 Fork 0
Code Issues Actions Packages Projects Releases 40 Wiki Activity

readme changes

Browse Source
This commit is contained in:
mmacierzanka committed 2021-06-23 20:37:29 +02:00
1 parent 120eb061fb
commit 64a396e24e
1 file changed
+15 -12
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+15 -12
View File
@@ -61,18 +61,18 @@ Optional arguments for this method
> [IMPORTANT] > [IMPORTANT]
> All commands have to be declared above the *start* method > All commands have to be declared above the *start* method
### All parameters ### All parameters
- name - *string* - command name (used to trigger the command) - **name** - *string* - command name (used to trigger the command)
- function - *Function* - function that will trigger when the commands gets called - **function** - *Function* - function that will trigger when the commands gets called
- visible - *boolean* - show command in the *help message* (optional, defaults to *true*) - **visible** - *boolean* - show command in the *help message* (optional, defaults to *true*)
- description - *string* - command description shown in the *help message* (optional) - **description** - *string* - command description shown in the *help message* (optional)
- usage - *string* - command usage description shown in the *help message* (optional) - **usage** - *string* - command usage description shown in the *help message* (optional)
- permissions - *[PermissionResolvable](https://discord.js.org/#/docs/main/stable/typedef/PermissionResolvable)* - permissions needed to run the command (optional) - **permissions** - *[PermissionResolvable](https://discord.js.org/#/docs/main/stable/typedef/PermissionResolvable)* - permissions needed to run the command (optional)
- aliases - *string | string[]* - other words that can trigger the command with prefix (optional) - **aliases** - *string | string[]* - other words that can trigger the command with prefix (optional)
- keywords - *string | string[]* - other words that can trigger the command without prefix (optional) - **keywords** - *string | string[]* - other words that can trigger the command without prefix (optional)
### Command function ### Command function
#### Arguments #### Arguments
- m - *[Message](https://discord.js.org/#/docs/main/stable/class/Message)* - a message object instance containing message content, author and additional informations - **m** - *[Message](https://discord.js.org/#/docs/main/stable/class/Message)* - a message object instance containing message content, author and additional informations
- a - *string[]* - list of arguments passed with the message (separated with *argumentSeparator*) - **a** - *string[]* - list of arguments passed with the message (separated with *argumentSeparator*)
#### Return #### Return
If command function returns If command function returns
- *string* - the returned text will be sent as a reply to the command caller - *string* - the returned text will be sent as a reply to the command caller
@@ -104,8 +104,11 @@ bot.commands.add(new Command({
})); }));
``` ```
2. Call it from Discord text channel (example prefix: "!") 2. Call it from Discord text channel (example prefix: "!")
```javascript ```
!ping // replies "pong" with the user mention !ping
Result:
@mention, pong
``` ```
#### Arguments example #### Arguments example
1. Create a command 1. Create a command