some DisplayEntity & TextDisplay Data

Author: Faithcaio

src/main/java/org/spongepowered/api/data/Keys.java

@@ -116,6 +116,7 @@
 import org.spongepowered.api.entity.display.BillboardType;
 import org.spongepowered.api.entity.display.DisplayEntity;
 import org.spongepowered.api.entity.display.ItemDisplayType;
+import org.spongepowered.api.entity.display.TextAlignment;
 import org.spongepowered.api.entity.display.TextDisplay;
 import org.spongepowered.api.entity.explosive.EndCrystal;
 import org.spongepowered.api.entity.explosive.Explosive;
@@ -505,6 +506,9 @@ public final class Keys {
      * <p>In vanilla minecraft is this value in steps of 1/15 from 0 to 1.</p>
      * <p>For the skylight see {@link #SKY_LIGHT}.</p>
      * Readonly
+     * <p>
+     * Or the blocklight override for a {@link DisplayEntity}.
+     * </p>
      */
     public static final Key<Value<Integer>> BLOCK_LIGHT = Keys.key(ResourceKey.sponge("block_light"), Integer.class);
 
@@ -1185,6 +1189,11 @@ public final class Keys {
      */
     public static final Key<Value<Boolean>> HAS_CHEST = Keys.key(ResourceKey.sponge("has_chest"), Boolean.class);
 
+    /**
+     * Whether the {@link TextDisplay} has a default background.
+     */
+    public static final Key<Value<Boolean>> HAS_DEFAULT_BACKGROUND = Keys.key(ResourceKey.sponge("has_default_background"), Boolean.class);
+
     /**
      *Whether a {@link Turtle} currently has an egg.
      */
@@ -1254,6 +1263,11 @@ public final class Keys {
      */
     public static final Key<Value<Boolean>> HAS_SKYLIGHT = Keys.key(ResourceKey.sponge("has_skylight"), Boolean.class);
 
+    /**
+     * Whether the {@link TextDisplay} has a shadow.
+     */
+    public static final Key<Value<Boolean>> HAS_TEXT_SHADOW = Keys.key(ResourceKey.sponge("has_text_shadow"), Boolean.class);
+
     /**
      * Whether a server player has viewed the credits.
      *
@@ -2067,6 +2081,11 @@ public final class Keys {
      */
     public static final Key<Value<Integer>> LIGHT_EMISSION = Keys.key(ResourceKey.sponge("light_emission"), Integer.class);
 
+    /**
+     * The maximum line width of a {@link TextDisplay}.
+     */
+    public static final Key<Value<Integer>> LINE_WIDTH = Keys.key(ResourceKey.sponge("line_width"), Integer.class);
+
     /**
      * A {@link Llama}'s {@link LlamaType}.
      */
@@ -2331,6 +2350,11 @@ public final class Keys {
      */
     public static final Key<Value<Boolean>> ON_GROUND = Keys.key(ResourceKey.sponge("on_ground"), Boolean.class);
 
+    /**
+     * The opacity of a {@link TextDisplay}. 0 to 255
+     */
+    public static final Key<Value<Byte>> OPACITY = Keys.key(ResourceKey.sponge("opacity"), Byte.class);
+
     /**
      * The {@link Orientation} of an {@link ItemFrame}.
      */
@@ -2681,6 +2705,11 @@ public final class Keys {
      */
     public static final Key<Value<Long>> SEED = Keys.key(ResourceKey.sponge("structure_seed"), Long.class);
 
+    /**
+     * Whether {@link TextDisplay} are visible through blocks.
+     */
+    public static final Key<Value<Boolean>> SEE_THROUGH_BLOCKS = Keys.key(ResourceKey.sponge("see_through_blocks"), Boolean.class);
+
     /**
      * The {@link SerializationBehavior} of a {@link WorldTemplate} or {@link ServerWorldProperties}
      * Readonly
@@ -2740,6 +2769,9 @@ public final class Keys {
      * The skylight value at a {@link ServerLocation}.
      * For the blocklight see {@link #BLOCK_LIGHT}.
      * Readonly
+     * <p>
+     * Or the skylight override for a {@link DisplayEntity}.
+     * </p>
      */
     public static final Key<Value<Integer>> SKY_LIGHT = Keys.key(ResourceKey.sponge("sky_light"), Integer.class);
 
@@ -2969,6 +3001,16 @@ public final class Keys {
      */
     public static final Key<Value<TemperatureModifier>> TEMPERATURE_MODIFIER = Keys.key(ResourceKey.sponge("temperature_modifier"), TemperatureModifier.class);
 
+    /**
+     * The {@link TextAlignment} of a {@link TextDisplay}.
+     */
+    public static final Key<Value<TextAlignment>> TEXT_ALIGNMENT = Keys.key(ResourceKey.sponge("text_alignment"), TextAlignment.class);
+
+    /**
+     * The background {@link java.awt.Color} of a {@link TextDisplay}.
+     */
+    public static final Key<Value<java.awt.Color>> TEXT_BACKGROUND_COLOR = Keys.key(ResourceKey.sponge("text_background_color"), java.awt.Color.class);
+
     /**
      * The remaining fuse time in ticks of a {@link FusedExplosive}.
      * This value may be set to an arbitrary value

src/main/java/org/spongepowered/api/entity/display/DisplayEntity.java

@@ -27,25 +27,35 @@
 import org.spongepowered.api.data.Keys;
 import org.spongepowered.api.entity.Entity;
 
+import java.util.Optional;
+
 public interface DisplayEntity extends Entity {
 
     // TODO rotation/transformation?
 
-    // TODO interpolation?
+    // TODO interpolation? textopacity/backgroundcolor
 
     default BillboardType billboardType() {
         return this.require(Keys.BILLBOARD_TYPE);
     }
-//
-//    default int skyLight() {
-//        // TODO impl
-//        return this.require(Keys.SKY_LIGHT);
-//    }
-//
-//    default int blockLight() {
-//        // TODO impl
-//        return this.require(Keys.BLOCK_LIGHT);
-//    }
+
+    /**
+     * Returns the skylight override.
+     *
+     * @return the skylight override
+     */
+    default Optional<Integer> skyLight() {
+        return this.get(Keys.SKY_LIGHT);
+    }
+
+    /**
+     * Returns the blocklight override.
+     *
+     * @return the blocklight override
+     */
+    default Optional<Integer> blockLight() {
+        return this.get(Keys.BLOCK_LIGHT);
+    }
 
     // TODO view_range float/double
 

src/main/java/org/spongepowered/api/entity/display/TextAlignment.java

@@ -0,0 +1,33 @@
+/*
+ * This file is part of SpongeAPI, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * Copyright (c) contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package org.spongepowered.api.entity.display;
+
+import org.spongepowered.api.registry.DefaultedRegistryValue;
+import org.spongepowered.api.util.annotation.CatalogedBy;
+
+@CatalogedBy(ItemDisplayTypes.class)
+public interface TextAlignment extends DefaultedRegistryValue {
+
+}

src/main/java/org/spongepowered/api/entity/display/TextAlignments.java

@@ -0,0 +1,60 @@
+/*
+ * This file is part of SpongeAPI, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * Copyright (c) contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package org.spongepowered.api.entity.display;
+
+import org.spongepowered.api.ResourceKey;
+import org.spongepowered.api.Sponge;
+import org.spongepowered.api.registry.DefaultedRegistryReference;
+import org.spongepowered.api.registry.Registry;
+import org.spongepowered.api.registry.RegistryKey;
+import org.spongepowered.api.registry.RegistryScope;
+import org.spongepowered.api.registry.RegistryScopes;
+import org.spongepowered.api.registry.RegistryTypes;
+
+@SuppressWarnings("unused")
+@RegistryScopes(scopes = RegistryScope.GAME)
+public final class TextAlignments {
+
+    // @formatter:off
+    // SORTFIELDS:ON
+    public static final DefaultedRegistryReference<TextAlignment> CENTER = TextAlignments.key(ResourceKey.sponge("center"));
+
+    public static final DefaultedRegistryReference<TextAlignment> LEFT = TextAlignments.key(ResourceKey.sponge("left"));
+
+    public static final DefaultedRegistryReference<TextAlignment> RIGHT = TextAlignments.key(ResourceKey.sponge("right"));
+
+    // SORTFIELDS:OFF
+    // @formatter:on
+    private TextAlignments() {
+    }
+
+    public static Registry<TextAlignment> registry() {
+        return Sponge.game().registry(RegistryTypes.TEXT_ALIGNMENT);
+    }
+
+    private static DefaultedRegistryReference<TextAlignment> key(final ResourceKey location) {
+        return RegistryKey.of(RegistryTypes.TEXT_ALIGNMENT, location).asDefaultedReference(Sponge::game);
+    }
+}

src/main/java/org/spongepowered/api/entity/display/TextDisplay.java

@@ -27,6 +27,8 @@
 import net.kyori.adventure.text.Component;
 import org.spongepowered.api.data.Keys;
 
+import java.awt.Color;
+
 public interface TextDisplay extends DisplayEntity {
 
     /**
@@ -38,4 +40,68 @@ default Component displayedText() {
         return this.require(Keys.DISPLAY_NAME);
     }
 
+    /**
+     * Gets the maximum line width used to split lines of text.
+     *
+     * @return The maximum line width used to split lines of text
+     */
+    default int lineWidth() {
+        return this.require(Keys.LINE_WIDTH);
+    }
+
+    /**
+     * Gets the opacity of the displayed text.
+     *
+     * @return The opacity of the displayed text
+     */
+    default int textOpacity() {
+        return this.require(Keys.OPACITY);
+    }
+
+    /**
+     * Checks if the displayed text is visible through blocks.
+     *
+     * @return True if the displayed text is visible through blocks, false otherwise
+     */
+    default boolean canSeeThroughBlocks() {
+        return this.require(Keys.SEE_THROUGH_BLOCKS);
+    }
+
+    /**
+     * Checks if the displayed text has a shadow.
+     *
+     * @return True if the displayed text has a shadow, false otherwise
+     */
+    default boolean hasShadow() {
+        return this.require(Keys.HAS_TEXT_SHADOW);
+    }
+
+    /**
+     * Gets the background color of the displayed text.
+     * Note that this supports alpha values.
+     *
+     * @return The background color of the displayed text
+     */
+    default Color backgroundColor() {
+        return this.require(Keys.TEXT_BACKGROUND_COLOR);
+    }
+
+    /**
+     * Gets the background color of the displayed text.
+     *
+     * @return The background color of the displayed text
+     */
+    default boolean defaultBackground() {
+        return this.require(Keys.HAS_DEFAULT_BACKGROUND);
+    }
+
+    /**
+     * Gets the alignment direction of the displayed text.
+     *
+     * @return The alignment direction of the displayed text
+     */
+    default TextAlignment textAlignment() {
+        return this.require(Keys.TEXT_ALIGNMENT);
+    }
+
 }

src/main/java/org/spongepowered/api/registry/RegistryTypes.java

@@ -105,6 +105,7 @@
 import org.spongepowered.api.entity.attribute.type.AttributeType;
 import org.spongepowered.api.entity.display.BillboardType;
 import org.spongepowered.api.entity.display.ItemDisplayType;
+import org.spongepowered.api.entity.display.TextAlignment;
 import org.spongepowered.api.entity.living.monster.boss.dragon.phase.DragonPhaseType;
 import org.spongepowered.api.entity.living.player.chat.ChatVisibility;
 import org.spongepowered.api.entity.living.player.gamemode.GameMode;
@@ -483,6 +484,8 @@ public final class RegistryTypes {
 
     public static final DefaultedRegistryType<TeleportHelperFilter> TELEPORT_HELPER_FILTER = RegistryTypes.spongeKeyInGame("teleport_helper_filter");
 
+    public static final DefaultedRegistryType<TextAlignment> TEXT_ALIGNMENT = RegistryTypes.spongeKeyInGame("text_alignment");
+
     public static final DefaultedRegistryType<TicketType<?>> TICKET_TYPE = RegistryTypes.spongeKeyInGame("ticket_type");
 
     public static final DefaultedRegistryType<TransactionType> TRANSACTION_TYPE = RegistryTypes.spongeKeyInGame("transaction_type");