|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Faction
A Faction is an arbitrary numeric range, where different mobs/players can be within that range, if they have the faction at all. Factions can be programmatically set to change due to events that occur to/around the mob, and adjust themselves relative to other factions. Subsets of the faction can be given readable names for display to the user.
FactionMember.fetchFaction(String)
,
FactionMember.addFaction(String, int)
Nested Class Summary | |
---|---|
static class |
Faction.Align
legacy enumerator constant for Faction.FRange.alignEquiv() denoting that the range does not reflect alignment |
static interface |
Faction.FAbilityUsage
A Faction Ability Usage object represents a set of criterium that can be used to determine whether this faction allows a mob or player to use a particular ability, or class of abilities. |
static interface |
Faction.FactionChangeEvent
A Faction Change Event is an event that triggers an automatic change in a mob or players faction value. |
static interface |
Faction.FData
A FactionData object is stored inside other objects that keep track of their own faction. |
static interface |
Faction.FRange
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. |
static interface |
Faction.FReactionItem
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. |
static interface |
Faction.FZapFactor
A factor defines how modifications of faction value, up or down, are modified on a mob by mob basis. |
Field Summary | |
---|---|
static java.lang.String[] |
EXPAFFECT_DESCS
String descriptions for the valid experienceFlag() constants |
static java.lang.String[] |
EXPAFFECT_NAMES
String list for the valid experienceFlag() constants |
static long |
IFLAG_CUSTOMTICK
internal flag masks meaning to skip normal ticking, retrieved by getInternalFlags() |
static long |
IFLAG_IGNOREAUTO
internal flag masks meaning to skip standard auto system, retrieved by getInternalFlags() |
static long |
IFLAG_NEVERSAVE
internal flag masks meaning to never save to a file, retrieved by getInternalFlags() |
static int |
TAG_ABILITY_
index constant for tag names in TAG_NAMES denoting the ABILITY tag |
static int |
TAG_AFFBEHAV_
index constant for tag names in TAG_NAMES denoting the AFFBEHAV tag |
static int |
TAG_AUTOCHOICES
index constant for tag names in TAG_NAMES denoting the AUTOCHOICES tag |
static int |
TAG_AUTODEFAULTS
index constant for tag names in TAG_NAMES denoting the AUTODEFAULTS tag |
static int |
TAG_CHANGE_
index constant for tag names in TAG_NAMES denoting the CHANGE tag |
static int |
TAG_CHOICEINTRO
index constant for tag names in TAG_NAMES denoting the CHOICEINTRO tag |
static int |
TAG_DEFAULT
index constant for tag names in TAG_NAMES denoting the DEFAULT tag |
static int |
TAG_EDITALONE
index constant for tag names in TAG_NAMES denoting the EDITALONE tag |
static int |
TAG_EXPERIENCE
index constant for tag names in TAG_NAMES denoting the EXPERIENCE tag |
static int |
TAG_FACTOR_
index constant for tag names in TAG_NAMES denoting the FACTOR tag |
static int |
TAG_MAXIMUM
index constant for tag names in TAG_NAMES denoting the MAXIMUM tag |
static int |
TAG_MINIMUM
index constant for tag names in TAG_NAMES denoting the MINIMUM tag |
static int |
TAG_NAME
index constant for tag names in TAG_NAMES denoting the NAME tag |
static java.lang.String[] |
TAG_NAMES
list of valid tag names for internal faction data, retrieved by getTagValue(String) |
static int |
TAG_RANGE_
index constant for tag names in TAG_NAMES denoting the RANGE tag |
static int |
TAG_RATEMODIFIER
index constant for tag names in TAG_NAMES denoting the RATEMODIFIER tag |
static int |
TAG_REACTION_
index constant for tag names in TAG_NAMES denoting the RELATION tag |
static int |
TAG_RELATION_
index constant for tag names in TAG_NAMES denoting the RELATION tag |
static int |
TAG_SCOREDISPLAY
index constant for tag names in TAG_NAMES denoting the SCOREDISPLAY tag |
static int |
TAG_SHOWINFACTIONSCMD
index constant for tag names in TAG_NAMES denoting the SHOWINFACTIONSCMD tag |
static int |
TAG_SPECIALREPORTED
index constant for tag names in TAG_NAMES denoting the SPECIALREPORTED tag |
static int |
TAG_USELIGHTREACTIONS
index constant for tag names in TAG_NAMES denoting the SCOREDISPLAY tag |
Method Summary | |
---|---|
java.util.Enumeration<Faction.FAbilityUsage> |
abilityUsages()
Returns an enumeration of Faction.FactionAbilityUsage objects for this Faction. |
Faction.FAbilityUsage |
addAbilityUsage(java.lang.String key)
Adds a new Faction.FactionAbilityUsage object to this Faction based on the given definitional key. |
boolean |
addAffectBehav(java.lang.String ID,
java.lang.String parms,
java.lang.String gainMask)
Adds a new Ability or Behavior to this Faction. |
Faction.FZapFactor |
addFactor(double gain,
double loss,
java.lang.String mask)
Adds a new change factor to this Faction. |
Faction.FRange |
addRange(java.lang.String key)
Adds a new Faction.FactionRange object to this faction using an encoded key. |
boolean |
addReaction(java.lang.String range,
java.lang.String mask,
java.lang.String abilityID,
java.lang.String parms)
Adds a new reaction to this faction. |
boolean |
addRelation(java.lang.String factionID,
double relation)
Adds a new faction relation factor to this faction. |
java.util.Enumeration<java.lang.String> |
affectsBehavs()
Returns an enumeration of Abilities or Behavior IDs that are automatically but conditionally added to mobs (not players) with this faction. |
java.lang.String |
ALL_CHANGE_EVENT_TYPES()
Computed completed at runtime, this method returns all possible valid FactionChangeEvent event ids that can be used to define triggers. |
int |
asPercent(int faction)
Returns the given faction value, as a percent from minimum of the range of this faction |
int |
asPercentFromAvg(int faction)
Returns the given value faction value, as a percent from average of the range values of this faction. |
java.util.Enumeration<java.lang.String> |
autoDefaults()
Returns the automatic default faction mask/value list, which is possibly applied whenever a mob or player is brought to life for the first time. |
boolean |
canUse(MOB mob,
Ability A)
Returns whether the given player/mob is prevented from using the given Ability based on any of the Faction.FactionAbilityUsage (faction ability usage) criterium defined for this Faction. |
java.util.Enumeration<java.lang.String> |
changeEventKeys()
Returns an enumeration of change event keys, which are the code names of the triggers that cause faction values to change automatically. |
java.lang.String |
choiceIntro()
Gets the filename of a file, from the resources directory, that is displayed to users when they are given the choice of a starting value to this faction. |
java.util.Enumeration<java.lang.String> |
choices()
Returns the player choosable faction mask/value list, which is possibly presented whenever a player creates a new character. |
void |
clearChangeEvents()
Removes all FactionChangeEvents |
Faction.FactionChangeEvent |
createChangeEvent(java.lang.String key)
Adds a new FactionChangeEvent object to this faction using the given event code name, or fully encoded event string. |
java.util.Enumeration<java.lang.String> |
defaults()
Returns the default faction mask/value list, which is applied whenever a Faction Change Event applies a Faction Add command. |
boolean |
delAbilityUsage(Faction.FAbilityUsage usage)
Removes the given Faction.FactionAbilityUsage object from this faction |
boolean |
delAffectBehav(java.lang.String ID)
Removes the given ability or behavior from this Faction. |
boolean |
delChangeEvent(Faction.FactionChangeEvent event)
Removes a FactionChangeEvent of the given event (trigger) id. |
boolean |
delFactor(Faction.FZapFactor f)
Removes the given change factor from this faction. |
boolean |
delRange(Faction.FRange FR)
Removes the given FactionRange object from the faction. |
boolean |
delReaction(Faction.FReactionItem item)
Removes the given reaction from this Faction. |
boolean |
delRelation(java.lang.String factionID)
Removes the give faction relation from this faction. |
int |
difference()
Returns the difference between the highest and lowest range value |
void |
disable(boolean truefalse)
Disables this faction, as if it had been added to the DISABLE= entry in the coffeemud.ini file. |
void |
executeChange(MOB source,
MOB target,
Faction.FactionChangeEvent event)
Executes a Faction change event for the given event source and target, and the applicable FactionChangeEvent event object for this faction |
java.lang.String |
experienceFlag()
Returns the string code describing how a faction-holders experience changes from killing another faction holder affect his own faction value. |
java.lang.String |
factionID()
The official, unique faction id of this faction. |
java.util.Enumeration<Faction.FZapFactor> |
factors()
Returns an enumeration of Object arrays referring to the a factor to multiply times the base amount (100) of faction change (up or down) for particular mobs who match a given Zapper mask. |
Faction.FRange |
fetchRange(int faction)
Returns the Faction.FactionRange object that applies to the given faction value. |
Faction.FRange |
fetchRange(java.lang.String codeName)
Returns the Faction.FactionRange object that applies to the given faction range code name. |
java.lang.String |
fetchRangeName(int faction)
Returns the name of the Faction.FactionRange object that applies to the given faction value. |
Faction.FactionChangeEvent[] |
findAbilityChangeEvents(Ability key)
Returns a FactionChangeEvent that applies when the given Ability is used |
int |
findAutoDefault(MOB mob)
Returns the automatic default faction value that applies to the given mob. |
java.util.List<java.lang.Integer> |
findChoices(MOB mob)
Returns a vector of Integer objects representing the choosable faction values available to the given mob when they create a new character. |
int |
findDefault(MOB mob)
Returns the default faction value that applies to the given mob. |
double |
findFactor(MOB mob,
boolean gain)
Returns the applicable change factor for the given mob, and the whether the faction change was a gain or loss (not a gain). |
Faction.FAbilityUsage |
getAbilityUsage(int x)
Returns the enumerated Faction.FactionAbilityUsage object at the given index. |
java.lang.String[] |
getAffectBehav(java.lang.String ID)
Returns a string array containing the parms at index 0, and the gainMask at 1. |
Faction.FactionChangeEvent[] |
getChangeEvents(java.lang.String key)
Returns a FactionChangeEvent that applies when the given event name (a trigger code) occurs in the game. |
Faction.FZapFactor |
getFactor(int x)
Returns the given enumerated change factor |
java.lang.String |
getINIDef(java.lang.String tag,
java.lang.String delimeter)
Retrieves an entry for an ini properties definition document that describes this faction. |
long |
getInternalFlags()
Return the bitmap of internal-use flags for this faction. |
double |
getRelation(java.lang.String factionID)
Returns the relation factor of the given faction id. |
java.lang.String |
getTagValue(java.lang.String tag)
Returns the value of a given internal faction variable. |
boolean |
hasFaction(MOB mob)
Checks to see if the given mob has this faction. |
boolean |
hasUsage(Ability A)
Returns whether any of the Faction.FactionAbilityUsage objects for this Faction apply to the given ability. |
void |
initializeFaction(java.lang.String aname)
Initializes a new faction with default values |
void |
initializeFaction(java.lang.StringBuffer file,
java.lang.String fID)
Initializes a new faction from a faction.ini properties formatted document, and a given new faction ID |
boolean |
isDisabled()
Returns true if this faction is presently specified in the coffeemud ini file entry "DISABLE", thereby designating that this faction is currently disabled. |
boolean |
isPreLoaded()
Returns true if this faction is presently specified in the coffeemud ini file entry "FACTIONS", thereby designating that this faction is loaded at boot-time, as opposed to run-time. |
Faction.FData |
makeFactionData(MOB mob)
Returns a FactionData object for the given mob to store his faction information in. |
int |
maximum()
Returns the highest absolute range value |
int |
middle()
Gets the median absolute range value |
int |
minimum()
Gets the lowest absolute range value |
java.lang.String |
name()
The friendly, displayable name of this faction. |
int |
randomFaction()
Returns a random value within the valid range of this faction |
java.util.Enumeration<Faction.FRange> |
ranges()
Returns an enumeration of all available Faction.FactionRange objects, representing the entire score of available values valid for this faction. |
double |
rateModifier()
A modifier of the base amount of faction value change, namely 100. |
java.util.Enumeration<Faction.FReactionItem> |
reactions()
Returns an enumeration of Faction.FactionReaction items associated with this faction. |
java.util.Enumeration<Faction.FReactionItem> |
reactions(java.lang.String rangeCode)
Returns an enumeration of Faction.FactionReaction items associated with this faction and the given range code. |
java.util.Enumeration<java.lang.String> |
relationFactions()
Returns an enumeration of faction ids (of other factions) that are automatically changed, up or down, when this faction changes. |
void |
setAutoDefaults(java.util.List<java.lang.String> v)
Sets the automatic default faction mask/value list, which is possibly applied whenever a mob or player is brought to life for the first time. |
void |
setChoiceIntro(java.lang.String newStr)
Sets the filename of a file, from the resources directory, that is displayed to users when they are given the choice of a starting value to this faction. |
void |
setChoices(java.util.List<java.lang.String> v)
Sets the player choosable faction mask/value list, which is possibly presented whenever a player creates a new character. |
void |
setDefaults(java.util.List<java.lang.String> v)
Sets the default faction mask/value list, which is applied whenever a Faction Change Event applies a Faction Add command. |
void |
setExperienceFlag(java.lang.String newStr)
Sets the string code describing how a faction-holders experience changes from killing another faction holder affect his own faction value. |
void |
setFactionID(java.lang.String newStr)
Sets the official, unique faction id of this faction. |
void |
setInternalFlags(long bitmap)
Set the bitmap of internal-use flags for this faction. |
void |
setLightReactions(boolean truefalse)
Set this faction to use the light-reaction system, which is easier on resources, but not as powerful. |
void |
setName(java.lang.String newStr)
Sets the friendly, displayable name of this faction. |
void |
setRateModifier(double d)
Sets the modifier of the base amount of faction value change, namely 100. |
void |
setShowInEditor(boolean truefalse)
Sets whether this factions value is shown as a line item in mob editors |
void |
setShowInFactionsCommand(boolean truefalse)
Sets whether this factions value is shown in player Factions command |
void |
setShowInScore(boolean truefalse)
Sets whether this faction is displayed in the player Score command. |
void |
setShowInSpecialReported(boolean truefalse)
Sets whether this factions value is shown in certain special admins commands. |
boolean |
showInEditor()
Returns whether this factions value is shown as a line item in mob editors |
boolean |
showInFactionsCommand()
Returns whether this factions value is shown in player Factions command |
boolean |
showInScore()
Returns whether this faction is displayed in the player Score command. |
boolean |
showInSpecialReported()
Returns whether this factions value is shown in certain special admins commands. |
void |
updateFactionData(MOB mob,
Faction.FData data)
Updates the given FactionData object that the given mob to store his faction information in. |
java.lang.String |
usageFactorRangeDescription(Ability A)
Returns the list of faction ranges that apply based on Faction.FactionAbilityUsage usage factor that apply to the given ability. |
boolean |
useLightReactions()
Return whether this faction uses the light-reaction system, which is easier on resources, but not as powerful. |
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.MsgListener |
---|
executeMsg, okMessage |
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Contingent |
---|
amDestroyed, destroy, isSavable, setSavable |
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject |
---|
copyOf, ID, initializeClass, newInstance |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Field Detail |
---|
static final long IFLAG_IGNOREAUTO
getInternalFlags()
static final long IFLAG_NEVERSAVE
getInternalFlags()
static final long IFLAG_CUSTOMTICK
getInternalFlags()
static final java.lang.String[] EXPAFFECT_NAMES
experienceFlag()
constants
static final java.lang.String[] EXPAFFECT_DESCS
experienceFlag()
constants
static final int TAG_NAME
TAG_NAMES
denoting the NAME tag
static final int TAG_MINIMUM
TAG_NAMES
denoting the MINIMUM tag
static final int TAG_MAXIMUM
TAG_NAMES
denoting the MAXIMUM tag
static final int TAG_SCOREDISPLAY
TAG_NAMES
denoting the SCOREDISPLAY tag
static final int TAG_SPECIALREPORTED
TAG_NAMES
denoting the SPECIALREPORTED tag
static final int TAG_EDITALONE
TAG_NAMES
denoting the EDITALONE tag
static final int TAG_DEFAULT
TAG_NAMES
denoting the DEFAULT tag
static final int TAG_AUTODEFAULTS
TAG_NAMES
denoting the AUTODEFAULTS tag
static final int TAG_AUTOCHOICES
TAG_NAMES
denoting the AUTOCHOICES tag
static final int TAG_CHOICEINTRO
TAG_NAMES
denoting the CHOICEINTRO tag
static final int TAG_RATEMODIFIER
TAG_NAMES
denoting the RATEMODIFIER tag
static final int TAG_EXPERIENCE
TAG_NAMES
denoting the EXPERIENCE tag
static final int TAG_RANGE_
TAG_NAMES
denoting the RANGE tag
static final int TAG_CHANGE_
TAG_NAMES
denoting the CHANGE tag
static final int TAG_ABILITY_
TAG_NAMES
denoting the ABILITY tag
static final int TAG_FACTOR_
TAG_NAMES
denoting the FACTOR tag
static final int TAG_RELATION_
TAG_NAMES
denoting the RELATION tag
static final int TAG_SHOWINFACTIONSCMD
TAG_NAMES
denoting the SHOWINFACTIONSCMD tag
static final int TAG_AFFBEHAV_
TAG_NAMES
denoting the AFFBEHAV tag
static final int TAG_REACTION_
TAG_NAMES
denoting the RELATION tag
static final int TAG_USELIGHTREACTIONS
TAG_NAMES
denoting the SCOREDISPLAY tag
static final java.lang.String[] TAG_NAMES
getTagValue(String)
Method Detail |
---|
void initializeFaction(java.lang.String aname)
aname
- the factionID (and default name)initializeFaction(StringBuffer, String)
,
factionID()
void initializeFaction(java.lang.StringBuffer file, java.lang.String fID)
file
- the ini properties style documentfID
- the new factionIDinitializeFaction(String)
,
factionID()
,
getINIDef(String, String)
java.lang.String getTagValue(java.lang.String tag)
tag
- the tag to get the value of
TAG_NAMES
java.lang.String getINIDef(java.lang.String tag, java.lang.String delimeter)
tag
- the tag to retrieve a properties definition fordelimeter
- if the tag represents a list, this is the delimiter for entries.
getINIDef(String, String)
,
initializeFaction(StringBuffer, String)
,
TAG_NAMES
Faction.FData makeFactionData(MOB mob)
mob
- the mob to generate affects and behaviors for
Faction.FData
void updateFactionData(MOB mob, Faction.FData data)
mob
- the mob to generate affects and behaviors fordata
- the old faction data objectFaction.FData
boolean hasFaction(MOB mob)
mob
- the mob to check
int asPercent(int faction)
faction
- the faction value to convert to a percent
boolean isPreLoaded()
boolean isDisabled()
disable(boolean)
void disable(boolean truefalse)
isDisabled()
truefalse
- disable true to disable, false otherwiseint asPercentFromAvg(int faction)
faction
- the faction value to convert to a percent
int randomFaction()
java.lang.String factionID()
setFactionID(String)
void setFactionID(java.lang.String newStr)
newStr
- the new unique id of this factionfactionID()
java.lang.String name()
name
in interface CMObject
setName(String)
void setName(java.lang.String newStr)
newStr
- the new name of this factionname()
java.lang.String choiceIntro()
findChoices(MOB)
void setChoiceIntro(java.lang.String newStr)
newStr
- the new filename of the choice description filefindChoices(MOB)
int minimum()
int middle()
int difference()
int maximum()
java.lang.String experienceFlag()
EXPAFFECT_NAMES
,
EXPAFFECT_DESCS
void setExperienceFlag(java.lang.String newStr)
newStr
- the new string code for xp changes to faction changesEXPAFFECT_NAMES
,
EXPAFFECT_DESCS
boolean showInScore()
void setShowInScore(boolean truefalse)
truefalse
- true if displayed in Score, false otherwiseboolean showInSpecialReported()
void setShowInSpecialReported(boolean truefalse)
truefalse
- true if displayed in special admin commands, false otherwiseboolean showInEditor()
void setShowInEditor(boolean truefalse)
truefalse
- true if displayed in mob editors, false otherwiseboolean showInFactionsCommand()
void setShowInFactionsCommand(boolean truefalse)
truefalse
- true if displayed in factions command, false otherwisejava.util.Enumeration<java.lang.String> defaults()
changeEventKeys()
,
setDefaults(List)
,
MaskingLibrary
int findDefault(MOB mob)
mob
- the mob to find a default faction value for
defaults()
void setDefaults(java.util.List<java.lang.String> v)
v
- the new default faction mask/value listchangeEventKeys()
,
MaskingLibrary
,
defaults()
java.util.Enumeration<java.lang.String> autoDefaults()
MaskingLibrary
,
setAutoDefaults(List)
int findAutoDefault(MOB mob)
mob
- the mob to find a default value of this faction for.
defaults()
void setAutoDefaults(java.util.List<java.lang.String> v)
v
- the new automatic default faction mask/value listdefaults()
,
MaskingLibrary
double rateModifier()
setRateModifier(double)
void setRateModifier(double d)
d
- the new modifier of the base amount of faction value changerateModifier()
java.util.Enumeration<java.lang.String> choices()
MaskingLibrary
,
setChoices(List)
java.util.List<java.lang.Integer> findChoices(MOB mob)
mob
- the player mob to evaluate
choices()
void setChoices(java.util.List<java.lang.String> v)
v
- the list of choosable faction mask/valuesMaskingLibrary
,
choices()
java.util.Enumeration<Faction.FRange> ranges()
addRange(String)
,
delRange(com.planet_ink.coffee_mud.Common.interfaces.Faction.FRange)
,
Faction.FRange
Faction.FRange fetchRange(int faction)
faction
- the value to find a matching range object for
Faction.FRange
,
ranges()
java.lang.String fetchRangeName(int faction)
faction
- the value to find a matching range object for
ranges()
Faction.FRange addRange(java.lang.String key)
key
- the encoded values for the new faction range
Faction.FRange
,
ranges()
boolean delRange(Faction.FRange FR)
FR
- the faction range object to remove
Faction.FRange
,
ranges()
Faction.FRange fetchRange(java.lang.String codeName)
codeName
- the code name to find a matching range object for
ranges()
,
Faction.FRange.codeName()
java.util.Enumeration<java.lang.String> changeEventKeys()
Faction.FactionChangeEvent
,
createChangeEvent(String eventID)
,
delChangeEvent(Faction.FactionChangeEvent event)
,
ALL_CHANGE_EVENT_TYPES()
,
executeChange(MOB, MOB, com.planet_ink.coffee_mud.Common.interfaces.Faction.FactionChangeEvent)
Faction.FactionChangeEvent[] findAbilityChangeEvents(Ability key)
key
- the Ability to find a change event for.
Faction.FactionChangeEvent
,
changeEventKeys()
,
executeChange(MOB, MOB, com.planet_ink.coffee_mud.Common.interfaces.Faction.FactionChangeEvent)
,
ALL_CHANGE_EVENT_TYPES()
Faction.FactionChangeEvent[] getChangeEvents(java.lang.String key)
key
- the code name of the event that occurred
Faction.FactionChangeEvent
,
changeEventKeys()
,
Faction.FactionChangeEvent.MISC_TRIGGERS
,
executeChange(MOB, MOB, com.planet_ink.coffee_mud.Common.interfaces.Faction.FactionChangeEvent)
,
ALL_CHANGE_EVENT_TYPES()
Faction.FactionChangeEvent createChangeEvent(java.lang.String key)
key
- the field used to create the new FactionChangeEvent
Faction.FactionChangeEvent
,
changeEventKeys()
,
Faction.FactionChangeEvent.MISC_TRIGGERS
,
ALL_CHANGE_EVENT_TYPES()
boolean delChangeEvent(Faction.FactionChangeEvent event)
event
- the event object to remove from the list of change events
Faction.FactionChangeEvent
,
changeEventKeys()
,
Faction.FactionChangeEvent.MISC_TRIGGERS
,
ALL_CHANGE_EVENT_TYPES()
void clearChangeEvents()
Faction.FactionChangeEvent
,
changeEventKeys()
,
Faction.FactionChangeEvent.MISC_TRIGGERS
,
ALL_CHANGE_EVENT_TYPES()
void executeChange(MOB source, MOB target, Faction.FactionChangeEvent event)
source
- the source of the eventtarget
- the target of the eventevent
- the applicable event object for this factionFaction.FactionChangeEvent
,
changeEventKeys()
,
ALL_CHANGE_EVENT_TYPES()
java.lang.String ALL_CHANGE_EVENT_TYPES()
Faction.FactionChangeEvent
,
changeEventKeys()
java.util.Enumeration<Faction.FZapFactor> factors()
addFactor(double, double, String)
,
delFactor(Faction.FZapFactor)
,
findFactor(MOB, boolean)
,
MaskingLibrary
boolean delFactor(Faction.FZapFactor f)
f
- the factor to remove
factors()
Faction.FZapFactor getFactor(int x)
x
- which factor (0-number) to return
factors()
Faction.FZapFactor addFactor(double gain, double loss, java.lang.String mask)
gain
- the factor to apply on gains in factionloss
- the factor to apply on losses of factionmask
- the zapper mask to use to determine if this factor applies to a mob
factors()
,
MaskingLibrary
double findFactor(MOB mob, boolean gain)
mob
- the mob to compare against the zapper masks of the various factorsgain
- return the gain factor if true, or the loss factor if false
factors()
,
MaskingLibrary
java.util.Enumeration<java.lang.String> relationFactions()
factionID()
,
addRelation(String, double)
,
delRelation(String)
,
getRelation(String)
boolean delRelation(java.lang.String factionID)
factionID
- the faction id to remove
factionID()
,
relationFactions()
boolean addRelation(java.lang.String factionID, double relation)
factionID
- the faction id of the other factionrelation
- the relation factor to use as a multiplier
factionID()
,
relationFactions()
double getRelation(java.lang.String factionID)
factionID
- the other factions faction id
factionID()
,
relationFactions()
,
addRelation(String, double)
java.util.Enumeration<java.lang.String> affectsBehavs()
Ability
,
Behavior
,
addAffectBehav(String, String, String)
,
delAffectBehav(String)
,
getAffectBehav(String)
boolean delAffectBehav(java.lang.String ID)
ID
- the Abilities or Behavior ID to remove
Ability
,
Behavior
,
affectsBehavs()
boolean addAffectBehav(java.lang.String ID, java.lang.String parms, java.lang.String gainMask)
ID
- the Abilities or Behavior ID to addparms
- the parameters for the new affect or behaviorgainMask
- the zapper mask to check to see who qualifies
Ability
,
Behavior
,
affectsBehavs()
,
delAffectBehav(String)
java.lang.String[] getAffectBehav(java.lang.String ID)
ID
- the Abilities or Behavior ID
Ability
,
Behavior
,
affectsBehavs()
,
addAffectBehav(String, String, String)
java.util.Enumeration<Faction.FReactionItem> reactions()
addReaction(String, String, String, String)
,
delReaction(Faction.FReactionItem)
java.util.Enumeration<Faction.FReactionItem> reactions(java.lang.String rangeCode)
rangeCode
- the range code to filter by
addReaction(String, String, String, String)
,
delReaction(Faction.FReactionItem)
boolean delReaction(Faction.FReactionItem item)
item
- the faction reaction item to remove
addReaction(String, String, String, String)
,
reactions()
boolean addReaction(java.lang.String range, java.lang.String mask, java.lang.String abilityID, java.lang.String parms)
range
- the faction range to use as a determinateabilityID
- the ability/Behavior/or command IDparms
- the parameters for the new affect or behavior or commandmask
- the zapper mask to check to see which mob qualifies
delReaction(Faction.FReactionItem)
,
reactions()
,
Ability
,
Command
,
Behavior
void setLightReactions(boolean truefalse)
truefalse
- true to use the light reaction system, false otherwiseuseLightReactions()
boolean useLightReactions()
setLightReactions(boolean)
java.util.Enumeration<Faction.FAbilityUsage> abilityUsages()
Faction.FAbilityUsage
,
addAbilityUsage(String)
,
delAbilityUsage(com.planet_ink.coffee_mud.Common.interfaces.Faction.FAbilityUsage)
,
usageFactorRangeDescription(Ability)
,
hasUsage(Ability)
,
canUse(MOB, Ability)
java.lang.String usageFactorRangeDescription(Ability A)
A
- the ability to find a usage factor for, and then use to find applicable ranges
Faction.FAbilityUsage
,
abilityUsages()
,
Faction.FRange
boolean hasUsage(Ability A)
A
- the ability to find a usage criterium for
Faction.FAbilityUsage
,
abilityUsages()
boolean canUse(MOB mob, Ability A)
mob
- the mob/player to evaluateA
- the ability to evaluate
Faction.FAbilityUsage
,
abilityUsages()
Faction.FAbilityUsage addAbilityUsage(java.lang.String key)
key
- the definitional key, or null
Faction.FAbilityUsage
,
abilityUsages()
,
delAbilityUsage(com.planet_ink.coffee_mud.Common.interfaces.Faction.FAbilityUsage)
Faction.FAbilityUsage getAbilityUsage(int x)
x
- the index of the Faction.FactionAbilityUsage object to return
Faction.FAbilityUsage
,
abilityUsages()
boolean delAbilityUsage(Faction.FAbilityUsage usage)
usage
- the Faction.FactionAbilityUsage object to remove
Faction.FAbilityUsage
,
abilityUsages()
,
addAbilityUsage(String)
long getInternalFlags()
setInternalFlags(long)
void setInternalFlags(long bitmap)
bitmap
- the bitmap of internal-use flags for this faction.getInternalFlags()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |