Add "is in editor?" block

Author: Valmontechno

addon-api/content-script/Tab.js

@@ -62,6 +62,18 @@ export default class Tab extends Listenable {
     blocks.init(this);
     return blocks.addBlock(proccode, opts);
   }
+  /**
+   * Adds a custom reporter block definition. Internally this is a special-cased argument reporter block.
+   * @param {string} proccode the procedure definition code
+   * @param {boolean} isBoolean - whether the block is hexagonal.
+   * @param {object} opts - options.
+   * @param {Tab~blockCallback} opts.callback - the callback, the returned value is the output of the block.
+   * @param {boolean=} opts.hidden - whether the block is hidden from the palette.
+   */
+  addReporterBlock(proccode, isBoolean, opts) {
+    blocks.init(this);
+    return blocks.addReporterBlock(proccode, isBoolean, opts);
+  }
   /**
    * Removes a stack block definition. Should not be called in most cases.
    * @param {string} proccode the procedure definition code of the block

addon-api/content-script/blocks.js

@@ -103,6 +103,7 @@ export const addBlock = (proccode, { args, callback, hidden, displayName }) => {
 
   const blockData = {
     id: proccode,
+    type: "procedures_call",
     args,
     handler: callback,
     hide: !!hidden,
@@ -113,6 +114,23 @@ export const addBlock = (proccode, { args, callback, hidden, displayName }) => {
   queueToolboxUpdate();
 };
 
+export const addReporterBlock = (proccode, isBoolean, { callback, hidden }) => {
+  // The `proccode` parameter is not the proccode but the name of the argument
+  if (getCustomBlock(proccode)) {
+    return;
+  }
+
+  const blockData = {
+    id: proccode,
+    type: isBoolean ? "argument_reporter_boolean" : "argument_reporter_string_number",
+    handler: callback,
+    hide: !!hidden,
+    proccode,
+  };
+  customBlocks[proccode] = blockData;
+  queueToolboxUpdate();
+};
+
 export const removeBlock = (proccode) => {
   customBlocks[proccode] = null;
   customBlockParamNamesIdsDefaults[proccode] = null;
@@ -123,14 +141,21 @@ const generateBlockXML = () => {
   for (const proccode of Object.keys(customBlocks)) {
     const blockData = customBlocks[proccode];
     if (blockData.hide) continue;
-    const [names, ids, defaults] = getNamesIdsDefaults(blockData);
-    xml +=
-      '<block type="procedures_call" gap="16"><mutation generateshadows="true" warp="false"' +
-      ` proccode="${escapeHTML(proccode)}"` +
-      ` argumentnames="${escapeHTML(JSON.stringify(names))}"` +
-      ` argumentids="${escapeHTML(JSON.stringify(ids))}"` +
-      ` argumentdefaults="${escapeHTML(JSON.stringify(defaults))}"` +
-      "></mutation></block>";
+
+    if (blockData.type === "procedures_call") {
+      const [names, ids, defaults] = getNamesIdsDefaults(blockData);
+      xml +=
+        '<block type="procedures_call" gap="16"><mutation generateshadows="true" warp="false"' +
+        ` proccode="${escapeHTML(proccode)}"` +
+        ` argumentnames="${escapeHTML(JSON.stringify(names))}"` +
+        ` argumentids="${escapeHTML(JSON.stringify(ids))}"` +
+        ` argumentdefaults="${escapeHTML(JSON.stringify(defaults))}"` +
+        "></mutation></block>";
+
+    } else {
+      xml +=
+        `<block type="${blockData.type}"><field name="VALUE">${blockData.id}</field></block>`;
+    }
   }
   if (xml.length === 0) {
     const message = scratchAddons.l10n.get("noAddedBlocks", null, "No addons have added blocks.");
@@ -172,15 +197,20 @@ const injectWorkspace = (ScratchBlocks) => {
     const oldUpdateColour = BlockSvg.prototype.updateColour;
     BlockSvg.prototype.updateColour = function (...args) {
       // procedures_prototype also have a procedure code but we do not want to color them.
-      if (!this.isInsertionMarker() && this.type === "procedures_call") {
-        const block = this.procCode_ && getCustomBlock(this.procCode_);
-        const color = ScratchBlocks.Colours.text === "#000000" ? highContrastColor : defaultColor;
-        if (block) {
-          this.colour_ = customColor.color || color.color;
-          this.colourSecondary_ = customColor.secondaryColor || color.secondaryColor;
-          this.colourTertiary_ = customColor.tertiaryColor || color.tertiaryColor;
-          this.customContextMenu = null;
-        }
+      if (this.isInsertionMarker()) return;
+      let block;
+      if (this.type === "procedures_call") {
+        block = this.procCode_ && getCustomBlock(this.procCode_);
+      } else if (this.type === "argument_reporter_string_number" || this.type === "argument_reporter_boolean") {
+        const name = this.inputList[0].fieldRow[0].text_
+        block = name && getCustomBlock(name);
+      }
+      const color = ScratchBlocks.Colours.text === "#000000" ? highContrastColor : defaultColor;
+      if (block) {
+        this.colour_ = customColor.color || color.color;
+        this.colourSecondary_ = customColor.secondaryColor || color.secondaryColor;
+        this.colourTertiary_ = customColor.tertiaryColor || color.tertiaryColor;
+        this.customContextMenu = null;
       }
       return oldUpdateColour.call(this, ...args);
     };
@@ -315,6 +345,24 @@ export async function init(tab) {
     return oldStepToProcedure.call(this, thread, proccode);
   };
 
+  const oldArgumentReporterStringNumber = vm.runtime._primitives.argument_reporter_string_number;
+  vm.runtime._primitives.argument_reporter_string_number = (args, util) => {
+    const blockData = getCustomBlock(args.VALUE);
+    if (blockData) {
+      return blockData.handler();
+    }
+    return oldArgumentReporterStringNumber.call(this, args, util)
+  }
+
+  const oldArgumentReporterBoolean = vm.runtime._primitives.argument_reporter_boolean;
+  vm.runtime._primitives.argument_reporter_boolean = (args, util) => {
+    const blockData = getCustomBlock(args.VALUE);
+    if (blockData) {
+      return blockData.handler(args, util);
+    }
+    return oldArgumentReporterBoolean.call(this, args, util)
+  }
+
   const ScratchBlocks = await tab.traps.getBlockly();
   injectWorkspace(ScratchBlocks);
 }

addons/debugger/addon.json

@@ -1,6 +1,13 @@
 {
   "name": "Debugger",
-  "description": "Adds a new \"debugger\" window to the editor. Allows for logging into the \"Logs\" tab of the debugger window using the \"log\", \"warn\" and \"error\" blocks. The \"breakpoint\" block will pause the project when executed. All running stacks of blocks can be viewed in the \"Threads\" tab of the debugger window, and when paused the \"Step\" button can be used to execute the next block. A graph of frames per second and number of clones can be viewed in the \"Performance\" tab.",
+  "description": "Adds a new \"debugger\" window to the editor. Allows for logging into the \"Logs\" tab of the debugger window using the \"log\", \"warn\" and \"error\" blocks. The \"breakpoint\" block will pause the project when executed. All running stacks of blocks can be viewed in the \"Threads\" tab of the debugger window, and when paused the \"Step\" button can be used to execute the next block. A graph of frames per second and number of clones can be viewed in the \"Performance\" tab. The \"is it in editor?\" block allows to check if the project is running in the editor.",
+  "info": [
+    {
+      "type": "notice",
+      "text": "Debug blocks only work for Scratch Addons users with this enabled. The \"is in editor?\" block cannot therefore it cannot be used as an anti-cheat method.",
+      "id": "debuggerBlocks"
+    }
+  ],
   "credits": [
     {
       "name": "Tacodiva",
@@ -17,6 +24,10 @@
     },
     {
       "name": "retronbv"
+    },
+    {
+      "name": "Valmontechno",
+      "link": "https://github.com/Valmontechno"
     }
   ],
   "userscripts": [
@@ -84,9 +95,9 @@
   "tags": ["editor", "codeEditor", "featured"],
   "versionAdded": "1.16.0",
   "latestUpdate": {
-    "version": "1.33.0",
-    "temporaryNotice": "Graph animation is now disabled by default to increase performance. You can re-enable it if you want.",
-    "newSettings": ["fancy_graphs"]
+    "version": "1.43.0",
+    "temporaryNotice": "New available block: \"is in editor?\"",
+    "isMajor": true
   },
   "libraries": ["chartjs", "scratch-gui", "scratch-vm"]
 }

addons/debugger/userscript.js

@@ -68,6 +68,11 @@ export default async function ({ addon, console, msg }) {
       logMessage(content, thread, "error");
     },
   });
+  addon.tab.addReporterBlock("\u200B\u200Bis in editor?\u200B\u200B", true, {
+    callback: () => {
+      return document.body.classList.contains("sa-body-editor") ? true : 0;
+    }
+  });
 
   const vm = addon.tab.traps.vm;
   await new Promise((resolve, reject) => {