Class CustomClickActionEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.entity.player.CustomClickActionEvent

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

public class CustomClickActionEvent
extends net.neoforged.bus.api.Event
implements net.neoforged.bus.api.ICancellableEvent

Fired when a component's custom click action is triggered by a player. This may be due to clicking a sign, or a component in a dialog box or screen.

If an event handler receives this and performs its own custom action, that event handler must cancel this event.

During the configuration phase, the player is not yet in the world, so getProfile() must be used to obtain sender context.

This event is fired only on the logical server.

This event is cancelable. If canceled, vanilla's processing of the custom click payload is skipped.

Field Summary

Fields

Modifier and Type	Field	Description
private final Identifier	identifier
private final @Nullable Tag	payload
private final @Nullable ServerPlayer	player
private final com.mojang.authlib.GameProfile	profile

Constructor Summary

Constructors

Constructor	Description
CustomClickActionEvent(@Nullable ServerPlayer player, com.mojang.authlib.GameProfile profile, Identifier identifier, @Nullable Tag payload)

Method Summary

Modifier and Type	Method	Description
Identifier	getIdentifier()	Returns the custom click event's identifier.
@Nullable Tag	getPayload()	Returns the custom click event's payload.
@Nullable ServerPlayer	getPlayer()	Returns the player who clicked this custom click event, or null if it was received during configuration.
com.mojang.authlib.GameProfile	getProfile()	Returns the profile of the player that sent this custom click action.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.neoforged.bus.api.ICancellableEvent

isCanceled, setCanceled

Field Details

player

private final @Nullable ServerPlayer player

profile

private final com.mojang.authlib.GameProfile profile

identifier

private final Identifier identifier

payload

private final @Nullable Tag payload

Constructor Details

CustomClickActionEvent

@Internal
public CustomClickActionEvent(@Nullable ServerPlayer player,
 com.mojang.authlib.GameProfile profile,
 Identifier identifier,
 @Nullable Tag payload)

Method Details

getPlayer

public @Nullable ServerPlayer getPlayer()

Returns the player who clicked this custom click event, or null if it was received during configuration.

Returns:

the player who clicked this custom click event, or null if it was received during configuration

getProfile

public com.mojang.authlib.GameProfile getProfile()

Returns the profile of the player that sent this custom click action.

Returns:

the profile of the player that sent this custom click action

getIdentifier

public Identifier getIdentifier()

Returns the custom click event's identifier.

Returns:

the custom click event's identifier

getPayload

public @Nullable Tag getPayload()

Returns the custom click event's payload.

Returns:

the custom click event's payload