com.elmakers.mine.bukkit.api.spell

Enum SpellResult

java.lang.Object

java.lang.Enum<SpellResult>

com.elmakers.mine.bukkit.api.spell.SpellResult

All Implemented Interfaces:

Serializable, Comparable<SpellResult>

public enum SpellResult
extends Enum<SpellResult>

Every Spell will return a SpellResult when cast. This result will determine the messaging and effects used, as well as whether or not the Spell cast consumes its CastingCost costs.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALTERNATE
ALTERNATE_DOWN
ALTERNATE_JUMPING
ALTERNATE_JUMPING_DOWN
ALTERNATE_JUMPING_UP
ALTERNATE_SNEAK
ALTERNATE_SNEAK_DOWN
ALTERNATE_SNEAK_UP
ALTERNATE_UP
BACKFIRE
BLOCKED
CANCELLED
CAST
CAST_SELF
CAST_TARGET
COOLDOWN
CURSED
DEACTIVATE
ENTITY_REQUIRED
FAIL
FIZZLE
INSUFFICIENT_CHARGES
INSUFFICIENT_PERMISSION
INSUFFICIENT_RESOURCES
INVALID_WORLD
LIVING_ENTITY_REQUIRED
LOCATION_REQUIRED
NO_ACTION
NO_TARGET
PENDING
PLAYER_REQUIRED
REACTIVATE
STOP
TARGET_SELECTED
WORLD_REQUIRED

Method Summary

Modifier and Type	Method and Description
boolean	isAlternate() Determine if this result is an alternate-mode cast.
boolean	isFailure() Determine if this result is a failure or not.
boolean	isFree() Determine if this result is a free cast or not.
boolean	isFree(boolean castOnNoTarget)
boolean	isStop() Determine if this result should stop processing or not.
boolean	isSuccess() Determine if this result is a success or not.
boolean	isSuccess(boolean castOnNoTarget) Determine if this result is a success or not, possibly counting no_target as a success.
SpellResult	max(SpellResult other)
SpellResult	min(SpellResult other)
boolean	shouldRefundCooldown(boolean castOnNoTarget)
boolean	shouldRefundCosts(boolean castOnNoTarget, boolean refund)
static SpellResult	valueOf(String name) Returns the enum constant of this type with the specified name.
static SpellResult[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STOP

public static final SpellResult STOP

PENDING

public static final SpellResult PENDING

CAST

public static final SpellResult CAST

CAST_SELF

public static final SpellResult CAST_SELF

CAST_TARGET

public static final SpellResult CAST_TARGET

ALTERNATE

public static final SpellResult ALTERNATE

ALTERNATE_UP

public static final SpellResult ALTERNATE_UP

ALTERNATE_DOWN

public static final SpellResult ALTERNATE_DOWN

ALTERNATE_SNEAK

public static final SpellResult ALTERNATE_SNEAK

ALTERNATE_JUMPING

public static final SpellResult ALTERNATE_JUMPING

ALTERNATE_SNEAK_UP

public static final SpellResult ALTERNATE_SNEAK_UP

ALTERNATE_SNEAK_DOWN

public static final SpellResult ALTERNATE_SNEAK_DOWN

ALTERNATE_JUMPING_UP

public static final SpellResult ALTERNATE_JUMPING_UP

ALTERNATE_JUMPING_DOWN

public static final SpellResult ALTERNATE_JUMPING_DOWN

REACTIVATE

public static final SpellResult REACTIVATE

FIZZLE

public static final SpellResult FIZZLE

BACKFIRE

public static final SpellResult BACKFIRE

BLOCKED

public static final SpellResult BLOCKED

DEACTIVATE

public static final SpellResult DEACTIVATE

TARGET_SELECTED

public static final SpellResult TARGET_SELECTED

CURSED

public static final SpellResult CURSED

COOLDOWN

public static final SpellResult COOLDOWN

NO_TARGET

public static final SpellResult NO_TARGET

FAIL

public static final SpellResult FAIL

INSUFFICIENT_RESOURCES

public static final SpellResult INSUFFICIENT_RESOURCES

INSUFFICIENT_CHARGES

public static final SpellResult INSUFFICIENT_CHARGES

INSUFFICIENT_PERMISSION

public static final SpellResult INSUFFICIENT_PERMISSION

ENTITY_REQUIRED

public static final SpellResult ENTITY_REQUIRED

LIVING_ENTITY_REQUIRED

public static final SpellResult LIVING_ENTITY_REQUIRED

PLAYER_REQUIRED

public static final SpellResult PLAYER_REQUIRED

LOCATION_REQUIRED

public static final SpellResult LOCATION_REQUIRED

WORLD_REQUIRED

public static final SpellResult WORLD_REQUIRED

INVALID_WORLD

public static final SpellResult INVALID_WORLD

CANCELLED

public static final SpellResult CANCELLED

NO_ACTION

public static final SpellResult NO_ACTION

Method Detail

values

public static SpellResult[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SpellResult c : SpellResult.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SpellResult valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isFailure

public boolean isFailure()

Determine if this result is a failure or not.

Note that a spell result can be neither failure nor success.

Returns:

True if this cast was a failure.

isSuccess

public boolean isSuccess()

Determine if this result is a success or not.

Returns:

True if this cast was a success.

isSuccess

public boolean isSuccess(boolean castOnNoTarget)

Determine if this result is a success or not, possibly counting no_target as a success.

Returns:

True if this cast was a success.

isFree

public boolean isFree()

Determine if this result is a free cast or not.

Returns:

True if this cast should not consume costs.

isFree

public boolean isFree(boolean castOnNoTarget)

isStop

public boolean isStop()

Determine if this result should stop processing or not.

Returns:

True if this result should stop processing, either temporarily (PENDING) or permanently (CANCELLED)

shouldRefundCooldown

public boolean shouldRefundCooldown(boolean castOnNoTarget)

shouldRefundCosts

public boolean shouldRefundCosts(boolean castOnNoTarget,
                                 boolean refund)

isAlternate

public boolean isAlternate()

Determine if this result is an alternate-mode cast.

Returns:

True if this cast was an alternate-mode.

min

public SpellResult min(SpellResult other)

max

public SpellResult max(SpellResult other)