Package net.eternalclient.api.events

Class AbstractEvent

java.lang.Object

net.eternalclient.api.events.AbstractEvent

Direct Known Subclasses:

AbstractMuleEvent, AutoCastSpellEvent, BankPinEvent, BankScrollEvent, BuyItemEvent, CameraAngleEvent, CameraPitchEvent, CancelCollectOfferEvent, CastSpellEvent, ClientModeEvent, CloseGeEvent, CollectOffersEvent, ConfirmEvent, DeathsOfficeEvent, DepositAllEvent, DepositEquipmentEvent, DepositEvent, DepositInventoryEvent, DialogueEvent, DisableSoundEvent, DropAllEvent, EnterInputEvent, EntityInteractEvent, EquipmentLoadoutEvent, GeneralCancelEvent, GrandExchangeBankingEvent, GrandExchangeEvent, InteractionEvent, InventoryEvent, LoginEvent, LogoutEvent, MinigameScrollEvent, MinigameTeleportEvent, MouseEntityInteractEvent, MouseInventoryInteractEvent, MouseMenuInteractEvent, MouseMoveEvent, MouseWidgetInteractEvent, OpenBankEvent, OpenBuyEvent, OpenGeEvent, OpenSellEvent, ResetEvent, SearchEvent, SellItemEvent, SetPriceEvent, SetQuantityEvent, SetWithdrawModeEvent, ShopBuyEvent, ShopSellEvent, ToggleAcceptAidEvent, ToggleAutoRetaliateEvent, ToggleRunEvent, ToggleSpecialAttackEvent, TradeAddItemEvent, TradeRemoveItemEvent, WalkPathEvent, WidgetEvent, WithdrawAllEvent, WithdrawEvent, WithdrawLoadoutEvent, WorldHopperEvent, WorldHopScrollEvent

public abstract class AbstractEvent
extends java.lang.Object

This class provides a framework for creating new events. It contains methods for setting event completion conditions, interrupt conditions, timeouts, delays, and interactions. It also provides hooks for customizing event behavior.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AbstractEvent.State

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEvent()

Method Summary

Modifier and Type	Method	Description
void	execute()
boolean	executed()
static AbstractEvent	getActiveEvent()
java.lang.String	getCompleteMessage()
int	getDefaultEventTimeout()
java.util.function.Supplier<java.lang.Boolean>	getEventCompleteCondition()
int	getEventCompleteTimeout()
java.util.function.Supplier<java.lang.Boolean>	getEventInterruptCondition()
int	getEventTimeout()
java.lang.String	getFailMessage()
java.util.function.Supplier<java.lang.Boolean>	getRunLoggedOut()
boolean	isEventCompleted()
boolean	isEventFailed()
boolean	isEventInterrupted()
void	onComplete()
void	onEventExit()
void	onEventStart()
void	onFail()
abstract int	onLoop()
void	onStart()
void	onStop()
static void	setActiveEvent(AbstractEvent activeEvent)
void	setCompleted()
void	setCompleted(java.lang.String message)
AbstractEvent	setEventCompleteCondition(java.util.function.Supplier<java.lang.Boolean> condition)
AbstractEvent	setEventCompleteCondition(java.util.function.Supplier<java.lang.Boolean> condition, int sleepTimeout)
void	setEventCompleted(boolean eventCompleted)
void	setEventFailed(boolean eventFailed)
AbstractEvent	setEventInterruptCondition(java.util.function.Supplier<java.lang.Boolean> condition)
void	setEventInterrupted(boolean eventInterrupted)
AbstractEvent	setEventLoginHandler(boolean enabled)
AbstractEvent	setEventTimeout(int milliseconds)
AbstractEvent	setExecutionDelay(long milliseconds)
AbstractEvent	setExecutionDelay(java.util.function.Supplier<java.lang.Long> longSupplier)
AbstractEvent	setExecutionTickDelay(int ticks)
AbstractEvent	setExecutionTickDelay(java.util.function.Supplier<java.lang.Integer> intSupplier)
void	setFailed()
void	setFailed(java.lang.String message)
AbstractEvent	setInteractionMode(InteractionMode interactionMode)
AbstractEvent	setLoggedOutRunnable(java.lang.Runnable runnable)
AbstractEvent	setLoggedOutRunnable(java.lang.Runnable runnable, boolean runOnce)
AbstractEvent	setReturnDelay(long milliseconds)
AbstractEvent	setReturnDelay(long milliseconds, boolean onComplete)
AbstractEvent	setReturnDelay(java.util.function.Supplier<java.lang.Long> longSupplier)
AbstractEvent	setReturnDelay(java.util.function.Supplier<java.lang.Long> longSupplier, boolean onComplete)
AbstractEvent	setReturnTickDelay(int ticks)
AbstractEvent	setReturnTickDelay(int ticks, boolean onComplete)
AbstractEvent	setReturnTickDelay(java.util.function.Supplier<java.lang.Integer> intSupplier)
AbstractEvent	setReturnTickDelay(java.util.function.Supplier<java.lang.Integer> intSupplier, boolean onComplete)
AbstractEvent	setRunLoggedOut(boolean runLoggedOut)
AbstractEvent	setRunLoggedOut(java.util.function.Supplier<java.lang.Boolean> runLoggedOut)
AbstractEvent	setSleep(java.util.function.Supplier<java.lang.Integer> sleep)
boolean	shouldInterrupt()
int	sleep()
int	sleepAFK()
int	sleepLowPredictable()
int	sleepNormal()
int	sleepPredictable()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEvent

protected AbstractEvent()

Method Detail

getFailMessage

public java.lang.String getFailMessage()

getCompleteMessage

public java.lang.String getCompleteMessage()

getRunLoggedOut

public java.util.function.Supplier<java.lang.Boolean> getRunLoggedOut()

setRunLoggedOut

public AbstractEvent setRunLoggedOut(boolean runLoggedOut)

setRunLoggedOut

public AbstractEvent setRunLoggedOut(java.util.function.Supplier<java.lang.Boolean> runLoggedOut)

getEventInterruptCondition

public java.util.function.Supplier<java.lang.Boolean> getEventInterruptCondition()

setEventInterruptCondition

public AbstractEvent setEventInterruptCondition(java.util.function.Supplier<java.lang.Boolean> condition)

getEventCompleteTimeout

public int getEventCompleteTimeout()

getEventCompleteCondition

public java.util.function.Supplier<java.lang.Boolean> getEventCompleteCondition()

setEventCompleteCondition

public AbstractEvent setEventCompleteCondition(java.util.function.Supplier<java.lang.Boolean> condition)

isEventInterrupted

public boolean isEventInterrupted()

setEventInterrupted

public void setEventInterrupted(boolean eventInterrupted)

isEventFailed

public boolean isEventFailed()

setEventFailed

public void setEventFailed(boolean eventFailed)

isEventCompleted

public boolean isEventCompleted()

setEventCompleted

public void setEventCompleted(boolean eventCompleted)

setCompleted

public void setCompleted(java.lang.String message)

setCompleted

public void setCompleted()

setFailed

public void setFailed(java.lang.String message)

setFailed

public void setFailed()

shouldInterrupt

public boolean shouldInterrupt()

setEventCompleteCondition

public AbstractEvent setEventCompleteCondition(java.util.function.Supplier<java.lang.Boolean> condition,
                                               int sleepTimeout)

setEventTimeout

public AbstractEvent setEventTimeout(int milliseconds)

getEventTimeout

public int getEventTimeout()

setExecutionDelay

public AbstractEvent setExecutionDelay(long milliseconds)

setExecutionDelay

public AbstractEvent setExecutionDelay(java.util.function.Supplier<java.lang.Long> longSupplier)

setExecutionTickDelay

public AbstractEvent setExecutionTickDelay(int ticks)

setExecutionTickDelay

public AbstractEvent setExecutionTickDelay(java.util.function.Supplier<java.lang.Integer> intSupplier)

setReturnDelay

public AbstractEvent setReturnDelay(long milliseconds)

setReturnDelay

public AbstractEvent setReturnDelay(long milliseconds,
                                    boolean onComplete)

setReturnDelay

public AbstractEvent setReturnDelay(java.util.function.Supplier<java.lang.Long> longSupplier)

setReturnDelay

public AbstractEvent setReturnDelay(java.util.function.Supplier<java.lang.Long> longSupplier,
                                    boolean onComplete)

setReturnTickDelay

public AbstractEvent setReturnTickDelay(int ticks)

setReturnTickDelay

public AbstractEvent setReturnTickDelay(int ticks,
                                        boolean onComplete)

setReturnTickDelay

public AbstractEvent setReturnTickDelay(java.util.function.Supplier<java.lang.Integer> intSupplier)

setReturnTickDelay

public AbstractEvent setReturnTickDelay(java.util.function.Supplier<java.lang.Integer> intSupplier,
                                        boolean onComplete)

setSleep

public AbstractEvent setSleep(java.util.function.Supplier<java.lang.Integer> sleep)

setLoggedOutRunnable

public AbstractEvent setLoggedOutRunnable(java.lang.Runnable runnable)

setLoggedOutRunnable

public AbstractEvent setLoggedOutRunnable(java.lang.Runnable runnable,
                                          boolean runOnce)

setEventLoginHandler

public AbstractEvent setEventLoginHandler(boolean enabled)

setInteractionMode

public AbstractEvent setInteractionMode(InteractionMode interactionMode)

sleep

public int sleep()

sleepPredictable

public int sleepPredictable()

sleepLowPredictable

public int sleepLowPredictable()

sleepNormal

public int sleepNormal()

sleepAFK

public int sleepAFK()

onLoop

public abstract int onLoop()

onStart

public void onStart()

onStop

public void onStop()

onComplete

public void onComplete()

onFail

public void onFail()

onEventStart

public void onEventStart()

onEventExit

public void onEventExit()

execute

public void execute()

executed

public boolean executed()

getDefaultEventTimeout

public int getDefaultEventTimeout()

getActiveEvent

public static AbstractEvent getActiveEvent()

setActiveEvent

public static void setActiveEvent(AbstractEvent activeEvent)