Package org.spongepowered.api.event.cause.entity.damage

Interface DamageTypeTemplate.Builder

All Superinterfaces:
AbstractBuilder<DamageTypeTemplate>, Builder<DamageTypeTemplate,DamageTypeTemplate.Builder>, CopyableBuilder<DamageTypeTemplate,DamageTypeTemplate.Builder>, DataPackEntryBuilder<DamageType,DamageTypeTemplate,DamageTypeTemplate.Builder>, ResettableBuilder<DamageTypeTemplate,DamageTypeTemplate.Builder>, ResourceKeyedBuilder<DamageTypeTemplate,DamageTypeTemplate.Builder>
Enclosing interface:
DamageTypeTemplate
public static interface DamageTypeTemplate.Builder extends DataPackEntryBuilder<DamageType,DamageTypeTemplate,DamageTypeTemplate.Builder>

  • Method Details

    • name

      DamageTypeTemplate.Builder name(String name)
      Sets the name of the DamageType. Used as part of the death message translation key. TODO falling/intentional game design?
      Parameters:
      name - The name
      Returns:
      This builder, for chaining

    • scaling

      DamageTypeTemplate.Builder scaling(DamageScaling scaling)
      Sets damage scaling
      Parameters:
      scaling - the daamge scaling
      Returns:
      This builder

    • effect

      DamageTypeTemplate.Builder effect(DamageEffect effect)
      Sets damage effects
      Parameters:
      effect - the damage effect
      Returns:
      This builder

    • exhaustion

      DamageTypeTemplate.Builder exhaustion(double exhaustion)
      Sets the amount of exhaustion a DamageSource of this type will add to the entity, generally only to players. TODO check if this is still correct

      In vanilla gameplay, the default is 0.1, unless if the damage is absolute or bypasses armor, where the exhaustion gets set to 0.

      Parameters:
      exhaustion - The amount of exhaustion to add to the entity
      Returns:
      This builder