Class SquadCoordinator

Coordinates a group of AI entities with attack tokens, formations, and roles.

Usage:

const squad = new SquadCoordinator({ maxAttackers: 2 });
squad.addMember(enemy1, 'attacker');
squad.addMember(enemy2, 'flanker');
squad.setTarget(player);
// Each frame:
squad.update();
if (squad.requestAttackToken(enemy1)) { // enemy1 can attack }

Constructors

constructor

new SquadCoordinator(config?: { maxAttackers?: number }): SquadCoordinator
Parameters
- Optionalconfig: { maxAttackers?: number }
Returns SquadCoordinator
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:37

Accessors

activeAttackers

get activeAttackers(): number
Returns number
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:156

maxAttackTokens

get maxAttackTokens(): number
Returns number
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:157

memberCount

get memberCount(): number
Returns number
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:155

Methods

addMember

addMember(entity: Entity, role?: SquadRole): this
Add a member to the squad
Parameters
- entity: Entity
- role: SquadRole = 'attacker'
Returns this
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:42

destroy

destroy(): void
Returns void
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:167

getFormationPosition

getFormationPosition(entity: Entity): PositionLike | null
Get the formation position for a member (based on their index in the squad)
Parameters
- entity: Entity
Returns PositionLike | null
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:116

getMembers

getMembers(): Entity[]
Get all active members

Returns Entity[]
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:140

getMembersByRole

getMembersByRole(role: SquadRole): Entity[]
Get members by role
Parameters
- role: SquadRole
Returns Entity[]
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:131

getRole

getRole(entity: Entity): SquadRole | undefined
Get the role of a member
Parameters
- entity: Entity
Returns SquadRole | undefined
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:151

getTarget

getTarget(): PositionLike | null
Returns PositionLike | null
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:159

releaseAttackToken

releaseAttackToken(entity: Entity): void
Release an attack token (call when attack animation finishes)
Parameters
- entity: Entity
Returns void
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:70

removeMember

removeMember(entity: Entity): this
Remove a member
Parameters
- entity: Entity
Returns this
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:48

requestAttackToken

requestAttackToken(entity: Entity): boolean
Request an attack token. Returns true if the entity is allowed to attack.
Parameters
- entity: Entity
Returns boolean
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:61

setCircleFormation

setCircleFormation(radius: number): this
Set a circle formation
Parameters
- radius: number
Returns this
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:91

setFormation

setFormation(slots: FormationSlot[]): this
Set a formation pattern (offsets from target position)
Parameters
- slots: FormationSlot[]
Returns this
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:85

setLineFormation

setLineFormation(spacing: number): this
Set a line formation
Parameters
- spacing: number
Returns this
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:105

setMaxAttackers

setMaxAttackers(max: number): this
Set max simultaneous attackers
Parameters
- max: number
Returns this
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:162

setRole

setRole(entity: Entity, role: SquadRole): void
Change a member's role
Parameters
- entity: Entity
- role: SquadRole
Returns void
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:145

setTarget

setTarget(target: PositionLike | null): this
Set the target all squad members focus on
Parameters
- target: PositionLike | null
Returns this
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:55

update

update(): void
Prune dead/inactive members. Call periodically.

Returns void
- Defined in packages/clik-engine/src/ai/SquadCoordinator.ts:75

Class SquadCoordinator

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns SquadCoordinator

Accessors

activeAttackers

Returns number

maxAttackTokens

Returns number

memberCount

Returns number

Methods

addMember

Parameters

Returns this

destroy

Returns void

getFormationPosition

Parameters

Returns PositionLike | null

getMembers

Returns Entity[]

getMembersByRole

Parameters

Returns Entity[]

getRole

Parameters

Returns SquadRole | undefined

getTarget

Returns PositionLike | null

releaseAttackToken

Parameters

Returns void

removeMember

Parameters

Returns this

requestAttackToken

Parameters

Returns boolean

setCircleFormation

Parameters

Returns this

setFormation

Parameters

Returns this

setLineFormation

Parameters

Returns this

setMaxAttackers

Parameters

Returns this

setRole

Parameters

Returns void

setTarget

Parameters

Returns this

update

Returns void

Settings

On This Page