Skip to content

Commit

Permalink
Background ".sprite" support (#2748)
Browse files Browse the repository at this point in the history 
Backgrounds can now load ".sprite" files for top, middle and bottom images. The current action for any or all of those images can be set via scripting.

Backgrounds are not animated in the editor to prevent inconvenience.

Closes #1089.
  • Loading branch information
@Vankata453
Vankata453 authored Jul 31, 2024
1 parent 7fa1072 commit 1fbfd10
Show file tree
Hide file tree
Showing 4 changed files with 190 additions and 111 deletions.
239 changes: 143 additions & 96 deletions src/object/background.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
#include <simplesquirrel/vm.hpp>

#include "editor/editor.hpp"
#include "sprite/sprite.hpp"
#include "sprite/sprite_manager.hpp"
#include "supertux/d_scope.hpp"
#include "supertux/flip_level_transformer.hpp"
#include "supertux/gameconfig.hpp"
Expand All @@ -31,7 +33,105 @@
#include "util/reader_mapping.hpp"
#include "util/writer.hpp"
#include "video/drawing_context.hpp"
#include "video/surface.hpp"

static const std::unordered_map<std::string, std::string> fallback_paths = {
{"arctis2.png", "antarctic/arctis2.png"},
{"misty_snowhills_small.png", "antarctic/misty_snowhills_small.png"},
{"semi_arctic.jpg", "antarctic/semi_arctic.jpg"},
{"bridgecloud-dark.png", "arctic_bridge/bridgecloud-dark.png"},
{"bridgecloud-light.png", "arctic_bridge/bridgecloud-light.png"},
{"bridgeocean-fade.png", "arctic_bridge/bridgeocean-fade.png"},
{"bridgeocean-nofade.png", "arctic_bridge/bridgeocean-nofade.png"},
{"bridgeocean-original.png", "arctic_bridge/bridgeocean-original.png"},
{"arcticskies1.png", "arcticskies/arcticskies1.png"},
{"arcticskies2.png", "arcticskies/arcticskies2.png"},
{"arcticskies3.png", "arcticskies/arcticskies3.png"},
{"arcticskies35.png", "arcticskies/arcticskies35.png"},
{"arcticskies4.png", "arcticskies/arcticskies4.png"},
{"block-snow-background.png", "block_snow/block-snow-background.png"},
{"block-snow-midground.png", "block_snow/block-snow-midground.png"},
{"block-snow-top.png", "block_snow/block-snow-top.png"},
{"bluemountain-bottom.png", "bluemountain/bluemountain-bottom.png"},
{"bluemountain-middle.png", "bluemountain/bluemountain-middle.png"},
{"bluemountain-top.png", "bluemountain/bluemountain-top.png"},
{"bluemountain2.png", "bluemountain/bluemountain2.png"},
{"castle_foreground.png", "castle/castle_foreground.png"},
{"snowcastle.png", "castle/snowcastle.png"},
{"cloud-mountains-background.png", "cloud_mountains/cloud-mountains-background.png"},
{"cloud-mountains-bottom.png", "cloud_mountains/cloud-mountains-bottom.png"},
{"cloud-mountains-forground.png", "cloud_mountains/cloud-mountains-forground.png"},
{"cloud-mountains-midground.png", "cloud_mountains/cloud-mountains-midground.png"},
{"dawn_hill_para_blur.png", "forest/dawn_hill_para_blur.png"},
{"forest2_para.png", "forest/forest2_para.png"},
{"forest_para2.png", "forest/forest_para2.png"},
{"forest_para3.png", "forest/forest_para3.png"},
{"forest_para3_bottom.png", "forest/forest_para3_bottom.png"},
{"nighthills.png", "forest/nighthills.png"},
{"ghostforest.jpg", "ghostforest/ghostforest.jpg"},
{"ghostforest_grave.png", "ghostforest/ghostforest_grave.png"},
{"ghostforest_para.png", "ghostforest/ghostforest_para.png"},
{"cave2.jpg", "ice_cave/cave2.jpg"},
{"darkcave-background.png", "ice_cave/darkcave-background.png"},
{"darkcave-middle.png", "ice_cave/darkcave-middle.png"},
{"darkcave-preview.png", "ice_cave/darkcave-preview.png"},
{"darkcave-top_and_bottom.png", "ice_cave/darkcave-top_and_bottom.png"},
{"darkcavemidground-middle.png", "ice_cave/darkcavemidground-middle.png"},
{"darkcavemidground-top_and_bottom.png", "ice_cave/darkcavemidground-top_and_bottom.png"},
{"black_800px.png", "misc/black_800px.png"},
{"fog.png", "misc/fog.png"},
{"grid.png", "misc/grid.png"},
{"grid.surface", "misc/grid.surface"},
{"heatshimmer-displacement.png", "misc/heatshimmer-displacement.png"},
{"heatshimmer.png", "misc/heatshimmer.png"},
{"heatshimmer.surface", "misc/heatshimmer.surface"},
{"leaves.png", "misc/leaves.png"},
{"oiltux.jpg", "misc/oiltux.jpg"},
{"transparent_up.png", "misc/transparent_up.png"},
{"nightsky.png", "nightsky/nightsky.png"},
{"nightsky_bottom.png", "nightsky/nightsky_bottom.png"},
{"nightsky_middle.png", "nightsky/nightsky_middle.png"},
{"nightsky_para.png", "nightsky/nightsky_para.png"},
{"nightsky_top.png", "nightsky/nightsky_top.png"},
};

static SpritePtr load_background_sprite(const std::string& image_path)
{
if (image_path.empty())
return nullptr;

if (PHYSFS_exists(image_path.c_str()))
// No need to search fallback paths.
return SpriteManager::current()->create(image_path);

// Search for a fallback image in fallback_paths.
static const std::string default_dir = "images/background/";
static const std::string default_dir2 = "/images/background/";
std::string new_path = image_path;
if (image_path.substr(0, default_dir.length()) == default_dir)
new_path.erase(0, default_dir.length());
else if (image_path.substr(0, default_dir2.length()) == default_dir2)
new_path.erase(0, default_dir2.length());

auto it = fallback_paths.find(new_path);
if (it == fallback_paths.end())
// Unknown image, try checking for a ".deprecated" version, or use the dummy texture.
return SpriteManager::current()->create(image_path);

new_path = default_dir + it->second;
return SpriteManager::current()->create(new_path);
}

static SpritePtr load_background(const std::string& image_path)
{
SpritePtr sprite = load_background_sprite(image_path);
if (!sprite) return nullptr;

if (Editor::is_active())
sprite->pause_animation();

return sprite;
}


Background::Background() :
m_alignment(NO_ALIGNMENT),
Expand Down Expand Up @@ -193,9 +293,9 @@ Background::get_settings()
result.add_float(_("Scroll speed y"), &m_scroll_speed.y, "scroll-speed-y", 0.0f);
result.add_float(_("Parallax Speed x"), &m_parallax_speed.x, "speed", std::nullopt);
result.add_float(_("Parallax Speed y"), &m_parallax_speed.y, "speed-y", m_parallax_speed.x);
result.add_surface(_("Top image"), &m_imagefile_top, "image-top", "");
result.add_surface(_("Image"), &m_imagefile, "image");
result.add_surface(_("Bottom image"), &m_imagefile_bottom, "image-bottom", "");
result.add_sprite(_("Top image"), &m_imagefile_top, "image-top", "");
result.add_sprite(_("Image"), &m_imagefile, "image");
result.add_sprite(_("Bottom image"), &m_imagefile_bottom, "image-bottom", "");
result.add_rgba(_("Colour"), &m_color, "color");
result.add_enum(_("Draw target"), reinterpret_cast<int*>(&m_target),
{_("Normal"), _("Lightmap")},
Expand Down Expand Up @@ -334,13 +434,16 @@ Background::draw_image(DrawingContext& context, const Vector& pos_)

Canvas& canvas = context.get_canvas(m_target);

m_image->set_color(m_color);
m_image->set_blend(m_blend);

if (m_fill)
{
Rectf dstrect(Vector(pos_.x - context.get_width() / 2.0f,
pos_.y - context.get_height() / 2.0f),
Sizef(context.get_width(),
context.get_height()));
canvas.draw_surface_scaled(m_image, dstrect, m_layer);
m_image->draw_scaled(canvas, dstrect, m_layer);
}
else
{
Expand All @@ -351,7 +454,7 @@ Background::draw_image(DrawingContext& context, const Vector& pos_)
{
Vector p(pos_.x - parallax_image_size.width / 2.0f,
pos_.y + static_cast<float>(y) * img_h - img_h_2);
canvas.draw_surface(m_image, p, 0.f, m_color, m_blend, m_layer);
m_image->draw(canvas, p, m_layer);
}
break;

Expand All @@ -360,7 +463,7 @@ Background::draw_image(DrawingContext& context, const Vector& pos_)
{
Vector p(pos_.x + parallax_image_size.width / 2.0f - img_w,
pos_.y + static_cast<float>(y) * img_h - img_h_2);
canvas.draw_surface(m_image, p, 0.f, m_color, m_blend, m_layer);
m_image->draw(canvas, p, m_layer);
}
break;

Expand All @@ -369,7 +472,7 @@ Background::draw_image(DrawingContext& context, const Vector& pos_)
{
Vector p(pos_.x + static_cast<float>(x) * img_w - img_w_2,
pos_.y - parallax_image_size.height / 2.0f);
canvas.draw_surface(m_image, p, 0.f, m_color, m_blend, m_layer);
m_image->draw(canvas, p, m_layer);
}
break;

Expand All @@ -378,7 +481,7 @@ Background::draw_image(DrawingContext& context, const Vector& pos_)
{
Vector p(pos_.x + static_cast<float>(x) * img_w - img_w_2,
pos_.y - img_h + parallax_image_size.height / 2.0f);
canvas.draw_surface(m_image, p, 0.f, m_color, m_blend, m_layer);
m_image->draw(canvas, p, m_layer);
}
break;

Expand All @@ -391,15 +494,21 @@ Background::draw_image(DrawingContext& context, const Vector& pos_)

if (m_image_top && (y < 0))
{
canvas.draw_surface(m_image_top, p, 0.f, m_color, m_blend, m_layer);
m_image_top->set_color(m_color);
m_image_top->set_blend(m_blend);

m_image_top->draw(canvas, p, m_layer);
}
else if (m_image_bottom && (y > 0))
{
canvas.draw_surface(m_image_bottom, p, 0.f, m_color, m_blend, m_layer);
m_image_bottom->set_color(m_color);
m_image_bottom->set_blend(m_blend);

m_image_bottom->draw(canvas, p, m_layer);
}
else
{
canvas.draw_surface(m_image, p, 0.f, m_color, m_blend, m_layer);
m_image->draw(canvas, p, m_layer);
}
}
break;
Expand Down Expand Up @@ -438,94 +547,32 @@ Background::draw(DrawingContext& context)
context.pop_transform();
}

namespace {
std::unordered_map<std::string, std::string> fallback_paths = {
{"arctis2.png", "antarctic/arctis2.png"},
{"misty_snowhills_small.png", "antarctic/misty_snowhills_small.png"},
{"semi_arctic.jpg", "antarctic/semi_arctic.jpg"},
{"bridgecloud-dark.png", "arctic_bridge/bridgecloud-dark.png"},
{"bridgecloud-light.png", "arctic_bridge/bridgecloud-light.png"},
{"bridgeocean-fade.png", "arctic_bridge/bridgeocean-fade.png"},
{"bridgeocean-nofade.png", "arctic_bridge/bridgeocean-nofade.png"},
{"bridgeocean-original.png", "arctic_bridge/bridgeocean-original.png"},
{"arcticskies1.png", "arcticskies/arcticskies1.png"},
{"arcticskies2.png", "arcticskies/arcticskies2.png"},
{"arcticskies3.png", "arcticskies/arcticskies3.png"},
{"arcticskies35.png", "arcticskies/arcticskies35.png"},
{"arcticskies4.png", "arcticskies/arcticskies4.png"},
{"block-snow-background.png", "block_snow/block-snow-background.png"},
{"block-snow-midground.png", "block_snow/block-snow-midground.png"},
{"block-snow-top.png", "block_snow/block-snow-top.png"},
{"bluemountain-bottom.png", "bluemountain/bluemountain-bottom.png"},
{"bluemountain-middle.png", "bluemountain/bluemountain-middle.png"},
{"bluemountain-top.png", "bluemountain/bluemountain-top.png"},
{"bluemountain2.png", "bluemountain/bluemountain2.png"},
{"castle_foreground.png", "castle/castle_foreground.png"},
{"snowcastle.png", "castle/snowcastle.png"},
{"cloud-mountains-background.png", "cloud_mountains/cloud-mountains-background.png"},
{"cloud-mountains-bottom.png", "cloud_mountains/cloud-mountains-bottom.png"},
{"cloud-mountains-forground.png", "cloud_mountains/cloud-mountains-forground.png"},
{"cloud-mountains-midground.png", "cloud_mountains/cloud-mountains-midground.png"},
{"dawn_hill_para_blur.png", "forest/dawn_hill_para_blur.png"},
{"forest2_para.png", "forest/forest2_para.png"},
{"forest_para2.png", "forest/forest_para2.png"},
{"forest_para3.png", "forest/forest_para3.png"},
{"forest_para3_bottom.png", "forest/forest_para3_bottom.png"},
{"nighthills.png", "forest/nighthills.png"},
{"ghostforest.jpg", "ghostforest/ghostforest.jpg"},
{"ghostforest_grave.png", "ghostforest/ghostforest_grave.png"},
{"ghostforest_para.png", "ghostforest/ghostforest_para.png"},
{"cave2.jpg", "ice_cave/cave2.jpg"},
{"darkcave-background.png", "ice_cave/darkcave-background.png"},
{"darkcave-middle.png", "ice_cave/darkcave-middle.png"},
{"darkcave-preview.png", "ice_cave/darkcave-preview.png"},
{"darkcave-top_and_bottom.png", "ice_cave/darkcave-top_and_bottom.png"},
{"darkcavemidground-middle.png", "ice_cave/darkcavemidground-middle.png"},
{"darkcavemidground-top_and_bottom.png", "ice_cave/darkcavemidground-top_and_bottom.png"},
{"black_800px.png", "misc/black_800px.png"},
{"fog.png", "misc/fog.png"},
{"grid.png", "misc/grid.png"},
{"grid.surface", "misc/grid.surface"},
{"heatshimmer-displacement.png", "misc/heatshimmer-displacement.png"},
{"heatshimmer.png", "misc/heatshimmer.png"},
{"heatshimmer.surface", "misc/heatshimmer.surface"},
{"leaves.png", "misc/leaves.png"},
{"oiltux.jpg", "misc/oiltux.jpg"},
{"transparent_up.png", "misc/transparent_up.png"},
{"nightsky.png", "nightsky/nightsky.png"},
{"nightsky_bottom.png", "nightsky/nightsky_bottom.png"},
{"nightsky_middle.png", "nightsky/nightsky_middle.png"},
{"nightsky_para.png", "nightsky/nightsky_para.png"},
{"nightsky_top.png", "nightsky/nightsky_top.png"},
};

} // namespace

SurfacePtr
Background::load_background(const std::string& image_path)
void
Background::set_top_image_action(const std::string& action)
{
if (image_path.empty())
return nullptr;
if (m_image_top)
m_image_top->set_action(action);
}

if (PHYSFS_exists(image_path.c_str()))
// No need to search fallback paths.
return Surface::from_file(image_path);
void
Background::set_image_action(const std::string& action)
{
m_image->set_action(action);
}

// Search for a fallback image in fallback_paths.
const std::string& default_dir = "images/background/";
const std::string& default_dir2 = "/images/background/";
std::string new_path = image_path;
if (image_path.substr(0, default_dir.length()) == default_dir)
new_path.erase(0, default_dir.length());
else if (image_path.substr(0, default_dir2.length()) == default_dir2)
new_path.erase(0, default_dir2.length());
auto it = fallback_paths.find(new_path);
if (it == fallback_paths.end())
// Unknown image, let the texture manager select the dummy texture.
return Surface::from_file(image_path);
void
Background::set_bottom_image_action(const std::string& action)
{
if (m_image_bottom)
m_image_bottom->set_action(action);
}

new_path = default_dir + it->second;
return Surface::from_file(new_path);
void
Background::set_all_image_actions(const std::string& action)
{
set_top_image_action(action);
set_image_action(action);
set_bottom_image_action(action);
}

void
Expand Down
31 changes: 24 additions & 7 deletions src/object/background.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@
#define HEADER_SUPERTUX_OBJECT_BACKGROUND_HPP

#include "math/vector.hpp"
#include "sprite/sprite_ptr.hpp"
#include "supertux/game_object.hpp"
#include "supertux/timer.hpp"
#include "video/blend.hpp"
#include "video/drawing_context.hpp"
#include "video/flip.hpp"
#include "video/surface_ptr.hpp"

class ReaderMapping;

Expand Down Expand Up @@ -131,6 +131,26 @@ class Background final : public GameObject
* @param float $time
*/
void fade_color(float red, float green, float blue, float alpha, float time);
/**
* Sets the sprite action for the top image.
* @param string $action
*/
void set_top_image_action(const std::string& action);
/**
* Sets the sprite action for the main (middle) image.
* @param string $action
*/
void set_image_action(const std::string& action);
/**
* Sets the sprite action for the bottom image.
* @param string $action
*/
void set_bottom_image_action(const std::string& action);
/**
* Sets the sprite action for all images (top, middle and bottom).
* @param string $action
*/
void set_all_image_actions(const std::string& action);

private:
enum Alignment {
Expand All @@ -141,9 +161,6 @@ class Background final : public GameObject
BOTTOM_ALIGNMENT
};

private:
SurfacePtr load_background(const std::string& image_path);

private:
/** Backgrounds with NO_ALIGNMENT are repeated over the whole
screen, backgrounds with left, right, top, bottom alignment are
Expand All @@ -163,9 +180,9 @@ class Background final : public GameObject
Vector m_parallax_speed;
Vector m_scroll_speed;
Vector m_scroll_offset;
SurfacePtr m_image_top; /**< image to draw above pos */
SurfacePtr m_image; /**< image to draw, anchored at pos */
SurfacePtr m_image_bottom; /**< image to draw below pos+screenheight */
SpritePtr m_image_top; /**< image to draw above pos */
SpritePtr m_image; /**< image to draw, anchored at pos */
SpritePtr m_image_bottom; /**< image to draw below pos+screenheight */

Blend m_blend;
Color m_color;
Expand Down
Loading

0 comments on commit 1fbfd10

Please sign in to comment.