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

Class ChargeRequirement.Builder

java.lang.Object
net.storm.api.movement.pathfinder.model.requirement.charges.ChargeRequirement.Builder
Enclosing class:
ChargeRequirement
public static class ChargeRequirement.Builder extends Object
Builder class for constructing ChargeRequirement instances.

Provides a fluent API for configuring all aspects of charge tracking.

  • Constructor Details

    • Builder

      public Builder(String id)
      Creates a new builder with the specified ID.
      Parameters:
      id - unique identifier for this charge requirement

  • Method Details

    • itemIds

      public ChargeRequirement.Builder itemIds(int... itemIds)
      Sets the item IDs that this charge tracking applies to.
      Parameters:
      itemIds - array of item IDs
      Returns:
      this builder for chaining

    • chatTriggers

      public ChargeRequirement.Builder chatTriggers(List<Pattern> chatTriggers)
      Sets the chat trigger patterns for detecting charge messages.
      Parameters:
      chatTriggers - list of compiled regex patterns
      Returns:
      this builder for chaining

    • chatTrigger

      public ChargeRequirement.Builder chatTrigger(String regex)
      Adds a chat trigger pattern from a regex string.
      Parameters:
      regex - the regex pattern to match chat messages
      Returns:
      this builder for chaining

    • maxCharges

      public ChargeRequirement.Builder maxCharges(int maxCharges)
      Sets the maximum number of charges the item can hold.
      Parameters:
      maxCharges - maximum charge count
      Returns:
      this builder for chaining

    • dailyReset

      public ChargeRequirement.Builder dailyReset(boolean dailyReset)
      Sets whether charges reset daily (e.g., Achievement Diary items).
      Parameters:
      dailyReset - true if charges reset at daily reset time
      Returns:
      this builder for chaining

    • graphicId

      public ChargeRequirement.Builder graphicId(int graphicId)
      Sets the graphic ID that triggers charge detection.
      Parameters:
      graphicId - the graphic/spotanim ID
      Returns:
      this builder for chaining

    • animationId

      public ChargeRequirement.Builder animationId(int animationId)
      Sets the animation ID that triggers charge detection.
      Parameters:
      animationId - the animation ID
      Returns:
      this builder for chaining

    • build

      public ChargeRequirement build()
      Builds the ChargeRequirement instance.
      Returns:
      the configured ChargeRequirement