com.projectkorra.projectkorra.util

Class BlockSource

java.lang.Object

com.projectkorra.projectkorra.util.BlockSource

public class BlockSource
extends java.lang.Object

BlockSource is a class that handles water and earth bending sources. When a Player left clicks or presses shift the update method is called which attempts to update the player's sources. In this class ClickType refers to the way in which the source was selected. For example, Surge has two different ways to select a source, one involving shift and another involving left clicks.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BlockSource.BlockSourceType An enum representation of the source types available for bending abilities.

Constructor Summary

Constructors

Constructor and Description
BlockSource()

Method Summary

Modifier and Type	Method and Description
static BlockSourceInformation	getBlockSourceInformation(org.bukkit.entity.Player player, BlockSource.BlockSourceType sourceType, ClickType clickType) Access a block's source information, depending on a BlockSource.BlockSourceType and ClickType.
static org.bukkit.block.Block	getEarthOrLavaSourceBlock(org.bukkit.entity.Player player, double range, ClickType clickType) Attempts to access a Lava bendable block or an Earth block that was recently shifted or clicked on by the player.
static org.bukkit.block.Block	getEarthSourceBlock(org.bukkit.entity.Player player, double range, ClickType clickType) Attempts to access a Earth bendable block that was recently shifted or clicked on by the player.
static org.bukkit.block.Block	getEarthSourceBlock(org.bukkit.entity.Player player, double range, ClickType clickType, boolean allowNearbySubstitute) Attempts to access a Earth bendable block that was recently shifted or clicked on by the player.
static org.bukkit.block.Block	getLavaSourceBlock(org.bukkit.entity.Player player, double range, ClickType clickType) Attempts to access a Lava bendable block that was recently shifted or clicked on by the player.
static org.bukkit.block.Block	getSourceBlock(org.bukkit.entity.Player player, double range, BlockSource.BlockSourceType sourceType, ClickType clickType) Access a specific type of source block depending on a range and ClickType.
static BlockSourceInformation	getValidBlockSourceInformation(org.bukkit.entity.Player player, double range, BlockSource.BlockSourceType sourceType, ClickType clickType) Access a block source information depending on a range, BlockSource.BlockSourceType, and ClickType.
static org.bukkit.block.Block	getWaterSourceBlock(org.bukkit.entity.Player player, double range) Attempts to access a Water bendable block that was recently shifted or clicked on by the player.
static org.bukkit.block.Block	getWaterSourceBlock(org.bukkit.entity.Player player, double range, boolean allowWater, boolean allowIce, boolean allowPlant) Attempts to access a Water bendable block that was recently shifted or clicked on by the player.
static org.bukkit.block.Block	getWaterSourceBlock(org.bukkit.entity.Player player, double range, ClickType clickType) Attempts to access a Water bendable block that was recently shifted or clicked on by the player.
static org.bukkit.block.Block	getWaterSourceBlock(org.bukkit.entity.Player player, double range, ClickType clickType, boolean allowWater, boolean allowIce, boolean allowPlant) Attempts to access a Water bendable block that was recently shifted or clicked on by the player.
static org.bukkit.block.Block	getWaterSourceBlock(org.bukkit.entity.Player player, double range, ClickType clickType, boolean allowWater, boolean allowIce, boolean allowPlant, boolean allowSnow, boolean allowWaterBottles) Attempts to access a Water bendable block that was recently shifted or clicked on by the player.
static void	update(org.bukkit.entity.Player player, ClickType clickType) Updates all of the player's sources.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BlockSource

public BlockSource()

Method Detail

update

public static void update(org.bukkit.entity.Player player,
                          ClickType clickType)

Updates all of the player's sources.

Parameters:

player - the player performing the bending.

clickType - either ClickType.SHIFT_DOWN or ClickType.LEFT_CLICK

getBlockSourceInformation

public static BlockSourceInformation getBlockSourceInformation(org.bukkit.entity.Player player,
                                                               BlockSource.BlockSourceType sourceType,
                                                               ClickType clickType)

Access a block's source information, depending on a BlockSource.BlockSourceType and ClickType.

Parameters:

player - the player that is trying to bend.

clickType - the action that was performed to access the source, either ClickType.SHIFT_DOWN or ClickType.LEFT_CLICK.

Returns:

a valid bendable block, or null if none was found.

getValidBlockSourceInformation

public static BlockSourceInformation getValidBlockSourceInformation(org.bukkit.entity.Player player,
                                                                    double range,
                                                                    BlockSource.BlockSourceType sourceType,
                                                                    ClickType clickType)

Access a block source information depending on a range, BlockSource.BlockSourceType, and ClickType.

Parameters:

player - the player that is trying to bend.

range - the maximum range to access the block.

sourceType - the elemental type of block to find.

clickType - the action that was performed to access the source, either ClickType.SHIFT_DOWN or ClickType.LEFT_CLICK.

Returns:

a valid bendable block, or null if none was found.

getSourceBlock

public static org.bukkit.block.Block getSourceBlock(org.bukkit.entity.Player player,
                                                    double range,
                                                    BlockSource.BlockSourceType sourceType,
                                                    ClickType clickType)

Access a specific type of source block depending on a range and ClickType.

Parameters:

player - the player that is trying to bend.

range - the maximum range to access the block.

sourceType - the elemental type of block to find.

clickType - the action that was performed to access the source, either ClickType.SHIFT_DOWN or ClickType.LEFT_CLICK.

Returns:

a valid bendable block, or null if none was found.

getWaterSourceBlock

public static org.bukkit.block.Block getWaterSourceBlock(org.bukkit.entity.Player player,
                                                         double range)

Attempts to access a Water bendable block that was recently shifted or clicked on by the player.

Parameters:

player - the player that is trying to bend.

range - the maximum range to access the block.

Returns:

a valid Water bendable block, or null if none was found.

getWaterSourceBlock

public static org.bukkit.block.Block getWaterSourceBlock(org.bukkit.entity.Player player,
                                                         double range,
                                                         ClickType clickType)

Attempts to access a Water bendable block that was recently shifted or clicked on by the player.

Parameters:

player - the player that is trying to bend.

range - the maximum range to access the block.

clickType - the action that was performed to access the source, either ClickType.SHIFT_DOWN or ClickType.LEFT_CLICK.

Returns:

a valid Water bendable block, or null if none was found.

getWaterSourceBlock

public static org.bukkit.block.Block getWaterSourceBlock(org.bukkit.entity.Player player,
                                                         double range,
                                                         boolean allowWater,
                                                         boolean allowIce,
                                                         boolean allowPlant)

Attempts to access a Water bendable block that was recently shifted or clicked on by the player.

Parameters:

player - the player that is trying to bend.

range - the maximum range to access the block.

allowWater - true if water blocks are allowed.

allowIce - true if ice blocks are allowed.

allowPlant - true if plant blocks are allowed.

Returns:

a valid Water bendable block, or null if none was found.

getWaterSourceBlock

public static org.bukkit.block.Block getWaterSourceBlock(org.bukkit.entity.Player player,
                                                         double range,
                                                         ClickType clickType,
                                                         boolean allowWater,
                                                         boolean allowIce,
                                                         boolean allowPlant)

Attempts to access a Water bendable block that was recently shifted or clicked on by the player.

Parameters:

player - the player that is trying to bend.

range - the maximum range to access the block.

clickType - the action that was performed to access the source, either ClickType.SHIFT_DOWN or ClickType.LEFT_CLICK.

allowWater - true if water blocks are allowed.

allowIce - true if ice blocks are allowed.

allowPlant - true if plant blocks are allowed.

Returns:

a valid Water bendable block, or null if none was found.

getWaterSourceBlock

public static org.bukkit.block.Block getWaterSourceBlock(org.bukkit.entity.Player player,
                                                         double range,
                                                         ClickType clickType,
                                                         boolean allowWater,
                                                         boolean allowIce,
                                                         boolean allowPlant,
                                                         boolean allowSnow,
                                                         boolean allowWaterBottles)

Attempts to access a Water bendable block that was recently shifted or clicked on by the player.

Parameters:

player - the player that is trying to bend.

range - the maximum range to access the block.

clickType - the action that was performed to access the source, either ClickType.SHIFT_DOWN or ClickType.LEFT_CLICK.

allowWater - true if water blocks are allowed.

allowIce - true if ice blocks are allowed.

allowPlant - true if plant blocks are allowed.

allowWaterBottles - true if we should look for a close water block, that may have been created by a WaterBottle.

Returns:

a valid Water bendable block, or null if none was found.

getEarthSourceBlock

public static org.bukkit.block.Block getEarthSourceBlock(org.bukkit.entity.Player player,
                                                         double range,
                                                         ClickType clickType)

Attempts to access a Earth bendable block that was recently shifted or clicked on by the player.

Parameters:

player - the player that is trying to bend.

range - the maximum range to access the block.

clickType - the action that was performed to access the source, either ClickType.SHIFT_DOWN or ClickType.LEFT_CLICK.

Returns:

a valid Earth bendable block, or null if none was found.

getEarthSourceBlock

public static org.bukkit.block.Block getEarthSourceBlock(org.bukkit.entity.Player player,
                                                         double range,
                                                         ClickType clickType,
                                                         boolean allowNearbySubstitute)

Attempts to access a Earth bendable block that was recently shifted or clicked on by the player.

Parameters:

player - the player that is trying to bend.

range - the maximum range to access the block.

clickType - the action that was performed to access the source, either ClickType.SHIFT_DOWN or ClickType.LEFT_CLICK.

allowNearbySubstitute - if a valid earth source could not be found then this method will attempt to find a nearby valid earth block.

Returns:

a valid Earth bendable block, or null if none was found.

getLavaSourceBlock

public static org.bukkit.block.Block getLavaSourceBlock(org.bukkit.entity.Player player,
                                                        double range,
                                                        ClickType clickType)

Attempts to access a Lava bendable block that was recently shifted or clicked on by the player.

Parameters:

player - the player that is trying to bend.

range - the maximum range to access the block.

clickType - the action that was performed to access the source, either ClickType.SHIFT_DOWN or ClickType.LEFT_CLICK.

Returns:

a valid Lava bendable block, or null if none was found.

getEarthOrLavaSourceBlock

public static org.bukkit.block.Block getEarthOrLavaSourceBlock(org.bukkit.entity.Player player,
                                                               double range,
                                                               ClickType clickType)

Attempts to access a Lava bendable block or an Earth block that was recently shifted or clicked on by the player.

Parameters:

player - the player that is trying to bend.

range - the maximum range to access the block.

clickType - the action that was performed to access the source, either ClickType.SHIFT_DOWN or ClickType.LEFT_CLICK.

Returns:

a valid Earth or Lava bendable block, or null if none was found.