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

Class CommonFunctions

java.lang.Object

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

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

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

All Implemented Interfaces:

SelfReference

public class CommonFunctions
extends AbstractCommonFunctions
implements SelfReference

Field Summary

Fields inherited from class io.github.wysohn.triggerreactor.bukkit.manager.trigger.share.AbstractCommonFunctions

plugin

Constructor Summary

Constructors

Constructor and Description
CommonFunctions(TriggerReactorCore plugin)

Method Summary

Modifier and Type	Method and Description
Collection<? extends org.bukkit.entity.Player>	getPlayers() get list of online players online
org.bukkit.inventory.ItemStack	headForName(String targetName, int amount) Create a player head with given name.
org.bukkit.inventory.ItemStack	headForValue(String textureValue) Create a player head with given textureValue(base64 encoded).
org.bukkit.inventory.ItemStack	item(int type, int amount) Deprecated.
org.bukkit.inventory.ItemStack	item(int type, int amount, int data) Deprecated. use item(String, int, int) instead
org.bukkit.inventory.ItemStack	item(String type, int amount) Create a new ItemStack
org.bukkit.inventory.ItemStack	item(String type, int amount, int data) Create a new ItemStack
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();
SerializableLocation	serializeLocation(org.bukkit.Location loc) Create a new SerializableLocation, which implements ConfigurationSerializable
SerializableLocation	serializeLocation(org.bukkit.World world, double x, double y, double z) Create a new SerializableLocation, which implements ConfigurationSerializable
SerializableLocation	serializeLocation(org.bukkit.World world, double x, double y, double z, double yaw, double pitch) Create a new SerializableLocation, which implements ConfigurationSerializable
boolean	takeItem(org.bukkit.entity.Player player, int id, int amount) Deprecated. use takeItem(Player, String, int) instead
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, String id, int amount) take item from player.
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.bukkit.manager.trigger.share.AbstractCommonFunctions

addLore, block, bukkitColor, clearLore, color, currentArea, currentAreaAt, currentAreas, currentAreasAt, formatCurrency, formatCurrency, getEntitiesInArea, getItemTitle, getLore, getTargetBlock, hasLore, headForName, location, location, locationEqual, loreSize, oplayer, player, plugin, removeLore, setItemTitle, setLore, takeItem

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

Constructor Detail

CommonFunctions

public CommonFunctions(TriggerReactorCore plugin)

Method Detail

takeItem

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

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

take item from player.

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

Specified by:

takeItem in class AbstractCommonFunctions

Parameters:

player -

id -

amount -

Returns:

takeItem

public 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

Specified by:

takeItem in class AbstractCommonFunctions

Parameters:

player - target player

id - item id

amount - amount

Returns:

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

takeItem

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

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

take item from player.

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

Specified by:

takeItem in class AbstractCommonFunctions

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,
                        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

Specified by:

takeItem in class AbstractCommonFunctions

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

getPlayers

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

get list of online players online

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

Specified by:

getPlayers in class AbstractCommonFunctions

Returns:

player iterator

makePotionEffect

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

Description copied from class: AbstractCommonFunctions

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

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

Specified by:

makePotionEffect in class AbstractCommonFunctions

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.

item

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

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

Create a new ItemStack

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

Specified by:

item in class AbstractCommonFunctions

Parameters:

type - typeId

amount - amount of item

data - data

Returns:

the ItemStack

item

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

Create a new ItemStack

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

Specified by:

item in class AbstractCommonFunctions

Parameters:

type - typeId

amount - amount of item

data - data

Returns:

the ItemStack

item

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

Deprecated.

Create a new ItemStack

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

Specified by:

item in class AbstractCommonFunctions

Parameters:

type - typeId

amount - amount of item

Returns:

the ItemStack

item

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

Create a new ItemStack

Example) /trg run #GIVE item("STONE", 32)

Specified by:

item in class AbstractCommonFunctions

Parameters:

type - typeId

amount - amount of item

Returns:

the ItemStack

headForName

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

Description copied from class: AbstractCommonFunctions

Create a player head with given name.

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

Specified by:

headForName in class AbstractCommonFunctions

Parameters:

targetName - name of the owner of head

amount - amount

Returns:

the ItemStack head

headForValue

public 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\\"

Specified by:

headForValue in class AbstractCommonFunctions

Parameters:

textureValue - base64 encoded texture value

Returns:

the ItemStack head

serializeLocation

public SerializableLocation 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)

Specified by:

serializeLocation in class AbstractCommonFunctions

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 SerializableLocation 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)

Specified by:

serializeLocation in class AbstractCommonFunctions

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 SerializableLocation serializeLocation(org.bukkit.Location loc)

Create a new SerializableLocation, which implements ConfigurationSerializable

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

Specified by:

serializeLocation in class AbstractCommonFunctions

Parameters:

loc - The Location value

Returns:

The SerializableLocation value