Guide 1 Docs 2 Reference 3
18

Display type

An item, text, block or frame shown in the world, from world.display; its place, rotation, scale and look are live.

Functions 3

display:animate(opts: { at: Vec3?, scale: (Vec3 | number)?, rotation: Orientation?, text: Text?, color: Ink?, background: (Ink | false)?, line_width: number?, shadow: boolean?, duration: number?, })

Makes one tweened change of place, scale, rotation or text over duration seconds (0.5 by default), played by the client.

display:move(at: Vec3, rotation: Orientation?)

Removes the display. Sets position and optional rotation together.

display:destroy()

Fields 15

display.id: number

The raw entity id. hit.entity hands back this handle itself, so a pack rarely needs the number.

display.billboard: Billboard

Whether it is still present. Read-only. Where it sits; live, every kind. Its yaw, pitch and roll in degrees; live. Pitch 90 lays a text flat on a table. Reads a vec3; write a number for every axis at once. How it turns toward the viewer; text defaults to "center", the other kinds to "fixed".

display.glow: (Color | false)?

Its outline colour; nil or false for none.

display.duration: number

Seconds later changes take to play out on the client (1.19.4 and later); 0 by default.

display.glide: number

Advanced movement smoothing in seconds (1.20.2+); default 0.1, 0 follows duration.

display.lead: boolean?

Advanced: true enables linear prediction. Default false; nil restores it. Normally submit current positions and leave this alone.

display.item: string?

item kind

display.canvas: number?

Item kind: the canvas shown as a filled map; written as a canvas, read back as its map id.

display.context: Context?

Item kind: how the item is posed, as in a frame, a hand or on the ground.

display.text: string?

text kind Reads back the words; takes any text.

display.color: Color?

The colour of the words that did not pick one.

display.background: (Color | false)?

Text kind: the colour behind the words; nil or false for none.

display.line_width: number?

Text kind: the width its lines wrap at; 200 by default.

display.shadow: boolean?

Text kind: whether the words have a shadow; false by default.

display.block: string?

block kind