Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BaseTutorialStep

typedef

{{ arrows: Array, text: string | null }} TutorialStepStatus

Hierarchy

Index

Constructors

constructor

  • Parameters

    • root: any

    Returns BaseTutorialStep

Methods

addRequirement

  • addRequirement(requirement: any): void
  • Adds a new requirement which is checked before every update (e.g. game not paused)

    Parameters

    • requirement: any

    Returns void

computeStatus

  • computeStatus(): object
  • Subclass method to return the status

    Returns object

    • arrows: undefined[]
    • text: null

getId

  • getId(): any
  • Returns any

getIsFinished

  • getIsFinished(): boolean
  • Returns if the step is completed

    Returns boolean

getStatus

  • getStatus(): any
  • Returns the indicators and text for the given step

    Returns any

helperGetBlueprintCount

  • helperGetBlueprintCount(metaClass: any): number
  • Return the amount

    Parameters

    • metaClass: any

    Returns number

helperGetBuildingCount

  • helperGetBuildingCount(metaClass: any, includeBlueprints?: boolean): number
  • Returns the amount of buildings of the type

    Parameters

    • metaClass: any
    • Default value includeBlueprints: boolean = true

    Returns number

Static getId

  • getId(): string
  • Returns string