DamageSource.Builder (Spigot-API 1.20.5-R0.1-SNAPSHOT API)

Enclosing interface:: DamageSource

public static interface DamageSource.Builder

Utility class to make building a DamageSource easier. Only a DamageType is required.

Method Summary

Modifier and Type

Method

Description

DamageSource

build()

Create a new DamageSource instance using the supplied parameters.

DamageSource.Builder

withCausingEntity(Entity entity)

Set the Entity that caused the damage.

DamageSource.Builder

withDamageLocation(Location location)

Set the Location of the source of damage.

DamageSource.Builder

withDirectEntity(Entity entity)

Set the Entity that directly inflicted the damage.

Method Details
- withCausingEntity
  
  @NotNull DamageSource.Builder withCausingEntity(@NotNull Entity entity)
  
  Set the Entity that caused the damage.
  Parameters:
  
  entity - the entity
  
  Returns:
  
  this instance. Allows for chained method calls
  
  See Also:
  
  DamageSource.getCausingEntity()
- withDirectEntity
  
  @NotNull DamageSource.Builder withDirectEntity(@NotNull Entity entity)
  
  Set the Entity that directly inflicted the damage.
  Parameters:
  
  entity - the entity
  
  Returns:
  
  this instance. Allows for chained method calls
  
  See Also:
  
  DamageSource.getDirectEntity()
- withDamageLocation
  
  @NotNull DamageSource.Builder withDamageLocation(@NotNull Location location)
  
  Set the Location of the source of damage.
  Parameters:
  
  location - the location where the damage occurred
  
  Returns:
  
  this instance. Allows for chained method calls
  
  See Also:
  
  DamageSource.getSourceLocation()
- build
  
  @NotNull DamageSource build()
  
  Create a new DamageSource instance using the supplied parameters.
  
  Returns:
  
  the damage source instance