Add EntityCategory to API

Signed-off-by: Gabriel Harris-Rouquette <[email protected]>

Author: gabizou

src/main/java/org/spongepowered/api/entity/EntityCategories.java

@@ -0,0 +1,58 @@
+/*
+ * 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;
+
+import org.spongepowered.api.ResourceKey;
+import org.spongepowered.api.Sponge;
+import org.spongepowered.api.registry.DefaultedRegistryReference;
+import org.spongepowered.api.registry.RegistryKey;
+import org.spongepowered.api.registry.RegistryTypes;
+
+public final class EntityCategories {
+
+    //@formatter:off
+
+    public static final DefaultedRegistryReference<EntityCategory> MONSTER = EntityCategories.key(ResourceKey.sponge("monster"));
+
+    public static final DefaultedRegistryReference<EntityCategory> CREATURE = EntityCategories.key(ResourceKey.sponge("creature"));
+
+    public static final DefaultedRegistryReference<EntityCategory> AMBIENT = EntityCategories.key(ResourceKey.sponge("ambient"));
+
+    public static final DefaultedRegistryReference<EntityCategory> WATER_CREATURE = EntityCategories.key(ResourceKey.sponge("water_creature"));
+
+    public static final DefaultedRegistryReference<EntityCategory> WATER_AMBIENT = EntityCategories.key(ResourceKey.sponge("water_ambient"));
+
+    public static final DefaultedRegistryReference<EntityCategory> MISCELLANEOUS = EntityCategories.key(ResourceKey.sponge("misc"));
+
+    //@formatter:on
+
+    private EntityCategories() {
+        throw new AssertionError("You should not be attempting to instantiate this class.");
+    }
+
+    private static DefaultedRegistryReference<EntityCategory> key(final ResourceKey location) {
+        return RegistryKey.of(RegistryTypes.ENTITY_CATEGORY, location).asDefaultedReference(Sponge::game);
+    }
+}

src/main/java/org/spongepowered/api/entity/EntityCategory.java

@@ -0,0 +1,64 @@
+/*
+ * 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;
+
+import org.spongepowered.api.entity.living.animal.Chicken;
+import org.spongepowered.api.entity.living.monster.Creeper;
+import org.spongepowered.api.entity.living.monster.zombie.Zombie;
+import org.spongepowered.api.registry.DefaultedRegistryValue;
+import org.spongepowered.api.util.annotation.CatalogedBy;
+
+/**
+ * A category of entities that conveys a variety of meanings to
+ * consider a group of entities that may differ in {@link EntityType}
+ * are the "same category" grouping. Examples can be for monsters
+ * to include {@link Zombie}, {@link Creeper}, while a creature
+ * may include {@link Chicken}.
+ */
+@CatalogedBy(EntityCategories.class)
+public interface EntityCategory extends DefaultedRegistryValue {
+
+    /**
+     * Whether this category of entities is considered "friendly".
+     *
+     * @return True if this category of entities is friendly
+     */
+    boolean friendly();
+
+    /**
+     * Gets the distance in blocks in which an entity of this category
+     * may be considered to be despawned/removed from a World if too
+     * far from a Player.
+     * <p>Obvious exceptions include when the Entity logic considers
+     * itself not to be despawnable or owned/permanent by a player,
+     * function, or plugin thereof.
+     *
+     * @return The distance at which entities of this category may be
+     * considered to be removed if too far from a player
+     */
+    int despawnDistance();
+
+
+}

src/main/java/org/spongepowered/api/entity/EntityType.java

@@ -63,4 +63,11 @@ public interface EntityType<A extends Entity> extends DefaultedRegistryValue, Co
      * @return If the type can spawn far away from a player
      */
     boolean canSpawnAwayFromPlayer();
+
+    /**
+     * Gets the {@link EntityCategory} of this type.
+     *
+     * @return The category of this type
+     */
+    EntityCategory category();
 }

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

@@ -87,6 +87,7 @@
 import org.spongepowered.api.effect.potion.PotionEffectType;
 import org.spongepowered.api.effect.sound.SoundType;
 import org.spongepowered.api.effect.sound.music.MusicDisc;
+import org.spongepowered.api.entity.EntityCategory;
 import org.spongepowered.api.entity.EntityType;
 import org.spongepowered.api.entity.ai.goal.GoalExecutorType;
 import org.spongepowered.api.entity.ai.goal.GoalType;
@@ -134,7 +135,6 @@
 import org.spongepowered.api.statistic.StatisticCategory;
 import org.spongepowered.api.tag.Tag;
 import org.spongepowered.api.tag.TagType;
-import org.spongepowered.api.tag.TagTypes;
 import org.spongepowered.api.util.mirror.Mirror;
 import org.spongepowered.api.util.orientation.Orientation;
 import org.spongepowered.api.util.rotation.Rotation;
@@ -182,6 +182,8 @@ public final class RegistryTypes {
 
     public static final DefaultedRegistryType<EnchantmentType> ENCHANTMENT_TYPE = RegistryTypes.minecraftKeyInGame("enchantment");
 
+    public static final DefaultedRegistryType<EntityCategory> ENTITY_CATEGORY = RegistryTypes.spongeKeyInGame("mob_category");
+
     public static final DefaultedRegistryType<EntityType<@NonNull ?>> ENTITY_TYPE = RegistryTypes.minecraftKeyInGame("entity_type");
 
     public static final DefaultedRegistryType<FluidType> FLUID_TYPE = RegistryTypes.minecraftKeyInGame("fluid");