Package net.md_5.bungee.api.chat

Class HoverEvent

java.lang.Object

net.md_5.bungee.api.chat.HoverEvent

public final class HoverEvent
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	HoverEvent.Action

Constructor Summary

Constructors

Constructor	Description
HoverEvent(HoverEvent.Action action, BaseComponent[] value)	Deprecated. HoverEvent(Action, Content[])
HoverEvent(HoverEvent.Action action, Content... contents)	Creates event with an action and a list of contents.

Method Summary

Modifier and Type	Method	Description
void	addContent(Content content)	Adds a content to this hover event.
static Class<?>	getClass(HoverEvent.Action action, boolean array)	Gets the appropriate Content class for an HoverEvent.Action for the GSON serialization
BaseComponent[]	getValue()	Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Details

HoverEvent

public HoverEvent(HoverEvent.Action action,
 Content... contents)

Creates event with an action and a list of contents.

Parameters:

action - action of this event

contents - array of contents, provide at least one

HoverEvent

@Deprecated
public HoverEvent(HoverEvent.Action action,
 BaseComponent[] value)

Deprecated.

HoverEvent(Action, Content[])

Legacy constructor to create hover event.

Parameters:

action - the action

value - the value

Method Details

getValue

@Deprecated
public BaseComponent[] getValue()

Deprecated.

addContent

public void addContent(Content content)
                throws UnsupportedOperationException

Adds a content to this hover event.

Parameters:

content - the content add

Throws:

IllegalArgumentException - if is a legacy component and already has a content

UnsupportedOperationException - if content action does not match hover event action

getClass

public static Class<?> getClass(HoverEvent.Action action,
 boolean array)

Gets the appropriate Content class for an HoverEvent.Action for the GSON serialization

Parameters:

action - the action to get for

array - if to return the arrayed class

Returns:

the class