Factions

java.lang.Object
- com.planet_ink.coffee_mud.Libraries.StdLibrary
- - com.planet_ink.coffee_mud.Libraries.Factions

All Implemented Interfaces:

CMObject, Tickable, CMLibrary, FactionManager, java.lang.Cloneable, java.lang.Comparable<CMObject>
```
public class Factions
extends StdLibrary
implements FactionManager
```
Portions Copyright (c) 2003 Jeremy Vyska Portions Copyright (c) 2004-2023 Bo Zimmerman Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.FactionManager
  FactionManager.FAbilityMaskType

Field Summary

Fields
Modifier and Type	Field	Description
`protected java.util.List<java.lang.String>`	`autoReactions`
`SHashtable<java.lang.String,Faction>`	`factionMap`
`java.util.Map<Faction.Align,java.util.List<Faction.FRange>>`	`hashedFactionAligns`
`SHashtable<java.lang.String,Faction.FRange>`	`hashedFactionRanges`

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

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
isDebugging, name, serviceClient, tickStatus

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

Constructor Summary

Constructors
Constructor Description

Factions()

Constructors
Constructor	Description
`Factions()`

Method Summary

All Methods Instance Methods Concrete 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.
`protected void`	`addOutsidersAndTimers(Faction F, java.util.List<Faction.FactionChangeEvent> outSiders, java.util.List<Faction.FactionChangeEvent> timers)`
`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`	`getTickStatus()`	A coded status for this object during the period where its tick method is being called.
`int`	`getTotal(java.lang.String factionID)`	Gets the absolute number of points in this faction, essentially the max - min.
`java.lang.String`	`ID()`	The CoffeeMud Java Class ID shared by all instances of this object.
`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.
`java.lang.String`	`name()`	The displayable name of this object.
`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.
`void`	`propertiesLoaded()`	This method is called whenever system properties are altered by the user.
`java.util.Map<java.lang.String,Faction.FRange>`	`rangeCodeNames()`
`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.
`boolean`	`tick(Tickable ticking, int tickID)`	this is the method which is called periodically by the threading engine.
`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, shutdown

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

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
activate, checkDatabase, compareTo, copyOf, getServiceClient, initializeClass, L, newInstance, setThreadStatus, shutdown

- Field Detail
  - factionMap
```
public SHashtable<java.lang.String,Faction> factionMap
```
  - hashedFactionRanges
```
public SHashtable<java.lang.String,Faction.FRange> hashedFactionRanges
```
  - hashedFactionAligns
```
public java.util.Map<Faction.Align,java.util.List<Faction.FRange>> hashedFactionAligns
```
  - autoReactions
```
protected java.util.List<java.lang.String> autoReactions
```
- Constructor Detail
  - Factions
```
public Factions()
```
- Method Detail
  - ID
```
public java.lang.String ID()
```
    Description copied from interface: CMObject
    
    The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.
    
    Specified by:
    
    ID in interface CMObject
    
    Overrides:
    
    ID in class StdLibrary
    
    Returns:
    
    the name of this class
  - factions
```
public java.util.Enumeration<Faction> factions()
```
    Description copied from interface: FactionManager
    
    Returns the enumeration of all the factions
    
    Specified by:
    
    factions in interface FactionManager
    
    Returns:
    
    the enumeration of all the factions
    
    See Also:
    
    Faction, FactionManager.numFactions(), FactionManager.getFaction(String), FactionManager.getFactionByNumber(int)
  - numFactions
```
public int numFactions()
```
    Description copied from interface: FactionManager
    
    Return the total number of factions
    
    Specified by:
    
    numFactions in interface FactionManager
    
    Returns:
    
    the total number of factions
    
    See Also:
    
    FactionManager.factions(), FactionManager.getFaction(String), FactionManager.getFactionByNumber(int)
  - clearFactions
```
public void clearFactions()
```
    Description copied from interface: FactionManager
    
    Clears out all cached factions, which is part of the shutdown process
    
    Specified by:
    
    clearFactions in interface FactionManager
  - propertiesLoaded
```
public void propertiesLoaded()
```
    Description copied from interface: CMLibrary
    
    This method is called whenever system properties are altered by the user. This allows the library to react to any important properties they monitor.
    
    Specified by:
    
    propertiesLoaded in interface CMLibrary
    
    Overrides:
    
    propertiesLoaded in class StdLibrary
  - getFactionByNumber
```
public Faction getFactionByNumber(int index)
```
    Description copied from interface: FactionManager
    
    Returns the faction with the given enum index number.
    
    Specified by:
    
    getFactionByNumber in interface FactionManager
    
    Parameters:
    
    index - the index number
    
    Returns:
    
    the faction found, or null
    
    See Also:
    
    FactionManager.factions(), FactionManager.numFactions(), FactionManager.getFaction(String)
  - reloadFactions
```
public void reloadFactions(java.lang.String factionList)
```
    Description copied from interface: FactionManager
    
    Given a semi-colon delimited list of faction ids, this method will cause them all to be cached into memory, if they exist.
    
    Specified by:
    
    reloadFactions in interface FactionManager
    
    Parameters:
    
    factionList - the list of factions
  - rangeCodeNames
```
public java.util.Map<java.lang.String,Faction.FRange> rangeCodeNames()
```
  - isRangeCodeName
```
public boolean isRangeCodeName(java.lang.String key)
```
    Description copied from interface: FactionManager
    
    Returns whether the given string is, in fact, a range code for any existing faction. Range codes are like PUREGOOD, PUREEVIL, etc..
    
    Specified by:
    
    isRangeCodeName in interface FactionManager
    
    Parameters:
    
    key - the string to check
    
    Returns:
    
    true if the key is a range code
    
    See Also:
    
    Faction.FRange
  - getFactionRangeByCodeName
```
public Faction.FRange getFactionRangeByCodeName(java.lang.String rangeCodeName)
```
    Description copied from interface: FactionManager
    
    Returns the faction range object whose range code matches the given string.
    
    Specified by:
    
    getFactionRangeByCodeName in interface FactionManager
    
    Parameters:
    
    rangeCodeName - the range code name to search for
    
    Returns:
    
    the faction range object, or null
    
    See Also:
    
    FactionManager.getFactionByRangeCodeName(String), FactionManager.getRange(String, int), FactionManager.getRanges(String)
  - isFactionedThisWay
```
public boolean isFactionedThisWay(MOB mob,
                                  Faction.FRange rangeCode)
```
    Description copied from interface: FactionManager
    
    Returns whether the given mob has the faction represented by the range, and whether their faction value falls within that range.
    
    Specified by:
    
    isFactionedThisWay in interface FactionManager
    
    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
  - rangeDescription
```
public java.lang.String rangeDescription(Faction.FRange FR,
                                         java.lang.String andOr)
```
    Description copied from interface: FactionManager
    
    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.
    
    Specified by:
    
    rangeDescription in interface FactionManager
    
    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
  - addFaction
```
public boolean addFaction(Faction F)
```
    Description copied from interface: FactionManager
    
    Adds a new faction to the memory cache, or modify one with the same id.
    
    Specified by:
    
    addFaction in interface FactionManager
    
    Parameters:
    
    F - the faction to add
    
    Returns:
    
    true if the faction is disabled, false otherwise
    
    See Also:
    
    Faction, FactionManager.removeFaction(String), FactionManager.resaveFaction(Faction)
  - makeFactionFilename
```
public java.lang.String makeFactionFilename(java.lang.String factionID)
```
    Description copied from interface: FactionManager
    
    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.
    
    Specified by:
    
    makeFactionFilename in interface FactionManager
    
    Parameters:
    
    factionID - the faction id to build a filename for
    
    Returns:
    
    the full faction id filename
  - isFactionID
```
public boolean isFactionID(java.lang.String key)
```
    Description copied from interface: FactionManager
    
    Returns whether the given string is a legitimate, loadable faction id. If so, it will load the faction in the course of checking.
    
    Specified by:
    
    isFactionID in interface FactionManager
    
    Parameters:
    
    key - the string to check
    
    Returns:
    
    true if its a legit faction id
    
    See Also:
    
    FactionManager.isFactionLoaded(String)
  - isFactionLoaded
```
public boolean isFactionLoaded(java.lang.String key)
```
    Description copied from interface: FactionManager
    
    Returns whether the given string is the faction id of an already loaded and cached faction.
    
    Specified by:
    
    isFactionLoaded in interface FactionManager
    
    Parameters:
    
    key - the faction id to check
    
    Returns:
    
    true if the faction is already loaded
    
    See Also:
    
    FactionManager.isFactionID(String)
  - isAlignmentLoaded
```
public boolean isAlignmentLoaded(Faction.Align align)
```
    Description copied from interface: FactionManager
    
    Returns whether any factions are loaded that grant alignment. This includes the Alignment faction of course, but allows a bit of flexibility.
    
    Specified by:
    
    isAlignmentLoaded in interface FactionManager
    
    Parameters:
    
    align - the align enum to check
    
    Returns:
    
    true if any faction is loaded that uses it
    
    See Also:
    
    Faction.Align, FactionManager.getAlignPurity(int, com.planet_ink.coffee_mud.Common.interfaces.Faction.Align), FactionManager.getAlignMedianFacValue(com.planet_ink.coffee_mud.Common.interfaces.Faction.Align), FactionManager.getAlignEnum(String)
  - getFaction
```
public Faction getFaction(java.lang.String factionID)
```
    Description copied from interface: FactionManager
    
    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.
    
    Specified by:
    
    getFaction in interface FactionManager
    
    Parameters:
    
    factionID - the faction id to look for
    
    Returns:
    
    the faction found, or null
    
    See Also:
    
    FactionManager.factions(), FactionManager.numFactions(), FactionManager.getFactionByNumber(int)
  - getFactionByRangeCodeName
```
public Faction getFactionByRangeCodeName(java.lang.String rangeCodeName)
```
    Description copied from interface: FactionManager
    
    Returns the Faction that contains the given range code name.
    
    Specified by:
    
    getFactionByRangeCodeName in interface FactionManager
    
    Parameters:
    
    rangeCodeName - the range code name to search for
    
    Returns:
    
    the faction, or null
    
    See Also:
    
    FactionManager.getFactionRangeByCodeName(String), FactionManager.getRange(String, int), FactionManager.getRanges(String)
  - getFactionByName
```
public Faction getFactionByName(java.lang.String factionNamed)
```
    Description copied from interface: FactionManager
    
    Returns the faction object with the given exact case-insensitive display name.
    
    Specified by:
    
    getFactionByName in interface FactionManager
    
    Parameters:
    
    factionNamed - the display name to look for
    
    Returns:
    
    the faction obj or null
    
    See Also:
    
    FactionManager.getFaction(String)
  - removeFaction
```
public boolean removeFaction(java.lang.String factionID)
```
    Description copied from interface: FactionManager
    
    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.
    
    Specified by:
    
    removeFaction in interface FactionManager
    
    Parameters:
    
    factionID - the id to remove, or null for all
    
    Returns:
    
    true if a faction was removed, or false otherwise
    
    See Also:
    
    FactionManager.addFaction(Faction), FactionManager.resaveFaction(Faction)
  - listFactions
```
public java.lang.String listFactions()
```
    Description copied from interface: FactionManager
    
    Returns a friendly column based list of all factions, formatted for 80 col screen.
    
    Specified by:
    
    listFactions in interface FactionManager
    
    Returns:
    
    the viewable list of factions
  - name
```
public java.lang.String name()
```
    Description copied from interface: CMObject
    
    The displayable name of this object. May be modified by phyStats() object. Is derived from the Name().
    
    Specified by:
    
    name in interface CMObject
    
    Specified by:
    
    name in interface Tickable
    
    Overrides:
    
    name in class StdLibrary
    
    Returns:
    
    the modified final name of this object on the map.
    
    See Also:
    
    Environmental.Name()
  - getTickStatus
```
public int getTickStatus()
```
    Description copied from interface: Tickable
    
    A coded status for this object during the period where its tick method is being called. The statis is defined, at least in part, by constants in this interface STATUS_*. STATUS_NOT should be returned when the objects tick method is not currently in execution. It should never return STATUS_NOT when the objects tick method is in execution.
    
    Specified by:
    
    getTickStatus in interface Tickable
    
    Overrides:
    
    getTickStatus in class StdLibrary
    
    Returns:
    
    the numeric status of this object
    
    See Also:
    
    Tickable.tick(Tickable, int)
  - getName
```
public java.lang.String getName(java.lang.String factionID)
```
    Description copied from interface: FactionManager
    
    Returns the friendly faction display name associated with the given faction id
    
    Specified by:
    
    getName in interface FactionManager
    
    Parameters:
    
    factionID - the faction id to look for
    
    Returns:
    
    the friendly name, or empty string ""
  - getMinimum
```
public int getMinimum(java.lang.String factionID)
```
    Description copied from interface: FactionManager
    
    Returns the absolute minimum possible faction value that the faction with the given id can be assigned.
    
    Specified by:
    
    getMinimum in interface FactionManager
    
    Parameters:
    
    factionID - the faction id to look for
    
    Returns:
    
    the minimum possible value or 0
    
    See Also:
    
    FactionManager.getMaximum(String)
  - getMaximum
```
public int getMaximum(java.lang.String factionID)
```
    Description copied from interface: FactionManager
    
    Returns the absolute maximum possible faction value that the faction with the given id can be assigned.
    
    Specified by:
    
    getMaximum in interface FactionManager
    
    Parameters:
    
    factionID - the faction id to look for
    
    Returns:
    
    the maximum possible value or 0
    
    See Also:
    
    FactionManager.getMinimum(String)
  - getPercent
```
public int getPercent(java.lang.String factionID,
                      int faction)
```
    Description copied from interface: FactionManager
    
    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.
    
    Specified by:
    
    getPercent in interface FactionManager
    
    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:
    
    FactionManager.getRangePercent(String, int), FactionManager.getPercentFromAvg(String, int)
  - getPercentFromAvg
```
public int getPercentFromAvg(java.lang.String factionID,
                             int faction)
```
    Description copied from interface: FactionManager
    
    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.
    
    Specified by:
    
    getPercentFromAvg in interface FactionManager
    
    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:
    
    FactionManager.getRangePercent(String, int), FactionManager.getPercent(String, int), FactionManager.getPercentFromAvg(String, int)
  - getRange
```
public Faction.FRange getRange(java.lang.String factionID,
                               int faction)
```
    Description copied from interface: FactionManager
    
    Returns the faction range from the faction with the given faction id whose range covers the given faction value.
    
    Specified by:
    
    getRange in interface FactionManager
    
    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:
    
    FactionManager.getFactionByRangeCodeName(String), FactionManager.getFactionRangeByCodeName(String), FactionManager.getRanges(String)
  - getRanges
```
public java.util.Enumeration<Faction.FRange> getRanges(java.lang.String factionID)
```
    Description copied from interface: FactionManager
    
    Returns an enumerator of all faction range objects in the faction with the given id.
    
    Specified by:
    
    getRanges in interface FactionManager
    
    Parameters:
    
    factionID - the faction id of the faction to check
    
    Returns:
    
    the enumerator of faction range objects
    
    See Also:
    
    FactionManager.getFactionByRangeCodeName(String), FactionManager.getFactionRangeByCodeName(String), FactionManager.getRange(String, int)
  - getRangePercent
```
public double getRangePercent(java.lang.String factionID,
                              int faction)
```
    Description copied from interface: FactionManager
    
    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.
    
    Specified by:
    
    getRangePercent in interface FactionManager
    
    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:
    
    FactionManager.getPercent(String, int), FactionManager.getPercentFromAvg(String, int)
  - getTotal
```
public int getTotal(java.lang.String factionID)
```
    Description copied from interface: FactionManager
    
    Gets the absolute number of points in this faction, essentially the max - min.
    
    Specified by:
    
    getTotal in interface FactionManager
    
    Parameters:
    
    factionID - the faction id to check
    
    Returns:
    
    the max - min, or 0
  - getRandom
```
public int getRandom(java.lang.String factionID)
```
    Description copied from interface: FactionManager
    
    Returns a random faction number in the range from its minimum to maximum, given a faction id.
    
    Specified by:
    
    getRandom in interface FactionManager
    
    Parameters:
    
    factionID - the faction id to check
    
    Returns:
    
    a random faction number
  - getAlignmentID
```
public java.lang.String getAlignmentID()
```
    Description copied from interface: FactionManager
    
    Returns the faction ID assigned to 'alignment' (good, evil, neutral)
    
    Specified by:
    
    getAlignmentID in interface FactionManager
    
    Returns:
    
    the faction ID assigned to 'alignment' (good, evil, neutral)
  - getInclinationID
```
public java.lang.String getInclinationID()
```
    Description copied from interface: FactionManager
    
    Returns the faction ID assigned to 'inclination' (lawful, mod, chaotic)
    
    Specified by:
    
    getInclinationID in interface FactionManager
    
    Returns:
    
    the faction ID assigned to 'inclination' (lawful, mod, chaotic)
  - setAlignment
```
public void setAlignment(MOB mob,
                         Faction.Align newAlignment)
```
    Description copied from interface: FactionManager
    
    Changes the alignment of the given mob to the value of the Align enum given.
    
    Specified by:
    
    setAlignment in interface FactionManager
    
    Parameters:
    
    mob - the mob to change
    
    newAlignment - the new alignment by enum
    
    See Also:
    
    Faction.Align
  - setAlignmentOldRange
```
public void setAlignmentOldRange(MOB mob,
                                 int oldRange)
```
    Description copied from interface: FactionManager
    
    A legacy method for changing alignment according to the legacy values where 1000 is pure good, and 0 is evil.
    
    Specified by:
    
    setAlignmentOldRange in interface FactionManager
    
    Parameters:
    
    mob - the mob to change
    
    oldRange - the 0-1000 value
  - postChangeAllFactions
```
public boolean postChangeAllFactions(MOB mob,
                                     MOB victim,
                                     int amount,
                                     boolean quiet)
```
    Description copied from interface: FactionManager
    
    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?!
    
    Specified by:
    
    postChangeAllFactions in interface FactionManager
    
    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
```
public boolean postSkillFactionChange(MOB mob,
                                      Ability skillA,
                                      java.lang.String factionID,
                                      int amount)
```
    Description copied from interface: FactionManager
    
    Posts an official faction change even to the system that is related to a skill that changes faction.
    
    Specified by:
    
    postSkillFactionChange in interface FactionManager
    
    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
  - makeReactionFaction
```
public Faction makeReactionFaction(java.lang.String prefix,
                                   java.lang.String classID,
                                   java.lang.String Name,
                                   java.lang.String code,
                                   java.lang.String baseTemplateFilename)
```
    Description copied from interface: FactionManager
    
    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")
    
    Specified by:
    
    makeReactionFaction in interface FactionManager
    
    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
```
public Faction getSpecialAreaFaction(Area A)
```
    Description copied from interface: FactionManager
    
    If area reactions are enabled, and the given area has one of them, then this will return the areas faction.
    
    Specified by:
    
    getSpecialAreaFaction in interface FactionManager
    
    Parameters:
    
    A - the Area to check
    
    Returns:
    
    a Faction object, or null
    
    See Also:
    
    FactionManager.getSpecialFactions(MOB, Room)
  - getSpecialFactions
```
public Faction[] getSpecialFactions(MOB mob,
                                    Room R)
```
    Description copied from interface: FactionManager
    
    If reaction factions are enabled, and the given location has one of them, then this will return the applicable faction.
    
    Specified by:
    
    getSpecialFactions in interface FactionManager
    
    Parameters:
    
    mob - the mob involved
    
    R - the mobs location
    
    Returns:
    
    a Faction object, or null
    
    See Also:
    
    FactionManager.getSpecialAreaFaction(Area)
  - updatePlayerFactions
```
public void updatePlayerFactions(MOB mob,
                                 Room R,
                                 boolean forceAutoCheck)
```
    Description copied from interface: FactionManager
    
    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
    
    Specified by:
    
    updatePlayerFactions in interface FactionManager
    
    Parameters:
    
    mob - the player/npc mob to confirm against existing factions
    
    R - the room the mob is in
    
    forceAutoCheck - just set this to false
  - addOutsidersAndTimers
```
protected void addOutsidersAndTimers(Faction F,
                                     java.util.List<Faction.FactionChangeEvent> outSiders,
                                     java.util.List<Faction.FactionChangeEvent> timers)
```
  - tick
```
public boolean tick(Tickable ticking,
                    int tickID)
```
    Description copied from interface: Tickable
    
    this is the method which is called periodically by the threading engine. How often it is called depends on the parameters passed to the threadding engine when it is submitted for thread access. Typically the period is once per TIME_TICK period, but that is determined when the object is submitted to the thread engine.
    
    Specified by:
    
    tick in interface Tickable
    
    Overrides:
    
    tick in class StdLibrary
    
    Parameters:
    
    ticking - a reference to this Tickable object
    
    tickID - the TICKID_ constant describing this periodic call, as defined in Tickable
    
    Returns:
    
    true always, unless this object no longer wishes to ever tick again, in which case false
    
    See Also:
    
    Tickable, ServiceEngine, TickableGroup
  - getAlignPurity
```
public int getAlignPurity(int faction,
                          Faction.Align eq)
```
    Description copied from interface: FactionManager
    
    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.
    
    Specified by:
    
    getAlignPurity in interface FactionManager
    
    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, FactionManager.isAlignmentLoaded(com.planet_ink.coffee_mud.Common.interfaces.Faction.Align), FactionManager.getAlignMedianFacValue(com.planet_ink.coffee_mud.Common.interfaces.Faction.Align), FactionManager.getAlignEnum(String)
  - getInclinationPurity
```
public int getInclinationPurity(int faction,
                                Faction.Align eq)
```
    Description copied from interface: FactionManager
    
    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.
    
    Specified by:
    
    getInclinationPurity in interface FactionManager
    
    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
  - getAlignMedianFacValue
```
public int getAlignMedianFacValue(Faction.Align eq)
```
    Description copied from interface: FactionManager
    
    Returns the purist alignment/inclination faction value associated with the given Align enum. Also works for inclinatino.
    
    Specified by:
    
    getAlignMedianFacValue in interface FactionManager
    
    Parameters:
    
    eq - the align fac value to return a pure value for
    
    Returns:
    
    the pure value
    
    See Also:
    
    Faction.Align, FactionManager.isAlignmentLoaded(com.planet_ink.coffee_mud.Common.interfaces.Faction.Align), FactionManager.getAlignPurity(int, com.planet_ink.coffee_mud.Common.interfaces.Faction.Align), FactionManager.getAlignEnum(String)
  - getFactionTag
```
public Faction.FacTag getFactionTag(java.lang.String tag)
```
    Description copied from interface: FactionManager
    
    Returns which faction tag (FacTag) enum is represented by the given string, which is typically a parameter from a faction definition/ini file.
    
    Specified by:
    
    getFactionTag in interface FactionManager
    
    Parameters:
    
    tag - the string to check
    
    Returns:
    
    the FacTag object, or null
    
    See Also:
    
    Faction.FacTag
  - getAlignEnum
```
public Faction.Align getAlignEnum(java.lang.String str)
```
    Description copied from interface: FactionManager
    
    Returns the Align enum that matches the given string, or INDIFF if not found.
    
    Specified by:
    
    getAlignEnum in interface FactionManager
    
    Parameters:
    
    str - the Align enum string
    
    Returns:
    
    the Align enum object or INDIFF
    
    See Also:
    
    Faction.Align, FactionManager.isAlignmentLoaded(com.planet_ink.coffee_mud.Common.interfaces.Faction.Align), FactionManager.getAlignMedianFacValue(com.planet_ink.coffee_mud.Common.interfaces.Faction.Align), FactionManager.getAlignPurity(int, com.planet_ink.coffee_mud.Common.interfaces.Faction.Align)
  - modifyFaction
```
public void modifyFaction(MOB mob,
                          Faction meF)
                   throws java.io.IOException
```
    Description copied from interface: FactionManager
    
    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.
    
    Specified by:
    
    modifyFaction in interface FactionManager
    
    Parameters:
    
    mob - the player doing the editing, with a session
    
    meF - the faction object being edited
    
    Throws:
    
    java.io.IOException - session i/o errors
  - resaveFaction
```
public java.lang.String resaveFaction(Faction F)
```
    Description copied from interface: FactionManager
    
    Re-saves the given faction back to the cmfs.
    
    Specified by:
    
    resaveFaction in interface FactionManager
    
    Parameters:
    
    F - the faction to save
    
    Returns:
    
    "" if all is well, or an error message
    
    See Also:
    
    Faction, FactionManager.addFaction(Faction), FactionManager.removeFaction(String)
  - getAbilityFlagType
```
public FactionManager.FAbilityMaskType getAbilityFlagType(java.lang.String strflag)
```
    Description copied from interface: FactionManager
    
    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
    
    Specified by:
    
    getAbilityFlagType in interface FactionManager
    
    Parameters:
    
    strflag - the string to find a flag type rep of
    
    Returns:
    
    the ability mask type
    
    See Also:
    
    FactionManager.FAbilityMaskType

Class Factions

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.FactionManager

Field Summary

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

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

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

Constructor Summary

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 class java.lang.Object

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

Field Detail

factionMap

hashedFactionRanges

hashedFactionAligns

autoReactions

Constructor Detail

Factions

Method Detail

ID

factions

numFactions

clearFactions

propertiesLoaded

getFactionByNumber

reloadFactions

rangeCodeNames

isRangeCodeName

getFactionRangeByCodeName

isFactionedThisWay

rangeDescription

addFaction

makeFactionFilename

isFactionID

isFactionLoaded

isAlignmentLoaded

getFaction

getFactionByRangeCodeName

getFactionByName

removeFaction

listFactions

name

getTickStatus

getName

getMinimum

getMaximum

getPercent

getPercentFromAvg

getRange

getRanges

getRangePercent

getTotal

getRandom

getAlignmentID

getInclinationID

setAlignment

setAlignmentOldRange

postChangeAllFactions

postSkillFactionChange

makeReactionFaction

getSpecialAreaFaction

getSpecialFactions

updatePlayerFactions

addOutsidersAndTimers

tick

getAlignPurity

getInclinationPurity

getAlignMedianFacValue

getFactionTag

getAlignEnum

modifyFaction

resaveFaction

getAbilityFlagType