FactionManager

All Superinterfaces:

java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>, Tickable

All Known Implementing Classes:

Factions
```
public interface FactionManager
extends CMLibrary, Tickable
```
The Faction Manager is a storage class for all game Factions, handling lookups, storage, retrieval, and relations between them. There are also lookups for various faction parts, such as faction range codes, descriptions, and names. It also includes references to specific factions, such as alignment or inclination.

See Also:

Faction

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`FactionManager.FAbilityMaskType`	This enum identifies the different types of ability masks and flags that are found in faciton definitions.

Field Summary
- Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
  idConverter
- Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable
  STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`addFaction(Faction F)`	Adds a new faction to the memory cache, or modify one with the same id.
`void`	`clearFactions()`	Clears out all cached factions, which is part of the shutdown process
`java.util.Enumeration<Faction>`	`factions()`	Returns the enumeration of all the factions
`FactionManager.FAbilityMaskType`	`getAbilityFlagType(java.lang.String strflag)`	Returns what type of ability mask is represented by the string, as one of the FAbilityMaskType enums, which includes things like the Ability Code, Domain, Ability Flag (usually prefixed with "!"), or an Ability ID
`Faction.Align`	`getAlignEnum(java.lang.String str)`	Returns the Align enum that matches the given string, or INDIFF if not found.
`int`	`getAlignMedianFacValue(Faction.Align eq)`	Returns the purist alignment/inclination faction value associated with the given Align enum.
`java.lang.String`	`getAlignmentID()`	Returns the faction ID assigned to 'alignment' (good, evil, neutral)
`int`	`getAlignPurity(int faction, Faction.Align eq)`	Returns the percentage 0-100 of distance that the given faction value is from the given alignment enum.
`Faction`	`getFaction(java.lang.String factionID)`	Returns the faction with the given faction id.
`Faction`	`getFactionByName(java.lang.String factionNamed)`	Returns the faction object with the given exact case-insensitive display name.
`Faction`	`getFactionByNumber(int index)`	Returns the faction with the given enum index number.
`Faction`	`getFactionByRangeCodeName(java.lang.String rangeCodeName)`	Returns the Faction that contains the given range code name.
`Faction.FRange`	`getFactionRangeByCodeName(java.lang.String rangeCodeName)`	Returns the faction range object whose range code matches the given string.
`Faction.FacTag`	`getFactionTag(java.lang.String tag)`	Returns which faction tag (FacTag) enum is represented by the given string, which is typically a parameter from a faction definition/ini file.
`java.lang.String`	`getInclinationID()`	Returns the faction ID assigned to 'inclination' (lawful, mod, chaotic)
`int`	`getInclinationPurity(int faction, Faction.Align eq)`	Returns the percentage 0-100 of distance that the given faction value is from the given alignment enum.
`int`	`getMaximum(java.lang.String factionID)`	Returns the absolute maximum possible faction value that the faction with the given id can be assigned.
`int`	`getMinimum(java.lang.String factionID)`	Returns the absolute minimum possible faction value that the faction with the given id can be assigned.
`java.lang.String`	`getName(java.lang.String factionID)`	Returns the friendly faction display name associated with the given faction id
`int`	`getPercent(java.lang.String factionID, int faction)`	Returns the percentage of the total faction numeric range (0 to 100) that the given faction number represents.
`int`	`getPercentFromAvg(java.lang.String factionID, int faction)`	Returns the percentage of the total faction numeric range (0 to 100) that the given faction number represents.
`int`	`getRandom(java.lang.String factionID)`	Returns a random faction number in the range from its minimum to maximum, given a faction id.
`Faction.FRange`	`getRange(java.lang.String factionID, int faction)`	Returns the faction range from the faction with the given faction id whose range covers the given faction value.
`double`	`getRangePercent(java.lang.String factionID, int faction)`	Returns the percentage of the total faction numeric range (0.00 to 100.00) that the given faction number represents.
`java.util.Enumeration<Faction.FRange>`	`getRanges(java.lang.String factionID)`	Returns an enumerator of all faction range objects in the faction with the given id.
`Faction`	`getSpecialAreaFaction(Area A)`	If area reactions are enabled, and the given area has one of them, then this will return the areas faction.
`Faction[]`	`getSpecialFactions(MOB mob, Room R)`	If reaction factions are enabled, and the given location has one of them, then this will return the applicable faction.
`int`	`getTotal(java.lang.String factionID)`	Gets the absolute number of points in this faction, essentially the max - min.
`boolean`	`isAlignmentLoaded(Faction.Align align)`	Returns whether any factions are loaded that grant alignment.
`boolean`	`isFactionedThisWay(MOB mob, Faction.FRange rangeCode)`	Returns whether the given mob has the faction represented by the range, and whether their faction value falls within that range.
`boolean`	`isFactionID(java.lang.String key)`	Returns whether the given string is a legitimate, loadable faction id.
`boolean`	`isFactionLoaded(java.lang.String key)`	Returns whether the given string is the faction id of an already loaded and cached faction.
`boolean`	`isRangeCodeName(java.lang.String key)`	Returns whether the given string is, in fact, a range code for any existing faction.
`java.lang.String`	`listFactions()`	Returns a friendly column based list of all factions, formatted for 80 col screen.
`java.lang.String`	`makeFactionFilename(java.lang.String factionID)`	Returns a cmfs path, relative to /resources (so, not including that prefix) that the given faction id should be saved into.
`Faction`	`makeReactionFaction(java.lang.String prefix, java.lang.String classID, java.lang.String Name, java.lang.String code, java.lang.String baseTemplateFilename)`	Creates a reaction faction based from a template, to represent a specific entity in the reaction category.
`void`	`modifyFaction(MOB mob, Faction meF)`	This is an archon/system editor function to modify the specific attributes and parameters of the given faction.
`int`	`numFactions()`	Return the total number of factions
`boolean`	`postChangeAllFactions(MOB mob, MOB victim, int amount, boolean quiet)`	Posts an official faction change event to the system without actually designating a faction that changed.
`boolean`	`postSkillFactionChange(MOB mob, Ability skillA, java.lang.String factionID, int amount)`	Posts an official faction change even to the system that is related to a skill that changes faction.
`java.lang.String`	`rangeDescription(Faction.FRange FR, java.lang.String andOr)`	Returns a friendly list of the ranges and the faction name whose code matches a range in the given faction.
`void`	`reloadFactions(java.lang.String factionList)`	Given a semi-colon delimited list of faction ids, this method will cause them all to be cached into memory, if they exist.
`boolean`	`removeFaction(java.lang.String factionID)`	Deletes the faction from the memory cache with the given faction id, or all of the factions if the faction id is null.
`java.lang.String`	`resaveFaction(Faction F)`	Re-saves the given faction back to the cmfs.
`void`	`setAlignment(MOB mob, Faction.Align newAlignment)`	Changes the alignment of the given mob to the value of the Align enum given.
`void`	`setAlignmentOldRange(MOB mob, int oldRange)`	A legacy method for changing alignment according to the legacy values where 1000 is pure good, and 0 is evil.
`void`	`updatePlayerFactions(MOB mob, Room R, boolean forceAutoCheck)`	This function makes sure that any publicly available factions which the given mob in the given location are applied to the given mob, if they can be.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary
activate, getServiceClient, L, propertiesLoaded, shutdown

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
copyOf, ID, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable
getTickStatus, name, tick

- Method Detail
  - addFaction
```
boolean addFaction(Faction F)
```
    Adds a new faction to the memory cache, or modify one with the same id.
    
    Parameters:
    
    F - the faction to add
    
    Returns:
    
    true if the faction is disabled, false otherwise
    
    See Also:
    
    Faction, removeFaction(String), resaveFaction(Faction)
  - removeFaction
```
boolean removeFaction(java.lang.String factionID)
```
    Deletes the faction from the memory cache with the given faction id, or all of the factions if the faction id is null. So be careful.
    
    Parameters:
    
    factionID - the id to remove, or null for all
    
    Returns:
    
    true if a faction was removed, or false otherwise
    
    See Also:
    
    addFaction(Faction), resaveFaction(Faction)
  - resaveFaction
```
java.lang.String resaveFaction(Faction F)
```
    Re-saves the given faction back to the cmfs.
    
    Parameters:
    
    F - the faction to save
    
    Returns:
    
    "" if all is well, or an error message
    
    See Also:
    
    Faction, addFaction(Faction), removeFaction(String)
  - factions
```
java.util.Enumeration<Faction> factions()
```
    Returns the enumeration of all the factions
    
    Returns:
    
    the enumeration of all the factions
    
    See Also:
    
    Faction, numFactions(), getFaction(String), getFactionByNumber(int)
  - numFactions
```
int numFactions()
```
    Return the total number of factions
    
    Returns:
    
    the total number of factions
    
    See Also:
    
    factions(), getFaction(String), getFactionByNumber(int)
  - getFaction
```
Faction getFaction(java.lang.String factionID)
```
    Returns the faction with the given faction id. If the faction exists, but is not yet cached, this function will cause the faction to be brought into memory.
    
    Parameters:
    
    factionID - the faction id to look for
    
    Returns:
    
    the faction found, or null
    
    See Also:
    
    factions(), numFactions(), getFactionByNumber(int)
  - getFactionByNumber
```
Faction getFactionByNumber(int index)
```
    Returns the faction with the given enum index number.
    
    Parameters:
    
    index - the index number
    
    Returns:
    
    the faction found, or null
    
    See Also:
    
    factions(), numFactions(), getFaction(String)
  - listFactions
```
java.lang.String listFactions()
```
    Returns a friendly column based list of all factions, formatted for 80 col screen.
    
    Returns:
    
    the viewable list of factions
  - reloadFactions
```
void reloadFactions(java.lang.String factionList)
```
    Given a semi-colon delimited list of faction ids, this method will cause them all to be cached into memory, if they exist.
    
    Parameters:
    
    factionList - the list of factions
  - clearFactions
```
void clearFactions()
```
    Clears out all cached factions, which is part of the shutdown process
  - isRangeCodeName
```
boolean isRangeCodeName(java.lang.String key)
```
    Returns whether the given string is, in fact, a range code for any existing faction. Range codes are like PUREGOOD, PUREEVIL, etc..
    
    Parameters:
    
    key - the string to check
    
    Returns:
    
    true if the key is a range code
    
    See Also:
    
    Faction.FRange
  - rangeDescription
```
java.lang.String rangeDescription(Faction.FRange FR,
                                  java.lang.String andOr)
```
    Returns a friendly list of the ranges and the faction name whose code matches a range in the given faction. If multiples are found, they may be combined with the word AND or OR, for example. This method does a full scan of all ranges in one faction.
    
    Parameters:
    
    FR - the faction range to match
    
    andOr - the word to use when combining multiples
    
    Returns:
    
    the list of factions and their ranges that match
  - getFactionByRangeCodeName
```
Faction getFactionByRangeCodeName(java.lang.String rangeCodeName)
```
    Returns the Faction that contains the given range code name.
    
    Parameters:
    
    rangeCodeName - the range code name to search for
    
    Returns:
    
    the faction, or null
    
    See Also:
    
    getFactionRangeByCodeName(String), getRange(String, int), getRanges(String)
  - getFactionRangeByCodeName
```
Faction.FRange getFactionRangeByCodeName(java.lang.String rangeCodeName)
```
    Returns the faction range object whose range code matches the given string.
    
    Parameters:
    
    rangeCodeName - the range code name to search for
    
    Returns:
    
    the faction range object, or null
    
    See Also:
    
    getFactionByRangeCodeName(String), getRange(String, int), getRanges(String)
  - getRange
```
Faction.FRange getRange(java.lang.String factionID,
                        int faction)
```
    Returns the faction range from the faction with the given faction id whose range covers the given faction value.
    
    Parameters:
    
    factionID - the faction id of the faction to check
    
    faction - the amount of faction to find the range for
    
    Returns:
    
    the faction range object, or null
    
    See Also:
    
    getFactionByRangeCodeName(String), getFactionRangeByCodeName(String), getRanges(String)
  - getRanges
```
java.util.Enumeration<Faction.FRange> getRanges(java.lang.String factionID)
```
    Returns an enumerator of all faction range objects in the faction with the given id.
    
    Parameters:
    
    factionID - the faction id of the faction to check
    
    Returns:
    
    the enumerator of faction range objects
    
    See Also:
    
    getFactionByRangeCodeName(String), getFactionRangeByCodeName(String), getRange(String, int)
  - isFactionID
```
boolean isFactionID(java.lang.String key)
```
    Returns whether the given string is a legitimate, loadable faction id. If so, it will load the faction in the course of checking.
    
    Parameters:
    
    key - the string to check
    
    Returns:
    
    true if its a legit faction id
    
    See Also:
    
    isFactionLoaded(String)
  - isFactionLoaded
```
boolean isFactionLoaded(java.lang.String key)
```
    Returns whether the given string is the faction id of an already loaded and cached faction.
    
    Parameters:
    
    key - the faction id to check
    
    Returns:
    
    true if the faction is already loaded
    
    See Also:
    
    isFactionID(String)
  - getFactionByName
```
Faction getFactionByName(java.lang.String factionNamed)
```
    Returns the faction object with the given exact case-insensitive display name.
    
    Parameters:
    
    factionNamed - the display name to look for
    
    Returns:
    
    the faction obj or null
    
    See Also:
    
    getFaction(String)
  - getName
```
java.lang.String getName(java.lang.String factionID)
```
    Returns the friendly faction display name associated with the given faction id
    
    Parameters:
    
    factionID - the faction id to look for
    
    Returns:
    
    the friendly name, or empty string ""
  - getMinimum
```
int getMinimum(java.lang.String factionID)
```
    Returns the absolute minimum possible faction value that the faction with the given id can be assigned.
    
    Parameters:
    
    factionID - the faction id to look for
    
    Returns:
    
    the minimum possible value or 0
    
    See Also:
    
    getMaximum(String)
  - getMaximum
```
int getMaximum(java.lang.String factionID)
```
    Returns the absolute maximum possible faction value that the faction with the given id can be assigned.
    
    Parameters:
    
    factionID - the faction id to look for
    
    Returns:
    
    the maximum possible value or 0
    
    See Also:
    
    getMinimum(String)
  - getRangePercent
```
double getRangePercent(java.lang.String factionID,
                       int faction)
```
    Returns the percentage of the total faction numeric range (0.00 to 100.00) that the given faction number represents. E.g. a faction with -1000 to 1000 would return 50.00% for a faction value of 0. It returns 0 if the faction id is not found.
    
    Parameters:
    
    factionID - the faction id to get a range percent for.
    
    faction - the faction number to find the percent in
    
    Returns:
    
    the percentage in 0-100, with 2 decimal places
    
    See Also:
    
    getPercent(String, int), getPercentFromAvg(String, int)
  - getPercent
```
int getPercent(java.lang.String factionID,
               int faction)
```
    Returns the percentage of the total faction numeric range (0 to 100) that the given faction number represents. E.g. a faction with -1000 to 1000 would return 50% for a faction value of 0. It returns 0 if the faction id is not found.
    
    Parameters:
    
    factionID - the faction id to get a range percent for.
    
    faction - the faction number to find the percent in
    
    Returns:
    
    the percentage in 0-100
    
    See Also:
    
    getRangePercent(String, int), getPercentFromAvg(String, int)
  - getPercentFromAvg
```
int getPercentFromAvg(java.lang.String factionID,
                      int faction)
```
    Returns the percentage of the total faction numeric range (0 to 100) that the given faction number represents. E.g. a faction with -1000 to 1000 would return 50% for a faction value of 0. It returns 0 if the faction id is not found.
    
    Parameters:
    
    factionID - the faction id to get a range percent for.
    
    faction - the faction number to find the percent in
    
    Returns:
    
    the percentage in 0-100
    
    See Also:
    
    getRangePercent(String, int), getPercent(String, int), getPercentFromAvg(String, int)
  - getTotal
```
int getTotal(java.lang.String factionID)
```
    Gets the absolute number of points in this faction, essentially the max - min.
    
    Parameters:
    
    factionID - the faction id to check
    
    Returns:
    
    the max - min, or 0
  - getRandom
```
int getRandom(java.lang.String factionID)
```
    Returns a random faction number in the range from its minimum to maximum, given a faction id.
    
    Parameters:
    
    factionID - the faction id to check
    
    Returns:
    
    a random faction number
  - getFactionTag
```
Faction.FacTag getFactionTag(java.lang.String tag)
```
    Returns which faction tag (FacTag) enum is represented by the given string, which is typically a parameter from a faction definition/ini file.
    
    Parameters:
    
    tag - the string to check
    
    Returns:
    
    the FacTag object, or null
    
    See Also:
    
    Faction.FacTag
  - makeReactionFaction
```
Faction makeReactionFaction(java.lang.String prefix,
                            java.lang.String classID,
                            java.lang.String Name,
                            java.lang.String code,
                            java.lang.String baseTemplateFilename)
```
    Creates a reaction faction based from a template, to represent a specific entity in the reaction category. Categories are things like areas, races, planes, etc. e.g. makeReactionFaction("AREA_",A.ID(),A.Name(),areaCode,"examples/areareaction.ini")
    
    Parameters:
    
    prefix - prefix to add to the faction id to identify the reaction category
    
    classID - the literal entity class/ID() - for use in masks
    
    Name - the friendly name of the entity, prob also for masks or comm.
    
    code - the unique identifier for the entity, w/o spaces
    
    baseTemplateFilename - the cmfs path of the template to base the reaction on
    
    Returns:
    
    the fully formed and cached reaction faction, or null
  - getSpecialAreaFaction
```
Faction getSpecialAreaFaction(Area A)
```
    If area reactions are enabled, and the given area has one of them, then this will return the areas faction.
    
    Parameters:
    
    A - the Area to check
    
    Returns:
    
    a Faction object, or null
    
    See Also:
    
    getSpecialFactions(MOB, Room)
  - getSpecialFactions
```
Faction[] getSpecialFactions(MOB mob,
                             Room R)
```
    If reaction factions are enabled, and the given location has one of them, then this will return the applicable faction.
    
    Parameters:
    
    mob - the mob involved
    
    R - the mobs location
    
    Returns:
    
    a Faction object, or null
    
    See Also:
    
    getSpecialAreaFaction(Area)
  - getAbilityFlagType
```
FactionManager.FAbilityMaskType getAbilityFlagType(java.lang.String strflag)
```
    Returns what type of ability mask is represented by the string, as one of the FAbilityMaskType enums, which includes things like the Ability Code, Domain, Ability Flag (usually prefixed with "!"), or an Ability ID
    
    Parameters:
    
    strflag - the string to find a flag type rep of
    
    Returns:
    
    the ability mask type
    
    See Also:
    
    FactionManager.FAbilityMaskType
  - makeFactionFilename
```
java.lang.String makeFactionFilename(java.lang.String factionID)
```
    Returns a cmfs path, relative to /resources (so, not including that prefix) that the given faction id should be saved into. It will prefer /resources/factions, of course.
    
    Parameters:
    
    factionID - the faction id to build a filename for
    
    Returns:
    
    the full faction id filename
  - isFactionedThisWay
```
boolean isFactionedThisWay(MOB mob,
                           Faction.FRange rangeCode)
```
    Returns whether the given mob has the faction represented by the range, and whether their faction value falls within that range.
    
    Parameters:
    
    mob - the mob to check
    
    rangeCode - the faction range object to check the mob for
    
    Returns:
    
    true if the mob is in that range, false otherwise
  - updatePlayerFactions
```
void updatePlayerFactions(MOB mob,
                          Room R,
                          boolean forceAutoCheck)
```
    This function makes sure that any publicly available factions which the given mob in the given location are applied to the given mob, if they can be. This is a typical login/come to life method. Normally a faction can be set to not apply auto-values, but that behavior can be over-ridden with forceAutoCheck. There is really no good reason to ever do this, but it's there
    
    Parameters:
    
    mob - the player/npc mob to confirm against existing factions
    
    R - the room the mob is in
    
    forceAutoCheck - just set this to false
  - postChangeAllFactions
```
boolean postChangeAllFactions(MOB mob,
                              MOB victim,
                              int amount,
                              boolean quiet)
```
    Posts an official faction change event to the system without actually designating a faction that changed. This is weird and makes no sense and will prob never be used omg why is this even in here?!
    
    Parameters:
    
    mob - the mob whose factions have changed
    
    victim - the victim causing the change, if any
    
    amount - the amount of factions plus or minus
    
    quiet - true to be silent about the change, or false otherwise
    
    Returns:
    
    true if the message went through w/o problems
  - postSkillFactionChange
```
boolean postSkillFactionChange(MOB mob,
                               Ability skillA,
                               java.lang.String factionID,
                               int amount)
```
    Posts an official faction change even to the system that is related to a skill that changes faction.
    
    Parameters:
    
    mob - the mob whose faction has changed
    
    skillA - the skill that caused the faction change
    
    factionID - the faction id of the faction to change
    
    amount - the amount, plus or minus, to change
    
    Returns:
    
    true if the faction changes goes through ok
  - modifyFaction
```
void modifyFaction(MOB mob,
                   Faction meF)
            throws java.io.IOException
```
    This is an archon/system editor function to modify the specific attributes and parameters of the given faction. It requires a non-monster user who can edit the faction.
    
    Parameters:
    
    mob - the player doing the editing, with a session
    
    meF - the faction object being edited
    
    Throws:
    
    java.io.IOException - session i/o errors
  - getAlignmentID
```
java.lang.String getAlignmentID()
```
    Returns the faction ID assigned to 'alignment' (good, evil, neutral)
    
    Returns:
    
    the faction ID assigned to 'alignment' (good, evil, neutral)
  - setAlignment
```
void setAlignment(MOB mob,
                  Faction.Align newAlignment)
```
    Changes the alignment of the given mob to the value of the Align enum given.
    
    Parameters:
    
    mob - the mob to change
    
    newAlignment - the new alignment by enum
    
    See Also:
    
    Faction.Align
  - setAlignmentOldRange
```
void setAlignmentOldRange(MOB mob,
                          int oldRange)
```
    A legacy method for changing alignment according to the legacy values where 1000 is pure good, and 0 is evil.
    
    Parameters:
    
    mob - the mob to change
    
    oldRange - the 0-1000 value
  - getAlignPurity
```
int getAlignPurity(int faction,
                   Faction.Align eq)
```
    Returns the percentage 0-100 of distance that the given faction value is from the given alignment enum. This is used when figuring out the chance of successfully using an evil skill when one is only partially or not really evil.
    
    Parameters:
    
    faction - the faction value
    
    eq - the alignment enum
    
    Returns:
    
    the percentage of distance, where 0 is close, and 100 is far.
    
    See Also:
    
    Faction.Align, isAlignmentLoaded(com.planet_ink.coffee_mud.Common.interfaces.Faction.Align), getAlignMedianFacValue(com.planet_ink.coffee_mud.Common.interfaces.Faction.Align), getAlignEnum(String)
  - getAlignMedianFacValue
```
int getAlignMedianFacValue(Faction.Align eq)
```
    Returns the purist alignment/inclination faction value associated with the given Align enum. Also works for inclinatino.
    
    Parameters:
    
    eq - the align fac value to return a pure value for
    
    Returns:
    
    the pure value
    
    See Also:
    
    Faction.Align, isAlignmentLoaded(com.planet_ink.coffee_mud.Common.interfaces.Faction.Align), getAlignPurity(int, com.planet_ink.coffee_mud.Common.interfaces.Faction.Align), getAlignEnum(String)
  - getAlignEnum
```
Faction.Align getAlignEnum(java.lang.String str)
```
    Returns the Align enum that matches the given string, or INDIFF if not found.
    
    Parameters:
    
    str - the Align enum string
    
    Returns:
    
    the Align enum object or INDIFF
    
    See Also:
    
    Faction.Align, isAlignmentLoaded(com.planet_ink.coffee_mud.Common.interfaces.Faction.Align), getAlignMedianFacValue(com.planet_ink.coffee_mud.Common.interfaces.Faction.Align), getAlignPurity(int, com.planet_ink.coffee_mud.Common.interfaces.Faction.Align)
  - isAlignmentLoaded
```
boolean isAlignmentLoaded(Faction.Align align)
```
    Returns whether any factions are loaded that grant alignment. This includes the Alignment faction of course, but allows a bit of flexibility.
    
    Parameters:
    
    align - the align enum to check
    
    Returns:
    
    true if any faction is loaded that uses it
    
    See Also:
    
    Faction.Align, getAlignPurity(int, com.planet_ink.coffee_mud.Common.interfaces.Faction.Align), getAlignMedianFacValue(com.planet_ink.coffee_mud.Common.interfaces.Faction.Align), getAlignEnum(String)
  - getInclinationID
```
java.lang.String getInclinationID()
```
    Returns the faction ID assigned to 'inclination' (lawful, mod, chaotic)
    
    Returns:
    
    the faction ID assigned to 'inclination' (lawful, mod, chaotic)
  - getInclinationPurity
```
int getInclinationPurity(int faction,
                         Faction.Align eq)
```
    Returns the percentage 0-100 of distance that the given faction value is from the given alignment enum. This is used when figuring out the chance of successfully using a chaotic skill when one is only partially or not really chaotic.
    
    Parameters:
    
    faction - the faction value
    
    eq - the alignment enum
    
    Returns:
    
    the percentage of distance, where 0 is close, and 100 is far.
    
    See Also:
    
    Faction.Align

Interface FactionManager

Nested Class Summary

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable

Method Summary

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

Methods inherited from interface java.lang.Comparable

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable

Method Detail

addFaction

removeFaction

resaveFaction

factions

numFactions

getFaction

getFactionByNumber

listFactions

reloadFactions

clearFactions

isRangeCodeName

rangeDescription

getFactionByRangeCodeName

getFactionRangeByCodeName

getRange

getRanges

isFactionID

isFactionLoaded

getFactionByName

getName

getMinimum

getMaximum

getRangePercent

getPercent

getPercentFromAvg

getTotal

getRandom

getFactionTag

makeReactionFaction

getSpecialAreaFaction

getSpecialFactions

getAbilityFlagType

makeFactionFilename

isFactionedThisWay

updatePlayerFactions

postChangeAllFactions

postSkillFactionChange

modifyFaction

getAlignmentID

setAlignment

setAlignmentOldRange

getAlignPurity

getAlignMedianFacValue

getAlignEnum

isAlignmentLoaded

getInclinationID

getInclinationPurity