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

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

public static interface Faction.FactionReactionItem

Adds very temporary affects and behaviors to mobs who match the reaction zapper mask, and who are in the same room as someone with standing in this faction.

See Also:
Faction.addReaction(String, String, String, String), Faction.reactions()

Method Summary
 MaskingLibrary.CompiledZapperMask compiledPresentMOBMask()
          The compiled mask to tell which mobs to apply this reaction to
 java.lang.String parameters()
          The parameters for the ability/behavior/command above.
 java.lang.String presentMOBMask()
          The mask to tell which mobs to apply this reaction to
 java.lang.String rangeName()
          The name of the range which determines which folks with this faction get a reaction
 java.lang.String reactionObjectID()
          The ability/behavior/command id.
 void setParameters(java.lang.String str)
          Set the parameters for the ability/behavior/command above.
 void setPresentMOBMask(java.lang.String str)
          Set the mask to determine which mobs in the players presence will be affected.
 void setRangeName(java.lang.String str)
          Set the name of the range which determines which folks with this faction get a reaction
 void setReactionObjectID(java.lang.String str)
          Set the ability/behavior/command id.
 java.lang.String toString()
          Returns a semicolon-delimited string of the values of this reaction, suitable for using to create a new one later.
 

Method Detail

reactionObjectID

java.lang.String reactionObjectID()
The ability/behavior/command id.

Returns:
the ability/behavior/command id
See Also:
setReactionObjectID(String)

setReactionObjectID

void setReactionObjectID(java.lang.String str)
Set the ability/behavior/command id.

Parameters:
str - the ability/behavior/command id
See Also:
reactionObjectID()

presentMOBMask

java.lang.String presentMOBMask()
The mask to tell which mobs to apply this reaction to

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

compiledPresentMOBMask

MaskingLibrary.CompiledZapperMask compiledPresentMOBMask()
The compiled mask to tell which mobs to apply this reaction to

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

setPresentMOBMask

void setPresentMOBMask(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, presentMOBMask()

rangeName

java.lang.String rangeName()
The name of the range which determines which folks with this faction get a reaction

Returns:
the range which determines which folks with this faction get a reaction
See Also:
setRangeName(String)

setRangeName

void setRangeName(java.lang.String str)
Set the name of the range which determines which folks with this faction get a reaction

Parameters:
str - the range which determines which folks with this faction get a reaction
See Also:
rangeName()

parameters

java.lang.String parameters()
The parameters for the ability/behavior/command above.

Returns:
the parameters for the ability/behavior/command above
See Also:
setRangeName(String)

setParameters

void setParameters(java.lang.String str)
Set the parameters for the ability/behavior/command above.

Parameters:
str - the parameters for the ability/behavior/command above
See Also:
rangeName()

toString

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

Overrides:
toString in class java.lang.Object
Returns:
a semicolon-delimited string of the values of this reaction
See Also:
Faction.addReaction(String, String, String, String)