JsExtension.js

//@ts-check
/// <reference path="../JsExtensionTypes.d.ts" />
/**
 * This is a declaration of an extension for GDevelop 5.
 *
 * ℹ️ Changes in this file are watched and automatically imported if the editor
 * is running. You can also manually run `node import-GDJS-Runtime.js` (in newIDE/app/scripts).
 *
 * The file must be named "JsExtension.js", otherwise GDevelop won't load it.
 * ⚠️ If you make a change and the extension is not loaded, open the developer console
 * and search for any errors.
 *
 * More information on https://github.com/4ian/GDevelop/blob/master/newIDE/README-extensions.md
 */

/** @type {ExtensionModule} */
module.exports = {
  createExtension: function (_, gd) {
    const extension = new gd.PlatformExtension();
    extension
      .setExtensionInformation(
        'DebuggerTools',
        _('Debugger Tools'),
        _(
          'Allow to interact with the editor debugger from the game (notably: enable 2D debug draw, log a message in the debugger console).'
        ),
        'Arthur Pacaud (arthuro555), Aurélien Vivet (Bouh)',
        'MIT'
      )
      .setShortDescription(
        'Enable 2D debug draw, log messages to debugger console, pause execution.'
      )
      .setCategory('Advanced');
    extension
      .addInstructionOrExpressionGroupMetadata(_('Debugger Tools'))
      .setIcon('res/actions/bug32.png');

    extension
      .addAction(
        'Pause',
        _('Pause game execution'),
        _(
          'This pauses the game, useful for inspecting the game state through the debugger. ' +
            'Note that events will be still executed until the end before the game is paused.'
        ),
        _('Pause game execution'),
        '',
        'res/actions/bug32.png',
        'res/actions/bug32.png'
      )
      .addCodeOnlyParameter('currentScene', '')
      .getCodeExtraInformation()
      .setIncludeFile('Extensions/DebuggerTools/debuggertools.js')
      .setFunctionName('gdjs.evtTools.debuggerTools.pause');

    extension
      .addAction(
        'EnableDebugDraw',
        _('Draw collisions hitboxes and points'),
        _(
          'This activates the display of rectangles and information on screen showing the objects bounding boxes (blue), the hitboxes (red) and some points of objects.'
        ),
        _(
          'Enable debugging view of bounding boxes/collision masks: _PARAM1_ (include invisible objects: _PARAM2_, point names: _PARAM3_, custom points: _PARAM4_)'
        ),
        '',
        'res/actions/planicon24.png',
        'res/actions/planicon.png'
      )
      .addCodeOnlyParameter('currentScene', '')
      .addParameter('yesorno', _('Enable debug draw'), '', true)
      .setDefaultValue('yes')
      .addParameter(
        'yesorno',
        _('Show collisions for hidden objects'),
        '',
        true
      )
      .setDefaultValue('no')
      .addParameter('yesorno', _('Show points names'), '', true)
      .setDefaultValue('yes')
      .addParameter('yesorno', _('Show custom points'), '', true)
      .setDefaultValue('yes')
      .getCodeExtraInformation()
      .setIncludeFile('Extensions/DebuggerTools/debuggertools.js')
      .setFunctionName('gdjs.evtTools.debuggerTools.enableDebugDraw');

    extension
      .addAction(
        'EnableDebugDraw3D',
        _('Draw 3D collision shapes'),
        _(
          'This activates the display of wireframe meshes showing the 3D collision shapes of objects using the 3D physics engine (box, sphere, capsule, cylinder).'
        ),
        _(
          'Enable 3D debug draw of collision shapes: _PARAM1_ (color: _PARAM2_, depth test: _PARAM3_)'
        ),
        '',
        'res/actions/planicon24.png',
        'res/actions/planicon.png'
      )
      .addCodeOnlyParameter('currentScene', '')
      .addParameter('yesorno', _('Enable 3D debug draw'), '', true)
      .setDefaultValue('yes')
      .addParameter('color', _('Wireframe color'), '', true)
      .setDefaultValue('"0;255;0"')
      .addParameter(
        'yesorno',
        _('Apply depth test (hide shapes behind geometry)'),
        '',
        true
      )
      .setDefaultValue('yes')
      .getCodeExtraInformation()
      .setIncludeFile('Extensions/DebuggerTools/debuggertools.js')
      .setFunctionName('gdjs.evtTools.debuggerTools.enableDebugDraw3D');

    extension
      .addAction(
        'ToggleDebugDraw3D',
        _('Toggle 3D collision shapes drawing'),
        _(
          'Toggles the display of wireframe meshes showing the 3D collision shapes of objects using the 3D physics engine. The last used color and depth test settings are reused.'
        ),
        _('Toggle 3D debug draw of collision shapes'),
        '',
        'res/actions/planicon24.png',
        'res/actions/planicon.png'
      )
      .addCodeOnlyParameter('currentScene', '')
      .getCodeExtraInformation()
      .setIncludeFile('Extensions/DebuggerTools/debuggertools.js')
      .setFunctionName('gdjs.evtTools.debuggerTools.toggleDebugDraw3D');

    extension
      .addAction(
        'ConsoleLog',
        _('Log a message to the console'),
        _("Logs a message to the debugger's console."),
        _(
          'Log message _PARAM0_ of type _PARAM1_ to the console in group _PARAM2_'
        ),
        '',
        'res/actions/bug32.png',
        'res/actions/bug32.png'
      )
      .addParameter('string', 'Message to log', '', false)
      .addParameter(
        'stringWithSelector',
        'Message type',
        '["info", "warning", "error"]',
        true
      )
      .addParameter('string', 'Group of messages', '', true)
      .getCodeExtraInformation()
      .setIncludeFile('Extensions/DebuggerTools/debuggertools.js')
      .setFunctionName('gdjs.evtTools.debuggerTools.log');

    return extension;
  },
  runExtensionSanityTests: function (gd, extension) {
    return [];
  },
};