RulerBuilder

A builder for the Ruler item.

Extends GenericItemBuilder

Example

import OBR, { buildRuler } from "@owlbear-rodeo/sdk";

const item = buildRuler()
  .measurement("5ft")
  .variant("DASHED")
  .endPosition({ x: 150, y: 150 })
  .build();
OBR.scene.items.addItems([item]);

Reference

Methods

measurement

measurement(measurement);

Set the rulers measurement.

Parameters

NAME	TYPE	DESCRIPTION
measurement	string	The rulers measurement

Returns the current builder.

---

variant

variant(variant);

Set the rulers variant.

Parameters

NAME	TYPE	DESCRIPTION
variant	"FILLED" | "DASHED"	The rulers variant

Returns the current builder.

---

startPosition

startPosition(startPosition);

Set the rulers startPosition.

Parameters

NAME	TYPE	DESCRIPTION
startPosition	Vector2	The rulers start position

Returns the current builder.

---

endPosition

endPosition(endPosition: Vector2)

Set the rulers endPosition.

Parameters

NAME	TYPE	DESCRIPTION
endPosition	Vector2	The rulers end position

Returns the current builder.

---

build

build();

Returns the final Ruler item.

---