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 26

Example

// create the ui plugin object
 new UISystemPlugin;

Members

activeObject

Properties

Type	Description
UIObject	Object user is currently interacting with

Source: plugins/uiSystem.js, line 72

defaultButtonColor

Properties

Type	Description
Color	Default button color for UI elements

Source: plugins/uiSystem.js, line 46

defaultColor

Properties

Type	Description
Color	Default fill color for UI elements

Source: plugins/uiSystem.js, line 40

defaultCornerRadius

Properties

Type	Description
number	Default rounded rect corner radius for UI elements

Source: plugins/uiSystem.js, line 56

defaultDisabledColor

Properties

Type	Description
Color	Default color for disabled UI elements

Source: plugins/uiSystem.js, line 50

defaultFont

Properties

Type	Description
string	Default font for UI elements

Source: plugins/uiSystem.js, line 60

defaultGradientColor

Properties

Type	Description
Color	Uses a gradient fill combined with color

Source: plugins/uiSystem.js, line 52

defaultHoverColor

Properties

Type	Description
Color	Default hover color for UI elements

Source: plugins/uiSystem.js, line 48

defaultLineColor

Properties

Type	Description
Color	Default outline color for UI elements

Source: plugins/uiSystem.js, line 42

defaultLineWidth

Properties

Type	Description
number	Default line width for UI elements

Source: plugins/uiSystem.js, line 54

defaultSoundClick

Properties

Type	Description
Sound	Default sound when interactive UI element is clicked

Source: plugins/uiSystem.js, line 66

defaultSoundPress

Properties

Type	Description
Sound	Default sound when interactive UI element is pressed

Source: plugins/uiSystem.js, line 62

defaultSoundRelease

Properties

Type	Description
Sound	Default sound when interactive UI element is released

Source: plugins/uiSystem.js, line 64

defaultTextColor

Properties

Type	Description
Color	Default text color for UI elements

Source: plugins/uiSystem.js, line 44

defaultTextScale

Properties

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

Source: plugins/uiSystem.js, line 58

hoverObject

Properties

Type	Description
UIObject	Top most object user is over

Source: plugins/uiSystem.js, line 74

lastHoverObject

Properties

Type	Description
UIObject	Hover object at start of update

Source: plugins/uiSystem.js, line 76

nativeHeight

Properties

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

Source: plugins/uiSystem.js, line 78

uiContext

Properties

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

Source: plugins/uiSystem.js, line 70

uiObjects

Properties

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

Source: plugins/uiSystem.js, line 68

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 194

drawRect(pos, size, coloropt, lineWidthopt, lineColoropt, cornerRadiusopt, gradientColoropt)

Draw a rectangle to the UI context

Parameters:

Name	Type	Attributes	Default
`pos`	Vector2
`size`	Vector2
`color`	Color	<optional>	uiSystem.defaultColor
`lineWidth`	number	<optional>	uiSystem.defaultLineWidth
`lineColor`	Color	<optional>	uiSystem.defaultLineColor
`cornerRadius`	number	<optional>	uiSystem.defaultCornerRadius
`gradientColor`	Color	<optional>	uiSystem.defaultGradientColor

Source: plugins/uiSystem.js, line 153

drawText(text, pos, size, coloropt, lineWidthopt, lineColoropt, alignopt, fontopt, fontStyleopt, applyMaxWidthopt)

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

Source: plugins/uiSystem.js, line 233

drawTile(pos, size, tileInfo, coloropt, angleopt, mirroropt)

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

Source: plugins/uiSystem.js, line 217

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>	continously when dragging over

Source: plugins/uiSystem.js, line 250