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

Class CommonFunctions

java.lang.Object

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

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

All Implemented Interfaces:

SelfReference

public class CommonFunctions
extends CommonFunctions
implements SelfReference

Constructor Summary

Constructors

Constructor and Description
CommonFunctions(TriggerReactorCore plugin)

Method Summary

Modifier and Type	Method and Description
void	addLore(org.spongepowered.api.item.inventory.ItemStack IS, String lore) Append a lore to the specified ItemStack
void	addLore(org.spongepowered.api.item.inventory.ItemStack IS, org.spongepowered.api.text.Text lore)
org.spongepowered.api.boss.BossBarColor	barColor(String name)
void	clearLore(org.spongepowered.api.item.inventory.ItemStack IS) Clear all lores from item.
org.spongepowered.api.text.Text	color(String str) Translate & into minecraft color code
String	currentArea(org.spongepowered.api.entity.Entity entity) Get the name of area where entity is currently standing on.
String	currentAreaAt(org.spongepowered.api.world.Location location) Deprecated. this only return one AreaTrigger's name, yet there could be more
String[]	currentAreasAt(org.spongepowered.api.world.Location location) Get the name of area triggers containing the given location.
List<org.spongepowered.api.entity.Entity>	getEntitiesInArea(String areaTriggerName) Get list of entities tracked by this AreaTrigger.
org.spongepowered.api.text.Text	getItemTitle(org.spongepowered.api.item.inventory.ItemStack IS) Get title of the specified ItemStack.
org.spongepowered.api.text.Text	getLore(org.spongepowered.api.item.inventory.ItemStack IS, int index) get Lore at the specified index
Collection<? extends org.spongepowered.api.entity.living.player.Player>	getPlayers() get list of online players online
org.spongepowered.api.block.BlockState	getTargetBlock(org.spongepowered.api.entity.living.player.Player player, int maxDistance) Get the block snapshot which player is looking at
boolean	hasLore(org.spongepowered.api.item.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.spongepowered.api.item.inventory.ItemStack	headForName(String targetName) Create a player head with given name.
org.spongepowered.api.item.inventory.ItemStack	headForName(String targetName, int amount)
org.spongepowered.api.item.inventory.ItemStack	headForValue(String textureValue) Create a player head with given textureValue(base64 encoded).
org.spongepowered.api.item.inventory.ItemStack	item(String type, int amount) Create a new ItemStack
org.spongepowered.api.item.ItemType	itemType(String name)
org.spongepowered.api.world.Location<org.spongepowered.api.world.World>	location(String world, int x, int y, int z)
boolean	locationEqual(org.spongepowered.api.world.Location<org.spongepowered.api.world.World> loc1, org.spongepowered.api.world.Location<org.spongepowered.api.world.World> loc2) check if two location are equal not considering their decimal points
int	loreSize(org.spongepowered.api.item.inventory.ItemStack IS) get size of the lores for the specified ItemStack
org.spongepowered.api.boss.BossBar	makeBossBar(String title, org.spongepowered.api.boss.BossBarColor color, String style)
org.spongepowered.api.effect.potion.PotionEffect	makePotionEffect(String EffectType, int duration, int amplifier, boolean ambient, boolean particles, org.spongepowered.api.util.Color color) create a PotionEffect for use in entity.addPotionEffect();
org.spongepowered.api.entity.living.player.User	oplayer(String name) try to get offline player from name.
org.spongepowered.api.entity.living.player.Player	player(String name) try to get a player from name.
Object	plugin(String name) Simply try to get plugin object directly.
void	removeLore(org.spongepowered.api.item.inventory.ItemStack IS, int index) Remove lore at the 'index' of the specified ItemStack
void	setItemTitle(org.spongepowered.api.item.inventory.ItemStack IS, String title) Set title of the specified ItemStack
void	setItemTitle(org.spongepowered.api.item.inventory.ItemStack IS, org.spongepowered.api.text.Text title)
void	setLore(org.spongepowered.api.item.inventory.ItemStack IS, int index, String lore) Replace a lore at 'index' for the specified ItemStack
void	setLore(org.spongepowered.api.item.inventory.ItemStack IS, int index, org.spongepowered.api.text.Text lore)
org.spongepowered.api.util.Color	spongeColor(int red, int green, int blue) creates and returns a bukkit color object using the RGB values given.
boolean	takeItem(org.spongepowered.api.entity.living.player.Player player, org.spongepowered.api.item.inventory.ItemStack IS, int amount) take ItemStack from player.
boolean	takeItem(org.spongepowered.api.entity.living.player.Player player, String id, int amount) take item from player.
org.spongepowered.api.text.Text	text(String str) convert plain String to Sponge usable Text.

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

array, arrayOf, formatCurrency, formatCurrency, 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

plugin

public Object 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.

itemType

public org.spongepowered.api.item.ItemType itemType(String name)

takeItem

public boolean takeItem(org.spongepowered.api.entity.living.player.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;

Parameters:

player - target player

id - item name. Sponge does not support numerical item id.

amount - amount

Returns:

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

takeItem

public boolean takeItem(org.spongepowered.api.entity.living.player.Player player,
                        org.spongepowered.api.item.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);

Parameters:

player - target player

id - item name. Sponge does not support numerical item id.

amount - amount

Returns:

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

location

public org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location(String world,
                                                                                        int x,
                                                                                        int y,
                                                                                        int z)

locationEqual

public boolean locationEqual(org.spongepowered.api.world.Location<org.spongepowered.api.world.World> loc1,
                             org.spongepowered.api.world.Location<org.spongepowered.api.world.World> 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 -

loc2 -

Returns:

true if equal; false if not

makePotionEffect

public org.spongepowered.api.effect.potion.PotionEffect makePotionEffect(String EffectType,
                                                                         int duration,
                                                                         int amplifier,
                                                                         boolean ambient,
                                                                         boolean particles,
                                                                         org.spongepowered.api.util.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 - sets the color of the potion particle effects shown

Returns:

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

player

public org.spongepowered.api.entity.living.player.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.spongepowered.api.entity.living.player.User 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 Collection<? extends org.spongepowered.api.entity.living.player.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.spongepowered.api.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:

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

currentAreaAt

public String currentAreaAt(org.spongepowered.api.world.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

currentAreasAt

public String[] currentAreasAt(org.spongepowered.api.world.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.spongepowered.api.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 org.spongepowered.api.text.Text color(String str)

Translate & into minecraft color code

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

Parameters:

str - unprocessed string

Returns:

the sponge Text.

text

public org.spongepowered.api.text.Text text(String str)

convert plain String to Sponge usable Text.

Parameters:

str - String to convert

Returns:

Text

spongeColor

public org.spongepowered.api.util.Color spongeColor(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

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

Create a new ItemStack

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

Parameters:

type - type name. Sponge does not support numerical item types.

amount - amount of item

Returns:

the ItemStack

getItemTitle

public org.spongepowered.api.text.Text getItemTitle(org.spongepowered.api.item.inventory.ItemStack IS)

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

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

Parameters:

IS -

Returns:

setItemTitle

public void setItemTitle(org.spongepowered.api.item.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 -

title -

setItemTitle

public void setItemTitle(org.spongepowered.api.item.inventory.ItemStack IS,
                         org.spongepowered.api.text.Text title)

hasLore

public boolean hasLore(org.spongepowered.api.item.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 -

lore -

Returns:

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

getLore

public org.spongepowered.api.text.Text getLore(org.spongepowered.api.item.inventory.ItemStack IS,
                                               int index)

get Lore at the specified index

Parameters:

IS -

index -

Returns:

String of lore; null if not found

addLore

public void addLore(org.spongepowered.api.item.inventory.ItemStack IS,
                    String lore)

Append a lore to the specified ItemStack

Parameters:

IS -

lore -

addLore

public void addLore(org.spongepowered.api.item.inventory.ItemStack IS,
                    org.spongepowered.api.text.Text lore)

setLore

public void setLore(org.spongepowered.api.item.inventory.ItemStack IS,
                    int index,
                    String lore)

Replace a lore at 'index' for the specified ItemStack

Parameters:

IS -

index -

lore -

setLore

public void setLore(org.spongepowered.api.item.inventory.ItemStack IS,
                    int index,
                    org.spongepowered.api.text.Text lore)

removeLore

public void removeLore(org.spongepowered.api.item.inventory.ItemStack IS,
                       int index)

Remove lore at the 'index' of the specified ItemStack

Parameters:

IS -

index -

clearLore

public void clearLore(org.spongepowered.api.item.inventory.ItemStack IS)

Clear all lores from item.

Parameters:

IS -

loreSize

public int loreSize(org.spongepowered.api.item.inventory.ItemStack IS)

get size of the lores for the specified ItemStack

Parameters:

IS -

Returns:

getTargetBlock

public org.spongepowered.api.block.BlockState getTargetBlock(org.spongepowered.api.entity.living.player.Player player,
                                                             int maxDistance)

Get the block snapshot which player is looking at

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

Parameters:

player -

maxDistance -

Returns:

block

headForName

public org.spongepowered.api.item.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 org.spongepowered.api.item.inventory.ItemStack headForName(String targetName,
                                                                  int amount)

headForValue

public org.spongepowered.api.item.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

barColor

public org.spongepowered.api.boss.BossBarColor barColor(String name)
                                                 throws IllegalArgumentException,
                                                        NoSuchFieldException

Throws:

IllegalArgumentException

NoSuchFieldException

makeBossBar

public org.spongepowered.api.boss.BossBar makeBossBar(String title,
                                                      org.spongepowered.api.boss.BossBarColor color,
                                                      String style)