com.planet_ink.coffee_mud.Common
Class DefaultFaction.DefaultFactionRange

java.lang.Object
  com.planet_ink.coffee_mud.Common.DefaultFaction.DefaultFactionRange

All Implemented Interfaces:

Faction.FactionRange

Enclosing class:

DefaultFaction

public static class DefaultFaction.DefaultFactionRange
extends java.lang.Object
implements Faction.FactionRange

Field Summary

int	AlignEquiv
java.lang.String	CodeName
int	high
int	low
Faction	myFaction
java.lang.String	Name

Constructor Summary

DefaultFaction.DefaultFactionRange(Faction F, java.lang.String key)

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
Faction	myFaction()
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

low

public int low

high

public int high

Name

public java.lang.String Name

CodeName

public java.lang.String CodeName

AlignEquiv

public int AlignEquiv

myFaction

public Faction myFaction

Constructor Detail

DefaultFaction.DefaultFactionRange

public DefaultFaction.DefaultFactionRange(Faction F,
                                          java.lang.String key)

Method Detail

low

public int low()

Description copied from interface: Faction.FactionRange

Returns the numerically low value of this faction range

Specified by:

low in interface Faction.FactionRange

Returns:

the numerically low value of this faction range

See Also:

Faction.FactionRange.setLow(int)

high

public int high()

Description copied from interface: Faction.FactionRange

Returns the numerically high value of this faction range

Specified by:

high in interface Faction.FactionRange

Returns:

the numerically high value of this faction range

See Also:

Faction.FactionRange.setHigh(int)

name

public java.lang.String name()

Description copied from interface: Faction.FactionRange

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

Specified by:

name in interface Faction.FactionRange

Returns:

the name of this range of values

See Also:

Faction.FactionRange.setName(String)

codeName

public java.lang.String codeName()

Description copied from interface: Faction.FactionRange

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

Specified by:

codeName in interface Faction.FactionRange

Returns:

the unique code name that describes this range of faction values

alignEquiv

public int alignEquiv()

Description copied from interface: Faction.FactionRange

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

Specified by:

alignEquiv in interface Faction.FactionRange

Returns:

an alignment constant

See Also:

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

myFaction

public Faction myFaction()

setLow

public void setLow(int newVal)

Description copied from interface: Faction.FactionRange

Sets the numerically low value of this faction range

Specified by:

setLow in interface Faction.FactionRange

Parameters:

newVal - the numerically low value of this faction range

See Also:

Faction.FactionRange.low()

setHigh

public void setHigh(int newVal)

Description copied from interface: Faction.FactionRange

Sets the numerically high value of this faction range

Specified by:

setHigh in interface Faction.FactionRange

Parameters:

newVal - the numerically high value of this faction range

See Also:

Faction.FactionRange.high()

setName

public void setName(java.lang.String newVal)

Description copied from interface: Faction.FactionRange

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

Specified by:

setName in interface Faction.FactionRange

Parameters:

newVal - the name of this range of values

See Also:

Faction.FactionRange.name()

setAlignEquiv

public void setAlignEquiv(int newVal)

Description copied from interface: Faction.FactionRange

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

Specified by:

setAlignEquiv in interface Faction.FactionRange

Parameters:

newVal - a new alignment constant

See Also:

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

toString

public java.lang.String toString()

Description copied from interface: Faction.FactionRange

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

Specified by:

toString in interface Faction.FactionRange

Overrides:

toString in class java.lang.Object

Returns:

a semicolon-delimited range

See Also:

Faction.addRange(String)

random

public int random()

Description copied from interface: Faction.FactionRange

Returns a random numeric value within this faction range

Specified by:

random in interface Faction.FactionRange

Returns:

a random numeric value within this faction range