Class Sextant

Hierarchy

Orb<AtlasNode>
- Sextant

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Sextant(mods: Mod[]): Sextant

Inherited from Generator.constructor
- Defined in packages/mods/src/generators/Generator.ts:30
Parameters
- mods: Mod[]
Returns Sextant

Properties

atlas

atlas: AtlasNode[] | undefined

mods

mods: Mod[]

type

type: Type = Type.master

Static type

type: Type = Type

Methods

applicableTo

applicableTo(node: AtlasNode): ApplicableFlags

Overrides Generator.applicableTo
- Defined in packages/mods/src/generators/Sextant.ts:87
Parameters
- node: AtlasNode
Returns ApplicableFlags

applyTo

applyTo(node: AtlasNode): AtlasNode

Overrides Generator.applyTo
- Defined in packages/mods/src/generators/Sextant.ts:70
Parameters
- node: AtlasNode
Returns AtlasNode

chooseMod

chooseMod(container: AtlasNode): Mod | undefined

Inherited from Orb.chooseMod
- Defined in packages/mods/src/generators/Orb.ts:42
Parameters
- container: AtlasNode
Returns Mod | undefined

findAdjacentWithSpawnweight

findAdjacentWithSpawnweight(mod: Mod, node: AtlasNode): AtlasNode | undefined

- Defined in packages/mods/src/generators/Sextant.ts:110
Parameters
- mod: Mod
- node: AtlasNode
Returns AtlasNode | undefined

getAvailableMods

getAvailableMods(): Mod[]

Inherited from Generator.getAvailableMods
- Defined in packages/mods/src/generators/Generator.ts:50
returns a copy of #mods

we can stick with a shallow copy since Mod are supposed to be immutable

Returns Mod[]

isApplicableTo

isApplicableTo(container: AtlasNode, whitelist?: string[]): boolean

Inherited from Generator.isApplicableTo
- Defined in packages/mods/src/generators/Generator.ts:54
Parameters
- container: AtlasNode
- Default value whitelist: string[] = []
Returns boolean

isModApplicableTo

isModApplicableTo(mod: Mod, container: AtlasNode): ModApplicableFlags

Inherited from Generator.isModApplicableTo
- Defined in packages/mods/src/generators/Generator.ts:58
Parameters
- mod: Mod
- container: AtlasNode
Returns ModApplicableFlags

isModSpawnableOn

isModSpawnableOn(mod: Mod, node: AtlasNode): SpawnableFlags

Overrides Orb.isModSpawnableOn
- Defined in packages/mods/src/generators/Sextant.ts:123
Parameters
- mod: Mod
- node: AtlasNode
Returns SpawnableFlags

modsFor

modsFor(node: AtlasNode, whitelist?: string[]): { mod: Mod; spawnable: Flags; spawnweight: number }[]

Overrides Orb.modsFor
- Defined in packages/mods/src/generators/Sextant.ts:145
Parameters
- node: AtlasNode
- Default value whitelist: string[] = []
Returns { mod: Mod; spawnable: Flags; spawnweight: number }[]

rollMod

rollMod(container: AtlasNode): AtlasNode

Inherited from Orb.rollMod
- Defined in packages/mods/src/generators/Orb.ts:63
adds a mod from chooseMod ignoring if it's applicable

Parameters
- container: AtlasNode
Returns AtlasNode

spawnweightFor

spawnweightFor(mod: Mod, container: AtlasNode): number | undefined

Inherited from Orb.spawnweightFor
- Defined in packages/mods/src/generators/Orb.ts:91
Parameters
- mod: Mod
- container: AtlasNode
Returns number | undefined

Static blockedMods

blockedMods(target: AtlasNode, atlas: AtlasNode[]): Mod[]

- Defined in packages/mods/src/generators/Sextant.ts:58
creates a list of mod that are either a) already applied to this node because they are directly in range b) already applied to adjacent nodes and would create duplicates if applied to this node in other words: consider every mod from maps within a sextant distance of 2

Parameters
- target: AtlasNode
- atlas: AtlasNode[]
Returns Mod[]

Static build

build(mods: ModProps[]): Sextant

- Defined in packages/mods/src/generators/Sextant.ts:45
Parameters
- mods: ModProps[]
Returns Sextant

Static buildMods

buildMods(mods: ModProps[]): Mod[]

Inherited from Orb.buildMods
- Defined in packages/mods/src/generators/Orb.ts:36
Parameters
- mods: ModProps[]
Returns Mod[]

Static modFilter

modFilter(mod: ModProps): boolean

Overrides Orb.modFilter
- Defined in packages/mods/src/generators/Sextant.ts:41
Parameters
- mod: ModProps
Returns boolean

Generated using TypeDoc