Skip to content

Commit

Permalink
Add EntityCategory to API
Browse files Browse the repository at this point in the history
Signed-off-by: Gabriel Harris-Rouquette <gabizou@me.com>
  • Loading branch information
gabizou committed Sep 15, 2021
1 parent 1b2527e commit 2ddc835
Show file tree
Hide file tree
Showing 4 changed files with 102 additions and 1 deletion.
28 changes: 28 additions & 0 deletions src/main/java/org/spongepowered/api/entity/EntityCategories.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
* 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;

public class EntityCategories {
}
64 changes: 64 additions & 0 deletions src/main/java/org/spongepowered/api/entity/EntityCategory.java
Original file line number Diff line number Diff line change
@@ -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();


}
7 changes: 7 additions & 0 deletions src/main/java/org/spongepowered/api/entity/EntityType.java
Original file line number Diff line number Diff line change
Expand Up @@ -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();
}
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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");
Expand Down

0 comments on commit 2ddc835

Please sign in to comment.