Class Formation

Directed geometric formation where each agent holds a numbered slot. The formation rotates to face the direction of travel.

Install via recast.withPlugin(Formation), then use recast.createFormation(options).

Index

Constructors

Methods

requestMoveTarget addAgent removeAgent destroy install

Properties

Constructors

constructor

new Formation(
recastInstance: RecastModule,
options: FormationOptions,
): Formation
Parameters
- recastInstance: RecastModule
- options: FormationOptions
Returns Formation
- Defined in recast.d.ts:873

Methods

requestMoveTarget

requestMoveTarget(x: number, y: number, z: number): void
Set the target destination for the whole formation.
Parameters
- x: number
- y: number
- z: number
Returns void
- Defined in recast.d.ts:881

addAgent

addAgent(id: number): void
Add an agent to the next available slot.
Parameters
- id: number
Returns void
- Defined in recast.d.ts:883

removeAgent

removeAgent(id: number): void
Remove an agent by ID, freeing its slot.
Parameters
- id: number
Returns void
- Defined in recast.d.ts:885

destroy

destroy(): void
Stop updating and clean up event listeners.

Returns void
- Defined in recast.d.ts:887

`Static`install

install(recast: RecastModule): void
Register this plugin on a recast instance. Called internally by withPlugin.
Parameters
- recast: RecastModule
Returns void
- Defined in recast.d.ts:890

Properties

type

type: FormationType

Formation shape.

spacing

spacing: number

Slot spacing in world units.