Editor comment (#3181)

The editor comment allows level designers to leave a note for themselves or other level designers collaborating on the same level. Similar to a code comment, it can be used to write to-do lists, fixmes, or notes.

This feature supports info box formatting, like what you'd see in the info block or the text scroller.

Author: MatusGuy

data/images/engine/editor/editor-comment.png

@@ -177,7 +177,7 @@
     (icon "images/engine/editor/stalactite_ice_yeti.png"))
   (object
     (class "dart")
-    (icon "images/creatures/darttrap/granito/root_dart_left.png"))
+    (icon "images/creatures/darttrap/granito/root_dart_left.png"))
   (object
     (class "bigsnowball")
     (icon "images/objects/big_snowball/big_snowball.png"))
@@ -339,6 +339,9 @@
   (object
     (class "text-area")
     (icon "images/engine/editor/textarray.png"))
+  (object
+    (class "editor-comment")
+    (icon "images/engine/editor/editor-comment.png"))
  )
 
  (layers

data/images/engine/editor/objects.stoi

@@ -0,0 +1,121 @@
+//  SuperTux
+//  Copyright (C) 2025 MatusGuy <[email protected]>
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+#include "editor_comment.hpp"
+
+#include "editor/editor.hpp"
+#include "supertux/info_box_line.hpp"
+#include "util/reader_mapping.hpp"
+#include "video/drawing_context.hpp"
+
+EditorComment::EditorComment(const ReaderMapping& reader):
+  MovingObject(reader),
+  m_comment(""),
+  m_lines()
+{
+  parse_type(reader);
+
+  float w,h;
+  reader.get("width", w, 32.f * 3);
+  reader.get("height", h, 32.f * 3);
+  m_col.m_bbox.set_size(w, h);
+
+  reader.get("comment", m_comment);
+  refresh_comment();
+}
+
+void
+EditorComment::draw(DrawingContext& context)
+{
+  // TODO: There should be an object factory param
+  // for objects that only exist when testing in editor.
+  if (!Editor::current())
+    return;
+
+  float y = get_y();
+  for (std::unique_ptr<InfoBoxLine>& line : m_lines)
+  {
+    if (y >= get_bbox().get_bottom())
+      break;
+
+    line->draw(context, Rectf(Vector(get_x(), y), Sizef(get_width() / 2, y)), get_layer() + 1, InfoBoxLine::LEFT);
+    y += line->get_height();
+  }
+
+  context.color().draw_filled_rect(get_bbox(), get_color(), 0.f, get_layer());
+}
+
+void
+EditorComment::check_state()
+{
+  refresh_comment();
+}
+
+GameObjectTypes
+EditorComment::get_types() const
+{
+  return {
+    /* l10n: A note refers to a reminder left for future
+       level designers to read in order to better understand
+       the usage of certain features in a level, for example. */
+    { "note", _("Note") },
+
+    /* l10n: A to-do refers to a reminder left for the
+       author of the comment to finish designing something in
+       a level. */
+    { "todo", _("To-do") },
+
+    /* l10n: A fix-me refers to a reminder left for the
+       author of the comment to fix a flaw with the level
+       design. */
+    { "fixme", _("Fix-me") },
+
+    /* l10n: A hack refers to usage of an unintended or
+       non-ideal way of implementing a level design idea. */
+    { "hack", _("Hack") }
+  };
+}
+
+ObjectSettings
+EditorComment::get_settings()
+{
+  ObjectSettings result = MovingObject::get_settings();
+
+  result.add_multiline_text(_("Comment"), &m_comment, "comment");
+
+  return result;
+}
+
+void
+EditorComment::refresh_comment()
+{
+  m_lines = InfoBoxLine::split(m_comment, get_width(), true);
+}
+
+Color
+EditorComment::get_color() const
+{
+  switch (m_type)
+  {
+    case NOTE: return Color(0.19f, 0.65f, 0.32f, 0.6f);
+    case TODO: return Color(0.26f, 0.53f, 0.96f, 0.6f);
+    case FIXME: return Color(1.f, 0.44f, 0.11f, 0.6f);
+    case HACK: return Color(0.96f, 0.23f, 0.23f, 0.6f);
+    default: return Color();
+  }
+}
+
+/* EOF */

src/editor/editor_comment.cpp

@@ -0,0 +1,70 @@
+//  SuperTux
+//  Copyright (C) 2025 MatusGuy <[email protected]>
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+#ifndef HEADER_SUPERTUX_EDITOR_EDITOR_COMMENT_HPP
+#define HEADER_SUPERTUX_EDITOR_EDITOR_COMMENT_HPP
+
+#include "supertux/moving_object.hpp"
+#include "video/layer.hpp"
+
+class ReaderMapping;
+class InfoBoxLine;
+
+class EditorComment : public MovingObject
+{
+public:
+  enum Type
+  {
+    NOTE,
+    TODO,
+    FIXME,
+    HACK
+  };
+
+public:
+  EditorComment(const ReaderMapping& reader);
+
+  virtual void draw(DrawingContext& context) override;
+  virtual void update(float dt_sec) override { MovingObject::update(dt_sec); }
+  virtual HitResponse collision(MovingObject&, const CollisionHit&) override { return ABORT_MOVE; }
+  virtual void check_state() override;
+
+  virtual bool has_variable_size() const override { return true; }
+  static std::string class_name() { return "editor-comment"; }
+  virtual std::string get_class_name() const override { return class_name(); }
+  static std::string display_name() { return _("Editor Comment"); }
+  virtual std::string get_display_name() const override { return display_name(); }
+  virtual GameObjectClasses get_class_types() const override { return MovingObject::get_class_types().add(typeid(EditorComment)); }
+
+  virtual GameObjectTypes get_types() const override;
+  virtual ObjectSettings get_settings() override;
+
+  virtual int get_layer() const override { return LAYER_FOREGROUND1 - 5; }
+
+private:
+  void refresh_comment();
+  Color get_color() const;
+
+private:
+  std::string m_comment;
+  std::vector<std::unique_ptr<InfoBoxLine>> m_lines;
+
+private:
+  EditorComment(const EditorComment&) = delete;
+  EditorComment& operator=(const EditorComment&) = delete;
+};
+
+#endif // HEADER_SUPERTUX_EDITOR_EDITOR_COMMENT_HPP

src/editor/editor_comment.hpp

@@ -1023,7 +1023,7 @@ EditorOverlayWidget::on_mouse_button_up(const SDL_MouseButtonEvent& button)
 
       m_editor.get_selected_tilemap()->check_state();
     }
-    else if (m_editor.get_tileselect_input_type() == EditorTilebox::InputType::OBJECT)
+    else
     {
       if (m_dragging && m_dragged_object) {
         m_dragged_object->check_state();

src/editor/overlay_widget.cpp

@@ -79,6 +79,7 @@
 #include "badguy/yeti.hpp"
 #include "badguy/yeti_stalactite.hpp"
 #include "badguy/zeekling.hpp"
+#include "editor/editor_comment.hpp"
 #include "math/vector.hpp"
 #include "object/ambient_light.hpp"
 #include "object/ambient_sound.hpp"
@@ -317,6 +318,7 @@ GameObjectFactory::init_factories()
 
   // Editor stuff.
   add_factory<SpawnPointMarker>("spawnpoint");
+  add_factory<EditorComment>("editor-comment");
 
   // Worldmap objects.
   add_factory<worldmap::LevelTile>("level", OBJ_PARAM_WORLDMAP);

src/supertux/game_object_factory.cpp

@@ -102,13 +102,13 @@ InfoBoxLine::InfoBoxLine(char format_char, const std::string& text_) :
 }
 
 std::vector<std::unique_ptr<InfoBoxLine> >
-InfoBoxLine::split(const std::string& text, float width)
+InfoBoxLine::split(const std::string& text, float width, bool small)
 {
   std::vector<std::unique_ptr<InfoBoxLine> > lines;
 
   std::string::size_type i = 0;
   std::string::size_type l;
-  char format_char = '#';
+  char format_char = small ? ' ' : '#';
   while (i < text.size()) {
     // take care of empty lines - represent them as blank lines of normal text
     if (text[i] == '\n') {
@@ -125,7 +125,7 @@ InfoBoxLine::split(const std::string& text, float width)
     }
     else
     {
-      format_char = '#';
+      format_char = small ? ' ' : '#';
     }
     if (i >= text.size()) break;
 
@@ -155,22 +155,50 @@ InfoBoxLine::split(const std::string& text, float width)
   return lines;
 }
 
+Vector
+InfoBoxLine::calc_text_pos(const Rectf& bbox, float textwidth, LineAlignment alignment) const
+{
+  float x = 0.f;
+  switch (alignment)
+  {
+    case LineAlignment::LEFT:
+      x = bbox.get_left();
+      break;
+
+    case LineAlignment::RIGHT:
+      x = bbox.get_right() - textwidth;
+      break;
+
+    case LineAlignment::CENTER:
+      x = ((bbox.get_left() + bbox.get_right()) / 2 - (textwidth / 2));
+      break;
+
+    default:
+      break;
+  }
+
+  return Vector(x, bbox.get_top());
+}
+
 void
 InfoBoxLine::draw(DrawingContext& context, const Rectf& bbox, int layer, LineAlignment alignment)
 {
-  Vector position = bbox.p1();
-  switch (lineType) {
+  Vector pos;
+
+  switch (lineType)
+  {
     case IMAGE:
-      context.color().draw_surface(image, Vector(((bbox.get_left() + bbox.get_right() - static_cast<float>(image->get_width())) * 0.5f)
-        + (static_cast<float>(image->get_width()) * (alignment == LineAlignment::LEFT ? 0.5f : alignment == LineAlignment::RIGHT ? -0.5f : 0.f)), position.y), layer);
+      pos = calc_text_pos(bbox, static_cast<float>(image->get_width()), alignment);
+      context.color().draw_surface(image, pos, layer);
       break;
+
     case NORMAL_LEFT:
-      context.color().draw_text(font, text, Vector(position.x, position.y), ALIGN_LEFT, layer, color);
+      context.color().draw_text(font, text, bbox.p1(), ALIGN_LEFT, layer, color);
       break;
+
     default:
-      context.color().draw_text(font, text, Vector((bbox.get_left() + bbox.get_right()) / 2.f, position.y),
-        alignment == LineAlignment::LEFT ? ALIGN_LEFT :
-        alignment == LineAlignment::RIGHT ? ALIGN_RIGHT : ALIGN_CENTER, layer, color);
+      pos = calc_text_pos(bbox, font->get_text_width(text), alignment);
+      context.color().draw_text(font, text, pos, ALIGN_LEFT, layer, color);
       break;
   }
 }

src/supertux/info_box_line.cpp

@@ -21,6 +21,7 @@
 #include <vector>
 #include <memory>
 
+#include "math/vector.hpp"
 #include "video/color.hpp"
 #include "video/font_ptr.hpp"
 #include "video/surface_ptr.hpp"
@@ -42,7 +43,7 @@ class InfoBoxLine final
   void draw(DrawingContext& context, const Rectf& bbox, int layer, LineAlignment alignment = CENTER);
   float get_height() const;
 
-  static std::vector<std::unique_ptr<InfoBoxLine> > split(const std::string& text, float width);
+  static std::vector<std::unique_ptr<InfoBoxLine>> split(const std::string& text, float width, bool small = false);
 
   static bool is_valid_format_char(char format_char)
   {
@@ -60,6 +61,8 @@ class InfoBoxLine final
     }
   }
 
+private:
+  Vector calc_text_pos(const Rectf& bbox, float textwidth, LineAlignment alignment) const;
 private:
   InfoBoxLine::LineType lineType;
   FontPtr font;