Class: UISystemPlugin

Constructor

new UISystemPlugin(contextopt)

Create the global UI system object

Parameters:

Name	Type	Attributes	Description
`context`	CanvasRenderingContext2D	<optional>

Source: plugins/uiSystem.js, line 43

Example

// create the ui plugin object
 new UISystemPlugin;

Members

activateOnPress

Properties

Type	Description
boolean	Activate when mouse is pressed down instead of clicked

Source: plugins/uiSystem.js, line 58

activeObject

Properties

Type	Description
UIObject	Object user is currently interacting with

Source: plugins/uiSystem.js, line 114

confirmDialog

Properties

Type	Description
UIObject	Current confirm menu being shown

Source: plugins/uiSystem.js, line 120

defaultButtonColor

Properties

Type	Description
Color	Default button color for UI elements

Source: plugins/uiSystem.js, line 66

defaultColor

Properties

Type	Description
Color	Default fill color for UI elements

Source: plugins/uiSystem.js, line 60

defaultCornerRadius

Properties

Type	Description
number	Default rounded rect corner radius for UI elements

Source: plugins/uiSystem.js, line 76

defaultDisabledColor

Properties

Type	Description
Color	Default color for disabled UI elements

Source: plugins/uiSystem.js, line 70

defaultFont

Properties

Type	Description
string	Default font for UI elements

Source: plugins/uiSystem.js, line 80

defaultGradientColor

Properties

Type	Description
Color	Uses a gradient fill combined with color

Source: plugins/uiSystem.js, line 72

defaultHoverColor

Properties

Type	Description
Color	Default hover color for UI elements

Source: plugins/uiSystem.js, line 68

defaultLineColor

Properties

Type	Description
Color	Default outline color for UI elements

Source: plugins/uiSystem.js, line 62

defaultLineWidth

Properties

Type	Description
number	Default line width for UI elements

Source: plugins/uiSystem.js, line 74

defaultShadowBlur

Properties

Type	Description
number	Size of shadow blur

Source: plugins/uiSystem.js, line 90

defaultShadowColor

Properties

Type	Description
Color	Color for shadow

Source: plugins/uiSystem.js, line 88

defaultShadowOffset

Properties

Type	Description
Vector2	Offset of shadow blur

Source: plugins/uiSystem.js, line 92

defaultSoundClick

Properties

Type	Description
Sound	Default sound when interactive UI element is clicked

Source: plugins/uiSystem.js, line 86

defaultSoundPress

Properties

Type	Description
Sound	Default sound when interactive UI element is pressed

Source: plugins/uiSystem.js, line 82

defaultSoundRelease

Properties

Type	Description
Sound	Default sound when interactive UI element is released

Source: plugins/uiSystem.js, line 84

defaultTextColor

Properties

Type	Description
Color	Default text color for UI elements

Source: plugins/uiSystem.js, line 64

defaultTextFitScale

Properties

Type	Description
number	Default scale to use for fitting text to object

Source: plugins/uiSystem.js, line 78

hoverObject

Properties

Type	Description
UIObject	Top most object user is over

Source: plugins/uiSystem.js, line 116

lastHoverObject

Properties

Type	Description
UIObject	Hover object at start of update

Source: plugins/uiSystem.js, line 118

nativeHeight

Properties

Type	Description
number	If set ui coords will be renormalized to this canvas height

Source: plugins/uiSystem.js, line 94

navigationDelay

Properties

Type	Description
number	Time between navigation inputs in seconds

Source: plugins/uiSystem.js, line 102

navigationDirection

Properties

Type	Description
boolean	should the navigation be horizontal, vertical, or both?

Source: plugins/uiSystem.js, line 104

navigationMode

Properties

Type	Description
boolean	True if user last used navigation instead of mouse

Source: plugins/uiSystem.js, line 106

navigationObject

Properties

Type	Description
UIObject	Object currently selected by navigation (gamepad or keyboard)

Source: plugins/uiSystem.js, line 98

navigationTimer

Properties

Type	Description
Timer	Cooldown timer for navigation inputs

Source: plugins/uiSystem.js, line 100

uiContext

Properties

Type	Description
CanvasRenderingContext2D \| OffscreenCanvasRenderingContext2D	Context to render UI elements to

Source: plugins/uiSystem.js, line 112

uiObjects

Properties

Type	Description
Array.<UIObject>	List of all UI elements

Source: plugins/uiSystem.js, line 110

Methods

drawLine(posA, posB, lineWidthopt, lineColoropt)

Draw a line to the UI context

Parameters:

Name	Type	Attributes	Default
`posA`	Vector2
`posB`	Vector2
`lineWidth`	number	<optional>	uiSystem.defaultLineWidth
`lineColor`	Color	<optional>	uiSystem.defaultLineColor

Source: plugins/uiSystem.js, line 336

drawRect(pos, size, coloropt, lineWidthopt, lineColoropt, cornerRadiusopt, gradientColoropt, shadowColoropt, shadowBluropt, shadowOffsetopt)

Draw a rectangle to the UI context

Parameters:

Name	Type	Attributes	Default
`pos`	Vector2
`size`	Vector2
`color`	Color	<optional>
`lineWidth`	number	<optional>	0
`lineColor`	Color	<optional>
`cornerRadius`	number	<optional>	0
`gradientColor`	Color	<optional>
`shadowColor`	Color	<optional>
`shadowBlur`	number	<optional>	0
`shadowOffset`	Color	<optional>

Source: plugins/uiSystem.js, line 285

drawText(text, pos, size, coloropt, lineWidthopt, lineColoropt, alignopt, fontopt, fontStyleopt, applyMaxWidthopt, textShadowopt, shadowColoropt, shadowBluropt, shadowOffsetopt)

Draw text to the UI context

Parameters:

Name	Type	Attributes	Default
`text`	string
`pos`	Vector2
`size`	Vector2
`color`	Color	<optional>	uiSystem.defaultColor
`lineWidth`	number	<optional>	uiSystem.defaultLineWidth
`lineColor`	Color	<optional>	uiSystem.defaultLineColor
`align`	string	<optional>	center
`font`	string	<optional>	uiSystem.defaultFont
`fontStyle`	string	<optional>
`applyMaxWidth`	boolean	<optional>	true
`textShadow`	Vector2	<optional>
`shadowColor`	Color	<optional>
`shadowBlur`	number	<optional>	0
`shadowOffset`	Color	<optional>

Source: plugins/uiSystem.js, line 393

drawTile(pos, size, tileInfo, coloropt, angleopt, mirroropt, shadowColoropt, shadowBluropt, shadowOffsetopt)

Draw a tile to the UI context

Parameters:

Name	Type	Attributes	Default
`pos`	Vector2
`size`	Vector2
`tileInfo`	TileInfo
`color`	Color	<optional>	uiSystem.defaultColor
`angle`	number	<optional>	0
`mirror`	boolean	<optional>	false
`shadowColor`	Color	<optional>
`shadowBlur`	number	<optional>	0
`shadowOffset`	Color	<optional>

Source: plugins/uiSystem.js, line 362

getNavigableObjects() → {Array.<UIObject>}

Get all navigable UI objects sorted by navigationIndex

Source: plugins/uiSystem.js, line 470

Returns:

Type:: Array.<UIObject>

getNavigationDirection() → {number}

Get navigation direction from gamepad or keyboard

Source: plugins/uiSystem.js, line 500

Returns:

Type:: number

getNavigationOtherDirection() → {Vector2}

Get other axis navigation direction from gamepad or keyboard

Source: plugins/uiSystem.js, line 525

Returns:

Type:: Vector2

getNavigationWasPressed() → {boolean}

Get if navigation button was pressed from gamepad or keyboard

Source: plugins/uiSystem.js, line 544

Returns:

Type:: boolean

screenToNative(pos) → {Vector2}

Convert a screen space position to native UI position

Parameters:

Name	Type	Description
`pos`	Vector2

Source: plugins/uiSystem.js, line 441

Returns:

Type:: Vector2

setupDragAndDrop(onDropopt, onDragEnteropt, onDragLeaveopt, onDragOveropt)

Setup drag and drop event handlers Automatically prevents defaults and calls the given functions

Parameters:

Name	Type	Attributes	Description
`onDrop`	DragAndDropCallback	<optional>	when a file is dropped
`onDragEnter`	DragAndDropCallback	<optional>	when a file is dragged onto the window
`onDragLeave`	DragAndDropCallback	<optional>	when a file is dragged off the window
`onDragOver`	DragAndDropCallback	<optional>	continuously when dragging over

Source: plugins/uiSystem.js, line 425

showConfirmDialog(textopt, yesCallbackopt, noCallbackopt, sizeopt, exitKeyopt) → {UIObject}

Show a confirmation dialog with Yes/No buttons Centers the dialog on the screen with darkened background

Parameters:

Name	Type	Attributes	Default	Description
`text`	string	<optional>	Are you sure?	The message to display
`yesCallback`	function	<optional>		Called when Yes is clicked
`noCallback`	function	<optional>		Called when No is clicked
`size`	Vector2	<optional>		Size of the confirmation dialog
`exitKey`	string	<optional>	Escape	Key that can exit the menu

Source: plugins/uiSystem.js, line 559

Returns:

The confirmation menu object

Type:: UIObject