Package net.storm.api.movement.pathfinder.model.requirement

Class VarRequirement

java.lang.Object

net.storm.api.movement.pathfinder.model.requirement.VarRequirement

All Implemented Interfaces:

Supplier<Boolean>, Requirement

public class VarRequirement
extends Object
implements Requirement

Requirement that checks game variable (varbit/varp) values.

VarRequirement compares a varbit or varp against an expected value using the specified comparison operator. This is commonly used to check:

• Achievement diary completion
• Region visitation flags
• Quest progress stages
• Unlock states

Var Types

• VarType.VARBIT - Bit-packed variables within varps
• VarType.VARP - Full 32-bit player variables

Comparison Operators

• Comparison.EQUAL - Exact value match
• Comparison.GREATER_THAN_EQUAL - At least the specified value
• Comparison.LESS_THAN - Below the specified value
• And others in Comparison

Usage Example

 // Check if Varlamore has been visited (varbit 9652 >= 2)
 VarRequirement visited = new VarRequirement(
     Comparison.GREATER_THAN_EQUAL,
     VarType.VARBIT,
     9652,
     2
 );

 // Check if Kandarin hard diary is complete
 VarRequirement diary = new VarRequirement(
     Comparison.EQUAL,
     VarType.VARBIT,
     VarbitID.KANDARIN_DIARY_HARD_COMPLETE,
     1
 );

 if (visited.get()) {
     // Player has visited Varlamore
 }
 

See Also:

• Requirement
• VarType
• Comparison

Field Summary

Fields inherited from interface net.storm.api.movement.pathfinder.model.requirement.Requirement

ARCEUUS_FAIRY_RING, CABIN_FEVER_QUEST, DESERT_DIARY_ELITE, GRAND_TREE_QUEST, ICTHLARINS_LITTLE_HELPER, KARAMJA_DIARY_HARD, KHAREDST_PAGE_1, KHAREDST_PAGE_2, KHAREDST_PAGE_3, KHAREDST_PAGE_4, KHAREDST_PAGE_5, KUDOS_153, MONKEY_MADNESS_I, MONKEY_MADNESS_I_FINISHED, MONKEY_MADNESS_II, ONE_SMALL_FAVOUR, PANDEMONIUM_COMPLETED, PRIEST_IN_PERIL_QUEST, REGICIDE_QUEST, SONG_OF_THE_ELVES_QUEST, SUMMER_SHORE_COMPLETED, THE_GOLEM, VISITED_DEEPFIN_POINT, VISITED_KOUREND, VISITED_MORYTANIA, VISITED_PORT_ROBERTS, VISITED_VARLAMORE

Constructor Summary

Constructors

Constructor	Description
VarRequirement()

Method Summary

Modifier and Type	Method	Description
Boolean	get()	Checks if the variable value satisfies the comparison.

Methods inherited from class java.lang.Object

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

Constructor Details

VarRequirement

public VarRequirement()

Method Details

get

public Boolean get()

Checks if the variable value satisfies the comparison.

Specified by:

get in interface Supplier<Boolean>

Returns:

true if comparison passes, false otherwise