Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Orb<C>

abstract

a Generator that randomly rolls one of its mods ignores mods that have no spawnweight or 0 spawnweight for every tag

Type parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

mods

mods: Mod[]

Methods

Abstract applicableTo

  • applicableTo(container: C): Flags

  • Parameters

    • container: C

    Returns Flags

Abstract applyTo

  • applyTo(container: C): C

  • Parameters

    • container: C

    Returns C

chooseMod

  • chooseMod(container: C): Mod | undefined

  • Parameters

    • container: C

    Returns Mod | undefined

getAvailableMods

  • getAvailableMods(): Mod[]

  • returns a copy of #mods

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

    Returns Mod[]

isApplicableTo

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

  • Parameters

    • container: C
    • Default value whitelist: string[] = []

    Returns boolean

isModApplicableTo

isModSpawnableOn

  • Parameters

    • mod: Mod
    • container: C

    Returns SpawnableFlags

modsFor

  • Parameters

    • container: C
    • Default value whitelist: string[] = []

    Returns Array<GeneratorDetails<Mod>>

rollMod

  • rollMod(container: C): C

  • adds a mod from chooseMod ignoring if it's applicable

    Parameters

    • container: C

    Returns C

spawnweightFor

  • spawnweightFor(mod: Mod, container: C): number | undefined

  • Parameters

    • mod: Mod
    • container: C

    Returns number | undefined

Static buildMods

  • Parameters

    Returns Mod[]

Static modFilter

  • Parameters

    Returns boolean

Generated using TypeDoc