Skip to content

helix / TellrawPart

Abstract Class: TellrawPart

Defined in: core/frontend/nodes/tellraw_part.ts:18

Extended by

Constructors

Constructor

new TellrawPart(): TellrawPart

Returns

TellrawPart

Properties

clickEvent?

optional clickEvent?: ClickEvent

Defined in: core/frontend/nodes/tellraw_part.ts:21


hoverEvent?

optional hoverEvent?: HoverEvent

Defined in: core/frontend/nodes/tellraw_part.ts:22


style

readonly style: TextStyle = {}

Defined in: core/frontend/nodes/tellraw_part.ts:20

Accumulated styling; each fluent method writes one field here.

Methods

bold()

bold(value?): this

Defined in: core/frontend/nodes/tellraw_part.ts:33

Parameters

value?

boolean = true

Returns

this


color()

color(color): this

Defined in: core/frontend/nodes/tellraw_part.ts:28

Colour this span. Prefer the typed Color.GOLD; a raw #RRGGBB hex string is also accepted for custom colours.

Parameters

color

Color | `#${string}`

Returns

this


italic()

italic(value?): this

Defined in: core/frontend/nodes/tellraw_part.ts:38

Parameters

value?

boolean = true

Returns

this


obfuscated()

obfuscated(value?): this

Defined in: core/frontend/nodes/tellraw_part.ts:53

Parameters

value?

boolean = true

Returns

this


onClick()

onClick(event): this

Defined in: core/frontend/nodes/tellraw_part.ts:59

Attach a click action (see the click helper).

Parameters

event

ClickEvent

Returns

this


onHover()

onHover(event): this

Defined in: core/frontend/nodes/tellraw_part.ts:65

Attach a hover tooltip (see the hover helper).

Parameters

event

HoverEvent

Returns

this


strikethrough()

strikethrough(value?): this

Defined in: core/frontend/nodes/tellraw_part.ts:48

Parameters

value?

boolean = true

Returns

this


underlined()

underlined(value?): this

Defined in: core/frontend/nodes/tellraw_part.ts:43

Parameters

value?

boolean = true

Returns

this

Released under the MIT License · Credits