v1.3.2.6 API

Author: direwolf420

ClickerCompat.cs

@@ -23,7 +23,7 @@ internal class ClickerCompat : ModSystem
 
 		//This is the version of the calls that are used for the mod.
 		//If Clicker Class updates, it will keep working on the outdated calls, but new features might not be available
-		internal static readonly Version apiVersion = new Version(1, 3, 2);
+		internal static readonly Version apiVersion = new Version(1, 3, 2, 6);
 
 		internal static string versionString;
 
@@ -332,6 +332,16 @@ internal static void SetDust(Item item, int type)
 			ClickerClass?.Call("SetDust", versionString, item, type);
 		}
 
+		/// <summary>
+		/// Call in <see cref="ModItem.SetDefaults"/> for a clicker item to assign it an accessory type, so that items with that accessory type cannot be equipped together. Supported types:
+		/// ClickingGlove
+		/// </summary>
+		/// <param name="item">The clicker class item</param>
+		internal static void SetAccessoryType(Item item, string accessoryType)
+		{
+			ClickerClass?.Call("SetAccessoryType", versionString, item, accessoryType);
+		}
+
 		/// <summary>
 		/// Call in <see cref="ModItem.SetDefaults"/> for a clicker item to make it display total click count in the tooltip
 		/// </summary>
@@ -402,7 +412,7 @@ internal static bool GetArmorSet(Player player, string set)
 
 		/// <summary>
 		/// Call to check if a specific accessory effect is enabled (i.e. "Gamer Crate" will have multiple effects enabled). Supported accessories:
-		/// ChocolateChip, EnchantedLED, EnchantedLED2, HandCream, StickyKeychain, GlassOfMilk, CookieVisual, CookieVisual2, ClickingGlove, AncientClickingGlove, RegalClickingGlove, GoldenTicket, PortableParticleAccelerator, IcePack, MouseTrap, HotKeychain, TriggerFinger, ButtonMasher, AimAssistModule, AimbotModule.
+		/// ChocolateChip, EnchantedLED, EnchantedLED2, StickyKeychain, GlassOfMilk, CookieVisual, CookieVisual2, ClickingGlove, AncientClickingGlove, RegalClickingGlove, GoldenTicket, PortableParticleAccelerator, MouseTrap, HotKeychain, TriggerFinger, ButtonMasher, AimAssistModule, AimbotModule.
 		/// </summary>
 		/// <param name="player">The player</param>
 		internal static bool GetAccessory(Player player, string accessory)
@@ -412,7 +422,7 @@ internal static bool GetAccessory(Player player, string accessory)
 
 		/// <summary>
 		/// Call to set a specific player accessory effect (i.e. to emulate "Gamer Crate" you need to have set multiple effects). Supported accessories:
-		/// ChocolateChip, EnchantedLED, EnchantedLED2, HandCream, StickyKeychain, GlassOfMilk, CookieVisual, CookieVisual2, ClickingGlove, AncientClickingGlove, RegalClickingGlove, GoldenTicket, PortableParticleAccelerator, IcePack, MouseTrap, HotKeychain, TriggerFinger, ButtonMasher, AimAssistModule, AimbotModule.
+		/// ChocolateChip, EnchantedLED, EnchantedLED2, StickyKeychain, GlassOfMilk, CookieVisual, CookieVisual2, ClickingGlove, AncientClickingGlove, RegalClickingGlove, GoldenTicket, PortableParticleAccelerator, MouseTrap, HotKeychain, TriggerFinger, ButtonMasher, AimAssistModule, AimbotModule.
 		/// </summary>
 		/// <param name="player">The player</param>
 		internal static void SetAccessory(Player player, string accessory)
@@ -532,6 +542,18 @@ internal static bool HasClickEffect(Player player, string effect)
 		{
 			return ClickerClass?.Call("HasClickEffect", versionString, player, effect) as bool? ?? false;
 		}
+
+		/// <summary>
+		/// Sets an auto-reuse effect to be applied to the player. Will apply the fastest one onto the player (if there are multiple active ones)
+		/// </summary>
+		/// <param name="player">The player</param>
+		/// <param name="speedFactor">The multiplier to use time of 1 when this effect is active. Rounds down the result, minimum is 2 (game limitation). Example: 6f -> effective use time = 1 * 6f -> 60 / 6f -> 10 cps</param>
+		/// <param name="controlledByKeyBind">This effect will only be active if the player toggles it using the keybind from Clicker Class dedicated to it</param>
+		/// <param name="preventsClickEffects">This effect will not activate Click Effects while active</param>
+		internal static void SetAutoReuseEffect(Player player, float speedFactor, bool controlledByKeyBind = false, bool preventsClickEffects = false)
+		{
+			ClickerClass?.Call("SetAutoReuseEffect", versionString, player, speedFactor, controlledByKeyBind, preventsClickEffects);
+		}
 		#endregion
 	}
 }

Items/Accessories/ExampleClickerAccessory.cs

@@ -25,11 +25,15 @@ public override void SetStaticDefaults()
 				"Reduces the amount of clicks required for a click effect by 1" + "\n" +
 				"Gain up to 15% clicker damage based on your amount of clicks within a second" + "\n" +
 				"Every 15 clicks releases a burst of damaging chocolate" + "\n" +
-				"Makes the radius pulsate up to 50% of the default radius");
+				"Makes the radius pulsate up to 50% of the default radius" + "\n" +
+				"Pressing the '{$Mods.ClickerClass.Hotkeys.ClickerAccessory}' key will toggle auto click on all Clickers" + "\n" +
+				"While auto click is enabled, click rates are moderately decreased");
 		}
 
 		public override void SetDefaults()
 		{
+			//To prevent this accessory from being equippable with similar ones of the same archetype (if it exists in the base mod), use this:
+			//ClickerCompat.SetAccessoryType(Item, "ClickingGlove");
 			Item.width = 28;
 			Item.height = 20;
 			Item.value = 100000;
@@ -52,10 +56,14 @@ public override void UpdateAccessory(Player player, bool hideVisual)
 			//ClickerCompat.SetAccessoryItem(player, "Cookie", Item);
 			//ClickerCompat.SetAccessory(player, "CookieVisual");
 
-			//Enabled the click effect given by Chocolate Chip
+			//Enables the click effect given by Chocolate Chip
 			//You can use Clicker Classes base effects (you can find them in the source code), or your own ones
 			ClickerCompat.EnableClickEffect(player, "ClickerClass:ChocolateChip");
 
+			//Sets an auto-reuse effect to be applied to the player for all clickers
+			//In this case, it will make the clickers have a use time of 5 (resulting in 12 cps), and it will only work if the player uses the Clicker Class hotkey for toggling auto-reuse
+			ClickerCompat.SetAutoReuseEffect(player, 5f, true, false);
+
 			//How to check if an effect is enabled for the player
 			bool hasChocolateChip = ClickerCompat.HasClickEffect(player, "ClickerClass:ChocolateChip");