Class ViewOnlyOrb

Hierarchy

Orb<Item>
- ViewOnlyOrb

Index

Constructors

constructor

Properties

mods

Methods

Constructors

constructor

new ViewOnlyOrb(mods: Mod[]): ViewOnlyOrb

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

Properties

mods

mods: Mod[]

Methods

applicableTo

applicableTo(item: Item): ApplicableFlags

Overrides Generator.applicableTo
- Defined in packages/mods/src/generators/ViewOnlyOrb.ts:17
not applicable to anything

Parameters
- item: Item
Returns ApplicableFlags

applyTo

applyTo(item: Item): Item

Overrides Generator.applyTo
- Defined in packages/mods/src/generators/ViewOnlyOrb.ts:27
do nothing

Parameters
- item: Item
Returns Item

chooseMod

chooseMod(container: Item): Mod | undefined

Inherited from Orb.chooseMod
- Defined in packages/mods/src/generators/Orb.ts:42
Parameters
- container: Item
Returns Mod | 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: Item, whitelist?: string[]): boolean

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

isModApplicableTo

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

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

isModSpawnableOn

isModSpawnableOn(mod: Mod, container: Item): SpawnableFlags

Inherited from Orb.isModSpawnableOn
- Defined in packages/mods/src/generators/Orb.ts:72
Parameters
- mod: Mod
- container: Item
Returns SpawnableFlags

modsFor

modsFor(container: Item, whitelist?: string[]): Array<GeneratorDetails<Mod>>

Inherited from Orb.modsFor

Overrides Generator.modsFor
- Defined in packages/mods/src/generators/Orb.ts:100
Parameters
- container: Item
- Default value whitelist: string[] = []
Returns Array<GeneratorDetails<Mod>>

rollMod

rollMod(container: Item): Item

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: Item
Returns Item

spawnweightFor

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

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

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

Inherited from Orb.modFilter
- Defined in packages/mods/src/generators/Orb.ts:29
Parameters
- mod: ModProps
Returns boolean

Generated using TypeDoc