spellcast.gestures
Enum Gesture

java.lang.Object
  java.lang.Enum<Gesture>
      spellcast.gestures.Gesture

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Gesture>

public enum Gesture
extends java.lang.Enum<Gesture>

A Spellcast Gesture.

Spellcast defines eight valid gestures; emptyHand, palm, digit, fingers, wave, clap, snap, and knife.

It also uses two display gestures: antispell and unclear.

Gestures can also be two handed.

Version:

$Revision: 1.1 $

Author:

Barrie Treloar

Enum Constant Summary

ANTISPELL

CLAP

DIGIT

EMPTY_HAND

FINGERS

KNIFE

ONE_HANDED_CLAP

PALM

SNAP

TWO_HANDED_PALM

UNCLEAR

WAVE

Method Summary

java.lang.String	getName() Return the name of this gesture.
boolean	isTwoHanded() Indicates whether this Gesture is two handed or one handed.
boolean	isUnclear() Indicates whether the Gesture is unclear.
static Gesture	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Gesture[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EMPTY_HAND

public static final Gesture EMPTY_HAND

PALM

public static final Gesture PALM

DIGIT

public static final Gesture DIGIT

FINGERS

public static final Gesture FINGERS

WAVE

public static final Gesture WAVE

CLAP

public static final Gesture CLAP

SNAP

public static final Gesture SNAP

KNIFE

public static final Gesture KNIFE

ANTISPELL

public static final Gesture ANTISPELL

UNCLEAR

public static final Gesture UNCLEAR

TWO_HANDED_PALM

public static final Gesture TWO_HANDED_PALM

ONE_HANDED_CLAP

public static final Gesture ONE_HANDED_CLAP

Method Detail

values

public static final Gesture[] values()

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

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

Returns:

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

valueOf

public static Gesture valueOf(java.lang.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:

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

getName

public final java.lang.String getName()

Return the name of this gesture.

Returns:

the name of this gesture.

isTwoHanded

public final boolean isTwoHanded()

Indicates whether this Gesture is two handed or one handed. True is two handed, false otherwise.

Returns:

true for a two handed Gesture, false for a one handed Gesture.

isUnclear

public final boolean isUnclear()

Indicates whether the Gesture is unclear. An unclear Gesture will not be visible to the Being.

Returns:

value true if the Gesture is unclear, false otherwise.