org.starhope.appius.game.npc.plebeian
Enum PlebeianActor

java.lang.Object
  java.lang.Enum<PlebeianActor>
      org.starhope.appius.game.npc.plebeian.PlebeianActor

All Implemented Interfaces:

Serializable, Comparable<PlebeianActor>

public enum PlebeianActor
extends Enum<PlebeianActor>

When an Action fires through a Quaestor, there are two or three users who can be involved in that Action: the subject, the object, and the user embodying the listener. (Any or all of the three can be null, however.)

This is an enumeration which embodies these three actors, used in ScriptRunner mostly (e.g. PlebeianScriptRunner )

Author:

brpocock@star-hope.org

Enum Constant Summary

Myself
The observer who is listening for an Action

Object
The Object of the Action

Subject
The Subject of the Action

Method Summary

static PlebeianActor	valueOf(String name) Returns the enum constant of this type with the specified name.
static PlebeianActor[]	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

Subject

public static final PlebeianActor Subject

The Subject of the Action

Object

public static final PlebeianActor Object

The Object of the Action

Myself

public static final PlebeianActor Myself

The observer who is listening for an Action

Method Detail

values

public static PlebeianActor[] 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 (PlebeianActor c : PlebeianActor.values())
    System.out.println(c);

Returns:

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

valueOf

public static PlebeianActor 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