API Docs for: 1.4.0
Show:

Kiwi.HUD.Widget.Button Class

Extends Kiwi.HUD.TextField
Defined in: src\hud\widgets\Button.ts:10
Module: Widget
Parent Module: HUD

A subclass of the TextField that has its own input component so that you can listen for mouse events on this widget.

Constructor

Kiwi.HUD.Widget.Button

(
  • game
  • text
  • x
  • y
)
Kiwi.HUD.Widget.Button

Defined in src\hud\widgets\Button.ts:10

Parameters:

  • game Kiwi.Game

    The game that this belongs to.

  • text String

    The text that you want to display inside the button.

  • x Number

    The x-coordnates of this Widget.

  • y Number

    The y-coordinates of this Widget.

Returns:

Kiwi.HUD.Widget.Button:

Item Index

Methods

Properties

Methods

objType

() String public

Defined in src\hud\widgets\Button.ts:35

The type of object that this is.

Returns:

String:

"ButtonWidget"

Properties

input

Kiwi.HUD.HUDComponents.WidgetInput public

Defined in src\hud\widgets\Button.ts:45

The WidgetInput component that handles the management of events for this button.