Package io.github.jspinak.brobot.action.basic.vanish

Class VanishOptions

java.lang.Object

io.github.jspinak.brobot.action.ActionConfig

io.github.jspinak.brobot.action.basic.find.BaseFindOptions

io.github.jspinak.brobot.action.basic.vanish.VanishOptions

public final class VanishOptions
extends BaseFindOptions

Configuration for vanish actions.

VanishOptions provides configuration for waiting until an object disappears from the screen. This extends BaseFindOptions since vanishing is essentially a reverse find operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VanishOptions.Builder	Builder for constructing VanishOptions with a fluent API.

Nested classes/interfaces inherited from class io.github.jspinak.brobot.action.ActionConfig

ActionConfig.Illustrate

Method Summary

Modifier and Type	Method	Description
FindStrategy	getFindStrategy()	Gets the find strategy for this options instance.
double	getTimeout()

Methods inherited from class io.github.jspinak.brobot.action.basic.find.BaseFindOptions

getMatchAdjustmentOptions, getMaxMatchesToActOn, getSearchDuration, getSearchRegions, getSimilarity, isCaptureImage, isUseDefinedRegion

Methods inherited from class io.github.jspinak.brobot.action.ActionConfig

getAfterActionLog, getBeforeActionLog, getFailureLog, getIllustrate, getPauseAfterEnd, getPauseBeforeBegin, getSubsequentActions, getSuccessCriteria, getSuccessLog

Methods inherited from class java.lang.Object

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

Method Details

getFindStrategy

public FindStrategy getFindStrategy()

Description copied from class: BaseFindOptions

Gets the find strategy for this options instance.

Subclasses should override this method to return their specific strategy. For example, PatternFindOptions would map its Strategy enum to FindStrategy, while ColorFindOptions would return FindStrategy.COLOR.

Specified by:

getFindStrategy in class BaseFindOptions

Returns:

The find strategy to use for this find operation

getTimeout

public double getTimeout()