Package org.geysermc.geyser.api.entity.property

Interface GeyserEntityProperty<T>

Type Parameters:
T - the type of value stored by this property
All Known Subinterfaces:
GeyserBooleanEntityProperty, GeyserEnumEntityProperty<E>, GeyserFloatEntityProperty, GeyserIntEntityProperty, GeyserStringEnumProperty
public interface GeyserEntityProperty<T>
Represents a property that can be attached to an entity.

Entity properties are used to describe metadata about an entity, such as integers, floats, booleans, or enums.

Since:
2.9.0
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull T
    defaultValue()
    Gets the default value of this property which is set upon spawning entities.
    @NonNull Identifier
    identifier()
    Gets the unique name of this property.

  • Method Details

    • identifier

      @NonNull Identifier identifier()
      Gets the unique name of this property. Custom properties cannot use the vanilla namespace to avoid collisions with vanilla entity properties.
      Returns:
      the property identifier
      Since:
      2.9.0

    • defaultValue

      @NonNull T defaultValue()
      Gets the default value of this property which is set upon spawning entities.
      Returns:
      the default value of this property
      Since:
      2.9.0