Package com.griefdefender.api.event

Interface RentClaimEvent

All Superinterfaces:

net.kyori.event.Cancellable, ClaimEvent, Event

public interface RentClaimEvent
extends ClaimEvent, net.kyori.event.Cancellable

An event that is fired before a claim is rented. Note: Canceling this event will prevent claim being rented.

Method Summary

Modifier and Type	Method	Description
double	getOriginalRentBalance()	Gets the original rent balance.
double	getOriginalRentRate()	Gets the original rent rate for claim.
PaymentType	getPaymentType()	Gets the rent PaymentType
double	getRentBalance()	Gets the current rent balance due.
User	getRenter()	Gets the User being charged.
double	getRentRate()	Gets the current rent rate.
void	setRentRate(double newRentRate)	Sets a new rent rate for claim.

Methods inherited from interface net.kyori.event.Cancellable

cancelled, cancelled

Methods inherited from interface com.griefdefender.api.event.ClaimEvent

getClaim, getClaims, getMessage, getSource, getSourceUser, setMessage

Methods inherited from interface com.griefdefender.api.event.Event

getCause

Method Details

getOriginalRentBalance

double getOriginalRentBalance()

Gets the original rent balance. Note: This is the previous balance before the new rate was applied.

Returns:

The original rent balance

getOriginalRentRate

double getOriginalRentRate()

Gets the original rent rate for claim.

Returns:

The original rent rate

getRentBalance

double getRentBalance()

Gets the current rent balance due. Note: To adjust the rent balance, use setRentRate(double)

Returns:

The current rent balance

getRentRate

double getRentRate()

Gets the current rent rate.

Returns:

The current rent rate

setRentRate

void setRentRate(double newRentRate)

Sets a new rent rate for claim.

Parameters:

newRentRate - The new rent rate.

getRenter

User getRenter()

Gets the User being charged.

Returns:

The user being charged

getPaymentType

PaymentType getPaymentType()

Gets the rent PaymentType

Returns:

The payment type