TDebugPanel

The debug panel holds a number of stats to display on the UI. The panel also acts as the default section.

Hierarchy

• default
  • TDebugPanel

Index

Constructors

• constructor

Properties

• dead
• name
• rows
• startOpen
• uuid

Methods

• addButtons
• addCheckbox
• addFredValue
• addInput
• addSection
• addSelect
• addValue
• getData
• remove
• toggle
• update

Constructors

constructor

• new TDebugPanel(events: default, isOpen?: boolean, engine: default): default

• Overrides TDebugPanelSection.constructor

  Parameters

  • events: default

  • isOpen: boolean = false

  • engine: default

  Returns default

Properties

publicdead

dead: boolean = false

Inherited from TDebugPanelSection.dead

publicname

name: string

Inherited from TDebugPanelSection.name

publicrows

rows: IDebugPanelRow[] = []

Inherited from TDebugPanelSection.rows

publicstartOpen

startOpen: boolean

Inherited from TDebugPanelSection.startOpen

publicuuid

uuid: string

Inherited from TDebugPanelSection.uuid

Methods

publicaddButtons

• addButtons(label: string, ...buttons: TButton[]): default

• Inherited from TDebugPanelSection.addButtons

  Add new row to the section with buttons

  ---

  Parameters

  • label: string

    Text label for row

  • rest...buttons: TButton[]

    Array of buttons for the row

  Returns default

publicaddCheckbox

• addCheckbox(label: string, startingValue: boolean, onChange: (value: boolean) => void): default

• Inherited from TDebugPanelSection.addCheckbox

  Add new row to the section with a checkbox

  ---

  Parameters

  • label: string

  • startingValue: boolean

  • onChange: (value: boolean) => void

  Returns default

publicaddFredValue

• addFredValue(label: string, valueKey: string): default

• Inherited from TDebugPanelSection.addFredValue

  Add new row to the section with string value from Fred stats

  ---

  Parameters

  • label: string

    Text label for row

  • valueKey: string

  Returns default

publicaddInput

• addInput(label: string, inputType: TDebugInputTypes, startingValue: string, onChange: (value: string) => void, inputProps?: TDebugInputProps): default

• Inherited from TDebugPanelSection.addInput

  Add new row to the section with an input

  ---

  Parameters

  • label: string

  • inputType: TDebugInputTypes

  • startingValue: string

  • onChange: (value: string) => void

  • optionalinputProps: TDebugInputProps

  Returns default

publicaddSection

• addSection(name: string, startOpen?: boolean): default

• Add new section to the debug panel

  ---

  Parameters

  • name: string

    Name of section

  • startOpen: boolean = false

  Returns default

publicaddSelect

• addSelect(label: string, options: TDebugSelectOption[], startingValue: string, onChange: (value: string) => void): default

• Inherited from TDebugPanelSection.addSelect

  Add new row to the section with a select box

  ---

  Parameters

  • label: string

  • options: TDebugSelectOption[]

  • startingValue: string

  • onChange: (value: string) => void

  Returns default

publicaddValue

• addValue(label: string, updateFunction: TUpdateFunction, indentLevel?: number): default

• Inherited from TDebugPanelSection.addValue

  Add new row to the section with string value

  ---

  Parameters

  • label: string

    Text label for row

  • updateFunction: TUpdateFunction

    Function to return value every update

  • indentLevel: number = 0

  Returns default

publicgetData

• getData(): TDebugPanelSectionSerializedData

• Inherited from TDebugPanelSection.getData

  Returns TDebugPanelSectionSerializedData

publicremove

• remove(): void

• Inherited from TDebugPanelSection.remove

  Remove section from the debug panel

  ---

  Returns void

publictoggle

• toggle(): void

• Toggle visibily of the debug panel

  ---

  Returns void

publicupdate

• update(engine: default, delta: number): void

• Overrides TDebugPanelSection.update

  Runs every update to keep rows up to date

  ---

  Parameters

  • engine: default

  • delta: number

  Returns void