Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TitleComponentStateRef

The state object describes the information to visualize for this component.

Hierarchy

Index

Constructors

constructor

  • This constructor is an implementation detail. Do not use this.

    Parameters

    • ptr: number

    Returns TitleComponentStateRef

Properties

ptr

ptr: number

Methods

attempts

  • attempts(): number
  • Returns the amount of total attempts.

    Returns number

finishedRuns

  • finishedRuns(): number
  • Returns the amount of successfully finished attempts.

    Returns number

iconChangeLen

  • iconChangeLen(): number
  • The length of the game's icon data.

    Returns number

iconChangePtr

  • iconChangePtr(): number
  • The data of the game's icon. This value is only specified whenever the icon changes. If you explicitly want to query this value, remount the component. The buffer may be empty. This indicates that there is no icon. If no change occurred, null is returned instead.

    Returns number

isCentered

  • isCentered(): boolean
  • Specifies whether the title should centered or aligned to the left instead.

    Returns boolean

line1

  • line1(): string
  • The first title line to show. This is either the game's name, or a combination of the game's name and the category.

    Returns string

line2

  • line2(): string
  • By default the category name is shown on the second line. Based on the settings, it can however instead be shown in a single line together with the game name. In that case null is returned instead.

    Returns string

showsAttempts

  • showsAttempts(): boolean
  • Returns whether the amount of total attempts is supposed to be shown.

    Returns boolean

showsFinishedRuns

  • showsFinishedRuns(): boolean
  • Returns whether the amount of successfully finished attempts is supposed to be shown.

    Returns boolean

Generated using TypeDoc