FactionRegistry

Faction registry managing bidirectional and asymmetric faction standings, numerical reputations, and disposition queries (friendly, neutral, hostile).

Constructor

new FactionRegistry(configopt)

Parameters:
NameTypeAttributesDefaultDescription
configObject<optional>
{}

Registry configuration.

Properties
NameTypeAttributesDefaultDescription
defaultDispositionstring<optional>
"neutral"

Disposition when no relation exists.

defaultReputationnumber<optional>
0

Default numerical reputation.

hostileThresholdnumber<optional>
-25

Reputation at or below which disposition is hostile.

friendlyThresholdnumber<optional>
25

Reputation at or above which disposition is friendly.

factionsArray<optional>
[]

Initial faction names to register.

Classes

FactionRegistry

Methods

(static) deserialize(data) → {FactionRegistry}

Creates and deserializes a new FactionRegistry instance.

Parameters:
NameTypeDescription
dataObject

Serialized data.

Returns:
Type: 
FactionRegistry

(static) resolveFaction(target) → {string}

Resolves a faction name from a string, entity, or combatant.

Parameters:
NameTypeDescription
targetObject | string

Entity, combatant, or faction string.

Returns:

Faction name.

Type: 
string

clear()

Clears all recorded standings and registrations.

getDisposition(source, target) → {string}

Gets the disposition of source towards target ("friendly", "neutral", or "hostile"). Respects explicit disposition overrides and derives from reputation thresholds.

Parameters:
NameTypeDescription
sourceObject | string

Source faction or entity.

targetObject | string

Target faction or entity.

Returns:

Disposition string.

Type: 
string

getFactions() → {Array}

Returns all registered faction names.

Returns:

List of faction names.

Type: 
Array

getReputation(source, target) → {number}

Gets the numerical reputation of source faction towards target.

Parameters:
NameTypeDescription
sourceObject | string

Source faction or entity.

targetObject | string

Target faction or entity.

Returns:

Numerical reputation.

Type: 
number

hasFaction(name) → {boolean}

Checks if a faction is registered.

Parameters:
NameTypeDescription
namestring

Faction name.

Returns:
Type: 
boolean

isFriendly(source, target) → {boolean}

Checks if source faction considers target friendly.

Parameters:
NameTypeDescription
sourceObject | string

Source faction or entity.

targetObject | string

Target faction or entity.

Returns:

True if friendly.

Type: 
boolean

isHostile(source, target) → {boolean}

Checks if source faction considers target hostile.

Parameters:
NameTypeDescription
sourceObject | string

Source faction or entity.

targetObject | string

Target faction or entity.

Returns:

True if hostile.

Type: 
boolean

isNeutral(source, target) → {boolean}

Checks if source faction considers target neutral.

Parameters:
NameTypeDescription
sourceObject | string

Source faction or entity.

targetObject | string

Target faction or entity.

Returns:

True if neutral.

Type: 
boolean

modifyReputation(source, target, delta, optionsopt) → {number}

Modifies numerical reputation between source and target by delta.

Parameters:
NameTypeAttributesDefaultDescription
sourceObject | string

Source faction or entity.

targetObject | string

Target faction or entity.

deltanumber

Amount to adjust reputation by.

optionsObject<optional>
{}

Options object.

Properties
NameTypeAttributesDefaultDescription
bidirectionalboolean<optional>
false

Whether to adjust target->source as well.

Returns:

New reputation score.

Type: 
number

registerFaction(name) → {FactionRegistry}

Registers a faction name into the registry.

Parameters:
NameTypeDescription
namestring

Faction name.

Returns:

This instance.

Type: 
FactionRegistry

restore(data) → {FactionRegistry}

Restores faction standings from serialized data.

Parameters:
NameTypeDescription
dataObject

Serialized state object.

Returns:

This instance.

Type: 
FactionRegistry

serialize() → {Object}

Serializes faction standings into a plain JSON-compatible object.

Returns:
Type: 
Object

setDisposition(source, target, disposition, optionsopt) → {FactionRegistry}

Sets an explicit disposition override from source towards target.

Parameters:
NameTypeAttributesDefaultDescription
sourceObject | string

Source faction or entity.

targetObject | string

Target faction or entity.

dispositionstring

"friendly", "neutral", or "hostile".

optionsObject<optional>
{}

Options object.

Properties
NameTypeAttributesDefaultDescription
bidirectionalboolean<optional>
false

Whether to set target->source as well.

setReputationboolean<optional>
true

Whether to synchronize numerical reputation baseline.

Returns:

This instance.

Type: 
FactionRegistry

setReputation(source, target, value, optionsopt) → {FactionRegistry}

Sets numerical reputation from source towards target. Supports asymmetric (default) or bidirectional updates.

Parameters:
NameTypeAttributesDefaultDescription
sourceObject | string

Source faction or entity.

targetObject | string

Target faction or entity.

valuenumber

Numerical reputation value.

optionsObject<optional>
{}

Options object.

Properties
NameTypeAttributesDefaultDescription
bidirectionalboolean<optional>
false

Whether to set target->source as well.

keepOverrideboolean<optional>
false

Whether to keep explicit disposition overrides.

Returns:

This instance.

Type: 
FactionRegistry