Package com.planet_ink.coffee_mud.Libraries.interfaces

Enum TrackingLibrary.TrackingFlag

java.lang.Object

java.lang.Enum<TrackingLibrary.TrackingFlag>

com.planet_ink.coffee_mud.Libraries.interfaces.TrackingLibrary.TrackingFlag

All Implemented Interfaces:

TrackingLibrary.RFilter, java.io.Serializable, java.lang.Comparable<TrackingLibrary.TrackingFlag>

Enclosing interface:

TrackingLibrary

public static enum TrackingLibrary.TrackingFlag
extends java.lang.Enum<TrackingLibrary.TrackingFlag>
implements TrackingLibrary.RFilter

A Tracking Flag is a form of RFiler that is an enum that includes various pre-configured rfilters used throughout the engine.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AREAONLY
CEILINGSSONLY
FLOORSONLY
INDOORONLY
NOAIR
NOCLIMB
NOCRAWL
NOEMPTYGRIDS
NOHIDDENAREAS
NOHOMES
NOPRIVATEPROPERTY
NOTHINAREAS
NOWATER
OPENONLY
OUTDOORONLY
PASSABLE
SHOREONLY
UNDERWATERONLY
UNLOCKEDONLY
WATERSURFACEONLY
WATERSURFACEORSHOREONLY

Field Summary

Fields

Modifier and Type	Field	Description
TrackingLibrary.RFilter	myFilter

Method Summary

Modifier and Type	Method	Description
boolean	isFilteredOut(Room hostR, Room R, Exit E, int dir)	The room in question is always the second one, "R".
static TrackingLibrary.TrackingFlag	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static TrackingLibrary.TrackingFlag[]	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

NOHOMES

public static final TrackingLibrary.TrackingFlag NOHOMES

OPENONLY

public static final TrackingLibrary.TrackingFlag OPENONLY

UNLOCKEDONLY

public static final TrackingLibrary.TrackingFlag UNLOCKEDONLY

PASSABLE

public static final TrackingLibrary.TrackingFlag PASSABLE

AREAONLY

public static final TrackingLibrary.TrackingFlag AREAONLY

NOTHINAREAS

public static final TrackingLibrary.TrackingFlag NOTHINAREAS

NOHIDDENAREAS

public static final TrackingLibrary.TrackingFlag NOHIDDENAREAS

NOEMPTYGRIDS

public static final TrackingLibrary.TrackingFlag NOEMPTYGRIDS

NOAIR

public static final TrackingLibrary.TrackingFlag NOAIR

NOPRIVATEPROPERTY

public static final TrackingLibrary.TrackingFlag NOPRIVATEPROPERTY

NOWATER

public static final TrackingLibrary.TrackingFlag NOWATER

WATERSURFACEONLY

public static final TrackingLibrary.TrackingFlag WATERSURFACEONLY

WATERSURFACEORSHOREONLY

public static final TrackingLibrary.TrackingFlag WATERSURFACEORSHOREONLY

SHOREONLY

public static final TrackingLibrary.TrackingFlag SHOREONLY

UNDERWATERONLY

public static final TrackingLibrary.TrackingFlag UNDERWATERONLY

FLOORSONLY

public static final TrackingLibrary.TrackingFlag FLOORSONLY

CEILINGSSONLY

public static final TrackingLibrary.TrackingFlag CEILINGSSONLY

NOCLIMB

public static final TrackingLibrary.TrackingFlag NOCLIMB

NOCRAWL

public static final TrackingLibrary.TrackingFlag NOCRAWL

OUTDOORONLY

public static final TrackingLibrary.TrackingFlag OUTDOORONLY

INDOORONLY

public static final TrackingLibrary.TrackingFlag INDOORONLY

Field Detail

myFilter

public TrackingLibrary.RFilter myFilter

Method Detail

values

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

Returns:

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

valueOf

public static TrackingLibrary.TrackingFlag 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

java.lang.NullPointerException - if the argument is null

isFilteredOut

public boolean isFilteredOut(Room hostR,
                             Room R,
                             Exit E,
                             int dir)

Description copied from interface: TrackingLibrary.RFilter

The room in question is always the second one, "R". The hostR is a room being travelled from, and is optional. The exit and direction are the travelling means, if any.

Specified by:

isFilteredOut in interface TrackingLibrary.RFilter

Parameters:

hostR - the starting room

R - the room being filtered, and the target room

E - the exit from the host to target room

dir - the direction from host to target room

Returns:

true if the room is to be skipped, or false otherwise