Package dev.kitteh.factions
Interface Universe
- All Known Implementing Classes:
JSONUniverse,MemoryUniverse
@AvailableSince("4.0.0")
@NonExtendable
@NullMarked
public interface Universe
Information not tied to any given faction.
-
Method Summary
Modifier and TypeMethodDescriptiondefault booleangrace()Gets if grace is currently enabledGets grace time remaining.voidgraceRemaining(Duration graceRemaining) Sets grace time remaining.booleanisUpgradeEnabled(Upgrade upgrade) Gets if a given upgrade is enabled.static Universeuniverse()Gets the universe.upgradeSettings(Upgrade upgrade) Gets the upgrade settings for an upgrade.
-
Method Details
-
universe
Gets the universe.- Returns:
- the universe
-
graceRemaining
Duration graceRemaining()Gets grace time remaining.- Returns:
- remaining grace time or zero if not active
-
grace
@AvailableSince("4.1.1") default boolean grace()Gets if grace is currently enabled- Returns:
- true if grace enabled
-
graceRemaining
Sets grace time remaining.- Parameters:
graceRemaining- remaining grace time or zero to deactivate
-
isUpgradeEnabled
Gets if a given upgrade is enabled.- Parameters:
upgrade- upgrade to check- Returns:
- true if enabled
-
upgradeSettings
Gets the upgrade settings for an upgrade.- Parameters:
upgrade- upgrade- Returns:
- settings for the upgrade
-