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 23

Example

// create the ui plugin object
 new UISystemPlugin;

Members

defaultButtonColor

Properties

Type	Description
Color	Default button color for UI elements

Source: plugins/uiSystem.js, line 43

defaultColor

Properties

Type	Description
Color	Default fill color for UI elements

Source: plugins/uiSystem.js, line 37

defaultCornerRadius

Properties

Type	Description
number	Default rounded rect corner radius for UI elements

Source: plugins/uiSystem.js, line 51

defaultDisabledColor

Properties

Type	Description
Color	Default color for disabled UI elements

Source: plugins/uiSystem.js, line 47

defaultFont

Properties

Type	Description
string	Default font for UI elements

Source: plugins/uiSystem.js, line 55

defaultHoverColor

Properties

Type	Description
Color	Default hover color for UI elements

Source: plugins/uiSystem.js, line 45

defaultLineColor

Properties

Type	Description
Color	Default outline color for UI elements

Source: plugins/uiSystem.js, line 39

defaultLineWidth

Properties

Type	Description
number	Default line width for UI elements

Source: plugins/uiSystem.js, line 49

defaultSoundClick

Properties

Type	Description
Sound	Default sound when interactive UI element is clicked

Source: plugins/uiSystem.js, line 61

defaultSoundPress

Properties

Type	Description
Sound	Default sound when interactive UI element is pressed

Source: plugins/uiSystem.js, line 57

defaultSoundRelease

Properties

Type	Description
Sound	Default sound when interactive UI element is released

Source: plugins/uiSystem.js, line 59

defaultTextColor

Properties

Type	Description
Color	Default text color for UI elements

Source: plugins/uiSystem.js, line 41

defaultTextScale

Properties

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

Source: plugins/uiSystem.js, line 53

uiContext

Properties

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

Source: plugins/uiSystem.js, line 65

uiObjects

Properties

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

Source: plugins/uiSystem.js, line 63

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 147

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

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

Source: plugins/uiSystem.js, line 124

drawText(text, pos, size, coloropt, lineWidthopt, lineColoropt, alignopt, fontopt, 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
`applyMaxWidth`	boolean	<optional>	true

Source: plugins/uiSystem.js, line 180

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 165