com.projectkorra.projectkorra

Class GeneralMethods

java.lang.Object

com.projectkorra.projectkorra.GeneralMethods

public class GeneralMethods
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static org.bukkit.Material[]	INTERACTABLE_MATERIALS
static java.lang.Integer[]	NON_OPAQUE

Constructor Summary

Constructors

Constructor and Description
GeneralMethods(ProjectKorra plugin)

Method Summary

Modifier and Type	Method and Description
static boolean	abilityExists(java.lang.String string) Checks to see if an AbilityExists.
static void	bindAbility(org.bukkit.entity.Player player, java.lang.String ability) Binds a Ability to the hotbar slot that the player is on.
static void	bindAbility(org.bukkit.entity.Player player, java.lang.String ability, int slot) Binds a Ability to a specific hotbar slot.
static boolean	blockAbilities(org.bukkit.entity.Player player, java.util.List<java.lang.String> abilitiesToBlock, org.bukkit.Location loc, double radius) Cycles through a list of ability names to check if any instances of the abilities exist at a specific location.
static void	breakBlock(org.bukkit.block.Block block) Breaks a block and sets it to AIR.
static boolean	canView(org.bukkit.entity.Player player, java.lang.String ability)
static void	createBendingPlayer(java.util.UUID uuid, java.lang.String player) Creates a BendingPlayer with the data from the database.
static void	deserializeFile() Deserializes the configuration file "bendingPlayers.yml" of the old BendingPlugin and creates a converted.yml ready for conversion.
static void	displayColoredParticle(org.bukkit.Location loc, ParticleEffect type, java.lang.String hexVal, float xOffset, float yOffset, float zOffset)
static void	displayColoredParticle(org.bukkit.Location loc, java.lang.String hexVal)
static void	displayColoredParticle(org.bukkit.Location loc, java.lang.String hexVal, float xOffset, float yOffset, float zOffset)
static void	displayMovePreview(org.bukkit.entity.Player player, CoreAbility ability)
static void	displayParticleVector(org.bukkit.Location loc, ParticleEffect type, float xTrans, float yTrans, float zTrans)
static void	dropItems(org.bukkit.block.Block block, java.util.Collection<org.bukkit.inventory.ItemStack> items) Drops a Collection<ItemStack> of items on a specified block.
static java.util.List<org.bukkit.block.Block>	getBlocksAlongLine(org.bukkit.Location ploc, org.bukkit.Location tloc, org.bukkit.World w)
static java.util.List<org.bukkit.block.Block>	getBlocksAroundPoint(org.bukkit.Location location, double radius) Gets a List<Blocks> within the specified radius around the specified location.
static org.bukkit.block.BlockFace	getCardinalDirection(org.bukkit.util.Vector vector)
static java.util.List<org.bukkit.Location>	getCircle(org.bukkit.Location loc, int radius, int height, boolean hollow, boolean sphere, int plusY)
static java.lang.String	getCurrentDate()
static org.bukkit.util.Vector	getDirection(org.bukkit.Location location, org.bukkit.Location destination)
static double	getDistanceFromLine(org.bukkit.util.Vector line, org.bukkit.Location pointonline, org.bukkit.Location point)
static java.util.Collection<org.bukkit.inventory.ItemStack>	getDrops(org.bukkit.block.Block block, org.bukkit.Material type, byte data, org.bukkit.inventory.ItemStack breakitem) Gets a Collection<ItemStack> of item drops from a single block.
static java.util.List<org.bukkit.entity.Entity>	getEntitiesAroundPoint(org.bukkit.Location location, double radius) Gets a List<Entity> of entities around a specified radius from the specified area
static long	getGlobalCooldown()
static int	getIntCardinalDirection(org.bukkit.util.Vector vector)
static org.bukkit.plugin.Plugin	getItems()
static java.lang.String	getLastUsedAbility(org.bukkit.entity.Player player, boolean checkCombos) Returns the last ability used by a player.
static org.bukkit.Location	getLeftSide(org.bukkit.Location location, double distance) Gets a location with a specified distance away from the left side of a location.
static int	getMaxPresets(org.bukkit.entity.Player player)
static org.bukkit.util.Vector	getOrthogonalVector(org.bukkit.util.Vector axis, double degrees, double length)
static java.util.Collection<org.bukkit.entity.Player>	getPlayersAroundPoint(org.bukkit.Location location, double distance)
static org.bukkit.Location	getPointOnLine(org.bukkit.Location origin, org.bukkit.Location target, double distance)
static org.bukkit.plugin.Plugin	getProbending()
static org.bukkit.Location	getRightSide(org.bukkit.Location location, double distance) Returns a location with a specified distance away from the right side of a location.
static org.bukkit.plugin.Plugin	getRPG()
static org.bukkit.plugin.Plugin	getSpirits()
static org.bukkit.entity.Entity	getTargetedEntity(org.bukkit.entity.Player player, double range)
static org.bukkit.entity.Entity	getTargetedEntity(org.bukkit.entity.Player player, double range, java.util.List<org.bukkit.entity.Entity> avoid)
static org.bukkit.Location	getTargetedLocation(org.bukkit.entity.Player player, double originselectrange, java.lang.Integer... nonOpaque2)
static org.bukkit.Location	getTargetedLocation(org.bukkit.entity.Player player, int range)
static org.bukkit.block.Block	getTopBlock(org.bukkit.Location loc, int range)
static org.bukkit.block.Block	getTopBlock(org.bukkit.Location loc, int positiveY, int negativeY) Returns the top block based around loc.
static boolean	hasItems()
static boolean	hasProbending()
static boolean	hasRPG()
static boolean	hasSpirits()
static boolean	isAdjacentToThreeOrMoreSources(org.bukkit.block.Block block)
static boolean	isImportEnabled()
static boolean	isInteractable(org.bukkit.block.Block block)
static boolean	isObstructed(org.bukkit.Location location1, org.bukkit.Location location2)
static boolean	isRegionProtectedFromBuild(Ability ability, org.bukkit.Location loc)
static boolean	isRegionProtectedFromBuild(org.bukkit.entity.Player player, org.bukkit.Location loc)
static boolean	isRegionProtectedFromBuild(org.bukkit.entity.Player player, java.lang.String ability, org.bukkit.Location loc) isRegionProtectedFromBuild is one of the most server intensive methods in the plugin.
static boolean	isRegionProtectedFromBuildPostCache(org.bukkit.entity.Player player, java.lang.String ability, org.bukkit.Location loc)
static boolean	isSolid(org.bukkit.block.Block block)
static boolean	isUndead(org.bukkit.entity.Entity entity) Checks if an entity is Undead
static boolean	isWeapon(org.bukkit.Material mat)
static void	loadBendingPlayer(BendingPlayer pl)
static void	reloadPlugin(org.bukkit.command.CommandSender sender)
static void	removeBlock(org.bukkit.block.Block block)
static void	removeUnusableAbilities(java.lang.String player)
static org.bukkit.util.Vector	rotateVectorAroundVector(org.bukkit.util.Vector axis, org.bukkit.util.Vector rotator, double degrees)
static org.bukkit.util.Vector	rotateXZ(org.bukkit.util.Vector vec, double theta) Rotates a vector around the Y plane.
static void	runDebug()
static void	saveAbility(BendingPlayer bPlayer, int slot, java.lang.String ability)
static void	saveElements(BendingPlayer bPlayer)
static void	savePermaRemoved(BendingPlayer bPlayer)
static void	saveSubElements(BendingPlayer bPlayer)
static void	setVelocity(org.bukkit.entity.Entity entity, org.bukkit.util.Vector velocity)
static org.bukkit.entity.FallingBlock	spawnFallingBlock(org.bukkit.Location loc, int type)
static org.bukkit.entity.FallingBlock	spawnFallingBlock(org.bukkit.Location loc, int type, byte data)
static org.bukkit.entity.FallingBlock	spawnFallingBlock(org.bukkit.Location loc, org.bukkit.Material type)
static org.bukkit.entity.FallingBlock	spawnFallingBlock(org.bukkit.Location loc, org.bukkit.Material type, byte data)
static void	startCacheCleaner(double period)
static void	stopBending()
static void	stopPlugin()
static void	writeToDebug(java.lang.String message)

Methods inherited from class java.lang.Object

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

Field Detail

NON_OPAQUE

public static final java.lang.Integer[] NON_OPAQUE

INTERACTABLE_MATERIALS

public static final org.bukkit.Material[] INTERACTABLE_MATERIALS

Constructor Detail

GeneralMethods

public GeneralMethods(ProjectKorra plugin)

Method Detail

abilityExists

public static boolean abilityExists(java.lang.String string)

Checks to see if an AbilityExists. Uses method #getAbility(String) to check if it exists.

Parameters:

string - Ability Name

Returns:

true if ability exists

bindAbility

public static void bindAbility(org.bukkit.entity.Player player,
                               java.lang.String ability)

Binds a Ability to the hotbar slot that the player is on.

Parameters:

player - The player to bind to

ability - The ability name to Bind

See Also:

bindAbility(Player, String, int)

bindAbility

public static void bindAbility(org.bukkit.entity.Player player,
                               java.lang.String ability,
                               int slot)

Binds a Ability to a specific hotbar slot.

Parameters:

player - The player to bind to

ability -

slot -

See Also:

bindAbility(Player, String)

blockAbilities

public static boolean blockAbilities(org.bukkit.entity.Player player,
                                     java.util.List<java.lang.String> abilitiesToBlock,
                                     org.bukkit.Location loc,
                                     double radius)

Cycles through a list of ability names to check if any instances of the abilities exist at a specific location. If an instance of the ability is found then it will be removed, with the exception FireShield, and AirShield.

breakBlock

public static void breakBlock(org.bukkit.block.Block block)

Breaks a block and sets it to AIR.

Parameters:

block - The block to break

canView

public static boolean canView(org.bukkit.entity.Player player,
                              java.lang.String ability)

createBendingPlayer

public static void createBendingPlayer(java.util.UUID uuid,
                                       java.lang.String player)

Creates a BendingPlayer with the data from the database. This runs when a player logs in.

Parameters:

uuid - The UUID of the player

player - The player name

Throws:

java.sql.SQLException

deserializeFile

public static void deserializeFile()

Deserializes the configuration file "bendingPlayers.yml" of the old BendingPlugin and creates a converted.yml ready for conversion.

Throws:

java.io.IOException - If the "bendingPlayers.yml" file is not found

displayColoredParticle

public static void displayColoredParticle(org.bukkit.Location loc,
                                          ParticleEffect type,
                                          java.lang.String hexVal,
                                          float xOffset,
                                          float yOffset,
                                          float zOffset)

displayColoredParticle

public static void displayColoredParticle(org.bukkit.Location loc,
                                          java.lang.String hexVal)

displayColoredParticle

public static void displayColoredParticle(org.bukkit.Location loc,
                                          java.lang.String hexVal,
                                          float xOffset,
                                          float yOffset,
                                          float zOffset)

displayParticleVector

public static void displayParticleVector(org.bukkit.Location loc,
                                         ParticleEffect type,
                                         float xTrans,
                                         float yTrans,
                                         float zTrans)

dropItems

public static void dropItems(org.bukkit.block.Block block,
                             java.util.Collection<org.bukkit.inventory.ItemStack> items)

Drops a Collection<ItemStack> of items on a specified block.

Parameters:

block - The block to drop items on.

items - The items to drop.

displayMovePreview

public static void displayMovePreview(org.bukkit.entity.Player player,
                                      CoreAbility ability)

getBlocksAlongLine

public static java.util.List<org.bukkit.block.Block> getBlocksAlongLine(org.bukkit.Location ploc,
                                                                        org.bukkit.Location tloc,
                                                                        org.bukkit.World w)

getBlocksAroundPoint

public static java.util.List<org.bukkit.block.Block> getBlocksAroundPoint(org.bukkit.Location location,
                                                                          double radius)

Gets a List<Blocks> within the specified radius around the specified location.

Parameters:

location - The base location

radius - The block radius from location to include within the list of blocks

Returns:

The list of Blocks

getCardinalDirection

public static org.bukkit.block.BlockFace getCardinalDirection(org.bukkit.util.Vector vector)

getCircle

public static java.util.List<org.bukkit.Location> getCircle(org.bukkit.Location loc,
                                                            int radius,
                                                            int height,
                                                            boolean hollow,
                                                            boolean sphere,
                                                            int plusY)

getCurrentDate

public static java.lang.String getCurrentDate()

getDirection

public static org.bukkit.util.Vector getDirection(org.bukkit.Location location,
                                                  org.bukkit.Location destination)

getDistanceFromLine

public static double getDistanceFromLine(org.bukkit.util.Vector line,
                                         org.bukkit.Location pointonline,
                                         org.bukkit.Location point)

getDrops

public static java.util.Collection<org.bukkit.inventory.ItemStack> getDrops(org.bukkit.block.Block block,
                                                                            org.bukkit.Material type,
                                                                            byte data,
                                                                            org.bukkit.inventory.ItemStack breakitem)

Gets a Collection<ItemStack> of item drops from a single block.

Parameters:

block - The single block

type - The Material type to change the block into

data - The block data to change the block into

breakitem - Unused

Returns:

The item drops fromt the specified block

getEntitiesAroundPoint

public static java.util.List<org.bukkit.entity.Entity> getEntitiesAroundPoint(org.bukkit.Location location,
                                                                              double radius)

Gets a List<Entity> of entities around a specified radius from the specified area

Parameters:

location - The base location

radius - The radius of blocks to look for entities from the location

Returns:

A list of entities around a point

getGlobalCooldown

public static long getGlobalCooldown()

getIntCardinalDirection

public static int getIntCardinalDirection(org.bukkit.util.Vector vector)

getItems

public static org.bukkit.plugin.Plugin getItems()

getLastUsedAbility

public static java.lang.String getLastUsedAbility(org.bukkit.entity.Player player,
                                                  boolean checkCombos)

Returns the last ability used by a player. Also checks if a combo was used.

Parameters:

player - The player to check

Returns:

name of last ability used

getLeftSide

public static org.bukkit.Location getLeftSide(org.bukkit.Location location,
                                              double distance)

Gets a location with a specified distance away from the left side of a location.

Parameters:

location - The origin location

distance - The distance to the left

Returns:

the location of the distance to the left

getMaxPresets

public static int getMaxPresets(org.bukkit.entity.Player player)

getOrthogonalVector

public static org.bukkit.util.Vector getOrthogonalVector(org.bukkit.util.Vector axis,
                                                         double degrees,
                                                         double length)

getPlayersAroundPoint

public static java.util.Collection<org.bukkit.entity.Player> getPlayersAroundPoint(org.bukkit.Location location,
                                                                                   double distance)

getPointOnLine

public static org.bukkit.Location getPointOnLine(org.bukkit.Location origin,
                                                 org.bukkit.Location target,
                                                 double distance)

getRightSide

public static org.bukkit.Location getRightSide(org.bukkit.Location location,
                                               double distance)

Returns a location with a specified distance away from the right side of a location.

Parameters:

location - The origin location

distance - The distance to the right

Returns:

the location of the distance to the right

getProbending

public static org.bukkit.plugin.Plugin getProbending()

getRPG

public static org.bukkit.plugin.Plugin getRPG()

getSpirits

public static org.bukkit.plugin.Plugin getSpirits()

getTargetedEntity

public static org.bukkit.entity.Entity getTargetedEntity(org.bukkit.entity.Player player,
                                                         double range,
                                                         java.util.List<org.bukkit.entity.Entity> avoid)

getTargetedEntity

public static org.bukkit.entity.Entity getTargetedEntity(org.bukkit.entity.Player player,
                                                         double range)

getTargetedLocation

public static org.bukkit.Location getTargetedLocation(org.bukkit.entity.Player player,
                                                      double originselectrange,
                                                      java.lang.Integer... nonOpaque2)

getTargetedLocation

public static org.bukkit.Location getTargetedLocation(org.bukkit.entity.Player player,
                                                      int range)

getTopBlock

public static org.bukkit.block.Block getTopBlock(org.bukkit.Location loc,
                                                 int range)

getTopBlock

public static org.bukkit.block.Block getTopBlock(org.bukkit.Location loc,
                                                 int positiveY,
                                                 int negativeY)

Returns the top block based around loc. PositiveY is the maximum amount of distance it will check upward. Similarly, negativeY is for downward.

hasItems

public static boolean hasItems()

hasProbending

public static boolean hasProbending()

hasRPG

public static boolean hasRPG()

hasSpirits

public static boolean hasSpirits()

isAdjacentToThreeOrMoreSources

public static boolean isAdjacentToThreeOrMoreSources(org.bukkit.block.Block block)

isImportEnabled

public static boolean isImportEnabled()

isInteractable

public static boolean isInteractable(org.bukkit.block.Block block)

isObstructed

public static boolean isObstructed(org.bukkit.Location location1,
                                   org.bukkit.Location location2)

isRegionProtectedFromBuild

public static boolean isRegionProtectedFromBuild(org.bukkit.entity.Player player,
                                                 java.lang.String ability,
                                                 org.bukkit.Location loc)

isRegionProtectedFromBuild is one of the most server intensive methods in the plugin. It uses a blockCache that keeps track of recent blocks that may have already been checked. Abilities like TremorSense call this ability 5 times per tick even though it only needs to check a single block, instead of doing all 5 of those checks this method will now look in the map first.

isRegionProtectedFromBuild

public static boolean isRegionProtectedFromBuild(Ability ability,
                                                 org.bukkit.Location loc)

isRegionProtectedFromBuild

public static boolean isRegionProtectedFromBuild(org.bukkit.entity.Player player,
                                                 org.bukkit.Location loc)

isRegionProtectedFromBuildPostCache

public static boolean isRegionProtectedFromBuildPostCache(org.bukkit.entity.Player player,
                                                          java.lang.String ability,
                                                          org.bukkit.Location loc)

isSolid

public static boolean isSolid(org.bukkit.block.Block block)

isUndead

public static boolean isUndead(org.bukkit.entity.Entity entity)

Checks if an entity is Undead

isWeapon

public static boolean isWeapon(org.bukkit.Material mat)

loadBendingPlayer

public static void loadBendingPlayer(BendingPlayer pl)

reloadPlugin

public static void reloadPlugin(org.bukkit.command.CommandSender sender)

removeBlock

public static void removeBlock(org.bukkit.block.Block block)

removeUnusableAbilities

public static void removeUnusableAbilities(java.lang.String player)

rotateVectorAroundVector

public static org.bukkit.util.Vector rotateVectorAroundVector(org.bukkit.util.Vector axis,
                                                              org.bukkit.util.Vector rotator,
                                                              double degrees)

rotateXZ

public static org.bukkit.util.Vector rotateXZ(org.bukkit.util.Vector vec,
                                              double theta)

Rotates a vector around the Y plane.

runDebug

public static void runDebug()

saveAbility

public static void saveAbility(BendingPlayer bPlayer,
                               int slot,
                               java.lang.String ability)

saveElements

public static void saveElements(BendingPlayer bPlayer)

saveSubElements

public static void saveSubElements(BendingPlayer bPlayer)

savePermaRemoved

public static void savePermaRemoved(BendingPlayer bPlayer)

setVelocity

public static void setVelocity(org.bukkit.entity.Entity entity,
                               org.bukkit.util.Vector velocity)

spawnFallingBlock

public static org.bukkit.entity.FallingBlock spawnFallingBlock(org.bukkit.Location loc,
                                                               int type)

spawnFallingBlock

public static org.bukkit.entity.FallingBlock spawnFallingBlock(org.bukkit.Location loc,
                                                               int type,
                                                               byte data)

spawnFallingBlock

public static org.bukkit.entity.FallingBlock spawnFallingBlock(org.bukkit.Location loc,
                                                               org.bukkit.Material type)

spawnFallingBlock

public static org.bukkit.entity.FallingBlock spawnFallingBlock(org.bukkit.Location loc,
                                                               org.bukkit.Material type,
                                                               byte data)

startCacheCleaner

public static void startCacheCleaner(double period)

stopBending

public static void stopBending()

stopPlugin

public static void stopPlugin()

writeToDebug

public static void writeToDebug(java.lang.String message)