Package org.bukkit.damage

Interface DamageSource.Builder

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
@NotNull DamageSource	build()	Create a new DamageSource instance using the supplied parameters.
@NotNull DamageSource.Builder	withCausingEntity(@NotNull Entity entity)	Set the Entity that caused the damage.
@NotNull DamageSource.Builder	withDamageLocation(@NotNull Location location)	Set the Location of the source of damage.
@NotNull DamageSource.Builder	withDirectEntity(@NotNull Entity entity)	Set the Entity that directly inflicted the damage.

Method Details

withCausingEntity

@NotNull
@NotNull DamageSource.Builder withCausingEntity(@NotNull
 @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
@NotNull DamageSource.Builder withDirectEntity(@NotNull
 @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
@NotNull DamageSource.Builder withDamageLocation(@NotNull
 @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
@NotNull DamageSource build()

Create a new DamageSource instance using the supplied parameters.

Returns:

the damage source instance