flexlay/supertux/gameobj_factor.py

# Flexlay - A Generic 2D Game Editor
# Copyright (C) 2014 Ingo Ruhnke <grumbel@gmail.com>
#
# 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/>.


from typing import Any, Callable, Optional, Type

import os
import logging
from collections import OrderedDict

from flexlay.object_brush import ObjectBrush
from flexlay.util.config import Config
from flexlay.math import Pointf

from supertux.gameobj import GameObj
from supertux.badguys import badguy_sprites
from supertux.gameobjs import (
    AmbientSound,
    Background,
    BadGuy,
    BonusBlock,
    Camera,
    Candle,
    Climbable,
    Coin,
    DartTrap,
    Decal,
    Dispenser,
    Door,
    Flame,
    GhostFlame,
    Gradient,
    InfoBlock,
    InvisibleWall,
    LevelTime,
    ParticleSystem,
    Platform,
    Powerup,
    Pushbutton,
    ResetPoint,
    ScriptTrigger,
    ScriptedObject,
    SecretArea,
    SequenceTrigger,
    SimpleObject,
    SimpleTileObject,
    SpawnPoint,
    Switch,
    Torch,
    Trampoline,
    Tux,
    WeakBlock,
    WilloWisp,
    Wind,
)
from supertux.worldmap_object import (
    SpecialTile,
    WorldmapLevel,
    WorldmapSpawnpoint,
)
from supertux.sprite import SuperTuxSprite


def format_sprite_name(name: str) -> str:
    """
    sprite_name -> Sprite Name
    """
    name = name.replace("_", " ")
    name = name.title()
    return name


class SuperTuxGameObjFactory:
    """
    identifier: section in the .stl file, used for load and save, most of the time, also for Drag&drop
    sprite: used in the object selection and/or in the ObjMapSpriteObject
    functor: creates the object

    ObjectBrush(sprite, metadata)

    See editor/supertux-editor/LevelObjects/Objects.cs
    """

    def __init__(self) -> None:
        self.objects: OrderedDict[str, tuple[str, Callable[[], GameObj]]] = OrderedDict()
        # List of (identifier, image, tag)
        self.badguys: list[tuple[str, str, Optional[str]]] = []
        self.init_factories()

    def create_gameobj_at(self, identifier: str, pos: Pointf) -> Optional[GameObj]:
        data = self.objects.get(identifier)
        if data is None:
            logging.warning("couldn't create: %r at %s" % (identifier, pos))
            return None
        else:
            _, constructor = data
            obj: GameObj = constructor()
            assert obj.objmap_object is not None
            obj.objmap_object.pos = pos
            return obj

    def create_gameobj(self, identifier: str, sexpr: Any) -> Optional[GameObj]:
        data = self.objects.get(identifier)
        if data is None:
            logging.warning("couldn't create: %r" % identifier)
            return None
        else:
            _, constructor = data
            obj = constructor()
            obj.read(sexpr)
            obj.update()
            return obj

    def create_object_brushes(self) -> list[ObjectBrush]:
        """Creates Object Brushes for each sprite"""

        assert Config.current is not None

        # print("Creating object brushes...")
        brushes = []
        for identifier, (sprite_path, constructor) in self.objects.items():
            if sprite_path is not None:
                supertux_sprite = SuperTuxSprite.from_file(os.path.join(Config.current.datadir, sprite_path))
                assert supertux_sprite is not None
                sprite = supertux_sprite.get_sprite()
                assert sprite is not None
                brush = ObjectBrush(sprite, identifier)
                brushes.append(brush)
        return brushes

    def add_object(self, gameobj_class: Type[GameObj]) -> None:
        assert gameobj_class.identifier is not None
        self.objects[gameobj_class.identifier] = (gameobj_class.sprite, gameobj_class)

    def add_badguy(self, identifier: str, sprite_path: str, tag: Optional[str] = None) -> None:
        assert identifier not in self.objects, f"identifier already present: '{identifier}'"
        self.objects[identifier] = (sprite_path, lambda: BadGuy(identifier, sprite_path))
        if tag:
            self.badguys.append((identifier, sprite_path, tag))
        else:
            self.badguys.append((identifier, sprite_path, None))

    def add_simple_object(self, identifier: str, sprite: str) -> None:
        self.objects[identifier] = (sprite, lambda: SimpleObject(identifier, sprite))

    def add_simple_tile(self, identifier: str, sprite: str) -> None:
        self.objects[identifier] = (sprite, lambda: SimpleTileObject(identifier, sprite))

    def add_particle_system(self, identifier: str, sprite: str, kind: str) -> None:
        self.objects[identifier] = (sprite, lambda: ParticleSystem(kind, sprite))

    def init_factories(self) -> None:
        self.add_simple_object("point", "images/engine/editor/point.png")
        self.add_simple_object("rock", "images/tiles/blocks/block11.png")
        self.add_simple_object("heavycoin", "images/objects/coin/heavy_coin.png")

        self.add_simple_tile("unstable_tile", "images/objects/unstable_tile/crumbling-1.png")

        self.add_object(AmbientSound)
        self.add_object(Background)
        self.add_object(Camera)
        self.add_object(Coin)
        self.add_object(Decal)
        self.add_object(Dispenser)
        self.add_object(SequenceTrigger)
        self.add_object(ScriptTrigger)

        self.add_object(BonusBlock)
        self.add_object(Candle)
        self.add_object(DartTrap)
        self.add_object(Door)
        self.add_object(GhostFlame)
        self.add_object(Flame)
        self.add_object(Gradient)
        self.add_object(InfoBlock)
        self.add_object(InvisibleWall)
        self.add_object(LevelTime)
        self.add_object(Platform)
        self.add_object(Powerup)
        self.add_object(Pushbutton)
        self.add_object(ResetPoint)
        self.add_object(ScriptedObject)
        self.add_object(Climbable)
        self.add_object(SecretArea)
        self.add_object(SpawnPoint)
        self.add_object(Switch)
        self.add_object(Torch)
        self.add_object(Tux)
        self.add_object(Trampoline)
        self.add_object(WeakBlock)
        self.add_object(WilloWisp)
        self.add_object(Wind)

        self.add_object(WorldmapLevel)
        self.add_object(WorldmapSpawnpoint)
        self.add_object(SpecialTile)

        for identifier, sprite_path in badguy_sprites:
            self.add_badguy(identifier, sprite_path)

        self.add_particle_system("particles-clouds", "images/engine/editor/clouds.png", "clouds")
        self.add_particle_system("particles-rain", "images/engine/editor/rain.png", "rain")
        self.add_particle_system("particles-snow", "images/engine/editor/snow.png", "snow")


supertux_gameobj_factory = SuperTuxGameObjFactory()


# EOF #