Added signals and enhanced many classes (plus added new icon)

Author: stringfromjava

core/src/main/java/me/stringfromjava/funkin/Funkin.java

@@ -1,15 +1,21 @@
 package me.stringfromjava.funkin;
 
-import aurelienribon.tweenengine.Tween;
 import com.badlogic.gdx.Game;
-import com.badlogic.gdx.graphics.g2d.Sprite;
+import com.badlogic.gdx.Gdx;
+import com.badlogic.gdx.audio.Music;
+import com.badlogic.gdx.audio.Sound;
 import me.stringfromjava.funkin.backend.display.FunkinScreen;
 import me.stringfromjava.funkin.tween.FunkinTween;
+import me.stringfromjava.funkin.util.FunkinSignal;
+import me.stringfromjava.funkin.util.Paths;
+
+import java.util.HashMap;
+import java.util.Map;
 
 /**
  * Global manager and utility class for the game.
  * <p>
- * This is where you want to do the main things, like switching states.
+ * This is where you want to do the main things, like switching screens, playing sounds/music, etc.
  */
 public final class Funkin {
 
@@ -27,6 +33,19 @@ public final class Funkin {
      */
     public static Game game;
 
+    /**
+     * A map containing all sounds that are currently playing.
+     * <p>
+     * The key is the sound's ID (created by libGDX), and the value is the sound itself.
+     * Note that it's not recommended to access this unless you know what you're doing!
+     */
+    public static Map<Long, Sound> soundPool = new HashMap<>();
+
+    /**
+     * The object where the current music being played is stored.
+     */
+    public static Music music = null;
+
     /**
      * Has the global manager been initialized yet?
      */
@@ -59,17 +78,95 @@ public static void initialize(Game gameInstance) {
      * @param screen The new {@code FunkinScreen} to set as the current screen.
      */
     public static void setScreen(FunkinScreen screen) {
+        Signals.preScreenSwitch.dispatch();
         if (!initialized) {
             throw new IllegalStateException("FNF:JE has not been initialized yet!");
         }
         if (screen == null) {
             throw new IllegalArgumentException("Screen cannot be null!");
         }
         if (Funkin.screen != null) {
+            Funkin.screen.hide();
             Funkin.screen.dispose();
         }
         Funkin.screen = screen;
         game.setScreen(screen);
+        Signals.postScreenSwitch.dispatch();
+    }
+
+    /**
+     * Plays a sound. (Duh.)
+     *
+     * @param path The path to play the sound from.
+     * @return The sound instance itself.
+     */
+    public static Sound playSound(String path) {
+        Sound sound = Gdx.audio.newSound(Paths.asset(path));
+        long id = sound.play();
+        if (id != -1) { // libGDX will return -1 if the sound fails to play.
+            soundPool.put(id, sound);
+        }
+        return sound;
+    }
+
+    /**
+     * Plays new music. (Duh.)
+     *
+     * @param path The path to play the music from.
+     * @return The music instance itself.
+     */
+    public static Music playMusic(String path) {
+        return playMusic(path, 1.0f, true);
+    }
+
+    /**
+     * Plays new music. (Duh.)
+     *
+     * @param path   The path to play the music from.
+     * @param volume The volume to play the music at.
+     * @return The music instance itself.
+     */
+    public static Music playMusic(String path, float volume) {
+        return playMusic(path, volume, true);
+    }
+
+    /**
+     * Plays new music. (Duh.)
+     *
+     * @param path   The path to play the music from.
+     * @param volume The volume to play the music at.
+     * @param looped Should the music loop when it is finished playing?
+     * @return The music instance itself.
+     */
+    public static Music playMusic(String path, float volume, boolean looped) {
+        Music music = Gdx.audio.newMusic(Paths.asset(path));
+        if (Funkin.music != null && Funkin.music.isPlaying()) {
+            Funkin.music.stop();
+        }
+        Funkin.music = music;
+        music.setVolume(volume);
+        music.setLooping(looped);
+        music.play();
+        return music;
+    }
+
+    /**
+     * Contains all the global events that get dispatched when something happens in the game.
+     * <p>
+     * This includes anything from the screen being switched, the game updating every frame, and
+     * just about everything you can think of.
+     */
+    public static class Signals {
+
+        public static final FunkinSignal preRender = new FunkinSignal();
+        public static final FunkinSignal postRender = new FunkinSignal();
+        public static final FunkinSignal preScreenSwitch = new FunkinSignal();
+        public static final FunkinSignal postScreenSwitch = new FunkinSignal();
+        public static final FunkinSignal preGameClose = new FunkinSignal();
+        public static final FunkinSignal postGameClose = new FunkinSignal();
+
+        private Signals() {
+        }
     }
 
     private Funkin() {

core/src/main/java/me/stringfromjava/funkin/FunkinGame.java

@@ -0,0 +1,59 @@
+package me.stringfromjava.funkin;
+
+import com.badlogic.gdx.Game;
+import com.badlogic.gdx.Gdx;
+import com.badlogic.gdx.audio.Sound;
+import me.stringfromjava.funkin.backend.display.cache.TextureCache;
+import me.stringfromjava.funkin.game.InitScreen;
+import me.stringfromjava.funkin.tween.FunkinTween;
+
+/**
+ * An enhanced version of libGDX's {@link Game} object.
+ * <p>
+ * If you want to change what happens to the pre and window
+ * configurations, you might want to see {@link me.stringfromjava.funkin.lwjgl3.Lwjgl3Launcher} in the
+ * {@code lwjgl3} folder.
+ */
+public class FunkinGame extends Game {
+
+    @Override
+    public void create() {
+        setScreen(new InitScreen());
+    }
+
+    @Override
+    public void render() {
+        super.render();
+        Funkin.Signals.preRender.dispatch();
+
+        float delta = Gdx.graphics.getDeltaTime();
+        FunkinTween.globalManager.update(delta);
+
+        Funkin.Signals.postRender.dispatch();
+    }
+
+    @Override
+    public void dispose() {
+        Funkin.Signals.preGameClose.dispatch();
+
+        TextureCache.dispose();
+
+        // Dispose of all sounds and the music (if there is any playing).
+        if (Funkin.music != null) {
+            Funkin.music.stop();
+            Funkin.music.dispose();
+        }
+
+        var soundPoolKeys = Funkin.soundPool.keySet();
+        for (long key : soundPoolKeys) {
+            Sound sound = Funkin.soundPool.get(key);
+            if (sound == null) {
+                continue;
+            }
+            sound.stop();
+            sound.dispose();
+        }
+
+        Funkin.Signals.postGameClose.dispatch();
+    }
+}

core/src/main/java/me/stringfromjava/funkin/Main.java

@@ -1,6 +1,6 @@
 package me.stringfromjava.funkin.backend.display;
 
-import aurelienribon.tweenengine.TweenManager;
+import com.badlogic.gdx.Screen;
 import com.badlogic.gdx.graphics.Color;
 import com.badlogic.gdx.graphics.OrthographicCamera;
 import com.badlogic.gdx.graphics.Texture;
@@ -18,13 +18,7 @@
  * Base class for creating a better screen display
  * with more functionality than the default {@link com.badlogic.gdx.Screen} interface.
  */
-public abstract class FunkinScreen implements com.badlogic.gdx.Screen {
-
-    /**
-     * The {@link TweenManager} used for
-     * adding nice transitions (mainly for sprites).
-     */
-    protected TweenManager tweenManager;
+public abstract class FunkinScreen implements Screen {
 
     /**
      * The {@link SpriteBatch} used to render
@@ -52,7 +46,6 @@ public abstract class FunkinScreen implements com.badlogic.gdx.Screen {
 
     @Override
     public void show() {
-        tweenManager = new TweenManager();
         spriteBatch = new SpriteBatch();
 
         camera = new OrthographicCamera();

core/src/main/java/me/stringfromjava/funkin/backend/display/FunkinScreen.java

@@ -1,15 +1,16 @@
-package me.stringfromjava.funkin;
+package me.stringfromjava.funkin.game;
 
-import com.badlogic.gdx.graphics.g2d.Sprite;
+import me.stringfromjava.funkin.Funkin;
 import me.stringfromjava.funkin.backend.display.FunkinScreen;
+import me.stringfromjava.funkin.game.menus.TitleScreen;
 
 public class InitScreen extends FunkinScreen {
 
-    private Sprite logo;
-
     @Override
     public void show() {
         super.show();
+        System.out.println("setup complete");
+        Funkin.setScreen(new TitleScreen());
     }
 
     @Override

…me/stringfromjava/funkin/InitScreen.java …ringfromjava/funkin/game/InitScreen.javacore/src/main/java/me/stringfromjava/funkin/InitScreen.java renamed to core/src/main/java/me/stringfromjava/funkin/game/InitScreen.java core/src/main/java/me/stringfromjava/funkin/InitScreen.java renamed to core/src/main/java/me/stringfromjava/funkin/game/InitScreen.java

@@ -0,0 +1,17 @@
+package me.stringfromjava.funkin.game.menus;
+
+import com.badlogic.gdx.graphics.g2d.Sprite;
+import me.stringfromjava.funkin.Funkin;
+import me.stringfromjava.funkin.backend.display.FunkinScreen;
+
+public class TitleScreen extends FunkinScreen {
+
+    private Sprite logo;
+
+    @Override
+    public void show() {
+        super.show();
+        Funkin.playSound("shared/sounds/tickleFight.ogg");
+        Funkin.playMusic("preload/music/freakyMenu/freakyMenu.ogg", 0.5f);
+    }
+}

core/src/main/java/me/stringfromjava/funkin/game/menus/TitleScreen.java

@@ -2,6 +2,7 @@
 
 import aurelienribon.tweenengine.Tween;
 import aurelienribon.tweenengine.TweenManager;
+import com.badlogic.gdx.Gdx;
 import com.badlogic.gdx.graphics.g2d.Sprite;
 import me.stringfromjava.funkin.tween.accessors.SpriteAccessor;
 
@@ -17,8 +18,6 @@ public final class FunkinTween {
 
     /**
      * Registers all tween accessors used in the game.
-     * <p>
-     * TODO: Make it possible to where you don't need accessors!
      */
     public static void registerAccessors() {
         Tween.registerAccessor(Sprite.class, new SpriteAccessor());

core/src/main/java/me/stringfromjava/funkin/tween/FunkinTween.java

@@ -0,0 +1,46 @@
+package me.stringfromjava.funkin.util;
+
+import java.util.ArrayList;
+
+/**
+ * Utility class for creating objects that can execute multiple
+ * runnables when it is dispatched (or triggered).
+ */
+public class FunkinSignal {
+
+    private ArrayList<Runnable> runnables;
+
+    public FunkinSignal() {
+        runnables = new ArrayList<>();
+    }
+
+    /**
+     * Adds a new {@link Runnable} to {@code this} signal to be executed upon
+     * {@code dispatch()} being called.
+     *
+     * @param runnable The new runnable to add to the signal.
+     */
+    public void add(Runnable runnable) {
+        if (runnable != null) {
+            runnables.add(runnable);
+        }
+    }
+
+    /**
+     * Removes all runnables from {@code this} signal.
+     */
+    public void clear() {
+        runnables.clear();
+    }
+
+    /**
+     * Triggers {@code this} signal and executes all runnables.
+     */
+    public void dispatch() {
+        for (Runnable runnable : runnables) {
+            if (runnable != null) {
+                runnable.run();
+            }
+        }
+    }
+}

core/src/main/java/me/stringfromjava/funkin/util/FunkinSignal.java

@@ -1,14 +1,15 @@
 package me.stringfromjava.funkin.util;
 
+import com.badlogic.gdx.Gdx;
 import com.badlogic.gdx.files.FileHandle;
 
 /**
  * Utility class for simplifying asset paths.
  */
-public final class PathUtil {
+public final class Paths {
 
     public static FileHandle asset(String path) {
-        return new FileHandle(path);
+        return Gdx.files.internal(path);
     }
 
     public static FileHandle shared(String path) {
@@ -19,6 +20,6 @@ public static FileHandle image(String path) {
         return shared(String.format("images/%s.png", path));
     }
 
-    private PathUtil() {
+    private Paths() {
     }
 }