Class ClockworkMultiroomFlowField

A flow field that spans multiple rooms, storing multiple directions per tile.

Index

Constructors

Methods

addDirection free get getDirections getRoom getRooms pathToOrigin set setDirections

Constructors

constructor

new ClockworkMultiroomFlowField(
_flowField: MultiroomFlowField,
): ClockworkMultiroomFlowField
Parameters
- _flowField: MultiroomFlowField
Returns ClockworkMultiroomFlowField
- Defined in wrappers/multiroomFlowField.ts:10

Methods

addDirection

addDirection(pos: RoomPosition, direction: DirectionConstant): void
Add a direction to the list of valid directions at a given position.
Parameters
- pos: RoomPosition
- direction: DirectionConstant
Returns void
- Defined in wrappers/multiroomFlowField.ts:43

free

free(): void
Free the memory allocated for this flow field.

Returns void
- Defined in wrappers/multiroomFlowField.ts:76

get

get(pos: RoomPosition): number
Get the flow field value at a given position.
Parameters
- pos: RoomPosition
Returns number
- Defined in wrappers/multiroomFlowField.ts:15

getDirections

getDirections(pos: RoomPosition): DirectionConstant[]
Get the list of valid directions at a given position.
Parameters
- pos: RoomPosition
Returns DirectionConstant[]
- Defined in wrappers/multiroomFlowField.ts:29

getRoom

getRoom(roomName: string): null | ClockworkFlowField
Get the flow field for a given room.
Parameters
- roomName: string
Returns null | ClockworkFlowField
- Defined in wrappers/multiroomFlowField.ts:61

getRooms

getRooms(): string[]
Get the list of rooms in the flow field.

Returns string[]
- Defined in wrappers/multiroomFlowField.ts:50

pathToOrigin

pathToOrigin(start: RoomPosition): ClockworkPath
Find a path from a given position to the origin of the flow field.
Parameters
- start: RoomPosition
Returns ClockworkPath
- Defined in wrappers/multiroomFlowField.ts:69

set

set(pos: RoomPosition, value: number): void
Set the flow field value at a given position.
Parameters
- pos: RoomPosition
- value: number
Returns void
- Defined in wrappers/multiroomFlowField.ts:22

setDirections

setDirections(pos: RoomPosition, directions: DirectionConstant[]): void
Set the list of valid directions at a given position.
Parameters
- pos: RoomPosition
- directions: DirectionConstant[]
Returns void
- Defined in wrappers/multiroomFlowField.ts:36