Package net.openosrs.api.operation

Class OperationOwner

java.lang.Object

net.openosrs.api.operation.OperationOwner

All Implemented Interfaces:

java.lang.AutoCloseable

public final class OperationOwner
extends java.lang.Object
implements java.lang.AutoCloseable

One plugin run or explicitly managed script lifetime. Closing it forbids new actions.

Constructor Summary

Constructors

Constructor	Description
OperationOwner()

Method Summary

Modifier and Type	Method	Description
void	close()
static OperationOwner	current()
static OperationOwner	currentOrNew()
long	getId()
boolean	isActive()
java.lang.Runnable	onCancel(java.lang.Runnable cancellation)	Registers cleanup only; listeners must not send game actions.
<T> T	whileActive(java.util.function.Supplier<T> step, T cancelled)	Linearizes a complete client-thread step against owner shutdown.

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationOwner

public OperationOwner()

Method Detail

current

public static OperationOwner current()

currentOrNew

public static OperationOwner currentOrNew()

getId

public long getId()

isActive

public boolean isActive()

onCancel

public java.lang.Runnable onCancel(java.lang.Runnable cancellation)

Registers cleanup only; listeners must not send game actions. Returns listener removal.

whileActive

public <T> T whileActive(java.util.function.Supplier<T> step,
                         T cancelled)

Linearizes a complete client-thread step against owner shutdown.

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable