[ V1.1 ] New mod

Check parameters has been modded to allow 2 new types of comparison.

actions/check_parameters_MOD.js

@@ -0,0 +1,215 @@
+module.exports = {
+  //---------------------------------------------------------------------
+  // Command Only
+  //
+  // If this is 'true', then this will only be available for commands.
+  //---------------------------------------------------------------------
+
+  commandOnly: true,
+
+  //---------------------------------------------------------------------
+  // Action Name
+  //
+  // This is the name of the action displayed in the editor.
+  //---------------------------------------------------------------------
+
+  name: "Check Parameters MOD",
+
+  //---------------------------------------------------------------------
+  // Action Section
+  //
+  // This is the section the action will fall into.
+  //---------------------------------------------------------------------
+
+  section: "Conditions",
+
+  //---------------------------------------------------------------------
+  // Action Subtitle
+  //
+  // This function generates the subtitle displayed next to the name.
+  //---------------------------------------------------------------------
+
+  subtitle(data, presets) {
+    return `${presets.getConditionsText(data)}`;
+  },
+
+  //---------------------------------------------------------------------
+  // Action Meta Data
+  //
+  // Helps check for updates and provides info if a custom mod.
+  // If this is a third-party mod, please set "author" and "authorUrl".
+  //
+  // It's highly recommended "preciseCheck" is set to false for third-party mods.
+  // This will make it so the patch version (0.0.X) is not checked.
+  //---------------------------------------------------------------------
+
+
+	meta: { version: "2.1.2", preciseCheck: true, author: "DBM Extended", authorUrl: "https://github.com/DBM-Extended/mods", downloadURL: "https://github.com/DBM-Extended/mods/tree/main/actions/check_parameters_MOD.js" },
+
+
+  //---------------------------------------------------------------------
+  // Action Fields
+  //
+  // These are the fields for the action. These fields are customized
+  // by creating elements with corresponding IDs in the HTML. These
+  // are also the names of the fields stored in the action's JSON data.
+  //---------------------------------------------------------------------
+
+  fields: ["condition", "comparison", "value", "branch"],
+
+  //---------------------------------------------------------------------
+  // Command HTML
+  //
+  // This function returns a string containing the HTML used for
+  // editing actions.
+  //
+  // The "isEvent" parameter will be true if this action is being used
+  // for an event. Due to their nature, events lack certain information,
+  // so edit the HTML to reflect this.
+  //---------------------------------------------------------------------
+
+  html(isEvent, data) {
+    return `
+<div>
+	<div style="float: left; width: calc(50% - 12px);">
+		<span class="dbminputlabel">Condition</span><br>
+		<select id="condition" class="round">
+			<option value="0" selected>Number of Parameters is...</option>
+			<option value="1">Number of Member Mentions are...</option>
+			<option value="2">Number of Channel Mentions are...</option>
+			<option value="3">Number of Role Mentions are...</option>
+		</select>
+	</div>
+	<div style="padding-left: 18px; float: left; width: calc(25% - 12px);">
+		<span class="dbminputlabel">Comparison</span><br>
+		<select id="comparison" class="round">
+			<option value="0" selected>=</option>
+			<option value="1">\<</option>
+			<option value="2">\></option>
+      <option value="3">>=</option>
+			<option value="4"><=</option>
+		</select>
+	</div>
+	<div style="padding-left: 18px; float: left; width: calc(25% - 12px);">
+		<span class="dbminputlabel">Number</span><br>
+		<input id="value" class="round" type="text">
+	</div>
+</div>
+
+<br><br><br><br>
+
+<hr class="subtlebar">
+
+<br>
+
+<conditional-input id="branch" style="padding-top: 8px;"></conditional-input>`;
+  },
+
+  //---------------------------------------------------------------------
+  // Action Editor Pre-Init Code
+  //
+  // Before the fields from existing data in this action are applied
+  // to the user interface, this function is called if it exists.
+  // The existing data is provided, and a modified version can be
+  // returned. The returned version will be used if provided.
+  // This is to help provide compatibility with older versions of the action.
+  //
+  // The "formatters" argument contains built-in functions for formatting
+  // the data required for official DBM action compatibility.
+  //---------------------------------------------------------------------
+
+  preInit(data, formatters) {
+    return formatters.compatibility_2_0_0_iftruefalse_to_branch(data);
+  },
+
+  //---------------------------------------------------------------------
+  // Action Editor Init Code
+  //
+  // When the HTML is first applied to the action editor, this code
+  // is also run. This helps add modifications or setup reactionary
+  // functions for the DOM elements.
+  //---------------------------------------------------------------------
+
+  init() {},
+
+  //---------------------------------------------------------------------
+  // Action Bot Function
+  //
+  // This is the function for the action within the Bot's Action class.
+  // Keep in mind event calls won't have access to the "msg" parameter,
+  // so be sure to provide checks for variable existence.
+  //---------------------------------------------------------------------
+
+  action(cache) {
+    const data = cache.actions[cache.index];
+    const msg = cache.msg;
+    let result = false;
+    if (msg && msg.content.length > 0) {
+      const condition = parseInt(data.condition, 10);
+      let value = 0;
+      switch (condition) {
+        case 0:
+          value = msg.content.split(/\s+/).length - 1;
+          break;
+        case 1:
+          value = msg.mentions.members.size;
+          break;
+        case 2:
+          value = msg.mentions.channels.size;
+          break;
+        case 3:
+          value = msg.mentions.roles.size;
+          break;
+      }
+      const comparison = parseInt(data.comparison, 10);
+      const value2 = parseInt(data.value, 10);
+      switch (comparison) {
+        case 0:
+          result = value == value2;
+          break;
+        case 1:
+          result = value < value2;
+          break;
+        case 2:
+          result = value > value2;
+          break;
+        case 3:
+          result = value <= value2;
+          break;
+        case 4:
+          result = value >= value2;
+          break;
+      }
+    }
+    this.executeResults(result, data?.branch ?? data, cache);
+  },
+
+  //---------------------------------------------------------------------
+  // Action Bot Mod Init
+  //
+  // An optional function for action mods. Upon the bot's initialization,
+  // each command/event's actions are iterated through. This is to
+  // initialize responses to interactions created within actions
+  // (e.g. buttons and select menus for Send Message).
+  //
+  // If an action provides inputs for more actions within, be sure
+  // to call the `this.prepareActions` function to ensure all actions are
+  // recursively iterated through.
+  //---------------------------------------------------------------------
+
+  modInit(data) {
+    this.prepareActions(data.branch?.iftrueActions);
+    this.prepareActions(data.branch?.iffalseActions);
+  },
+
+  //---------------------------------------------------------------------
+  // Action Bot Mod
+  //
+  // Upon initialization of the bot, this code is run. Using the bot's
+  // DBM namespace, one can add/modify existing functions if necessary.
+  // In order to reduce conflicts between mods, be sure to alias
+  // functions you wish to overwrite.
+  //---------------------------------------------------------------------
+
+  mod() {},
+};