Class default

Hierarchy

  • default

Properties

amount dataType disabledByMods gameModeLock? progressHandler? unlockedHandler? visibility

Methods

inherit onProgress onUnlocked set setAlwaysUnlockable setGameModes setNotDisabledByMods setVisibility check counter event increment

Properties

amount

amount: number

dataType

dataType: MilestoneDataType

disabledByMods

disabledByMods: boolean = true

Optional gameModeLock

gameModeLock?: GameMode[] = ...

Optional progressHandler

progressHandler?: ((newData?: string | number) => any)

Type declaration

    • (newData?: string | number): any

    • Parameters

      • Optional newData: string | number

      Returns any

Optional unlockedHandler

unlockedHandler?: ((tellPlayer: (() => void)) => any)

Type declaration

    • (tellPlayer: (() => void)): any

    • Parameters

      • tellPlayer: (() => void)
          • (): void

          • Returns void

      Returns any

visibility

visibility: MilestoneVisibility = MilestoneVisibility.Visible

Methods

inherit

  • Inherits the metadata (visibility, applicable game modes, whether it's disabled by mods, any unlock handler) of another MilestoneDefinition.

    Parameters

    Returns default

onProgress

  • Parameters

    • handler: ((newData?: string | number) => any)
        • (newData?: string | number): any

        • Parameters

          • Optional newData: string | number

          Returns any

    Returns default

onUnlocked

  • Parameters

    • handler: ((tellPlayer: (() => void)) => any)
        • (tellPlayer: (() => void)): any

        • Parameters

          • tellPlayer: (() => void)
              • (): void

              • Returns void

          Returns any

    Returns default

set

  • Replaces the type and desired amount of this MilestoneDefinition with the type and desired amount of another's.

    Parameters

    Returns default

setAlwaysUnlockable

  • Sets this milestone to be unlockable in all game modes, and not disabled by mods.

    Returns default

setGameModes

  • Parameters

    • Rest ...gameModes: GameMode[]

      What game modes this milestone can be unlocked in. Defaults to [Hardcore]

    Returns default

  • Sets this milestone to be unlockable in all game modes.

    Parameters

    • all: "all"

    Returns default

setNotDisabledByMods

  • Returns default

setVisibility

  • Parameters

    • visibility: MilestoneVisibility

      Whether the milestone is completely visible, has its name hidden, or has its required amt hidden. Defaults to Visible

    Returns default

Static check

  • This milestone will be granted when an amount of conditions happen simultaneously.
    For example, this could be used to check for a skill level.

    Parameters

    • amount: number

    Returns default

Static counter

  • This milestone type requires a number of entries, each of which must be distinct.
    For example, this could be used to check if the player has tamed every single creature type.

    Parameters

    • amount: number

    Returns default

Static event

  • This milestone is a milestone that will be granted the first time it's updated. Can be used for keeping track of metagame progress.

    Returns default

Static increment

  • This milestone will be granted after being incremented amount times. It does not require each increment to have a different ID, like counter does.
    For example, this type could be used for "number of turns played".

    Parameters

    • amount: number

    Returns default

Settings

Member Visibility

Theme

Generated using TypeDoc