Interface GEOResource
-
- All Superinterfaces:
Keyed
public interface GEOResource extends Keyed
AGEOResource
is a virtual resource that can be thought of as world-gen. However it cannot be found in aWorld
. This resource only exists in memory and can be retrieved through aGEOMiner
or similar devices. AGEOResource
can be detected via theGEOScanner
.- Author:
- TheBusyBiscuit
- See Also:
ResourceManager
,GEOMiner
,GEOScanner
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description int
getDefaultSupply(World.Environment environment, Biome biome)
Returns the default supply of this resource in that biomeItemStack
getItem()
ThisItemStack
is used for display-purposes in the GEO Scanner.int
getMaxDeviation()
Returns how much the value may deviate from the default supply (positive only).String
getName()
Returns the name of this resource (e.g.default String
getName(Player p)
This method returns a localized name for thisGEOResource
in theLanguage
the givenPlayer
selected.boolean
isObtainableFromGEOMiner()
Returns whether this Resource can be obtained using a GEO Miner.default void
register()
Registers this GEO Resource
-
-
-
Method Detail
-
getDefaultSupply
int getDefaultSupply(World.Environment environment, Biome biome)
Returns the default supply of this resource in that biome- Parameters:
environment
- TheWorld.Environment
this area is currently in (NORMAL / NETHER / THE_END)biome
- TheBiome
this area is currently in.- Returns:
- The default supply found in a
Chunk
with the givenBiome
-
getMaxDeviation
int getMaxDeviation()
Returns how much the value may deviate from the default supply (positive only).- Returns:
- The deviation or spread of the supply
-
getName
String getName()
Returns the name of this resource (e.g. "Oil")- Returns:
- The name of this Resource
-
getItem
ItemStack getItem()
ThisItemStack
is used for display-purposes in the GEO Scanner. But will also determine the Output of the GEO Miner, if it is applicable for that.- Returns:
- The
ItemStack
version of this Resource.
-
isObtainableFromGEOMiner
boolean isObtainableFromGEOMiner()
Returns whether this Resource can be obtained using a GEO Miner. This will automatically add it to the GEO - Miner.- Returns:
- Whether you can get obtain this resource using a GEO Miner.
-
register
default void register()
Registers this GEO Resource
-
getName
default String getName(Player p)
This method returns a localized name for thisGEOResource
in theLanguage
the givenPlayer
selected.- Parameters:
p
- ThePlayer
to localize the name for.- Returns:
- The localized name for this
GEOResource
-
-