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

Interface DamageSource.Builder

All Superinterfaces:

AbstractBuilder<DamageSource>, Builder<DamageSource,DamageSource.Builder>, CopyableBuilder<DamageSource,DamageSource.Builder>, ResettableBuilder<DamageSource,DamageSource.Builder>

Enclosing interface:

DamageSource

public static interface DamageSource.Builder
extends Builder<DamageSource,DamageSource.Builder>, CopyableBuilder<DamageSource,DamageSource.Builder>

Method Summary

Modifier and Type	Method	Description
DamageSource.Builder	block(@Nullable BlockSnapshot blockSnapshot)	Sets the BlockSnapshot to act as the "damage source".
DamageSource.Builder	block(@Nullable ServerLocation location)	Sets the ServerLocation to use as a "source".
DamageSource	build()	Builds an instance of this damage source, based on the values you inputted into the builder.
DamageSource.Builder	entity(@Nullable Entity entity)	Sets the Entity as the damage "source".
DamageSource.Builder	indirectEntity(@Nullable Entity proxy)	Sets the Entity that is indirectly damaging.
default DamageSource.Builder	type(Supplier<? extends DamageType> damageType)	Sets the DamageType of this source.
DamageSource.Builder	type(DamageType damageType)	Sets the DamageType of this source.

Methods inherited from interface org.spongepowered.api.util.Builder

reset

Methods inherited from interface org.spongepowered.api.util.CopyableBuilder

from

Method Details

type

default DamageSource.Builder type(Supplier<? extends DamageType> damageType)

Sets the DamageType of this source.

This is required to be set.

Parameters:

damageType - The desired damage type

Returns:

This builder

type

DamageSource.Builder type(DamageType damageType)

Sets the DamageType of this source.

This is required to be set.

Parameters:

damageType - The desired damage type

Returns:

This builder

entity

DamageSource.Builder entity(@Nullable Entity entity)

Sets the Entity as the damage "source".

Parameters:

entity - The entity

Returns:

This builder, for chaining

indirectEntity

DamageSource.Builder indirectEntity(@Nullable Entity proxy)

Sets the Entity that is indirectly damaging.

Parameters:

proxy - The indirect entity

Returns:

This builder, for chaining

block

DamageSource.Builder block(@Nullable ServerLocation location)

Sets the ServerLocation to use as a "source".

Parameters:

location - The location of the block as the damage source

Returns:

This builder, for chaining

block

DamageSource.Builder block(@Nullable BlockSnapshot blockSnapshot)

Sets the BlockSnapshot to act as the "damage source".

Parameters:

blockSnapshot - The block snapshot to use as the damage source

Returns:

This builder, for chaining

build

DamageSource build()
            throws IllegalStateException

Builds an instance of this damage source, based on the values you inputted into the builder.

Specified by:

build in interface AbstractBuilder<DamageSource>

Returns:

The resulting damage source

Throws:

IllegalStateException - If a value required to be set is not set