io.lumine.xikage.mythicmobs.api.bukkit

Class BukkitAPIHelper

java.lang.Object

io.lumine.xikage.mythicmobs.api.bukkit.BukkitAPIHelper

public class BukkitAPIHelper
extends Object

A bunch of special helper methods to help developers with basic tasks in MythicMobs. Only usable on Bukkit/Spigot. Retrieved using MythicMobs.inst().getAPIHelper();

Since:

4.0.0

Author:

Ashijin

See Also:

BukkitAdapter

Constructor Summary

Constructors

Constructor and Description
BukkitAPIHelper()

Method Summary

Modifier and Type	Method and Description
boolean	addThreat(org.bukkit.entity.Entity mob, org.bukkit.entity.LivingEntity target, double amount) Increases threat for a target in a mob's threat table
boolean	castSkill(org.bukkit.entity.Entity e, String skillName)
boolean	castSkill(org.bukkit.entity.Entity e, String skillName, org.bukkit.entity.Entity trigger, org.bukkit.Location origin, Collection<org.bukkit.entity.Entity> eTargets, Collection<org.bukkit.Location> lTargets, float power)
boolean	castSkill(org.bukkit.entity.Entity e, String skillName, float power)
boolean	castSkill(org.bukkit.entity.Entity e, String skillName, org.bukkit.Location origin)
boolean	castSkill(org.bukkit.entity.Entity e, String skillName, org.bukkit.Location origin, Collection<org.bukkit.entity.Entity> eTargets, Collection<org.bukkit.Location> lTargets, float power)
boolean	castSkill(org.bukkit.entity.Entity e, String skillName, org.bukkit.Location origin, float power)
MythicMob	getMythicMob(String type) Returns whether the given entity is a MythicMob
ActiveMob	getMythicMobInstance(org.bukkit.entity.Entity e)
boolean	isMythicMob(org.bukkit.entity.Entity l)
boolean	isMythicMob(UUID u)
boolean	reduceThreat(org.bukkit.entity.Entity mob, org.bukkit.entity.LivingEntity target, double amount) Reduces threat for a target in a mob's threat table
org.bukkit.entity.Entity	spawnMythicMob(MythicMob type, org.bukkit.Location location, int level) Spawns a Mythic Mob and returns the Bukkit Entity object
org.bukkit.entity.Entity	spawnMythicMob(String type, org.bukkit.Location location) Spawns a Mythic Mob and returns the Bukkit Entity object
org.bukkit.entity.Entity	spawnMythicMob(String type, org.bukkit.Location location, int level) Spawns a Mythic Mob and returns the Bukkit Entity object
boolean	taunt(org.bukkit.entity.Entity mob, org.bukkit.entity.LivingEntity target) Sets TARGET to 110% of the mob's target's threat value, and forces the mob to switch targets

Methods inherited from class java.lang.Object

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

Constructor Detail

BukkitAPIHelper

public BukkitAPIHelper()

Method Detail

getMythicMob

public MythicMob getMythicMob(String type)

Returns whether the given entity is a MythicMob

Parameters:

type - The Bukkit Entity to check

Returns:

boolean

spawnMythicMob

public org.bukkit.entity.Entity spawnMythicMob(MythicMob type,
                                               org.bukkit.Location location,
                                               int level)
                                        throws InvalidMobTypeException

Spawns a Mythic Mob and returns the Bukkit Entity object

Parameters:

type - The MythicMob type you are trying to spawn

location - The Bukkit location the mob should be spawned at

level - The level of the mob to spawn

Returns:

Returns the entity that was spawned, or null if spawning failed.

Throws:

InvalidMobTypeException

spawnMythicMob

public org.bukkit.entity.Entity spawnMythicMob(String type,
                                               org.bukkit.Location location)
                                        throws InvalidMobTypeException

Spawns a Mythic Mob and returns the Bukkit Entity object

Parameters:

type - The name of the MythicMob you are trying to spawn

location - The Bukkit location the mob should be spawned atll

Returns:

Returns the entity that was spawned, or null if spawning failed.

Throws:

InvalidMobTypeException

spawnMythicMob

public org.bukkit.entity.Entity spawnMythicMob(String type,
                                               org.bukkit.Location location,
                                               int level)
                                        throws InvalidMobTypeException

Spawns a Mythic Mob and returns the Bukkit Entity object

Parameters:

type - The name of the MythicMob you are trying to spawn

location - The Bukkit location the mob should be spawned at

level - The level of the mob to spawn

Returns:

Returns the entity that was spawned, or null if spawning failed.

Throws:

InvalidMobTypeException

isMythicMob

public boolean isMythicMob(org.bukkit.entity.Entity l)

isMythicMob

public boolean isMythicMob(UUID u)

getMythicMobInstance

public ActiveMob getMythicMobInstance(org.bukkit.entity.Entity e)

castSkill

public boolean castSkill(org.bukkit.entity.Entity e,
                         String skillName)

castSkill

public boolean castSkill(org.bukkit.entity.Entity e,
                         String skillName,
                         float power)

castSkill

public boolean castSkill(org.bukkit.entity.Entity e,
                         String skillName,
                         org.bukkit.Location origin)

castSkill

public boolean castSkill(org.bukkit.entity.Entity e,
                         String skillName,
                         org.bukkit.Location origin,
                         float power)

castSkill

public boolean castSkill(org.bukkit.entity.Entity e,
                         String skillName,
                         org.bukkit.Location origin,
                         Collection<org.bukkit.entity.Entity> eTargets,
                         Collection<org.bukkit.Location> lTargets,
                         float power)

castSkill

public boolean castSkill(org.bukkit.entity.Entity e,
                         String skillName,
                         org.bukkit.entity.Entity trigger,
                         org.bukkit.Location origin,
                         Collection<org.bukkit.entity.Entity> eTargets,
                         Collection<org.bukkit.Location> lTargets,
                         float power)

addThreat

public boolean addThreat(org.bukkit.entity.Entity mob,
                         org.bukkit.entity.LivingEntity target,
                         double amount)

Increases threat for a target in a mob's threat table

Parameters:

mob - The MythicMob you want to increase threat for

target - The target that should have threat increased

amount - The amount to increase threat by

Returns:

Returns false if the mob supplied is not a valid MythicMob with ThreatTables enabled

reduceThreat

public boolean reduceThreat(org.bukkit.entity.Entity mob,
                            org.bukkit.entity.LivingEntity target,
                            double amount)

Reduces threat for a target in a mob's threat table

Parameters:

mob - The MythicMob you want to reduce threat for

target - The target that should have threat reduced

amount - The amount to reduce threat by

Returns:

Returns false if the mob supplied is not a valid MythicMob with ThreatTables enabled

taunt

public boolean taunt(org.bukkit.entity.Entity mob,
                     org.bukkit.entity.LivingEntity target)

Sets TARGET to 110% of the mob's target's threat value, and forces the mob to switch targets

Parameters:

mob - The MythicMob you want to swap targets

target - The new target for the mob

Returns:

Returns false if the mob supplied is not a valid MythicMob with ThreatTables enabled