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

All Known Implementing Classes:
DefaultFaction.DefaultFactionZapFactor
Enclosing interface:
Faction

public static interface Faction.FZapFactor

A factor defines how modifications of faction value, up or down, are modified on a mob by mob basis.

See Also:
Faction.addFactor(double, double, String), Faction.factors()

Method Summary
 MaskingLibrary.CompiledZMask compiledMOBMask()
          The compiled mask to tell which mobs to apply this factor to
 double gainFactor()
          Get the gain factor (0-1)
 double lossFactor()
          Set the loss factor (0-1)
 java.lang.String MOBMask()
          The mask to tell which mobs to apply this factor to
 void setGainFactor(double val)
          Set the gain factor (0-1)
 void setLossFactor(double val)
          Set the loss factor (0-1)
 void setMOBMask(java.lang.String str)
          Set the mask to determine which mobs in the players presence will be affected.
 java.lang.String toString()
          Returns a semicolon-delimited string of the values of this factpr, suitable for using to create a new one later.
 

Method Detail

gainFactor

double gainFactor()
Get the gain factor (0-1)

Returns:
the gain factor (0-1)
See Also:
setGainFactor(double)

setGainFactor

void setGainFactor(double val)
Set the gain factor (0-1)

Parameters:
val - the gain factor (0-1)
See Also:
gainFactor()

lossFactor

double lossFactor()
Set the loss factor (0-1)

Returns:
the loss factor (0-1)
See Also:
setGainFactor(double)

setLossFactor

void setLossFactor(double val)
Set the loss factor (0-1)

Parameters:
val - the loss factor (0-1)
See Also:
gainFactor()

MOBMask

java.lang.String MOBMask()
The mask to tell which mobs to apply this factor to

Returns:
mask to tell which mobs to apply this reaction to
See Also:
setMOBMask(String)

compiledMOBMask

MaskingLibrary.CompiledZMask compiledMOBMask()
The compiled mask to tell which mobs to apply this factor to

Returns:
the compiled mask to tell which mobs to apply this reaction to
See Also:
setMOBMask(String)

setMOBMask

void setMOBMask(java.lang.String str)
Set the mask to determine which mobs in the players presence will be affected. This is a zappermask.

Parameters:
str - the mask to determine which mobs in the players presence will be affected
See Also:
MaskingLibrary, MOBMask()

toString

java.lang.String toString()
Returns a semicolon-delimited string of the values of this factpr, suitable for using to create a new one later.

Overrides:
toString in class java.lang.Object
Returns:
a string of the values of this factor
See Also:
Faction.addFactor(double,double,String)