Package io.papermc.paper.datacomponent.item

Interface UseEffects.Builder

All Superinterfaces:

DataComponentBuilder<UseEffects>

Enclosing interface:

UseEffects

@Experimental
@NonExtendable
public static interface UseEffects.Builder
extends DataComponentBuilder<UseEffects>

Builder for UseEffects.

Method Summary

Modifier and Type	Method	Description
UseEffects.Builder	canSprint(boolean canSprint)	Sets whether the player can sprint while using the item.
UseEffects.Builder	interactVibrations(boolean interactVibrations)	Sets whether using the item generates interaction vibrations.
UseEffects.Builder	speedMultiplier(float speedMultiplier)	Sets the speed multiplier while using the item.

Methods inherited from interface io.papermc.paper.datacomponent.DataComponentBuilder

build

Method Details

canSprint

@Contract(value="_ -> this",
          mutates="this")
UseEffects.Builder canSprint(boolean canSprint)

Sets whether the player can sprint while using the item.

Parameters:

canSprint - true to allow sprinting

Returns:

the builder for chaining

See Also:

• UseEffects.canSprint()

interactVibrations

@Contract(value="_ -> this",
          mutates="this")
UseEffects.Builder interactVibrations(boolean interactVibrations)

Sets whether using the item generates interaction vibrations.

Parameters:

interactVibrations - true to generate vibrations

Returns:

the builder for chaining

See Also:

• UseEffects.interactVibrations()

speedMultiplier

@Contract(value="_ -> this",
          mutates="this")
UseEffects.Builder speedMultiplier(float speedMultiplier)

Sets the speed multiplier while using the item.

Parameters:

speedMultiplier - multiplier (1.0 >= value >= 0.0)

Returns:

the builder for chaining

See Also:

• UseEffects.speedMultiplier()