An randomevent which replaces an object with another object. More...

Inheritance diagram for com.runehive.game.task.impl.ObjectReplacementEvent:

Collaboration diagram for com.runehive.game.task.impl.ObjectReplacementEvent:

Public Member Functions
void	execute ()
	A function representing the unit of work that will be carried out.
	ObjectReplacementEvent (GameObject original, int delay)
	ObjectReplacementEvent (GameObject original, int replacement, int delay)
	ObjectReplacementEvent (GameObject original, int replacement, int delay, Runnable onEndRun)
Public Member Functions inherited from com.runehive.game.task.Task
Task	attach (Object newKey)
	Attaches a new key.
synchronized final void	cancel ()
	Cancels all subsequent executions.
synchronized final void	cancel (boolean logout)
	Cancels all subsequent executions.
boolean	canRun ()
	Determines if the task can be ran.
Optional< Object >	getAttachment ()
String	getCreationStackTraceStr ()
int	getDelay ()
Long	getElapsedTimeFromRunStartTime ()
Optional< Long >	getRunStartTime ()
long	getTaskCreationTime ()
String	getTaskId ()
boolean	isInstant ()
boolean	isRunning ()
void	setDelay (int delay)
	Sets the cyclic delay.
void	setExecutionTime ()
	Task (boolean instant, int delay)
	Creates a new `Task`.
	Task (int delay)
	Creates a new `Task` that doesn't execute instantly.

Protected Member Functions
void	onCancel (boolean logout)
	A function executed on cancellation.
void	onSchedule ()
	A function executed on registration.
Protected Member Functions inherited from com.runehive.game.task.Task
void	baseExecute ()
boolean	canSchedule ()
	A function executed on registration.

Private Attributes
final Runnable	onEndRun
	The on event end runnable.
final GameObject	original
	The original game object.
final int	originalId
	The replacement game object.
final int	replacement
	The replacement game object.

Additional Inherited Members
Package Functions inherited from com.runehive.game.task.Task
void	onException (Exception e)
	A function executed on thrown exceptions.
void	onLoop ()
	A function executed when iterated over.
final synchronized void	process ()
synchronized void	setRunning (boolean running)

Detailed Description

An randomevent which replaces an object with another object.

Author: Daniel | Obey; Michael | Chex

Definition at line 12 of file ObjectReplacementEvent.java.

Constructor & Destructor Documentation

◆ ObjectReplacementEvent() [1/3]

com.runehive.game.task.impl.ObjectReplacementEvent.ObjectReplacementEvent	(	GameObject	original,
		int	delay )

Definition at line 26 of file ObjectReplacementEvent.java.

                                                                  {
        super(false, delay);
        this.original = original;
        this.originalId = original.getId();
        this.replacement = -1;
        this.onEndRun = () -> {
        };
    }

References com.runehive.game.task.Task.delay, and original.

◆ ObjectReplacementEvent() [2/3]

com.runehive.game.task.impl.ObjectReplacementEvent.ObjectReplacementEvent	(	GameObject	original,
		int	replacement,
		int	delay )

Definition at line 35 of file ObjectReplacementEvent.java.

                                                                                   {
        super(false, delay);
        this.original = original;
        this.originalId = original.getId();
        this.replacement = replacement;
        this.onEndRun = () -> {
        };
    }

References com.runehive.game.task.Task.delay, original, and replacement.

◆ ObjectReplacementEvent() [3/3]

com.runehive.game.task.impl.ObjectReplacementEvent.ObjectReplacementEvent	(	GameObject	original,
		int	replacement,
		int	delay,
		Runnable	onEndRun )

Definition at line 44 of file ObjectReplacementEvent.java.

                                                                                                      {
        super(false, delay);
        this.original = original;
        this.originalId = original.getId();
        this.replacement = replacement;
        this.onEndRun = onEndRun;
    }

References com.runehive.game.task.Task.delay, onEndRun, original, and replacement.

Member Function Documentation

◆ execute()

void com.runehive.game.task.impl.ObjectReplacementEvent.execute ( )

A function representing the unit of work that will be carried out.

Reimplemented from com.runehive.game.task.Task.

Definition at line 62 of file ObjectReplacementEvent.java.

                          {
        cancel();
    }

References com.runehive.game.task.Task.cancel().

Here is the call graph for this function:

◆ onCancel()

void com.runehive.game.task.impl.ObjectReplacementEvent.onCancel ( boolean logout )

protected

A function executed on cancellation.

Reimplemented from com.runehive.game.task.Task.

Definition at line 67 of file ObjectReplacementEvent.java.

                                            {
        if (replacement == -1) {
            original.register();
        } else {
            original.transform(originalId);
        }
 
        onEndRun.run();
    }

References onEndRun, original, originalId, and replacement.

◆ onSchedule()

void com.runehive.game.task.impl.ObjectReplacementEvent.onSchedule ( )

protected

A function executed on registration.

Reimplemented from com.runehive.game.task.Task.

Definition at line 53 of file ObjectReplacementEvent.java.

                                {
        if (replacement == -1) {
            original.unregister();
            return;
        }
        original.transform(replacement);
    }