BOX.md

Box

A box that can be rendered on screen.

---

Constructor

new Box(scene, config);

Arguments

• scene — Scene The scene this Object is a part of.
• config — Object The Box's config object.
  • config.x — number This Box object's x-coordinate.
  • config.y — number This Box object's y-coordinate.
  • config.width — number This Box object's width.
  • config.height — number This Box object's height.
  • config.color — string Optional Box color.
  • config.backgroundColor — string Optional background color.
  • config.style — string The box line style. "line" || "double"

---

Methods

get width()

Get the rounded width of the box.

set width(n)

Set the width of the box.

Arguments

• n — number The new width of the box.

Throws

• Error If the width value is not of type 'number'.

get height()

Get the rounded height of the box.

set height(n)

Set the height of the box.

Arguments

• n — number The new height of the box.

Throws

• Error If the height value is not of type 'number'.

get renderable()

Generate the renderable representation of the box.

Returns

• PixelMesh The PixelMesh representation of the box based on its dimensions, color, and style.

---

Static Methods

asPixelMesh(width, height, color, backgroundColor, style)

Get just the renderable PixelMesh portion of a Box instance.

Parameters

• width — number This Box object's width.
• height — number This Box object's height.
• color — string Option Box color.
• backgroundColor — string Optional background color.
• style — string The box line style. "line" || "double"

Returns

The generated PixelMesh.

Example

const myGameObject = new GameObject(scene, 0, 0, "system");

myGameObject.renderable = Box.asPixelMesh(
	width,
	height,
	color,
	backgroundColor,
	style
);