Package studio.magemonkey.fabled.dynamic.trigger

Class SkillUpgradeTrigger

java.lang.Object

studio.magemonkey.fabled.dynamic.trigger.SkillUpgradeTrigger

All Implemented Interfaces:

Trigger<PlayerSkillUpgradeEvent>

public class SkillUpgradeTrigger
extends Object
implements Trigger<PlayerSkillUpgradeEvent>

A trigger for when a player levels up a skill.

Constructor Summary

Constructors

Constructor	Description
SkillUpgradeTrigger()

Method Summary

Modifier and Type	Method	Description
org.bukkit.entity.LivingEntity	getCaster(PlayerSkillUpgradeEvent event)	Fetches the caster as determined by the triggering event.
Class<PlayerSkillUpgradeEvent>	getEvent()
String	getKey()
org.bukkit.entity.LivingEntity	getTarget(PlayerSkillUpgradeEvent event, Settings settings)	Fetches the target as determined by the triggering event.
void	setValues(PlayerSkillUpgradeEvent event, CastData data)	Reads data from the event and provides values to the caster's value data.
boolean	shouldTrigger(PlayerSkillUpgradeEvent event, int level, Settings settings)

Methods inherited from class java.lang.Object

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

Methods inherited from interface studio.magemonkey.fabled.dynamic.trigger.Trigger

postProcess

Constructor Details

SkillUpgradeTrigger

public SkillUpgradeTrigger()

Method Details

getKey

public String getKey()

Specified by:

getKey in interface Trigger<PlayerSkillUpgradeEvent>

Returns:

unique key for the trigger

getEvent

public Class<PlayerSkillUpgradeEvent> getEvent()

Specified by:

getEvent in interface Trigger<PlayerSkillUpgradeEvent>

Returns:

class of the event related to the trigger

shouldTrigger

public boolean shouldTrigger(PlayerSkillUpgradeEvent event,
 int level,
 Settings settings)

Specified by:

shouldTrigger in interface Trigger<PlayerSkillUpgradeEvent>

Parameters:

event - event details

level - the level of the owning skill

settings - skill settings

Returns:

true if the skill should activate, false otherwise

getCaster

public org.bukkit.entity.LivingEntity getCaster(PlayerSkillUpgradeEvent event)

Fetches the caster as determined by the triggering event.

Specified by:

getCaster in interface Trigger<PlayerSkillUpgradeEvent>

Parameters:

event - event details

Returns:

the one to apply the trigger for

getTarget

public org.bukkit.entity.LivingEntity getTarget(PlayerSkillUpgradeEvent event,
 Settings settings)

Fetches the target as determined by the triggering event. This can be the same as the caster.

Specified by:

getTarget in interface Trigger<PlayerSkillUpgradeEvent>

Parameters:

event - event details

settings - skill settings

Returns:

the one being affected by the trigger (initial target)

setValues

public void setValues(PlayerSkillUpgradeEvent event,
 CastData data)

Reads data from the event and provides values to the caster's value data. This can be used within skills for more flexible effects. An example of this in base triggers is the Launch trigger providing the speed a projectile was launched so mechanics can replace it with equally-fast projectiles.

Specified by:

setValues in interface Trigger<PlayerSkillUpgradeEvent>

Parameters:

event - event details

data - caster's value data to populate