Class ClockworkMultiroomFlowField

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

Index

Constructors

Methods

addDirection free get getDirections getRoom getRooms pathToOrigin pathToOriginWithPortals set setDirections

Constructors

constructor

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

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:59

free

free(): void
Frees the underlying WASM multiroom flow field allocation.

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

get

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

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:45

getRoom

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

getRooms

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

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

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:85

pathToOriginWithPortals

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

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:38

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:52