Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ImmutableContainer<T, B>

immutable implementation of Container

Type parameters

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • mods: T[]

    Returns ImmutableContainer

Properties

mods

mods: T[]

Methods

addMod

  • addMod(mod: T): this

  • adds a new non-existing mod

    Parameters

    • mod: T

    Returns this

any

  • any(): boolean

  • checks if this container has any mods

    Returns boolean

asArray

  • asArray(): T[]

  • Returns T[]

builder

  • builder(): B

  • Returns B

getTags

  • getTags(): Tag[]

  • tags of the mods in the container

    Returns Tag[]

hasMod

  • hasMod(mod: T): boolean

  • Parameters

    • mod: T

    Returns boolean

hasModGroup

  • hasModGroup(other: T): boolean

  • Parameters

    • other: T

    Returns boolean

hasRoomFor

  • hasRoomFor(mod: T): boolean

  • checks if theres more place for a mod with their generationtype

    Parameters

    • mod: T

    Returns boolean

Abstract inDomainOf

  • inDomainOf(mod_domain: number): boolean

  • Parameters

    • mod_domain: number

    Returns boolean

indexOfMod

  • indexOfMod(mod: T): number

  • Parameters

    • mod: T

    Returns number

indexOfModWithId

  • indexOfModWithId(id: string): number

  • Parameters

    • id: string

    Returns number

Abstract level

  • level(): number

  • Returns number

Abstract maxModsOfType

  • maxModsOfType(mod: T): number

  • Parameters

    • mod: T

    Returns number

numberOfModsOfType

  • numberOfModsOfType(mod_type: number): number

  • Parameters

    • mod_type: number

      generation type

    Returns number

removeAllMods

  • removeAllMods(): this

  • truncates mods

    Returns this

removeMod

  • removeMod(other: T): this

  • removes an existing mod

    Parameters

    • other: T

    Returns this

stats

  • stats(): {}

  • lists all the stats that are offered by its mods

    mods can have multiple stats so we sum their values grouped by stat id

    Returns {}

    • [key: string]: Stat

statsExtended

  • Returns StatWithModIndices[]

withMutations

  • withMutations(mutate: (builder: B) => B): this

  • Parameters

    • mutate: (builder: B) => B
        • (builder: B): B

        • Parameters

          • builder: B

          Returns B

    Returns this

Generated using TypeDoc