From bef8fda3daeef3e688f313dfbb198c57e667f38a Mon Sep 17 00:00:00 2001
From: jamesbt365 <jamesbt365@gmail.com>
Date: Tue, 4 Jun 2024 01:21:03 +0100
Subject: [PATCH] Make manual cooldowns on commands optional & document

---
 macros/src/command/mod.rs    |  4 ++--
 macros/src/command/prefix.rs |  5 ++++-
 macros/src/command/slash.rs  | 10 ++++++++--
 macros/src/lib.rs            |  2 +-
 src/structs/command.rs       |  2 +-
 5 files changed, 16 insertions(+), 7 deletions(-)

diff --git a/macros/src/command/mod.rs b/macros/src/command/mod.rs
index d94beb2b2d0f..5b1decf89714 100644
--- a/macros/src/command/mod.rs
+++ b/macros/src/command/mod.rs
@@ -49,7 +49,7 @@ pub struct CommandArgs {
     category: Option<String>,
     custom_data: Option<syn::Expr>,
 
-    manual_cooldowns: bool,
+    manual_cooldowns: Option<bool>,
 
     // In seconds
     global_cooldown: Option<u64>,
@@ -282,7 +282,7 @@ fn generate_command(mut inv: Invocation) -> Result<proc_macro2::TokenStream, dar
     let description = wrap_option_to_string(inv.description.as_ref());
     let category = wrap_option_to_string(inv.args.category.as_ref());
 
-    let manual_cooldowns = inv.args.manual_cooldowns;
+    let manual_cooldowns = wrap_option(inv.args.manual_cooldowns);
     let cooldown_config = generate_cooldown_config(&inv.args);
 
     let default_member_permissions = &inv.default_member_permissions;
diff --git a/macros/src/command/prefix.rs b/macros/src/command/prefix.rs
index a7ce403114c3..e79c57d37ce1 100644
--- a/macros/src/command/prefix.rs
+++ b/macros/src/command/prefix.rs
@@ -63,7 +63,10 @@ pub fn generate_prefix_action(inv: &Invocation) -> Result<proc_macro2::TokenStre
                 error,
             ))?;
 
-            if !ctx.framework.options.manual_cooldowns && !ctx.command.manual_cooldowns {
+            let is_framework_cooldown = !ctx.command.manual_cooldowns
+            .unwrap_or_else(|| ctx.framework.options.manual_cooldowns);
+
+            if is_framework_cooldown {
                 ctx.command.cooldowns.lock().unwrap().start_cooldown(ctx.cooldown_context());
             }
 
diff --git a/macros/src/command/slash.rs b/macros/src/command/slash.rs
index 62487b60fef9..c27dcad2e5fb 100644
--- a/macros/src/command/slash.rs
+++ b/macros/src/command/slash.rs
@@ -185,7 +185,10 @@ pub fn generate_slash_action(inv: &Invocation) -> Result<proc_macro2::TokenStrea
                 #( (#param_names: #param_types), )*
             ).await.map_err(|error| error.to_framework_error(ctx))?;
 
-            if !ctx.framework.options.manual_cooldowns && !ctx.command.manual_cooldowns {
+            let is_framework_cooldown = !ctx.command.manual_cooldowns
+            .unwrap_or_else(|| ctx.framework.options.manual_cooldowns);
+
+            if is_framework_cooldown {
                 ctx.command.cooldowns.lock().unwrap().start_cooldown(ctx.cooldown_context());
             }
 
@@ -215,7 +218,10 @@ pub fn generate_context_menu_action(
     Ok(quote::quote! {
         <#param_type as ::poise::ContextMenuParameter<_, _>>::to_action(|ctx, value| {
             Box::pin(async move {
-                if !ctx.framework.options.manual_cooldowns && !ctx.command.manual_cooldowns {
+                let is_framework_cooldown = !ctx.command.manual_cooldowns
+                .unwrap_or_else(|| ctx.framework.options.manual_cooldowns);
+
+                if is_framework_cooldown {
                     ctx.command.cooldowns.lock().unwrap().start_cooldown(ctx.cooldown_context());
                 }
 
diff --git a/macros/src/lib.rs b/macros/src/lib.rs
index 5316651af233..670806501ffd 100644
--- a/macros/src/lib.rs
+++ b/macros/src/lib.rs
@@ -67,7 +67,7 @@ for example for command-specific help (i.e. `~help command_name`). Escape newlin
 - `reuse_response`: After the first response, post subsequent responses as edits to the initial message (prefix only)
 
 ## Cooldown
-
+- `manual_cooldowns`: Allows overriding the framework's built-in cooldowns tracking without affecting other commands.
 - `global_cooldown`: Minimum duration in seconds between invocations, globally
 - `user_cooldown`: Minimum duration in seconds between invocations, per user
 - `guild_cooldown`: Minimum duration in seconds between invocations, per guild
diff --git a/src/structs/command.rs b/src/structs/command.rs
index 540965f31d7a..9a300b3f9369 100644
--- a/src/structs/command.rs
+++ b/src/structs/command.rs
@@ -62,7 +62,7 @@ pub struct Command<U, E> {
     ///
     /// Will override [`crate::FrameworkOptions::manual_cooldowns`] allowing manual cooldowns
     /// on select commands.
-    pub manual_cooldowns: bool,
+    pub manual_cooldowns: Option<bool>,
     /// Handles command cooldowns. Mainly for framework internal use
     pub cooldowns: std::sync::Mutex<crate::CooldownTracker>,
     /// Configuration for the [`crate::CooldownTracker`]