Do a few things that I wanted to do before release

Author: Geolykt

src/main/java/de/geolykt/starloader/api/empire/ActiveEmpire.java

@@ -37,9 +37,10 @@ public interface ActiveEmpire extends Empire, Metadatable {
      * was cancelled.
      *
      * @param empireSpecial The registry key of the special.
+     * @param force Whether to suppress the events that are fired otherwise
      * @return Whether the special was really removed.
      */
-    public boolean addSpecial(@NotNull NamespacedKey empireSpecial);
+    public boolean addSpecial(@NotNull NamespacedKey empireSpecial, boolean force);
 
     /**
      * Adds a callback that only applies to this empire.
@@ -55,11 +56,13 @@ public interface ActiveEmpire extends Empire, Metadatable {
      * Depending on the parameters the player can be notified about the event and the event may be included in the
      * bulletin ticker. This method does not allow to go lower that 1 for a good cause,
      * as this produces other severe issues like divide by 0.
+     * Even if the events are suppressed a transcend event will be fired if the threshold for that has been reached.
      *
      * @param notify False if the action should happen silently, true if it is done in a more natural manner
+     * @param force Whether to suppress the events that are fired otherwise
      * @return False if the event got cancelled or if the technology level is at 1
      */
-    public boolean decreaseTechnologyLevel(boolean notify);
+    public boolean decreaseTechnologyLevel(boolean notify, boolean force);
 
     /**
      * Obtains the {@link Vector} of the {@link StateActor StateActors} that are currently assigned to the empire.
@@ -153,11 +156,13 @@ public interface ActiveEmpire extends Empire, Metadatable {
      * have been cancelled or not.
      * Depending on the parameters the player can be notified about the event and the event may be included in the
      * bulletin ticker.
+     * Even if the events are suppressed a transcend event will be fired if the threshold for that has been reached.
      *
      * @param notify False if the action should happen silently, true if it is done in a more natural manner
+     * @param force Whether to suppress the events that are fired otherwise
      * @return False if the event got cancelled
      */
-    public boolean increaseTechnologyLevel(boolean notify);
+    public boolean increaseTechnologyLevel(boolean notify, boolean force);
 
     /**
      * Unassign a {@link StateActor} from the empire
@@ -174,9 +179,10 @@ public interface ActiveEmpire extends Empire, Metadatable {
      * was cancelled.
      *
      * @param empireSpecial The registry key of the special.
+     * @param force Whether to suppress the events that are fired otherwise
      * @return Whether the special was really removed.
      */
-    public boolean removeSpecial(@NotNull NamespacedKey empireSpecial);
+    public boolean removeSpecial(@NotNull NamespacedKey empireSpecial, boolean force);
 
     /**
      * Sets the motto of the empire. The motto of an empire is purely for the user

src/main/java/de/geolykt/starloader/api/gui/Drawing.java

@@ -112,7 +112,7 @@ public static float drawText(@NotNull String message, float x, float y, @NotNull
      *
      * @param message The message to send
      */
-    public static void sendBulletin(@NotNull String message) { // FIXME typo
+    public static void sendBulletin(@NotNull String message) {
         implementation.sendBulletin(message);
     }
 
@@ -121,7 +121,7 @@ public static void sendBulletin(@NotNull String message) { // FIXME typo
      * 
      * @param text The formatted text to send as a bulletin
      */
-    public static void sendBulltin(@NotNull FormattedText text) {
+    public static void sendBulletin(@NotNull FormattedText text) {
         implementation.sendBulletin(text);
     }
 

src/main/java/de/geolykt/starloader/api/gui/text/TextFactory.java

@@ -29,12 +29,26 @@ public interface TextFactory {
 
     /**
      * Creates a {@link FormattedText} based on a String. The default color is used.
+     * It uses the small font size, where as {@link #asDefaultFormattedText(String)} uses the "default" monotype font.
+     * The reason for this interesting naming decision is that normal bulletins make use of the small monotype font,
+     * where as some of the empire-specific bulletins make use of the "default" one.
      *
      * @param text The text to encode
      * @return The text as a {@link FormattedText}
      */
     public @NotNull FormattedText asFormattedText(@NotNull String text);
 
+    /**
+     * Creates a {@link FormattedText} based on a String. The default color is used.
+     * It uses the default font size, where as {@link #asFormattedText(String)} uses the small monotype font.
+     * The reason for this interesting naming decision is that normal bulletins make use of the small monotype font,
+     * where as some of the empire-specific bulletins make use of the "default" one.
+     *
+     * @param text The text to encode
+     * @return The text as a {@link FormattedText}
+     */
+    public @NotNull FormattedText asDefaultFormattedText(@NotNull String text);
+
     /**
      * Creates a {@link FormattedText} based on a String. The specified color is used.
      *

src/main/java/de/geolykt/starloader/api/resource/AudioSampleWrapper.java

@@ -4,38 +4,52 @@
 
 import com.badlogic.gdx.audio.Sound;
 
-import snoddasmannen.galimulator.AudioManager$AudioSample;
+/**
+ * Wrapper for sounds. They can be used to enrich the user experience, however this does not meant that the game is limited to
+ * this selection of sounds, as extensions can implement their own sounds. Due to the relative simplicity of such actions,
+ * the Starloader API does not (yet) provide a harmony or registry API for this and extensions need to work out their own
+ * systems to do these actions.
+ */
+public abstract class AudioSampleWrapper implements ResourceWrapper<Sound> {
 
-public final class AudioSampleWrapper implements ResourceWrapper<Sound> { // TODO maybe we can use the AudioSample directly, but how would an IDE react to this?
+    public static AudioSampleWrapper ACTOR_ORDERED = null;
 
+    public static AudioSampleWrapper ACTOR_SELECTED = null;
+
+    public static AudioSampleWrapper ALARM = null;
+    public static AudioSampleWrapper BAD_MINI = null;
+    public static AudioSampleWrapper BIG_LASER = null;
+    public static AudioSampleWrapper BIGBOOM_1 = null;
+    public static AudioSampleWrapper BIGBOOM_2 = null;
+    public static AudioSampleWrapper CLONE = null;
+    public static AudioSampleWrapper GOOD_MINI = null;
+    public static AudioSampleWrapper HEALRAY = null;
+    public static AudioSampleWrapper HIT_1 = null;
+    public static AudioSampleWrapper HIT_2 = null;
+    public static AudioSampleWrapper HIT_3 = null;
+    public static AudioSampleWrapper MISSILE = null;
+    public static AudioSampleWrapper SMALL_LASER = null;
+    public static AudioSampleWrapper UI_BIG_SELECT = null;
+    public static AudioSampleWrapper UI_ERROR = null;
+    public static AudioSampleWrapper UI_SMALL_SELECT = null;
+    /**
+     * The location of the resource within the respective data folder.
+     */
     private final String location;
-    private final AudioManager$AudioSample sample;
+    /**
+     * The sound resource that should be used
+     */
     private final Sound sound;
 
-    // This is madness
-    public static final AudioSampleWrapper ACTOR_SELECTED = new AudioSampleWrapper("uismallselect.wav", AudioManager$AudioSample.a);
-    public static final AudioSampleWrapper ACTOR_ORDERED = new AudioSampleWrapper("actoraction.wav", AudioManager$AudioSample.b);
-    public static final AudioSampleWrapper GOOD_MINI = new AudioSampleWrapper("goodmini.wav", AudioManager$AudioSample.c);
-    public static final AudioSampleWrapper BAD_MINI = new AudioSampleWrapper("badmini.wav", AudioManager$AudioSample.d);
-    public static final AudioSampleWrapper UI_SMALL_SELECT = new AudioSampleWrapper("uismallselect.wav", AudioManager$AudioSample.e);
-    public static final AudioSampleWrapper UI_BIG_SELECT = new AudioSampleWrapper("uiselect.wav", AudioManager$AudioSample.f);
-    public static final AudioSampleWrapper UI_ERROR = new AudioSampleWrapper("error.wav", AudioManager$AudioSample.g);
-    public static final AudioSampleWrapper BIG_LASER = new AudioSampleWrapper("biglaser.wav", AudioManager$AudioSample.h);
-    public static final AudioSampleWrapper SMALL_LASER = new AudioSampleWrapper("biglaser.wav", AudioManager$AudioSample.i);
-    public static final AudioSampleWrapper HIT_1 = new AudioSampleWrapper("smallhit1.wav", AudioManager$AudioSample.j);
-    public static final AudioSampleWrapper HIT_2 = new AudioSampleWrapper("smallhit2.wav", AudioManager$AudioSample.k);
-    public static final AudioSampleWrapper HIT_3 = new AudioSampleWrapper("smallhit3.wav", AudioManager$AudioSample.l);
-    public static final AudioSampleWrapper ALARM = new AudioSampleWrapper("alarm.wav", AudioManager$AudioSample.m);
-    public static final AudioSampleWrapper BIGBOOM_1 = new AudioSampleWrapper("bigboom1.wav", AudioManager$AudioSample.n);
-    public static final AudioSampleWrapper BIGBOOM_2 = new AudioSampleWrapper("bigboom2.wav", AudioManager$AudioSample.o);
-    public static final AudioSampleWrapper HEALRAY = new AudioSampleWrapper("healray.wav", AudioManager$AudioSample.p);
-    public static final AudioSampleWrapper CLONE = new AudioSampleWrapper("clone.wav", AudioManager$AudioSample.q);
-    public static final AudioSampleWrapper MISSILE = new AudioSampleWrapper("missile.wav", AudioManager$AudioSample.r);
-
-    private AudioSampleWrapper(String loc, AudioManager$AudioSample sample) {
+    /**
+     * Constructor.
+     *
+     * @param loc The location of the resource, should be formatted like a file name
+     * @param sample The sound sample of the instance
+     */
+    protected AudioSampleWrapper(String loc, Sound sample) {
         this.location = loc;
-        this.sample = sample;
-        this.sound = sample.sound; // FIXME DOES NOT WORK!
+        this.sound = sample;
     }
 
     @Override
@@ -48,11 +62,15 @@ private AudioSampleWrapper(String loc, AudioManager$AudioSample sample) {
         return sound;
     }
 
-    public void play() {
-        sample.a();
-    }
+    /**
+     * Plays the sample.
+     */
+    public abstract void play();
 
-    public void play(float volume) {
-        sample.a(volume);
-    }
+    /**
+     * Plays the sample at a strictly defined volume. Note that 1.0 is not always the default, however it often is.
+     *
+     * @param volume The volume of the sound, should range between 0.0 and 1.0
+     */
+    public abstract void play(float volume);
 }

src/main/java/de/geolykt/starloader/api/resource/ResourceWrapper.java

@@ -6,6 +6,8 @@
  * Indicates the something is wrapping a resource.
  * Due to the nature of the game most often they are enums,
  * which makes modification with them more limited than with other things.
+ * While for some enums they can be altered into a registry, for some other enums (most notably resources)
+ * there are no need to do this step and wrapping it would be easier, like here.
  *
  * @param <T> The object type that is wrapped by this resource wrapper
  */