Package net.openosrs.api.input

Enum InputMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<InputMode>
    public enum InputMode
extends java.lang.Enum<InputMode>
    How an interaction reaches the game.

    The mode is a routing decision, not a capability claim. A request that cannot be served in the requested mode is reported back through SubmissionResult rather than silently falling through to the other one, so a caller always knows which path ran.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      HUMAN_MOUSE
      Drive the real cursor across the canvas and click.
      PACKET
      Submit directly through the client's native menu-action pipeline.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean isHumanMouse()  
      static InputMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static InputMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • PACKET

        public static final InputMode PACKET
        Submit directly through the client's native menu-action pipeline. No cursor movement, no camera work, no canvas events. Deterministic and revision-stable, and the only mode that can address an off-screen target without first bringing it into view.

      • HUMAN_MOUSE

        public static final InputMode HUMAN_MOUSE
        Drive the real cursor across the canvas and click. The target must be visible, or made visible first by rotating, pitching, zooming or walking. Slower and fallible by design: it can miss, be interrupted, or find the target has moved.

    • Method Detail

      • values

        public static InputMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (InputMode c : InputMode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static InputMode valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • isHumanMouse

        public boolean isHumanMouse()