Skip to main content

Class: CampaignState

Represent a campaign current state, after applying all events related to the campaign

Constructors​

new CampaignState(c)​

new CampaignState(c): CampaignState

Parameters​

• c: WithRequired< Partial< CampaignState >, "id" | "roleplayer" | "ruleset" >

Returns​

CampaignState

Source​

core/campaign/campaign-state.ts:32

Properties​

actions​

actions: ActionDefinition[] = []

Source​

core/campaign/campaign-state.ts:28

actorTemplates​

actorTemplates: RemoveFunctions< Required< Omit< WithRequired< Partial< Actor >, "campaign" >, "campaign" > > >[] = []

Source​

core/campaign/campaign-state.ts:26

battles​

battles: Battle[] = []

Source​

core/campaign/campaign-state.ts:22

characters​

characters: Actor[] = []

Source​

core/campaign/campaign-state.ts:24

classes​

classes: Clazz[] = []

Source​

core/campaign/campaign-state.ts:30

id​

id: string

Source​

core/campaign/campaign-state.ts:18

itemTemplates​

itemTemplates: ItemDefinition[] = []

Source​

core/campaign/campaign-state.ts:25

races​

races: Race[] = []

Source​

core/campaign/campaign-state.ts:27

roleplayer​

roleplayer: Roleplayer

Source​

core/campaign/campaign-state.ts:20

rounds​

rounds: Round[] = []

Source​

core/campaign/campaign-state.ts:23

ruleset​

ruleset: Ruleset

Source​

core/campaign/campaign-state.ts:19

statuses​

statuses: StatusDefinition[] = []

Source​

core/campaign/campaign-state.ts:29

Methods​

allCharactersHaveActed()​

allCharactersHaveActed(events): boolean

Parameters​

• events: RoleplayerEvent[]

Returns​

boolean

Source​

core/campaign/campaign-state.ts:76

characterHasResource()​

characterHasResource(actor, resourceType): boolean

Parameters​

• actor: Actor

• resourceType: string

Returns​

boolean

Source​

core/campaign/campaign-state.ts:59

getCharacterEligibleTargets()​

getCharacterEligibleTargets(campaignState, actor, action): Actor[]

Parameters​

• campaignState: CampaignState

• actor: Actor

• action: ActionDefinition

Returns​

Actor[]

Source​

core/campaign/campaign-state.ts:50

getCharacterEvents()​

getCharacterEvents(characterId): RoleplayerEvent[]

Parameters​

• characterId: string

Returns​

RoleplayerEvent[]

Source​

core/campaign/campaign-state.ts:46

getCharacterRoundEvents()​

getCharacterRoundEvents(round, characterId): RoleplayerEvent[]

Parameters​

• round: Round

• characterId: string

Returns​

RoleplayerEvent[]

Source​

core/campaign/campaign-state.ts:41

getCurrentBattle()​

getCurrentBattle(): undefined | Battle

Returns​

undefined | Battle

Source​

core/campaign/campaign-state.ts:55

getCurrentRound()​

getCurrentRound(): Round

Returns​

Round

Source​

core/campaign/campaign-state.ts:63

getRoundEvents()​

getRoundEvents(round): RoleplayerEvent[]

Parameters​

• round: Round

Returns​

RoleplayerEvent[]

Source​

core/campaign/campaign-state.ts:37

reduce()​

reduce(event): void

Parameters​

• event: RoleplayerEvent

Returns​

void

Source​

core/campaign/campaign-state.ts:87