Damage Type+Tags Datapacks

Author: Faithcaio

src/main/java/org/spongepowered/api/datapack/DataPackType.java

@@ -26,6 +26,7 @@
 
 import org.spongepowered.api.advancement.AdvancementTemplate;
 import org.spongepowered.api.adventure.ChatTypeTemplate;
+import org.spongepowered.api.event.cause.entity.damage.DamageTypeTemplate;
 import org.spongepowered.api.item.recipe.RecipeRegistration;
 import org.spongepowered.api.registry.RegistryType;
 import org.spongepowered.api.tag.TagTemplate;
@@ -96,5 +97,7 @@ interface Factory {
         DataPackType<JigsawPoolTemplate> jigsawPool();
 
         DataPackType<ChatTypeTemplate> chatType();
+
+        DataPackType<DamageTypeTemplate> damageType();
     }
 }

src/main/java/org/spongepowered/api/datapack/DataPackTypes.java

@@ -29,6 +29,8 @@
 import org.spongepowered.api.adventure.ChatTypeTemplate;
 import org.spongepowered.api.block.BlockType;
 import org.spongepowered.api.entity.EntityType;
+import org.spongepowered.api.event.cause.entity.damage.DamageType;
+import org.spongepowered.api.event.cause.entity.damage.DamageTypeTemplate;
 import org.spongepowered.api.fluid.FluidType;
 import org.spongepowered.api.item.ItemType;
 import org.spongepowered.api.item.recipe.RecipeRegistration;
@@ -99,6 +101,9 @@ public final class DataPackTypes {
 
     public static final DataPackType<ChatTypeTemplate> CHAT_TYPE = Sponge.game().factoryProvider().provide(DataPackType.Factory.class).chatType();
 
+    public static final DataPackType<DamageTypeTemplate> DAMAGE_TYPE = Sponge.game().factoryProvider().provide(DataPackType.Factory.class).damageType();
+    public static final DataPackType<TagTemplate<DamageType>> DAMAGE_TYPE_TAG = Sponge.game().factoryProvider().provide(DataPackType.Factory.class).tag(RegistryTypes.DAMAGE_TYPE);
+
     // SORTFIELDS:OFF
 
     // TODO `worldgen/world_preset`? WorldGenerationConfig? with mapping of LevelStems

src/main/java/org/spongepowered/api/datapack/DataPacks.java

@@ -28,6 +28,8 @@
 import org.spongepowered.api.adventure.ChatTypeTemplate;
 import org.spongepowered.api.block.BlockType;
 import org.spongepowered.api.entity.EntityType;
+import org.spongepowered.api.event.cause.entity.damage.DamageType;
+import org.spongepowered.api.event.cause.entity.damage.DamageTypeTemplate;
 import org.spongepowered.api.fluid.FluidType;
 import org.spongepowered.api.item.ItemType;
 import org.spongepowered.api.item.recipe.RecipeRegistration;
@@ -95,6 +97,9 @@ public final class DataPacks {
     public static final DataPack<JigsawPoolTemplate> JIGSAW_POOL = DataPackTypes.JIGSAW_POOL.pack("plugin_worldgen", "Sponge plugin provided jigsaw pools");
     public static final DataPack<ChatTypeTemplate> CHAT_TYPE = DataPackTypes.CHAT_TYPE.pack("plugin_chat_types", "Sponge plugin provided chat types");
 
+    public static final DataPack<DamageTypeTemplate> DAMAGE_TYPE = DataPackTypes.DAMAGE_TYPE.pack("plugin_damage_types", "Sponge plugin provided damage types");
+    public static final DataPack<TagTemplate<DamageType>> DAMAGE_TYPE_TAG = DataPackTypes.DAMAGE_TYPE_TAG.pack("plugin_damage_types", "Sponge plugin provided damage type tags");
+
     // SORTFIELDS:ON
 
     private DataPacks() {

src/main/java/org/spongepowered/api/event/cause/entity/damage/DamageType.java

@@ -28,6 +28,7 @@
 import org.spongepowered.api.event.cause.entity.damage.source.DamageSource;
 import org.spongepowered.api.registry.DefaultedRegistryValue;
 import org.spongepowered.api.tag.Tag;
+import org.spongepowered.api.tag.Taggable;
 import org.spongepowered.api.util.Nameable;
 import org.spongepowered.api.util.annotation.CatalogedBy;
 
@@ -38,16 +39,8 @@
  * can damage an {@link Entity} with varying {@link DamageType}s depending on the circumstances.
  */
 @CatalogedBy(DamageTypes.class)
-public interface DamageType extends DefaultedRegistryValue, Nameable {
+public interface DamageType extends DefaultedRegistryValue, Nameable, Taggable<DamageType> {
 
-    /**
-     * Creates a new {@link Builder builder} to build a {@link DamageType}.
-     *
-     * @return A new builder
-     */
-    static Builder builder() {
-        return Sponge.game().builderProvider().provide(Builder.class);
-    }
 
     /**
      * Gets the amount of exhaustion this {@link DamageType} will add to the entity, generally only to players.

src/main/java/org/spongepowered/api/event/cause/entity/damage/DamageTypeTemplate.java

@@ -0,0 +1,97 @@
+/*
+ * 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.event.cause.entity.damage;
+
+import org.spongepowered.api.Sponge;
+import org.spongepowered.api.datapack.DataPackEntry;
+import org.spongepowered.api.event.cause.entity.damage.source.DamageSource;
+import org.spongepowered.api.util.DataPackEntryBuilder;
+
+/**
+ * A template for {@link DamageType damage types}.
+ */
+
+public interface DamageTypeTemplate extends DataPackEntry<DamageTypeTemplate> {
+
+    static Builder builder() {
+        return Sponge.game().builderProvider().provide(Builder.class).reset();
+    }
+
+    /**
+     * Returns the damage type
+     *
+     * @return the damage type
+     */
+    DamageType type();
+
+
+    interface Builder extends DataPackEntryBuilder<DamageType, DamageTypeTemplate, Builder> {
+
+        /**
+         * Sets the name of the {@link DamageType}.
+         * Used as part of the death message translation key.
+         * TODO falling/intentional game design?
+         *
+         * @param name The name
+         *
+         * @return This builder, for chaining
+         */
+        Builder name(String name);
+
+        /**
+         * Sets damage scaling
+         *
+         * @param scaling the daamge scaling
+         *
+         * @return This builder
+         */
+        Builder scaling(DamageScaling scaling);
+
+        /**
+         * Sets damage effects
+         *
+         * @param effect the damage effect
+         *
+         * @return This builder
+         */
+        Builder effect(DamageEffect effect);
+
+        /**
+         * Sets the amount of exhaustion a {@link DamageSource} of this type will
+         * add to the entity, generally only to players.
+         *
+         * TODO check if this is still correct
+         * <p>In vanilla gameplay, the default is 0.1, unless if the damage
+         * is absolute or bypasses armor, where the exhaustion gets set to 0.
+         * </p>
+         *
+         * @param exhaustion The amount of exhaustion to add to the entity
+         * @return This builder
+         */
+        Builder exhaustion(double exhaustion);
+
+    }
+
+}