Package org.geysermc.geyser.api.item.custom.v2.component.java

Interface JavaKineticWeapon

public interface JavaKineticWeapon

The kinetic weapon component is used to specify a spear-like attack when the item is in use.

Since:

2.9.3

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	JavaKineticWeapon.Builder	Builder for the kinetic weapon component.
static interface	JavaKineticWeapon.Condition	A condition used during the attack of a JavaKineticWeapon.

Method Summary

Modifier and Type	Method	Description
static @NonNull JavaKineticWeapon.Builder	builder()	Creates a builder for the kinetic weapon component.
static @NonNull JavaKineticWeapon.Condition	condition(@org.checkerframework.checker.index.qual.NonNegative int maxDurationTicks)	Creates a new JavaKineticWeapon.Condition.
static @NonNull JavaKineticWeapon.Condition	condition(@org.checkerframework.checker.index.qual.NonNegative int maxDurationTicks, float minSpeed, float minRelativeSpeed)	Creates a new JavaKineticWeapon.Condition.
@org.checkerframework.checker.index.qual.NonNegative int	delayTicks()	The minimum use time, in ticks, required for the weapon to be active.
@Nullable JavaKineticWeapon.Condition	dismountConditions()	The condition that has to meet for the attacker to dismount the target.

Method Details

delayTicks

@org.checkerframework.checker.index.qual.NonNegative int delayTicks()

The minimum use time, in ticks, required for the weapon to be active. Defaults to 0.

Returns:

the minimum use time, in ticks, required for the weapon to be active

Since:

2.9.3

dismountConditions

@Nullable JavaKineticWeapon.Condition dismountConditions()

The condition that has to meet for the attacker to dismount the target.

Returns:

the condition to dismount the target

Since:

2.9.3

builder

static @NonNull JavaKineticWeapon.Builder builder()

Creates a builder for the kinetic weapon component.

Returns:

a new builder

Since:

2.9.3

condition

static @NonNull JavaKineticWeapon.Condition condition(@org.checkerframework.checker.index.qual.NonNegative int maxDurationTicks)

Creates a new JavaKineticWeapon.Condition.

Parameters:

maxDurationTicks - the time in ticks after which the condition is no longer checked

Returns:

the new JavaKineticWeapon.Condition

Since:

2.9.3

See Also:

• JavaKineticWeapon.Condition
• JavaKineticWeapon.Condition.maxDurationTicks()

condition

static @NonNull JavaKineticWeapon.Condition condition(@org.checkerframework.checker.index.qual.NonNegative int maxDurationTicks,
 float minSpeed,
 float minRelativeSpeed)

Creates a new JavaKineticWeapon.Condition.

Parameters:

maxDurationTicks - the time in ticks after which the condition is no longer checked

minSpeed - the minimum speed of the attacker, in blocks per second

minRelativeSpeed - the minimum relative speed between the attacker and the target, in blocks per second

Returns:

the new JavaKineticWeapon.Condition

Since:

2.9.3

See Also:

• JavaKineticWeapon.Condition
• JavaKineticWeapon.Condition.maxDurationTicks()
• JavaKineticWeapon.Condition.minSpeed()
• JavaKineticWeapon.Condition.minRelativeSpeed()