Skip to content

Class: FactionState ​

Faction state shown by faction-war UI scripts.

Source ​

C++ class FactionState

Custom Constructor ​

FactionState

Remarks ​

This is a mutable data object filled by faction-war UI scripts. War state slots are fixed to five entries.

Constructors ​

Constructor ​

ts
protected new FactionState(): FactionState;

Engine-created faction state.

Returns ​

FactionState

Properties ​

actor_goodwill ​

ts
actor_goodwill: number;

Current goodwill from this faction to the actor.


bonus ​

ts
bonus: number;

Faction bonus level or id.


faction_id ​

ts
faction_id: string;

Faction community id.


icon ​

ts
icon: string;

Small faction icon texture.


icon_big ​

ts
icon_big: string;

Large faction icon texture.


location ​

ts
location: string;

Current faction map location.


member_count ​

ts
member_count: number;

Number of faction members.


name ​

ts
name: string;

Localized faction name or string table id.


power ​

ts
power: number;

Faction combat power.


resource ​

ts
resource: number;

Faction resource amount.


target ​

ts
target: string;

Current faction target.


target_desc ​

ts
target_desc: string;

Description of the current faction target.


war_state_hint1 ​

ts
war_state_hint1: string;

Hint for the first faction war state line.


war_state_hint2 ​

ts
war_state_hint2: string;

Hint for the second faction war state line.


war_state_hint3 ​

ts
war_state_hint3: string;

Hint for the third faction war state line.


war_state_hint4 ​

ts
war_state_hint4: string;

Hint for the fourth faction war state line.


war_state_hint5 ​

ts
war_state_hint5: string;

Hint for the fifth faction war state line.


war_state1 ​

ts
war_state1: string;

First faction war state line.


war_state2 ​

ts
war_state2: string;

Second faction war state line.


war_state3 ​

ts
war_state3: string;

Third faction war state line.


war_state4 ​

ts
war_state4: string;

Fourth faction war state line.


war_state5 ​

ts
war_state5: string;

Fifth faction war state line.