Package net.kyori.adventure.text.event

Interface ClickEvent.Payload.Custom

All Superinterfaces:

ClickEvent.Payload, net.kyori.examination.Examinable, Keyed

Enclosing interface:

ClickEvent.Payload

public static interface ClickEvent.Payload.Custom
extends ClickEvent.Payload, Keyed

A payload that holds custom data.

Since:

4.22.0

See Also:

• ClickEvent.Action.CUSTOM

Nested Class Summary

Nested classes/interfaces inherited from interface net.kyori.adventure.text.event.ClickEvent.Payload

ClickEvent.Payload.Custom, ClickEvent.Payload.Dialog, ClickEvent.Payload.Int, ClickEvent.Payload.Text

Method Summary

Modifier and Type	Method	Description
@NotNull String	data()	Deprecated. For removal since 4.23.0, custom payloads contain NBT data, use nbt() instead.
@NotNull BinaryTagHolder	nbt()	The custom data.

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Methods inherited from interface net.kyori.adventure.key.Keyed

key

Method Details

data

@Deprecated
@NotNull
@NotNull String data()

Deprecated.

For removal since 4.23.0, custom payloads contain NBT data, use nbt() instead. This method will return BinaryTagHolder.string() on the held NBT.

The custom data.

Returns:

the data

Since:

4.22.0

nbt

@NotNull
@NotNull BinaryTagHolder nbt()

The custom data.

See BinaryTagHolder.string() for a simple way to return SNBT from NBT data.

Returns:

the data

Since:

4.23.0