org.osbot.rs07.utility

Class ConditionalLoop

java.lang.Object

org.osbot.rs07.utility.ConditionalLoop

public class ConditionalLoop
extends java.lang.Object

Represents a class that can be used for looping with complex loop conditions. You can specify your own looping logic and a dynamic condition to continue, with a maximum number of loops as a fail safe.

Constructor Summary

Constructors

Constructor and Description
ConditionalLoop() Empty constructor to provide an empty instance.
ConditionalLoop(Bot bot, int maxLoopCycles) The maximum amount of loops this class will allow looping for.

Method Summary

Modifier and Type	Method and Description
boolean	condition() The condition that needs to be valid to continue the loop.
int	getLoopCount()
boolean	getResult() Determines whether or not the loop finished before it exceeded its maximum number of loop cycles.
void	setResult(boolean result)
ConditionalLoop	start() Starts the loop.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConditionalLoop

public ConditionalLoop()

Empty constructor to provide an empty instance. These are used in case legacy code is used in old scripts as the legacy Mouse Destinations do not support bot instances to bet set. This instance can not be used to loop on condition.

ConditionalLoop

public ConditionalLoop(Bot bot,
                       int maxLoopCycles)

The maximum amount of loops this class will allow looping for.

Parameters:

maxLoopCycles - The maximum number of cycles to loop.

Method Detail

condition

public boolean condition()

The condition that needs to be valid to continue the loop. This method should be overridden but has not been made abstract to create empty instances.

Returns:

The state of the condition.

start

public ConditionalLoop start()

Starts the loop.

Returns:

Returns this instance for chained method access.

getResult

public boolean getResult()

Determines whether or not the loop finished before it exceeded its maximum number of loop cycles.

Returns:

True if the loop finished without exceeding its maximum number of loop cycles, meaning the condition was met before exceeding its maximum number of allowed loop cycles.

setResult

public void setResult(boolean result)

getLoopCount

public int getLoopCount()