Kiwi.HUD.HUDWidget Class
The HUDWidget is an abstract class containing the fundamental properties and methods that every HUDWidget needs to have. This class is designed to be extended from and thus objects should not directly instantiate it.
Constructor
Kiwi.HUD.HUDWidget
-
game -
name -
x -
y
Parameters:
-
gameKiwi.GameThe game that this HUDWidget belongs to.
-
nameStringName of the type of HUDWidget.
-
xNumberThe coordinates of this HUDWidget on the x-axis.
-
yNumberThe coordinates of this HUDWidget on the y-axis.
Returns:
Item Index
Methods
Properties
- _device
- _horizontalOrigin
- _manager
- _tempContainer
- _tempParent
- _verticalOrigin
- _x
- _y
- BOTTOM static
- class
- components
- game
- horizontalOrigin
- LEFT static
- onCoordsUpdate
- RIGHT static
- style
- tempElement
- TOP static
- vertical
- x
- y
Methods
destroy
()
public
objType
()
String
public
Returns the type of object that this is.
Returns:
"HUDWidget"
removeTemplate
()
public
Used to remove any the template HTML from this HUDWidget. Currently doesn't have that great support.
setTemplate
-
main -
[element]
This method is used to remove existing DOM elements and place them inside a HUDWidget's container element. Useful so that when making HUD Widgets the developer can style HUDWidgets without having to create/write to much javascript.
Can be used by itself but maybe more useful if you customise it to suit your own needs. Currently doesn't have that great support.
Parameters:
-
mainStringmain - ID of an HTMLElement. This element should contain all of the elements you would like to place inside the HUDWidget.
-
[element]String optionalelement - ID of an HTMLElement that resides inside of the main param. This is the element that the HUDWidget can use to populate with information. E.g. Your score, health remaining, the icon, e.t.c.
update
()
public
The game update loop.
Properties
_device
_device
protected
The type of device that this game is being targeted at. Same as the deviceTargetOption on the game class. Used to detirmine how the HUD is to be managed behind the scenes. This is mainly indented for INTERNAL Kiwi use only and is public so that sub classes can have a reference to it.
_horizontalOrigin
String
protected
Contains the current CSS style that will used for the x position.
Should either be LEFT or RIGHT but these values are not checked upon assignment.
Default: 'left'
_manager
Kiwi.HUD.HUDManager
protected
The HUDManager that this widget 'belongs' to. This is mainly indented for INTERNAL Kiwi use only and is public so that sub classes can have a reference to it.
_tempContainer
HTMLElement
private
The container element for the template Currently doesn't have that great support.
_tempParent
HTMLElement
private
The parent of the template container. So that when removing a template we can place it in the right spot Currently doesn't have that great support.
_verticalOrigin
String
protected
Contains the current CSS style that will used for the y position.
Should either be TOP or BOTTOM but these values are not checked upon assignment.
Default: 'top'
_x
Number
private
The x coordinate of the widget
_y
Number
private
The y coordinate of the widget
BOTTOM
String
public
final
static
Contains the CSS style used to position a HUD element from the bottom corner.
Default: 'bottom'
class
String
public
The class name/s that the container element that this HUDWidget current has.
horizontalOrigin
String
public
Contains the current CSS style that will used for the x position.
Should either be LEFT or RIGHT but these values are not checked upon assignment.
Default: 'left'
LEFT
String
public
final
static
Contains the CSS style used to position a HUD element from the left corner.
Default: 'left'
RIGHT
String
public
final
static
Contains the CSS style used to position a HUD element from the right corner.
Default: 'right'
The HTMLDivElement that this widget is using.
The name of the widget which is used to identify the type of widget.
style
Any
public
A quick way to reference the style object that exists on the container element of this widget.
tempElement
HTMLElement
public
When a template has been set, this property will have a reference to the HTMLElement we can place the HUDWidget information into. Currently doesn't have that great support.
TOP
String
public
final
static
Contains the CSS style used to position a HUD element from the top corner.
Default: 'top'
vertical
String
public
Contains the current CSS style that will used for the y position.
Should either be TOP or BOTTOM but these values are not checked upon assignment.
Default: 'top'
x
Number
public
Get the x coordinate of the widget
y
Number
public
Get the y coordinate of the widget