Class Atlas

immutable data structure for the atlas in Path of Exile

main purpose is for reducer like usage in redux

Hierarchy

Atlas

Index

Constructors

constructor

Properties

nodes

Methods

Constructors

constructor

new Atlas(nodes: AtlasNodes): Atlas

- Defined in packages/mods/src/helpers/Atlas.ts:37
Parameters
- nodes: AtlasNodes
Returns Atlas

Properties

nodes

nodes: AtlasNodes

Methods

addMod

addMod(mod: Mod, world_area_id: string): this

- Defined in packages/mods/src/helpers/Atlas.ts:101
Parameters
- mod: Mod
- world_area_id: string
Returns this

applySextant

applySextant(sextant: Sextant, world_area_id: string): this

- Defined in packages/mods/src/helpers/Atlas.ts:128
Parameters
- sextant: Sextant
- world_area_id: string
Returns this

asArray

asArray(): AtlasNode[]

- Defined in packages/mods/src/helpers/Atlas.ts:44
Returns AtlasNode[]

blockedMods

blockedMods(world_area_id: string): Mod[]

- Defined in packages/mods/src/helpers/Atlas.ts:145
Parameters
- world_area_id: string
Returns Mod[]

builder

builder(): Builder

- Defined in packages/mods/src/helpers/Atlas.ts:61
Returns Builder

get

get(world_area_id: string): AtlasNode

- Defined in packages/mods/src/helpers/Atlas.ts:51
wrapper for map get that ensures a node or throws

Parameters
- world_area_id: string
Returns AtlasNode

modsFor

modsFor(sextant: Sextant, world_area_id: string): Array<GeneratorDetails<Mod>>

- Defined in packages/mods/src/helpers/Atlas.ts:136
Parameters
- sextant: Sextant
- world_area_id: string
Returns Array<GeneratorDetails<Mod>>

mutateNode

mutateNode(world_area_id: string, mutate: (node: AtlasNode) => AtlasNode): this

- Defined in packages/mods/src/helpers/Atlas.ts:109
Parameters
- world_area_id: string
- mutate: (node: AtlasNode) => AtlasNode
  - - (node: AtlasNode): AtlasNode
    - Parameters
      - node: AtlasNode
      Returns AtlasNode
Returns this

removeMod

removeMod(mod: Mod, world_area_id: HumanId): this

- Defined in packages/mods/src/helpers/Atlas.ts:105
Parameters
- mod: Mod
- world_area_id: HumanId
Returns this

reset

reset(): this

- Defined in packages/mods/src/helpers/Atlas.ts:90
removes mods on all maps

always returns a new copy

Returns this

withMutations

withMutations(mutate: (builder: Builder) => Builder): this

- Defined in packages/mods/src/helpers/Atlas.ts:73
batch mutations

if the returned object is strict equal to the prev one it doesn't return a new copy

Parameters
- mutate: (builder: Builder) => Builder
  - - (builder: Builder): Builder
    - Parameters
      - builder: Builder
      Returns Builder
Returns this

Static build

build(atlas: AtlasNodeProps[]): Atlas

- Defined in packages/mods/src/helpers/Atlas.ts:27
Parameters
- atlas: AtlasNodeProps[]
Returns Atlas

Static buildLookupTable

buildLookupTable(atlas: AtlasNodeProps[]): AtlasNodes

- Defined in packages/mods/src/helpers/Atlas.ts:21
Parameters
- atlas: AtlasNodeProps[]
Returns AtlasNodes

Static withBuilder

withBuilder(builder: Builder): Atlas

- Defined in packages/mods/src/helpers/Atlas.ts:33
Parameters
- builder: Builder
Returns Atlas

Generated using TypeDoc