Skip to content

@minecraft/server


@minecraft/server / PrimitiveShapesManager

Class: PrimitiveShapesManager ​

Defined in: @minecraft/server/index.d.ts:18653

Primitive Shapes class used to allow adding and removing text primitives to the world.

Properties ​

maxShapes ​

readonly maxShapes: number

Defined in: @minecraft/server/index.d.ts:18660

Remarks ​

This is the maximum number of allowed primitive shapes.

Methods ​

addText() ​

addText(text, dimension?): void

Defined in: @minecraft/server/index.d.ts:18673

Parameters ​

text ​

TextPrimitive

The text primitive to be added.

dimension? ​

Dimension

Returns ​

void

Remarks ​

Adds a new text primitive to the world.

Throws ​

This function can throw errors.

minecraftcommon.EngineError

PrimitiveShapeError


removeAll() ​

removeAll(): void

Defined in: @minecraft/server/index.d.ts:18679

Returns ​

void

Remarks ​

Removes all text primitives from the world.


removeText() ​

removeText(text): void

Defined in: @minecraft/server/index.d.ts:18686

Parameters ​

text ​

TextPrimitive

Returns ​

void

Remarks ​

Removes an instance of a text primitive from the world. This is equivalent to calling remove on the text itself.