Enum WarpRentType
- All Implemented Interfaces:
Serializable,Comparable<WarpRentType>,java.lang.constant.Constable
List of all possible outcome types when a rent is needed.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionvoidsendMessage(WPlayer warpPlayer, Warp warp, FileConfiguration configuration) Sends a message to a player about their rent status depending on the enum instance.static WarpRentTypeReturns the enum constant of this type with the specified name.static WarpRentType[]values()Returns an array containing the constants of this enum type, in the order they are declared.Methods inherited from class java.lang.Enum
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Enum Constant Details
-
SUCCESS
This constant is when the rent type was successful. (The player had the money to pay) This is used to determine what message to send to the player and is used in thePlayerWarpRentEvent.getRentType()method. -
ERROR
This constant is when the rent type was not successful. (The player had no money to pay) This is used to determine what message to send to the player and is used in thePlayerWarpRentEvent.getRentType()method.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
sendMessage
Sends a message to a player about their rent status depending on the enum instance.- Parameters:
warpPlayer- The player that will receive the message.warp- The warp that the rent has been triggered from.configuration- The configuration object to grab the appropriate message from.
-