3 |
3 | {{ linkText ?? '' }}
3 | If you want to compare your code to the code we've constructed so far, you can review it over on the GitHub repository
4 |
5 | here
33 |
34 |
--------------------------------------------------------------------------------
/guide/additional-features/cooldowns.md:
--------------------------------------------------------------------------------
1 | # Cooldowns
2 |
3 | Spam is something you generally want to avoid, especially if one of your commands require calls to other APIs or takes a bit of time to build/send.
4 |
5 | ::: tip
6 | This section assumes you followed the [Command Handling](/creating-your-bot/command-handling.md) part.
7 | :::
8 |
9 | First, add a cooldown property to your command. This will determine how long the user would have to wait (in seconds) before using the command again.
10 |
11 | ```js {4}
12 | const { SlashCommandBuilder } = require('discord.js');
13 |
14 | module.exports = {
15 | cooldown: 5,
16 | data: new SlashCommandBuilder()
17 | .setName('ping')
18 | .setDescription('Replies with Pong!'),
19 | async execute(interaction) {
20 | // ...
21 | },
22 | };
23 | ```
24 |
25 | In your main file, initialize a [Collection](/additional-info/collections.md) to store cooldowns of commands:
26 |
27 | ```js
28 | client.cooldowns = new Collection();
29 | ```
30 |
31 | The key will be the command names, and the values will be Collections associating the user's id (key) to the last time (value) this user used this command. Overall the logical path to get a user's last usage of a command will be `cooldowns > command > user > timestamp`.
32 |
33 | In your `InteractionCreate` event, add the following code:
34 |
35 | ```js {1,3-5,7-10,12-14}
36 | const { cooldowns } = interaction.client;
37 |
38 | if (!cooldowns.has(command.data.name)) {
39 | cooldowns.set(command.data.name, new Collection());
40 | }
41 |
42 | const now = Date.now();
43 | const timestamps = cooldowns.get(command.data.name);
44 | const defaultCooldownDuration = 3;
45 | const cooldownAmount = (command.cooldown ?? defaultCooldownDuration) * 1_000;
46 |
47 | if (timestamps.has(interaction.user.id)) {
48 | // ...
49 | }
50 |
51 | try {
52 | // ...
53 | } catch (error) {
54 | // ...
55 | }
56 | ```
57 |
58 | You check if the `cooldowns` Collection already has an entry for the command being used. If this is not the case, you can add a new entry, where the value is initialized as an empty Collection. Next, create the following variables:
59 |
60 | 1. `now`: The current timestamp.
61 | 2. `timestamps`: A reference to the Collection of user ids and timestamp key/value pairs for the triggered command.
62 | 3. `cooldownAmount`: The specified cooldown for the command, converted to milliseconds for straightforward calculation. If none is specified, this defaults to three seconds.
63 |
64 | If the user has already used this command in this session, get the timestamp, calculate the expiration time, and inform the user of the amount of time they need to wait before using this command again. Note the use of the `return` statement here, causing the code below this snippet to execute only if the user has not used this command in this session or the wait has already expired.
65 |
66 | Continuing with your current setup, this is the complete `if` statement:
67 |
68 | ```js {2-7}
69 | if (timestamps.has(interaction.user.id)) {
70 | const expirationTime = timestamps.get(interaction.user.id) + cooldownAmount;
71 |
72 | if (now < expirationTime) {
73 | const expiredTimestamp = Math.round(expirationTime / 1_000);
74 | return interaction.reply({ content: `Please wait, you are on a cooldown for \`${command.data.name}\`. You can use it again Ctrl + ` (backtick) to open its integrated terminal.
30 | :::
31 |
32 | On Windows, either:
33 |
34 | - `Shift + Right-click` inside your project directory and choose the "Open command window here" option
35 | - Press `Win + R` and run `cmd.exe`, and then `cd` into your project directory
36 |
37 | On macOS, either:
38 | - Open Launchpad or Spotlight and search for "Terminal"
39 | - In your "Applications" folder, under "Utilities", open the Terminal app
40 |
41 | On Linux, you can quickly open the terminal with `Ctrl + Alt + T`.
42 |
43 | With the terminal open, run the `node -v` command to make sure you've successfully installed Node.js.
44 |
45 | ### Initiating a project folder
46 |
47 | :::: code-group
48 | ::: code-group-item npm
49 | ```sh:no-line-numbers
50 | npm init
51 | ```
52 | :::
53 | ::: code-group-item yarn
54 | ```sh:no-line-numbers
55 | yarn init
56 | ```
57 | :::
58 | ::: code-group-item pnpm
59 | ```sh:no-line-numbers
60 | pnpm init
61 | ```
62 | :::
63 | ::: code-group-item bun
64 | ```sh:no-line-numbers
65 | bun init
66 | ```
67 | :::
68 | ::::
69 |
70 | This is the next command you'll be running. This command creates a `package.json` file for you, which will keep track of the dependencies your project uses, as well as other info.
71 |
72 | This command will ask you a sequence of questions–you should fill them out as you see fit. If you're not sure of something or want to skip it as a whole, leave it blank and press enter.
73 |
74 | ::: tip
75 | To get started quickly, you can run the following command to have it fill out everything for you.
76 |
77 | 
27 |
28 | 
67 |
68 |