com.elmakers.mine.bukkit.api.action

Interface CastContext

All Superinterfaces:

EffectContext, MageContext

public interface CastContext
extends MageContext

Method Summary

Modifier and Type	Method and Description
void	addHandler(ActionHandler handler)
void	addMessageParameter(String key, String value)
void	addResult(SpellResult result)
void	addWork(int work)
boolean	allowPassThrough(org.bukkit.block.Block block)
boolean	allowPassThrough(org.bukkit.Material material) Deprecated.
boolean	areAnyDestructible(org.bukkit.block.Block block)
boolean	canCast(org.bukkit.Location location)
void	cancelEffects()
boolean	canContinue(org.bukkit.Location location)
void	castMessage(String message)
void	castMessageKey(String key)
void	castMessageKey(String key, String message)
void	clearAttachables(org.bukkit.block.Block block)
void	clearBreakable(org.bukkit.block.Block block)
void	clearReflective(org.bukkit.block.Block block)
org.bukkit.block.Block	findBlockUnder(org.bukkit.block.Block block)
org.bukkit.Location	findPlaceToStand(org.bukkit.Location target, int verticalSearchDistance)
org.bukkit.Location	findPlaceToStand(org.bukkit.Location target, int verticalSearchDistance, boolean goUp)
org.bukkit.block.Block	findSpaceAbove(org.bukkit.block.Block block)
void	finish()
int	getActionsPerformed()
org.bukkit.configuration.ConfigurationSection	getAllVariables() Returns all variables, this can be an expensive call so avoid using it if possible.
CastContext	getBaseContext()
Double	getBreakable(org.bukkit.block.Block block)
MaterialBrush	getBrush()
Object	getCastData(String key)
CasterProperties	getCasterProperties(String propertyType)
org.bukkit.Location	getCastLocation() Get the source location of this cast.
MageController	getController()
Collection<EffectPlay>	getCurrentEffects()
org.bukkit.util.Vector	getDirection()
Collection<EffectPlayer>	getEffects(String key)
org.bukkit.entity.Entity	getEntity()
org.bukkit.Location	getEyeLocation()
org.bukkit.block.BlockFace	getFacingDirection()
org.bukkit.block.Block	getInteractBlock()
long	getLastTriggerTime()
org.bukkit.entity.LivingEntity	getLivingEntity()
org.bukkit.Location	getLocation()
Mage	getMage()
MageClass	getMageClass()
Set<org.bukkit.Material>	getMaterialSet(String key) Deprecated.
CastContext	getParent()
org.bukkit.plugin.Plugin	getPlugin()
org.bukkit.block.Block	getPreviousBlock()
org.bukkit.block.Block	getPreviousPreviousBlock()
Random	getRandom()
Double	getReflective(org.bukkit.block.Block block)
SpellResult	getResult()
ActionHandler	getRootHandler()
Spell	getSpell()
long	getStartTime()
org.bukkit.block.Block	getTargetBlock()
CasterProperties	getTargetCasterProperties(String propertyType)
org.bukkit.Location	getTargetCenterLocation()
Collection<org.bukkit.entity.Entity>	getTargetedEntities()
org.bukkit.entity.Entity	getTargetEntity()
org.bukkit.Location	getTargetLocation()
Set<UUID>	getTargetMessagesSent()
String	getTargetName()
boolean	getTargetsCaster()
org.bukkit.Location	getTargetSourceLocation()
TargetType	getTargetType()
UndoList	getUndoList()
org.bukkit.configuration.ConfigurationSection	getVariables() Returns cast-local variables
org.bukkit.configuration.ConfigurationSection	getVariables(VariableScope scope)
int	getVerticalSearchDistance()
Wand	getWand()
org.bukkit.Location	getWandLocation() Currently return the cast source location, but in the future may change to return only the wand location, or null if this spell was not cast with a wand.
int	getWorkAllowed()
org.bukkit.configuration.ConfigurationSection	getWorkingParameters()
org.bukkit.World	getWorld()
boolean	hasBreakPermission(org.bukkit.block.Block block)
boolean	hasBuildPermission(org.bukkit.block.Block block)
boolean	hasEffects(String key)
boolean	hasHandlers()
boolean	isBreakable(org.bukkit.block.Block block)
boolean	isConsumeFree()
boolean	isDestructible(org.bukkit.block.Block block)
boolean	isIndestructible(org.bukkit.block.Block block)
boolean	isOkToStandIn(org.bukkit.block.Block block)
boolean	isOkToStandIn(org.bukkit.Material mat) Deprecated.
boolean	isOkToStandOn(org.bukkit.block.Block block)
boolean	isOkToStandOn(org.bukkit.Material mat) Deprecated.
boolean	isPassthrough(org.bukkit.block.Block block)
boolean	isPassthrough(org.bukkit.Material material) Deprecated.
boolean	isReflective(org.bukkit.block.Block block)
boolean	isTransparent(org.bukkit.block.Block block)
boolean	isTransparent(org.bukkit.Material material) Deprecated.
boolean	isWater(org.bukkit.Material mat)
void	messageTargets(String messageKey)
String	parameterize(String command)
String	parameterizeMessage(String message) Deprecated.
void	performedActions(int count)
void	playEffects(String key)
void	playEffects(String key, float scale)
void	playEffects(String key, float scale, org.bukkit.block.Block sourceBlock)
void	playEffects(String effectName, float scale, org.bukkit.Location source, org.bukkit.entity.Entity sourceEntity, org.bukkit.Location target, org.bukkit.entity.Entity targetEntity)
void	playEffects(String effectName, float scale, org.bukkit.Location source, org.bukkit.entity.Entity sourceEntity, org.bukkit.Location target, org.bukkit.entity.Entity targetEntity, org.bukkit.block.Block sourceBlock)
SpellResult	processHandlers()
void	registerBreakable(org.bukkit.block.Block block, double breakable)
double	registerBreaking(org.bukkit.block.Block block, double breakAmount)
void	registerDamaged(org.bukkit.entity.Entity entity)
void	registerFakeBlock(org.bukkit.block.Block block, Collection<WeakReference<org.bukkit.entity.Player>> players)
void	registerForUndo(org.bukkit.block.Block block)
void	registerForUndo(org.bukkit.entity.Entity entity)
void	registerForUndo(Runnable runnable)
void	registerModified(org.bukkit.entity.Entity entity)
void	registerModifier(org.bukkit.entity.Entity entity, MageModifier modifier)
void	registerModifierForRemoval(org.bukkit.entity.Entity entity, String modifierKey)
void	registerMoved(org.bukkit.entity.Entity entity)
void	registerPotionEffectForRemoval(org.bukkit.entity.Entity entity, org.bukkit.potion.PotionEffectType potionEffectType)
void	registerPotionEffects(org.bukkit.entity.Entity entity)
void	registerReflective(org.bukkit.block.Block block, double reflectivity)
void	registerVelocity(org.bukkit.entity.Entity entity)
void	retarget(double range, double fov, double closeRange, double closeFOV, boolean useHitbox)
void	retarget(double range, double fov, double closeRange, double closeFOV, boolean useHitbox, int yOffset, boolean targetSpaceRequired, int targetMinOffset)
void	sendMessage(String message)
void	sendMessageKey(String key)
void	sendMessageKey(String key, String message)
void	setBrush(MaterialBrush brush)
void	setCastData(String key, Object value)
void	setDestructible(MaterialSet destructible)
void	setDirection(org.bukkit.util.Vector direction)
void	setIndestructible(MaterialSet indestructible)
void	setInitialResult(SpellResult result)
void	setPreviousBlock(org.bukkit.block.Block previous)
void	setResult(SpellResult result)
void	setSpellParameters(org.bukkit.configuration.ConfigurationSection parameters)
void	setTargetBlock(org.bukkit.block.Block targetBlock)
void	setTargetCenterLocation(org.bukkit.Location location)
void	setTargetedLocation(org.bukkit.Location location)
void	setTargetEntity(org.bukkit.entity.Entity targetEntity)
void	setTargetLocation(org.bukkit.Location targetLocation)
void	setTargetName(String name)
void	setTargetsCaster(boolean target)
void	setTargetSourceLocation(org.bukkit.Location targetLocation)
void	setWorkAllowed(int work)
void	showMessage(String message)
void	showMessage(String key, String def)
boolean	teleport(org.bukkit.entity.Entity entity, org.bukkit.Location location, int verticalSearchDistance)
boolean	teleport(org.bukkit.entity.Entity entity, org.bukkit.Location location, int verticalSearchDistance, boolean preventFall)
boolean	teleport(org.bukkit.entity.Entity entity, org.bukkit.Location location, int verticalSearchDistance, boolean preventFall, boolean safe)
boolean	teleport(org.bukkit.entity.Entity entity, org.bukkit.Location location, int verticalSearchDistance, boolean preventFall, boolean safe, boolean teleportVehicle)
void	unregisterBreaking(org.bukkit.block.Block block)
void	updateBlock(org.bukkit.block.Block block)
void	updateLastTriggerTime()

Methods inherited from interface com.elmakers.mine.bukkit.api.magic.MageContext

canTarget, canTarget, checkWand, getActiveProperties, getAttribute, getLogger, getMessage, getMessage, getVariable, isTargetable

Methods inherited from interface com.elmakers.mine.bukkit.api.effect.EffectContext

getEffectColor, getEffectParticle, getName, setLocation, trackEffects

Method Detail

getEntity

@Nullable
org.bukkit.entity.Entity getEntity()

Specified by:

getEntity in interface EffectContext

getLivingEntity

@Nullable
org.bukkit.entity.LivingEntity getLivingEntity()

Specified by:

getLivingEntity in interface EffectContext

getLocation

@Nullable
org.bukkit.Location getLocation()

Specified by:

getLocation in interface EffectContext

getTargetLocation

@Nullable
org.bukkit.Location getTargetLocation()

Specified by:

getTargetLocation in interface EffectContext

getTargetCenterLocation

@Nullable
org.bukkit.Location getTargetCenterLocation()

setTargetCenterLocation

void setTargetCenterLocation(org.bukkit.Location location)

getTargetSourceLocation

@Nullable
org.bukkit.Location getTargetSourceLocation()

getDirection

@Nullable
org.bukkit.util.Vector getDirection()

getFacingDirection

org.bukkit.block.BlockFace getFacingDirection()

setDirection

void setDirection(org.bukkit.util.Vector direction)

getWorld

@Nullable
org.bukkit.World getWorld()

getPlugin

@Nullable
org.bukkit.plugin.Plugin getPlugin()

getEyeLocation

@Nullable
org.bukkit.Location getEyeLocation()

Specified by:

getEyeLocation in interface EffectContext

getWandLocation

@Nullable
org.bukkit.Location getWandLocation()

Currently return the cast source location, but in the future may change to return only the wand location, or null if this spell was not cast with a wand.

Specified by:

getWandLocation in interface EffectContext

Returns:

The location

getCastLocation

@Nullable
org.bukkit.Location getCastLocation()

Get the source location of this cast.

Specified by:

getCastLocation in interface EffectContext

Returns:

The location

getTargetBlock

@Nullable
org.bukkit.block.Block getTargetBlock()

getInteractBlock

@Nullable
org.bukkit.block.Block getInteractBlock()

getTargetEntity

@Nullable
org.bukkit.entity.Entity getTargetEntity()

Specified by:

getTargetEntity in interface EffectContext

setTargetEntity

void setTargetEntity(org.bukkit.entity.Entity targetEntity)

setTargetLocation

void setTargetLocation(org.bukkit.Location targetLocation)

setTargetSourceLocation

void setTargetSourceLocation(org.bukkit.Location targetLocation)

setTargetBlock

void setTargetBlock(org.bukkit.block.Block targetBlock)

getSpell

@Nonnull
Spell getSpell()

getMage

@Nonnull
Mage getMage()

Specified by:

getMage in interface MageContext

getWand

@Nullable
Wand getWand()

Specified by:

getWand in interface MageContext

getMageClass

@Nullable
MageClass getMageClass()

getEffects

Collection<EffectPlayer> getEffects(String key)

hasEffects

boolean hasEffects(String key)

getController

@Nonnull
MageController getController()

Specified by:

getController in interface EffectContext

registerForUndo

void registerForUndo(Runnable runnable)

registerForUndo

void registerForUndo(org.bukkit.entity.Entity entity)

registerForUndo

void registerForUndo(org.bukkit.block.Block block)

registerModified

void registerModified(org.bukkit.entity.Entity entity)

registerDamaged

void registerDamaged(org.bukkit.entity.Entity entity)

clearAttachables

void clearAttachables(org.bukkit.block.Block block)

updateBlock

void updateBlock(org.bukkit.block.Block block)

registerVelocity

void registerVelocity(org.bukkit.entity.Entity entity)

registerMoved

void registerMoved(org.bukkit.entity.Entity entity)

registerPotionEffects

void registerPotionEffects(org.bukkit.entity.Entity entity)

registerPotionEffectForRemoval

void registerPotionEffectForRemoval(org.bukkit.entity.Entity entity,
                                    org.bukkit.potion.PotionEffectType potionEffectType)

registerModifier

void registerModifier(org.bukkit.entity.Entity entity,
                      MageModifier modifier)

registerModifierForRemoval

void registerModifierForRemoval(org.bukkit.entity.Entity entity,
                                String modifierKey)

registerBreakable

void registerBreakable(org.bukkit.block.Block block,
                       double breakable)

registerReflective

void registerReflective(org.bukkit.block.Block block,
                        double reflectivity)

registerBreaking

double registerBreaking(org.bukkit.block.Block block,
                        double breakAmount)

unregisterBreaking

void unregisterBreaking(org.bukkit.block.Block block)

registerFakeBlock

void registerFakeBlock(org.bukkit.block.Block block,
                       Collection<WeakReference<org.bukkit.entity.Player>> players)

getPreviousBlock

org.bukkit.block.Block getPreviousBlock()

getPreviousPreviousBlock

org.bukkit.block.Block getPreviousPreviousBlock()

setPreviousBlock

void setPreviousBlock(org.bukkit.block.Block previous)

isIndestructible

boolean isIndestructible(org.bukkit.block.Block block)

hasBuildPermission

boolean hasBuildPermission(org.bukkit.block.Block block)

hasBreakPermission

boolean hasBreakPermission(org.bukkit.block.Block block)

isBreakable

boolean isBreakable(org.bukkit.block.Block block)

isReflective

boolean isReflective(org.bukkit.block.Block block)

getBreakable

@Nullable
Double getBreakable(org.bukkit.block.Block block)

getReflective

@Nullable
Double getReflective(org.bukkit.block.Block block)

clearBreakable

void clearBreakable(org.bukkit.block.Block block)

clearReflective

void clearReflective(org.bukkit.block.Block block)

playEffects

void playEffects(String key)

playEffects

void playEffects(String key,
                 float scale)

playEffects

void playEffects(String key,
                 float scale,
                 org.bukkit.block.Block sourceBlock)

playEffects

void playEffects(String effectName,
                 float scale,
                 org.bukkit.Location source,
                 org.bukkit.entity.Entity sourceEntity,
                 org.bukkit.Location target,
                 org.bukkit.entity.Entity targetEntity)

playEffects

void playEffects(String effectName,
                 float scale,
                 org.bukkit.Location source,
                 org.bukkit.entity.Entity sourceEntity,
                 org.bukkit.Location target,
                 org.bukkit.entity.Entity targetEntity,
                 org.bukkit.block.Block sourceBlock)

cancelEffects

void cancelEffects()

Specified by:

cancelEffects in interface EffectContext

getCurrentEffects

Collection<EffectPlay> getCurrentEffects()

Specified by:

getCurrentEffects in interface EffectContext

findPlaceToStand

@Nullable
org.bukkit.Location findPlaceToStand(org.bukkit.Location target,
                                               int verticalSearchDistance)

findPlaceToStand

@Nullable
org.bukkit.Location findPlaceToStand(org.bukkit.Location target,
                                               int verticalSearchDistance,
                                               boolean goUp)

castMessage

void castMessage(String message)

sendMessage

void sendMessage(String message)

castMessageKey

void castMessageKey(String key,
                    String message)

castMessageKey

void castMessageKey(String key)

sendMessageKey

void sendMessageKey(String key,
                    String message)

sendMessageKey

void sendMessageKey(String key)

showMessage

void showMessage(String message)

showMessage

void showMessage(String key,
                 String def)

setTargetedLocation

void setTargetedLocation(org.bukkit.Location location)

findBlockUnder

org.bukkit.block.Block findBlockUnder(org.bukkit.block.Block block)

findSpaceAbove

org.bukkit.block.Block findSpaceAbove(org.bukkit.block.Block block)

isTransparent

@Deprecated
boolean isTransparent(org.bukkit.Material material)

Deprecated.

isTransparent

boolean isTransparent(org.bukkit.block.Block block)

isPassthrough

@Deprecated
boolean isPassthrough(org.bukkit.Material material)

Deprecated.

isPassthrough

boolean isPassthrough(org.bukkit.block.Block block)

isDestructible

boolean isDestructible(org.bukkit.block.Block block)

areAnyDestructible

boolean areAnyDestructible(org.bukkit.block.Block block)

getBrush

@Nullable
MaterialBrush getBrush()

setBrush

void setBrush(MaterialBrush brush)

getTargetedEntities

Collection<org.bukkit.entity.Entity> getTargetedEntities()

messageTargets

void messageTargets(String messageKey)

getRandom

Random getRandom()

getUndoList

UndoList getUndoList()

setTargetName

void setTargetName(String name)

getTargetName

String getTargetName()

getWorkAllowed

int getWorkAllowed()

setWorkAllowed

void setWorkAllowed(int work)

addWork

void addWork(int work)

performedActions

void performedActions(int count)

getActionsPerformed

int getActionsPerformed()

finish

void finish()

retarget

void retarget(double range,
              double fov,
              double closeRange,
              double closeFOV,
              boolean useHitbox)

retarget

void retarget(double range,
              double fov,
              double closeRange,
              double closeFOV,
              boolean useHitbox,
              int yOffset,
              boolean targetSpaceRequired,
              int targetMinOffset)

getBaseContext

CastContext getBaseContext()

getParent

CastContext getParent()

getTargetMessagesSent

Set<UUID> getTargetMessagesSent()

teleport

boolean teleport(org.bukkit.entity.Entity entity,
                 org.bukkit.Location location,
                 int verticalSearchDistance)

teleport

boolean teleport(org.bukkit.entity.Entity entity,
                 org.bukkit.Location location,
                 int verticalSearchDistance,
                 boolean preventFall)

teleport

boolean teleport(org.bukkit.entity.Entity entity,
                 org.bukkit.Location location,
                 int verticalSearchDistance,
                 boolean preventFall,
                 boolean safe)

teleport

boolean teleport(org.bukkit.entity.Entity entity,
                 org.bukkit.Location location,
                 int verticalSearchDistance,
                 boolean preventFall,
                 boolean safe,
                 boolean teleportVehicle)

allowPassThrough

@Deprecated
boolean allowPassThrough(org.bukkit.Material material)

Deprecated.

allowPassThrough

boolean allowPassThrough(org.bukkit.block.Block block)

getVerticalSearchDistance

int getVerticalSearchDistance()

isOkToStandIn

@Deprecated
boolean isOkToStandIn(org.bukkit.Material mat)

Deprecated.

isOkToStandIn

boolean isOkToStandIn(org.bukkit.block.Block block)

isWater

boolean isWater(org.bukkit.Material mat)

isOkToStandOn

@Deprecated
boolean isOkToStandOn(org.bukkit.Material mat)

Deprecated.

isOkToStandOn

boolean isOkToStandOn(org.bukkit.block.Block block)

getMaterialSet

@Nullable
 @Deprecated
Set<org.bukkit.Material> getMaterialSet(String key)

Deprecated.

setSpellParameters

void setSpellParameters(org.bukkit.configuration.ConfigurationSection parameters)

getResult

SpellResult getResult()

setInitialResult

void setInitialResult(SpellResult result)

setResult

void setResult(SpellResult result)

addResult

void addResult(SpellResult result)

getTargetsCaster

boolean getTargetsCaster()

setTargetsCaster

void setTargetsCaster(boolean target)

getTargetType

TargetType getTargetType()

canContinue

boolean canContinue(org.bukkit.Location location)

canCast

boolean canCast(org.bukkit.Location location)

parameterize

String parameterize(String command)

parameterizeMessage

@Deprecated
String parameterizeMessage(String message)

Deprecated.

isConsumeFree

boolean isConsumeFree()

addHandler

void addHandler(ActionHandler handler)

processHandlers

SpellResult processHandlers()

hasHandlers

boolean hasHandlers()

addMessageParameter

void addMessageParameter(String key,
                         String value)

getStartTime

long getStartTime()

getLastTriggerTime

long getLastTriggerTime()

updateLastTriggerTime

void updateLastTriggerTime()

getVariables

@Nonnull
org.bukkit.configuration.ConfigurationSection getVariables(VariableScope scope)

getVariables

@Nonnull
org.bukkit.configuration.ConfigurationSection getVariables()

Returns cast-local variables

getAllVariables

@Nonnull
org.bukkit.configuration.ConfigurationSection getAllVariables()

Returns all variables, this can be an expensive call so avoid using it if possible. This is also not modifiable, the configuration section returned is a copy.

getWorkingParameters

org.bukkit.configuration.ConfigurationSection getWorkingParameters()

getRootHandler

ActionHandler getRootHandler()

setCastData

void setCastData(@Nonnull
                 String key,
                 Object value)

getCastData

@Nullable
Object getCastData(@Nonnull
                             String key)

setDestructible

void setDestructible(MaterialSet destructible)

setIndestructible

void setIndestructible(MaterialSet indestructible)

getCasterProperties

@Nullable
CasterProperties getCasterProperties(String propertyType)

getTargetCasterProperties

@Nullable
CasterProperties getTargetCasterProperties(String propertyType)