io.github.wysohn.triggerreactor.bukkit.manager.trigger.share

Class AbstractCommonFunctions

java.lang.Object

io.github.wysohn.triggerreactor.core.manager.trigger.share.CommonFunctions

io.github.wysohn.triggerreactor.bukkit.manager.trigger.share.AbstractCommonFunctions

All Implemented Interfaces:

SelfReference

Direct Known Subclasses:

CommonFunctions

public abstract class AbstractCommonFunctions
extends CommonFunctions
implements SelfReference

Field Summary

Fields

Modifier and Type	Field and Description
protected TriggerReactorCore	plugin

Constructor Summary

Constructors

Constructor and Description
AbstractCommonFunctions(TriggerReactorCore plugin)

Method Summary

Modifier and Type	Method and Description
void	addLore(org.bukkit.inventory.ItemStack IS, String lore) Append a lore to the specified ItemStack
org.bukkit.block.Block	block(String world, int x, int y, int z) get Block instance.
org.bukkit.Color	bukkitColor(int red, int green, int blue) creates and returns a bukkit color object using the RGB values given.
void	clearLore(org.bukkit.inventory.ItemStack IS) Clear all lores from item.
String	color(String str) Translate & into minecraft color code
String	currentArea(org.bukkit.entity.Entity entity) Deprecated. this returns only one area among the areas where entity is in. Use currentAreas(Entity) instead to get all the areas.
String	currentAreaAt(org.bukkit.Location location) Deprecated. this only return one AreaTrigger's name, yet there could be more
String[]	currentAreas(org.bukkit.entity.Entity entity) Get the name of area where entity is currently standing on.
String[]	currentAreasAt(org.bukkit.Location location) Get the name of area triggers containing the given location.
String	formatCurrency(double money) Translate money into specified country's currency format.
String	formatCurrency(double money, String locale1, String locale2) Translate money into specified country's currency format.
List<org.bukkit.entity.Entity>	getEntitiesInArea(String areaTriggerName) Get list of entities tracked by this AreaTrigger.
String	getItemTitle(org.bukkit.inventory.ItemStack IS) Get title of the specified ItemStack.
String	getLore(org.bukkit.inventory.ItemStack IS, int index) get Lore at the specified index
abstract Collection<? extends org.bukkit.entity.Player>	getPlayers() get list of online players online
org.bukkit.block.Block	getTargetBlock(org.bukkit.entity.Player player, int maxDistance) Get the block which player is looking at
boolean	hasLore(org.bukkit.inventory.ItemStack IS, String lore) Check if the specified ItemStack contains the 'lore.' At least one is contained in the lore will return true.
org.bukkit.inventory.ItemStack	headForName(String targetName) Create a player head with given name.
abstract org.bukkit.inventory.ItemStack	headForName(String targetName, int amount) Create a player head with given name.
abstract org.bukkit.inventory.ItemStack	headForValue(String textureValue) Create a player head with given textureValue(base64 encoded).
abstract org.bukkit.inventory.ItemStack	item(int type, int amount) Deprecated. use item(String, int) instead
abstract org.bukkit.inventory.ItemStack	item(int type, int amount, int data) Deprecated. use item(String, int, int) instead
abstract org.bukkit.inventory.ItemStack	item(String type, int amount) Create a new ItemStack
abstract org.bukkit.inventory.ItemStack	item(String type, int amount, int data) Create a new ItemStack
org.bukkit.Location	location(String world, double x, double y, double z) Create Location instance.
org.bukkit.Location	location(String world, double x, double y, double z, double yaw, double pitch) Create Location instance including pitch and yaw
boolean	locationEqual(org.bukkit.Location loc1, org.bukkit.Location loc2) check if two location are equal not considering their decimal points
int	loreSize(org.bukkit.inventory.ItemStack IS) get size of the lores for the specified ItemStack
abstract org.bukkit.potion.PotionEffect	makePotionEffect(String EffectType, int duration, int amplifier, boolean ambient, boolean particles, org.bukkit.Color color) create a PotionEffect for use in entity.addPotionEffect();
org.bukkit.OfflinePlayer	oplayer(String name) try to get offline player from name.
org.bukkit.entity.Player	player(String name) try to get a player from name.
org.bukkit.plugin.Plugin	plugin(String name) Simply try to get plugin object directly.
void	removeLore(org.bukkit.inventory.ItemStack IS, int index) Remove lore at the 'index' of the specified ItemStack.
abstract Object	serializeLocation(org.bukkit.Location loc) Create a new SerializableLocation, which implements ConfigurationSerializable
abstract Object	serializeLocation(org.bukkit.World world, double x, double y, double z) Create a new SerializableLocation, which implements ConfigurationSerializable
abstract Object	serializeLocation(org.bukkit.World world, double x, double y, double z, double yaw, double pitch) Create a new SerializableLocation, which implements ConfigurationSerializable
void	setItemTitle(org.bukkit.inventory.ItemStack IS, String title) Set title of the specified ItemStack
void	setLore(org.bukkit.inventory.ItemStack IS, int index, String lore) Replace a lore at 'index' for the specified ItemStack.
abstract boolean	takeItem(org.bukkit.entity.Player player, int id, int amount) Deprecated. use takeItem(Player, String, int) instead
abstract boolean	takeItem(org.bukkit.entity.Player player, int id, int amount, int data) Deprecated. use takeItem(Player, String, int, int) instead
boolean	takeItem(org.bukkit.entity.Player player, org.bukkit.inventory.ItemStack IS, int amount) take ItemStack from player.
abstract boolean	takeItem(org.bukkit.entity.Player player, String id, int amount) take item from player.
abstract boolean	takeItem(org.bukkit.entity.Player player, String id, int amount, int data) take item from player.

Methods inherited from class io.github.wysohn.triggerreactor.core.manager.trigger.share.CommonFunctions

array, arrayOf, list, listOf, map, matches, mergeArguments, mergeArguments, mergeArguments, newInstance, parseDouble, parseEnum, parseInt, random, random, random, random, random, random, random, random, round, set, set, slocation, sqrt, staticGetFieldValue, staticMethod, staticSetFieldValue, toByte, toDouble, toFloat, toInt, toLong, toShort, typeOf

Methods inherited from class java.lang.Object

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

Field Detail

plugin

protected final TriggerReactorCore plugin

Constructor Detail

AbstractCommonFunctions

public AbstractCommonFunctions(TriggerReactorCore plugin)

Method Detail

plugin

public org.bukkit.plugin.Plugin plugin(String name)

Simply try to get plugin object directly. *

Example) #MESSAGE "spawn region info: "+plugin("WorldGuard").getRegionManager(player.getWorld()).getRegion("spawn")

Parameters:

name - name of the plugin.

Returns:

Plugin object on success; null if plugin not found or loaded.

takeItem

@Deprecated
public abstract boolean takeItem(org.bukkit.entity.Player player,
                                             int id,
                                             int amount)

Deprecated. use takeItem(Player, String, int) instead

Deprecated since 1.13. Even though you are advised to used the new method, this method is supported only for legacy-bukkit version

Parameters:

player -

id -

amount -

Returns:

takeItem

public abstract boolean takeItem(org.bukkit.entity.Player player,
                                 String id,
                                 int amount)

take item from player.

Example) /trg run IF takeItem(player, "STONE", 1); #MESSAGE "Removed one stone."; ELSE; #MESSAGE "You don't have a stone"; ENDIF;

You can find item names in Material

Parameters:

player - target player

id - item id

amount - amount

Returns:

true if took it; false if player doesn't have it

takeItem

@Deprecated
public abstract boolean takeItem(org.bukkit.entity.Player player,
                                             int id,
                                             int amount,
                                             int data)

Deprecated. use takeItem(Player, String, int, int) instead

Deprecated since 1.13. Even though you are advised to used the new method, this method is supported only for legacy-bukkit version

Parameters:

player -

id -

amount -

data -

Returns:

takeItem

public abstract boolean takeItem(org.bukkit.entity.Player player,
                                 String id,
                                 int amount,
                                 int data)

take item from player.

Example) /trg run IF takeItem(player, "STONE", 1, 1); #MESSAGE "Removed one granite."; ELSE; #MESSAGE "You don't have a granite"; ENDIF;

You can find item names in Material

Parameters:

player - target player

id - item id

amount - amount

data - data of item

Returns:

true if took it; false if player doesn't have it

takeItem

public boolean takeItem(org.bukkit.entity.Player player,
                        org.bukkit.inventory.ItemStack IS,
                        int amount)

take ItemStack from player. This check for every single metadata (title, lores, enchantment, etc.), so only the exactly matching items will be removed

Example) /trg run IF takeItem(player, {"some.item"}, 1);

You can find item names in Material

Parameters:

player - target player

IS - item id

amount - amount

Returns:

true if took it; false if player doesn't have it

location

public org.bukkit.Location location(String world,
                                    double x,
                                    double y,
                                    double z)

Create Location instance.

Parameters:

world - the name of world.

x - x coordinate

y - y coordinate

z - z coordinate

Returns:

the Location.

location

public org.bukkit.Location location(String world,
                                    double x,
                                    double y,
                                    double z,
                                    double yaw,
                                    double pitch)

Create Location instance including pitch and yaw

Parameters:

world - the name of world.

x - x coordinate

y - y coordinate

z - z coordinate

yaw - yaw

pitch - pitch

Returns:

the Location instance

block

public org.bukkit.block.Block block(String world,
                                    int x,
                                    int y,
                                    int z)

get Block instance. Be aware that when using the Block instance, it directly interferes with the Server Thread, so it may cause Exception if any action taken to this instance was from asynchronous triggers.

Parameters:

world - name of the world

x - x coordinate

y - y coordinate

z - z coordinate

Returns:

the Block instance

locationEqual

public boolean locationEqual(org.bukkit.Location loc1,
                             org.bukkit.Location loc2)

check if two location are equal not considering their decimal points

Example) /trg run IF locationEqual(player.getLocation(), {"otherLocation"}); #MESSAGE "match"; ENDIF;

Parameters:

loc1 - location

loc2 - other location

Returns:

true if equal; false if not

makePotionEffect

public abstract org.bukkit.potion.PotionEffect makePotionEffect(String EffectType,
                                                                int duration,
                                                                int amplifier,
                                                                boolean ambient,
                                                                boolean particles,
                                                                org.bukkit.Color color)

create a PotionEffect for use in entity.addPotionEffect();

Example) /trg run player.addPotionEffect( makePotionEffect("SPEED", 1000000, 5, false, true, bukkitColor(21,2,24) ))

Parameters:

EffectType - the name of the PotionEffectType to use

duration - how long the potioneffect should last when applied to an enitity

amplifier - how strong the effect should be

ambient - if true particle effects will be more transparent

particles - if false potion particle effects will not be shown

color - use bukkitColor() or is no longer available since 1.13

Returns:

returns a PotionEffect object or null if specified PotionEffectType was not found.

player

public org.bukkit.entity.Player player(String name)

try to get a player from name. Mostly online player.

Example) player("wysohn").performCommand("spawn")

Parameters:

name - name of player

Returns:

the Player object; it can be null if no player is found with the name

oplayer

public org.bukkit.OfflinePlayer oplayer(String name)

try to get offline player from name.

Example) /trg run #MESSAGE "UUID is: "+oplayer("wysohn").getUniqueId()

Parameters:

name - name of player

Returns:

the OfflinePlayer object; it never returns null but always return an offline player even if the player doesn't exist.

getPlayers

public abstract Collection<? extends org.bukkit.entity.Player> getPlayers()

get list of online players online

Example) /trg run FOR p = getPlayers(); p.performCommand("spawn"); ENDFOR;

Returns:

player iterator

currentArea

public String currentArea(org.bukkit.entity.Entity entity)

Deprecated. this returns only one area among the areas where entity is in. Use currentAreas(Entity) instead to get all the areas.

Get the name of area where entity is currently standing on.

Example) /trg run #MESSAGE "You are in the AreaTrigger named: "+currentArea(player)

Parameters:

entity - any entity(including player)

Returns:

name of area; null if player is not on any area.

currentAreaAt

public String currentAreaAt(org.bukkit.Location location)

Deprecated. this only return one AreaTrigger's name, yet there could be more

Get the name of area trigger at the target location. Since 2.1.8, as Area Triggers can overlap each other, there can be multiple result. This method is left as is, but it will return only the first area found. To get the full list of Area Triggers, use currentAreasAt(Location)

Parameters:

location - the location to check

Returns:

name of area; null if there is no area trigger at location

currentAreas

public String[] currentAreas(org.bukkit.entity.Entity entity)

Get the name of area where entity is currently standing on.

Example) /trg run #MESSAGE "You are in the AreaTrigger named: "+currentArea(player)

Parameters:

entity - any entity(including player)

Returns:

array of name of areas; array can be empty but never null.

currentAreasAt

public String[] currentAreasAt(org.bukkit.Location location)

Get the name of area triggers containing the given location.

Parameters:

location - the location to check

Returns:

array of AreaTrigger names. The array can be empty but never null.

getEntitiesInArea

public List<org.bukkit.entity.Entity> getEntitiesInArea(String areaTriggerName)

Get list of entities tracked by this AreaTrigger.

Parameters:

areaTriggerName - name of AreaTrigger to get entities from

Returns:

List of entities. null if the AreaTrigger with specified name doesn't exist.

color

public String color(String str)

Translate & into minecraft color code

Example) /trg run player.sendMessage(color("&aGREEN, &cRED"))

Parameters:

str - unprocessed string

Returns:

string with minecraft color codes

bukkitColor

public org.bukkit.Color bukkitColor(int red,
                                    int green,
                                    int blue)

creates and returns a bukkit color object using the RGB values given. the max value for the int arguments is 255 exceeding it may cause errors.

Example) /trg run partColor = bukkitColor(255,255,255)

Parameters:

red - red the value of red in RGB

green - green the value of green in RGB

blue - blue the value of blue in RGB

Returns:

returns a Color object from org.bukkit.Color

item

@Deprecated
public abstract org.bukkit.inventory.ItemStack item(int type,
                                                                int amount,
                                                                int data)

Deprecated. use item(String, int, int) instead

Deprecated since 1.13. Even though you are advised to used the new method, this method is supported only for legacy-bukkit version

Parameters:

type -

amount -

data -

Returns:

item

public abstract org.bukkit.inventory.ItemStack item(String type,
                                                    int amount,
                                                    int data)

Create a new ItemStack

Example) /trg run #GIVE item(1, 64, 0)

Parameters:

type - typeId

amount - amount of item

data - data

Returns:

the ItemStack

item

@Deprecated
public abstract org.bukkit.inventory.ItemStack item(int type,
                                                                int amount)

Deprecated. use item(String, int) instead

Deprecated since 1.13. Even though you are advised to used the new method, this method is supported only for legacy-bukkit version

Parameters:

type -

amount -

Returns:

item

public abstract org.bukkit.inventory.ItemStack item(String type,
                                                    int amount)

Create a new ItemStack

Example) /trg run #GIVE item(1, 32)

Parameters:

type - typeId

amount - amount of item

Returns:

the ItemStack

getItemTitle

public String getItemTitle(org.bukkit.inventory.ItemStack IS)

Get title of the specified ItemStack. Empty String if not exist.

Example) /trg run #MESSAGE "item name is: "+getItemTitle(player.getItemInHand())

Parameters:

IS - the target ItemStack to get title

Returns:

the title of the ItemStack. Empty string if it's not set.

setItemTitle

public void setItemTitle(org.bukkit.inventory.ItemStack IS,
                         String title)

Set title of the specified ItemStack

Example) /trg run myitem = item(1, 1); setItemTitle(myitem, "I'm stone"); #GIVE myitem;

Parameters:

IS - target ItemStack to change the title

title - the title

hasLore

public boolean hasLore(org.bukkit.inventory.ItemStack IS,
                       String lore)

Check if the specified ItemStack contains the 'lore.' At least one is contained in the lore will return true.

Parameters:

IS - ItemStack to check lores fore

lore - the lore

Returns:

true if 'lore' is in IS; false if not

getLore

public String getLore(org.bukkit.inventory.ItemStack IS,
                      int index)

get Lore at the specified index

Parameters:

IS - the ItemStack to get lore

index - index of the lore

Returns:

String of lore. If you use 'index' out of range or lore not exist, it returns null.

addLore

public void addLore(org.bukkit.inventory.ItemStack IS,
                    String lore)

Append a lore to the specified ItemStack

Parameters:

IS - the target ItemStack

lore - the lore to add

setLore

public void setLore(org.bukkit.inventory.ItemStack IS,
                    int index,
                    String lore)

Replace a lore at 'index' for the specified ItemStack. If the 'index' is less than 0, it will throw an error, but if 'index' is larger than previous size of lores, it will append empty strings as much as needed.

Parameters:

IS - the target ItemStack

index - index to replace the lore

lore - the lore to set

removeLore

public void removeLore(org.bukkit.inventory.ItemStack IS,
                       int index)

Remove lore at the 'index' of the specified ItemStack. if the 'index' is out of range, nothing will happen.

Parameters:

IS - target ItemStack

index - index of the lore to delete

clearLore

public void clearLore(org.bukkit.inventory.ItemStack IS)

Clear all lores from item.

Parameters:

IS - target ItemStack

loreSize

public int loreSize(org.bukkit.inventory.ItemStack IS)

get size of the lores for the specified ItemStack

Parameters:

IS - target ItemStack

Returns:

the number of lores

formatCurrency

public String formatCurrency(double money,
                             String locale1,
                             String locale2)

Translate money into specified country's currency format. You need to provide exact locale provided in http://www.oracle.com/technetwork/java/javase/java8locales-2095355.html

Overrides:

formatCurrency in class CommonFunctions

Parameters:

money - money

locale1 - language code (Ex. en)

locale2 - country code (Ex. US)

Returns:

formatted currecy

formatCurrency

public String formatCurrency(double money)

Translate money into specified country's currency format. US currency will be used.

Overrides:

formatCurrency in class CommonFunctions

Parameters:

money - money

Returns:

formatted currecy

getTargetBlock

public org.bukkit.block.Block getTargetBlock(org.bukkit.entity.Player player,
                                             int maxDistance)

Get the block which player is looking at

Example) /trg run #MESSAGE "looking at the block: "+getTargetBlock(player, 30);

Parameters:

player - Player instance

maxDistance - maximum distance. More distance cause more loads to CPU.

Returns:

block

headForName

public org.bukkit.inventory.ItemStack headForName(String targetName)

Create a player head with given name.

Example) /trg run #GIVE headForName("wysohn")

Parameters:

targetName - name of the owner of head

Returns:

the ItemStack head

headForName

public abstract org.bukkit.inventory.ItemStack headForName(String targetName,
                                                           int amount)

Create a player head with given name.

Example) /trg run #GIVE headForName("wysohn")

Parameters:

targetName - name of the owner of head

amount - amount

Returns:

the ItemStack head

headForValue

public abstract org.bukkit.inventory.ItemStack headForValue(String textureValue)

Create a player head with given textureValue(base64 encoded).

Example) /trg run #GIVE headForValue("eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlc y5taW5lY3JhZnQubmV0L3RleHR1cmUvN2RjZDdkZjUyNjQ1YzY4Y2RhZDg1NDhlNjFiM2Y3 NjU5NjQwNzcyMjZiYTg3MmI5ZDJiZDQ1YzQzOWQifX19\\")

Notice that there is an extra \ sign as \ is an escape sequence. The final String will be ...OWQifX19\ instead of ...OWQifX19\\"

Parameters:

textureValue - base64 encoded texture value

Returns:

the ItemStack head

serializeLocation

public abstract Object serializeLocation(org.bukkit.World world,
                                         double x,
                                         double y,
                                         double z)

Create a new SerializableLocation, which implements ConfigurationSerializable

Example) /trg run serialized = serializeLocation("wildw", 2, 13, 44)

Parameters:

world - The world instance in which this location resides

x - The x-coordinate of this location

y - The y-coordinate of this location

z - The z-coordinate of this location

Returns:

The SerializableLocation value

serializeLocation

public abstract Object serializeLocation(org.bukkit.World world,
                                         double x,
                                         double y,
                                         double z,
                                         double yaw,
                                         double pitch)

Create a new SerializableLocation, which implements ConfigurationSerializable

Example) /trg run serialized = serializeLocation("wildw", 2, 13, 44.6, 13)

Parameters:

world - The world instance in which this location resides

x - The x-coordinate of this location

y - The y-coordinate of this location

z - The z-coordinate of this location

yaw - The absolute rotation on the x-plane, in degrees

pitch - The absolute rotation on the y-plane, in degrees

Returns:

The SerializableLocation value

serializeLocation

public abstract Object serializeLocation(org.bukkit.Location loc)

Create a new SerializableLocation, which implements ConfigurationSerializable

Example) /trg run serialized = serializeLocation("wildw", 2, 13, 44.6, 13)

Parameters:

loc - The Location value

Returns:

The SerializableLocation value