com.github.lazoyoung.craftgames.api.module

Interface WorldModule

public WorldModule

Constructor Detail

WorldModule

public WorldModule()

Method Detail

getMapID

@NotNull
java.lang.String getMapID()

Get current map ID.

getLocation

@NotNull
org.bukkit.Location getLocation(double x,
                                          double y,
                                          double z,
                                          float yaw,
                                          float pitch)

Get Location of this world.

Parameters:

x - X-coordinate

y - Y-coordinate

z - Z-coordinate

yaw - Yaw angle

pitch - Pitch angle

Throws:

MapNotFound - is thrown if world is not generated yet.

See Also:

Location

getCoordTag

@Nullable
CoordTag getCoordTag(@NotNull
                                java.lang.String name)

Get class CoordTag by searching for name.

One tag can store as many locations as you want. Tags are captured via '/ctag capture' in editor mode.

See Also:

class CoordTag, name

getWorldBorder

@NotNull
org.bukkit.WorldBorder getWorldBorder()

Get WorldBorder of this world.

Throws:

MapNotFound - is thrown if world is not generated yet.

See Also:

WorldBorder

setBorderCenter

@Deprecated
void setBorderCenter(@NotNull
                                  java.lang.String blockTag,
                                  int index)

Deprecated.

Set center of WorldBorder for this world.

Parameters:

blockTag - Name of the block coordinate tag which represents the center of border.

index - Index of capture (This is optional).

Throws:

IllegalArgumentException - is thrown if blockTag does not indicate a block coordinate in this world.

MapNotFound - is thrown if world is not generated yet.

See Also:

WorldBorder

setDifficulty

void setDifficulty(@NotNull
                   org.bukkit.Difficulty difficulty)

Set difficulty for every world. (Defaults to Difficulty.NORMAL)

Parameters:

difficulty - The new difficulty

See Also:

Difficulty.NORMAL

setStormyWeather

void setStormyWeather(boolean storm,
                      boolean thunder)

Set world weather to storm or not.

Parameters:

storm - should it rain?

thunder - should it thunder?

Throws:

MapNotFound - is thrown if world is not generated yet.

See Also:

storm

getTime

long getTime(boolean absolute)

Get world time.

See World.getTime for relative time.

See World.getFullTime for absolute time.

Parameters:

absolute - If true, absolute time is returned. Relative in otherwise.

Throws:

MapNotFound - is thrown if world is not generated yet.

See Also:

World.getTime, World.getFullTime

addTime

void addTime(long time)

Add up the amount of time to this world.

Throws:

MapNotFound - is thrown if world is not generated yet.

See Also:

time

setTime

void setTime(long time,
             boolean absolute)

Set time for this world.

See World.setTime for relative time.

See World.setFullTime for absolute time.

Parameters:

time - New time.

absolute - If true, absolute time is returned. Relative in otherwise.

Throws:

MapNotFound - is thrown if world is not generated yet.

See Also:

World.setTime, World.setFullTime

setGameRule

void setGameRule(@NotNull
                 java.lang.String rule,
                 @NotNull
                 java.lang.Object value)

Change Minecraft GameRule.

Parameters:

rule - The name of rule to change

value - The new value to apply

Throws:

IllegalArgumentException - is thrown if rule doesn't indicate a GameRule.

See Also:

GameRule

fillContainers

void fillContainers(@NotNull
                    java.lang.String blockTag,
                    @NotNull
                    org.bukkit.loot.LootTable loot)

Fill a container block with loot table.

Parameters:

blockTag - designates the container location.

loot - describes the contents of items to fill.

Throws:

MapNotFound - is thrown if world is not generated yet.

See Also:

container

fillBlocks

void fillBlocks(@NotNull
                java.lang.String tag,
                @NotNull
                org.bukkit.Material material)

Fill blocks at the spot pointed by a tag.

Parameters:

tag - Name of a Block or Area tag

material - Type of blocks to fill

Throws:

IllegalArgumentException - is thrown if tag is irrelevant.

See Also:

tag

placeSchematics

void placeSchematics(@NotNull
                     java.lang.String tag,
                     @NotNull
                     java.lang.String path,
                     boolean biomes,
                     boolean entities,
                     boolean ignoreAir)

Place blocks by reading a schematic file where the path points to. The blocks will be placed relative to the coordinate of tag.

Parameters:

tag - The target(s) of blocks to be placed.If tag has multiple captures, the same amount of clones will be generated.

path - Path to schematic file. Root directory is same as where layout.yml resides.

biomes - Whether or not to copy biomes.

entities - Whether or not to copy entities.

ignoreAir - Whether or not to ignore air blocks.

Throws:

MapNotFound - is thrown if world is not generated yet.

See Also:

path, tag