Module net.botwithus.rs3

Package net.botwithus.rs3.script

Class TickingScript

java.lang.Object

net.botwithus.rs3.script.Script

net.botwithus.rs3.script.TickingScript

All Implemented Interfaces:

Runnable, Consumer<ServerTickedEvent>, ImmutableScript, ItemInputProvider, ItemOutputProvider, ItemProvider

public abstract class TickingScript
extends Script
implements Consumer<ServerTickedEvent>

Constructor Summary

Constructors

Constructor	Description
TickingScript(String name, ScriptConfig config, ScriptDefinition scriptDefinition)

Method Summary

Modifier and Type	Method	Description
final void	accept(@NotNull ServerTickedEvent event)
final boolean	initialize()	Initializes the script, this method loads the script configuration.
void	onDeactivation()
boolean	onInitialize()
abstract void	onTick(LocalPlayer self)
void	onUninitialize()
final void	run()
boolean	ticksElapsed(long targetTicks)

Methods inherited from class net.botwithus.rs3.script.Script

delay, delayUntil, delayUtil, getAuthor, getConfiguration, getDefinition, getDescription, getGraphicsContext, getInput, getLog, getName, getOutput, isActive, isBackgroundScript, isLocal, isPaused, onActivation, onPropertyChangeRequest, pause, print, print, print, print, println, println, println, resume, setActive, subscribe, syncConfig, uninitialize, unsubscribeAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Constructor Details

TickingScript

public TickingScript(String name,
 ScriptConfig config,
 ScriptDefinition scriptDefinition)

Method Details

onInitialize

public boolean onInitialize()

onTick

public abstract void onTick(LocalPlayer self)

ticksElapsed

public boolean ticksElapsed(long targetTicks)

initialize

public final boolean initialize()

Description copied from class: Script

Initializes the script, this method loads the script configuration.

Overrides:

initialize in class Script

Returns:

If the script should be active

onDeactivation

public void onDeactivation()

Overrides:

onDeactivation in class Script

accept

public final void accept(@NotNull
 @NotNull ServerTickedEvent event)

Specified by:

accept in interface Consumer<ServerTickedEvent>

run

public final void run()

Specified by:

run in interface Runnable

Specified by:

run in class Script

onUninitialize

public void onUninitialize()

Overrides:

onUninitialize in class Script