Package gg.xp.xivsupport.speech

Interface CalloutEvent

All Superinterfaces:

Event, HasCalloutTrackingKey, HasPrimaryValue, Serializable

All Known Implementing Classes:

BaseCalloutEvent, BasicCalloutEvent, DynamicCalloutEvent, ParentedCalloutEvent, ProcessedCalloutEvent

public interface CalloutEvent
extends Event, HasPrimaryValue, HasCalloutTrackingKey

Method Summary

Modifier and Type	Method	Description
@Nullable String	getCallText()
@Nullable Color	getColorOverride()
default String	getPrimaryValue()
default @Nullable String	getSound()
@Nullable CalloutTraceInfo	getTrace()
@Nullable String	getVisualText()
default @Nullable Component	graphicalComponent()
boolean	isExpired()
@Nullable HasCalloutTrackingKey	replaces()
void	setReplaces(HasCalloutTrackingKey replaces)
default boolean	shouldReplace(HasCalloutTrackingKey previous)

Methods inherited from interface gg.xp.reevent.events.Event

combineWith, delayedEnqueueAt, delayedEnqueueAtFront, dumpFields, getEffectiveHappenedAt, getEnqueuedAt, getHappenedAt, getParent, getPumpedAt, getPumpFinishedAt, getSourceEventHandler, getThisOrParentOfType, isImported, setEnqueuedAt, setHappenedAt, setImported, setParent, setPumpedAt, setPumpFinishedAt, setSourceEventHandler, shouldSave

Methods inherited from interface gg.xp.xivsupport.speech.HasCalloutTrackingKey

trackingKey

Method Details

getVisualText

@Nullable
@Nullable String getVisualText()

getCallText

@Nullable
@Nullable String getCallText()

getSound

@Nullable
default @Nullable String getSound()

isExpired

boolean isExpired()

getPrimaryValue

default String getPrimaryValue()

Specified by:

getPrimaryValue in interface HasPrimaryValue

Returns:

A text description of this object. Should be user-friendly and not over-the-top technical (fine-grained details belong in other fields, or in the Object.toString() method).

replaces

@Nullable
@Nullable HasCalloutTrackingKey replaces()

shouldReplace

default boolean shouldReplace(HasCalloutTrackingKey previous)

setReplaces

void setReplaces(HasCalloutTrackingKey replaces)

graphicalComponent

@Nullable
default @Nullable Component graphicalComponent()

getColorOverride

@Nullable
@Nullable Color getColorOverride()

getTrace

@Nullable
@Nullable CalloutTraceInfo getTrace()