com.planet_ink.coffee_mud.Common.interfaces
Interface Faction.FactionRange

All Known Implementing Classes:

DefaultFaction.DefaultFactionRange

Enclosing interface:

Faction

public static interface Faction.FactionRange

The foundation of any Faction, the Faction Range represents a range of values that constitutes a single named group of numeric values for the faction. A factions total range is determined by the high value of the highest range and the low value of the lowest range.

See Also:

Faction.addRange(String), Faction.ranges()

Method Summary

int	alignEquiv() Returns a constant reflecting whether this range of faction value is equivalent to one of the legacy alignment constant values.
java.lang.String	codeName() Returns the unique code name that describes this range of faction values
int	high() Returns the numerically high value of this faction range
int	low() Returns the numerically low value of this faction range
java.lang.String	name() Returns the nice friendly displayable name of this faction range, which need not be unique.
int	random() Returns a random numeric value within this faction range
void	setAlignEquiv(int newVal) Sets a constant reflecting whether this range of faction value is equivalent to one of the legacy alignment constant values.
void	setHigh(int newVal) Sets the numerically high value of this faction range
void	setLow(int newVal) Sets the numerically low value of this faction range
void	setName(java.lang.String newVal) Sets the nice friendly displayable name of this faction range, which need not be unique.
java.lang.String	toString() Returns a semicolon-delimited representation of this faction range, which can be used to create a new one later.

Method Detail

codeName

java.lang.String codeName()

Returns the unique code name that describes this range of faction values

Returns:

the unique code name that describes this range of faction values

low

int low()

Returns the numerically low value of this faction range

Returns:

the numerically low value of this faction range

See Also:

setLow(int)

setLow

void setLow(int newVal)

Sets the numerically low value of this faction range

Parameters:

newVal - the numerically low value of this faction range

See Also:

low()

high

int high()

Returns the numerically high value of this faction range

Returns:

the numerically high value of this faction range

See Also:

setHigh(int)

setHigh

void setHigh(int newVal)

Sets the numerically high value of this faction range

Parameters:

newVal - the numerically high value of this faction range

See Also:

high()

name

java.lang.String name()

Returns the nice friendly displayable name of this faction range, which need not be unique.

Returns:

the name of this range of values

See Also:

setName(String)

setName

void setName(java.lang.String newVal)

Sets the nice friendly displayable name of this faction range, which need not be unique.

Parameters:

newVal - the name of this range of values

See Also:

name()

alignEquiv

int alignEquiv()

Returns a constant reflecting whether this range of faction value is equivalent to one of the legacy alignment constant values.

Returns:

an alignment constant

See Also:

Faction.ALIGN_NAMES, Faction.ALIGN_INDIFF, Faction.ALIGN_EVIL, Faction.ALIGN_GOOD, Faction.ALIGN_NEUTRAL, setAlignEquiv(int)

setAlignEquiv

void setAlignEquiv(int newVal)

Sets a constant reflecting whether this range of faction value is equivalent to one of the legacy alignment constant values.

Parameters:

newVal - a new alignment constant

See Also:

Faction.ALIGN_NAMES, Faction.ALIGN_INDIFF, Faction.ALIGN_EVIL, Faction.ALIGN_GOOD, Faction.ALIGN_NEUTRAL, setAlignEquiv(int)

toString

java.lang.String toString()

Returns a semicolon-delimited representation of this faction range, which can be used to create a new one later.

Overrides:

toString in class java.lang.Object

Returns:

a semicolon-delimited range

See Also:

Faction.addRange(String)

random

int random()

Returns a random numeric value within this faction range

Returns:

a random numeric value within this faction range