GDevelop/Extensions/PanelSpriteObject/Extension.cpp

/**

GDevelop - Panel Sprite Extension
Copyright (c) 2012-2016 Victor Levasseur (victorlevasseur01@orange.fr)
This project is released under the MIT License.
*/
/**
 * Contributors to the extension:
 * Florian Rival ( Minor changes and adaptations )
 */

#include "GDCore/Extensions/PlatformExtension.h"
#include "GDCore/Tools/Localization.h"
#include "PanelSpriteObject.h"

void DeclarePanelSpriteObjectExtension(gd::PlatformExtension& extension) {
  extension
      .SetExtensionInformation(
          "PanelSpriteObject",
          _("Panel Sprite (9-patch) Object"),
          "Panel Sprite, also called 9-patch, is an object showing an image "
          "that can be resized by stretching or repeating the edges and "
          "corners as well as the filling.",
          "Victor Levasseur and Florian Rival",
          "Open source (MIT License)")
      .SetShortDescription("9-patch/panel sprite: image with stretched/tiled edges and corners for resizable UI elements.")
      .SetDimension("2D")
      .SetExtensionHelpPath("/objects/panel_sprite");
  extension
      .AddInstructionOrExpressionGroupMetadata(
          _("Panel Sprite (9-patch) Object"))
      .SetIcon("CppPlatform/Extensions/PanelSpriteIcon.png");

  gd::ObjectMetadata& obj =
      extension
          .AddObject<PanelSpriteObject>(
              "PanelSprite",
              _("Panel Sprite (\"9-patch\")"),
              _("An image with edges and corners that are stretched separately "
                "from "
                "the full image."),
              "CppPlatform/Extensions/PanelSpriteIcon.png")
          .SetCategory("General")
          .AddDefaultBehavior("EffectCapability::EffectBehavior")
          .AddDefaultBehavior("ResizableCapability::ResizableBehavior")
          .AddDefaultBehavior("OpacityCapability::OpacityBehavior");

  // Deprecated
  obj.AddCondition("Opacity",
                   _("Opacity"),
                   _("Compare the opacity of a Panel Sprite, between 0 (fully "
                     "transparent) to 255 (opaque)."),
                   _("the opacity"),
                   _("Visibility"),
                   "res/conditions/opacity24.png",
                   "res/conditions/opacity.png")

      .AddParameter("object", _("Object"), "PanelSprite")
      .UseStandardRelationalOperatorParameters(
          "number",
          gd::ParameterOptions::MakeNewOptions().SetDescription(
              _("Opacity to compare to (0-255)")))
      .SetHidden();

  // Deprecated
  obj.AddAction(
         "SetOpacity",
         _("Change Panel Sprite opacity"),
         _("Change the opacity of a Panel Sprite. 0 is fully transparent, 255 "
           "is opaque (default)."),
         _("the opacity"),
         _("Visibility"),
         "res/actions/opacity24.png",
         "res/actions/opacity.png")

      .AddParameter("object", _("Object"), "PanelSprite")
      .UseStandardOperatorParameters(
          "number",
          gd::ParameterOptions::MakeNewOptions().SetDescription(
              _("Opacity (0-255)")))
      .SetHidden();

  // Deprecated
  obj.AddExpression("Opacity",
                    _("Opacity"),
                    _("Opacity"),
                    _("Visibility"),
                    "res/actions/opacity.png")
      .AddParameter("object", _("Panel Sprite"), "PanelSprite")
      .SetHidden();

  obj.AddAction(
         "SetColor",
         _("Tint color"),
         _("Change the tint of a Panel Sprite. The default color is white."),
         _("Change tint of _PARAM0_ to _PARAM1_"),
         _("Effects"),
         "res/actions/color24.png",
         "res/actions/color.png")

      .AddParameter("object", _("Object"), "PanelSprite")
      .AddParameter("color", _("Tint"));

  // Deprecated
  obj.AddAction("Width",
                _("Width"),
                _("Modify the width of a Panel Sprite."),
                _("the width"),
                _("Size and angle"),
                "res/actions/scaleWidth24_black.png",
                "res/actions/scaleWidth_black.png")

      .AddParameter("object", _("Object"), "PanelSprite")
      .UseStandardOperatorParameters("number",
                                     gd::ParameterOptions::MakeNewOptions())
      .SetHidden()
      .SetFunctionName("SetWidth")
      .SetGetter("GetWidth");

  // Deprecated
  obj.AddCondition("Width",
                   _("Width"),
                   _("Check the width of a Panel Sprite."),
                   _("the width"),
                   _("Size and angle"),
                   "res/conditions/scaleWidth24_black.png",
                   "res/conditions/scaleWidth_black.png")

      .AddParameter("object", _("Object"), "PanelSprite")
      .UseStandardRelationalOperatorParameters(
          "number", gd::ParameterOptions::MakeNewOptions())
      .SetHidden()
      .SetFunctionName("GetWidth");

  // Deprecated
  obj.AddAction("Height",
                _("Height"),
                _("Modify the height of a Panel Sprite."),
                _("the height"),
                _("Size and angle"),
                "res/actions/scaleHeight24_black.png",
                "res/actions/scaleHeight_black.png")

      .AddParameter("object", _("Object"), "PanelSprite")
      .UseStandardOperatorParameters("number",
                                     gd::ParameterOptions::MakeNewOptions())
      .SetHidden()
      .SetFunctionName("SetHeight")
      .SetGetter("GetHeight");

  // Deprecated
  obj.AddCondition("Height",
                   _("Height"),
                   _("Check the height of a Panel Sprite."),
                   _("the height"),
                   _("Size and angle"),
                   "res/conditions/scaleHeight24_black.png",
                   "res/conditions/scaleHeight_black.png")

      .AddParameter("object", _("Object"), "PanelSprite")
      .UseStandardRelationalOperatorParameters(
          "number", gd::ParameterOptions::MakeNewOptions())
      .SetHidden()
      .SetFunctionName("SetHeight")
      .SetGetter("GetHeight");

  obj.AddAction("Angle",
                "Angle",
                "Modify the angle of a Panel Sprite.",
                "the angle",
                _("Size and angle"),
                "res/actions/rotate24_black.png",
                "res/actions/rotate_black.png")

      .SetHidden()  // Deprecated
      .AddParameter("object", _("Object"), "PanelSprite")
      .UseStandardOperatorParameters(
          "number",
          gd::ParameterOptions::MakeNewOptions().SetDescription(
              _("Angle (in degrees)")))
      .SetFunctionName("SetAngle")
      .SetGetter("GetAngle");

  obj.AddCondition("Angle",
                   "Angle",
                   "Check the angle of a Panel Sprite.",
                   "the angle",
                   _("Size and angle"),
                   "res/conditions/rotate24_black.png",
                   "res/conditions/rotate_black.png")

      .SetHidden()  // Deprecated
      .AddParameter("object", _("Object"), "PanelSprite")
      .UseStandardRelationalOperatorParameters(
          "number",
          gd::ParameterOptions::MakeNewOptions().SetDescription(
              _("Angle to compare to (in degrees)")))
      .SetFunctionName("SetAngle")
      .SetGetter("GetAngle");

  // Deprecated
  obj.AddAction("Image",
                _("Image name (deprecated)"),
                _("Change the image of a Panel Sprite."),
                _("Set image _PARAM1_ on _PARAM0_"),
                _("Image"),
                "res/imageicon24.png",
                "res/imageicon.png")
      .AddParameter("object", _("Object"), "PanelSprite")
      .AddParameter("string", _("Image name"))
      .AddCodeOnlyParameter("currentScene", "0")
      .SetHidden()
      .SetFunctionName("ChangeAndReloadImage");

  obj.AddAction("SetImageFromResource",
                _("Image name"),
                _("Change the image of a Panel Sprite."),
                _("Set image _PARAM1_ on _PARAM0_"),
                _("Image"),
                "res/imageicon24.png",
                "res/imageicon.png")
      .AddParameter("object", _("Object"), "PanelSprite")
      .AddParameter("imageResource", _("Image file (or image resource name)"))
      .AddCodeOnlyParameter("currentScene", "0")
      .SetFunctionName("ChangeAndReloadImage");
}