Interface ClockworkMultiroomDistanceMap

A distance map that covers multiple rooms. Typically returned by a function like bfsMultiroomDistanceMap rather than created directly.

interface ClockworkMultiroomDistanceMap {
    free(): void;
    get(pos: RoomPosition): number;
    getRoom(room: string): ClockworkDistanceMap | undefined;
    getRooms(): string[];
    pathToOrigin(
        start: RoomPosition,
        options?: DirectionOrderOptions,
    ): ClockworkPath;
    pathToOriginWithPortals(
        start: RoomPosition,
        options?: DirectionOrderOptions,
    ): ClockworkPath;
    set(pos: RoomPosition, value: number): void;
    toFlowField(options?: DirectionOrderOptions): ClockworkMultiroomFlowField;
    toFlowFieldWithPortals(
        options?: DirectionOrderOptions,
    ): ClockworkMultiroomFlowField;
    toMonoFlowField(
        options?: DirectionOrderOptions,
    ): ClockworkMultiroomMonoFlowField;
    toMonoFlowFieldWithPortals(
        options?: DirectionOrderOptions,
    ): ClockworkMultiroomMonoFlowField;
}

Index

Methods

free get getRoom getRooms pathToOrigin pathToOriginWithPortals set toFlowField toFlowFieldWithPortals toMonoFlowField toMonoFlowFieldWithPortals

Methods

free

free(): void
Frees the underlying WASM multiroom distance map allocation.

Returns void
- Defined in wrappers/multiroomDistanceMap.ts:38

get

get(pos: RoomPosition): number
Get the stored value for a given position.
Parameters
- pos: RoomPosition
Returns number
- Defined in wrappers/multiroomDistanceMap.ts:45

getRoom

getRoom(room: string): ClockworkDistanceMap | undefined
Get the DistanceMap for a given room.
Parameters
- room: string
Returns ClockworkDistanceMap | undefined
- Defined in wrappers/multiroomDistanceMap.ts:59

getRooms

getRooms(): string[]
List all the rooms covered by this distance map.

Returns string[]
- Defined in wrappers/multiroomDistanceMap.ts:67

pathToOrigin

pathToOrigin(
start: RoomPosition,
options?: DirectionOrderOptions,
): ClockworkPath
Path to the origin from a given position. Pass DirectionOrder.DiagonalFirst to prefer diagonal steps when multiple neighbors are equally close.
Parameters
- start: RoomPosition
- options: DirectionOrderOptions = {}
Returns ClockworkPath
- Defined in wrappers/multiroomDistanceMap.ts:77

pathToOriginWithPortals

pathToOriginWithPortals(
start: RoomPosition,
options?: DirectionOrderOptions,
): ClockworkPath
Portal-aware path to the origin from a given position. Pass DirectionOrder.DiagonalFirst to prefer diagonal steps when multiple neighbors are equally close.
Parameters
- start: RoomPosition
- options: DirectionOrderOptions = {}
Returns ClockworkPath
- Defined in wrappers/multiroomDistanceMap.ts:91

set

set(pos: RoomPosition, value: number): void
Set the stored value for a given position.
Parameters
- pos: RoomPosition
- value: number
Returns void
- Defined in wrappers/multiroomDistanceMap.ts:52

toFlowField

toFlowField(options?: DirectionOrderOptions): ClockworkMultiroomFlowField
Flow field for this distance map. Pass DirectionOrder.DiagonalFirst to prefer diagonal directions when multiple neighbors are equally close.
Parameters
- options: DirectionOrderOptions = {}
Returns ClockworkMultiroomFlowField
- Defined in wrappers/multiroomDistanceMap.ts:105

toFlowFieldWithPortals

toFlowFieldWithPortals(
options?: DirectionOrderOptions,
): ClockworkMultiroomFlowField
Portal-aware flow field for this distance map. Pass DirectionOrder.DiagonalFirst to prefer diagonal directions when multiple neighbors are equally close.
Parameters
- options: DirectionOrderOptions = {}
Returns ClockworkMultiroomFlowField
- Defined in wrappers/multiroomDistanceMap.ts:118

toMonoFlowField

toMonoFlowField(
options?: DirectionOrderOptions,
): ClockworkMultiroomMonoFlowField
Mono-directional flow field for this distance map. Pass DirectionOrder.DiagonalFirst to prefer diagonal directions when multiple neighbors are equally close.
Parameters
- options: DirectionOrderOptions = {}
Returns ClockworkMultiroomMonoFlowField
- Defined in wrappers/multiroomDistanceMap.ts:131

toMonoFlowFieldWithPortals

toMonoFlowFieldWithPortals(
options?: DirectionOrderOptions,
): ClockworkMultiroomMonoFlowField
Portal-aware monodirectional flow field for this distance map. Pass DirectionOrder.DiagonalFirst to prefer diagonal directions when multiple neighbors are equally close.
Parameters
- options: DirectionOrderOptions = {}
Returns ClockworkMultiroomMonoFlowField
- Defined in wrappers/multiroomDistanceMap.ts:144