Void damage configuration API

This commit is contained in:
Axionize 2024-09-25 04:43:26 -04:00
parent 2f8f0f1f81
commit 11f0f5a80a

View file

@ -52,6 +52,54 @@ import org.jetbrains.annotations.Nullable;
*/ */
public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient, Metadatable, PersistentDataHolder, Keyed, net.kyori.adventure.audience.ForwardingAudience { // Paper public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient, Metadatable, PersistentDataHolder, Keyed, net.kyori.adventure.audience.ForwardingAudience { // Paper
// Paper start - void damage configuration
/**
* Checks if void damage is enabled on this world.
*
* @return true if enabled
*/
boolean isVoidDamageEnabled();
/**
* Sets whether void damage is enabled on this world.
*
* @param enabled true to enable void damage
*/
void setVoidDamageEnabled(boolean enabled);
/**
* Gets the damage applied to the player when they are in the void in this world.
* Check {@link #isVoidDamageEnabled()} to see if void damage is enabled.
*
* @return amount of damage to apply
* @see #isVoidDamageEnabled()
*/
float getVoidDamageAmount();
/**
* Sets the damage applied to the player when they are in the void in this world.
* Check {@link #isVoidDamageEnabled()} to see if void damage is enabled.
*
* @param voidDamageAmount amount of damage to apply
*/
void setVoidDamageAmount(float voidDamageAmount);
/**
* Gets the offset applied to {@link #getMinHeight()} to determine the height at which void damage starts to apply.
*
* @return offset from min build height
* @see #isVoidDamageEnabled()
*/
double getVoidDamageMinBuildHeightOffset();
/**
* Sets the offset applied to {@link #getMinHeight()} to determine the height at which void damage starts to apply.
*
* @param minBuildHeightOffset offset from min build height
*/
void setVoidDamageMinBuildHeightOffset(double minBuildHeightOffset);
// Paper end - void damage configuration
// Paper start // Paper start
/** /**
* @return The amount of Entities in this world * @return The amount of Entities in this world