Enum Class GamevalType

java.lang.Object
java.lang.Enum<GamevalType>
com.botwithus.bot.api.gameval.GamevalType
All Implemented Interfaces:
Serializable, Comparable<GamevalType>, Constable
public enum GamevalType extends Enum<GamevalType>
A namespace of gameval symbolic names — one per table the game ships in cache index 67. A gameval name is only unique within its type, so every lookup names both (ITEM + "YEW_LOGS" → 1515).

The wire() string is the etype key stored in the index and is the shared vocabulary with the offline tooling — it matches the group file names under gameval_beta_out/ and the --etype argument of the Atlas query CLI. Two names differ between the game's vocabulary and the host's, and the wire string keeps the game's: ITEM is the game's obj table, and VARP is its var_player table.

LOC is scenery — the same entities the SceneObjects facade yields. It keeps the cache's spelling so a name resolved here and a name looked up in the offline tooling are unambiguously the same thing.

See Also:

  • Enum Constant Details

    • ITEM

      public static final GamevalType ITEM
      Items. The game's obj table.

    • NPC

      public static final GamevalType NPC
      NPCs.

    • LOC

      public static final GamevalType LOC
      Scenery. Yielded by api.objects().

    • INV

      public static final GamevalType INV
      Inventories / containers.

    • ENUM

      public static final GamevalType ENUM
      Enums (id → value tables).

    • STRUCT

      public static final GamevalType STRUCT
      Structs (param bags).

    • PARAM

      public static final GamevalType PARAM
      Params (struct/def attribute keys).

    • SEQ

      public static final GamevalType SEQ
      Animation sequences.

    • GRAPHIC

      public static final GamevalType GRAPHIC
      Spot animations / graphical effects.

    • QUEST

      public static final GamevalType QUEST
      Quests.

    • CATEGORY

      public static final GamevalType CATEGORY
      Item/equipment categories.

    • ACHIEVEMENT

      public static final GamevalType ACHIEVEMENT
      Achievements.

    • DBROW

      public static final GamevalType DBROW
      Database rows.

    • DBTABLE

      public static final GamevalType DBTABLE
      Database tables.

    • MAPELEMENT

      public static final GamevalType MAPELEMENT
      World-map elements.

    • INTERFACE

      public static final GamevalType INTERFACE
      Interfaces.

    • COMPONENT

      public static final GamevalType COMPONENT
      Interface components. Ids are packed as (interfaceId << 16) | componentId — use GamevalIndex.component(String) to get them split.

    • CURSOR

      public static final GamevalType CURSOR
      Mouse cursors.

    • HEADBAR

      public static final GamevalType HEADBAR
      Overhead health bars.

    • HITMARK

      public static final GamevalType HITMARK
      Hit splats.

    • STYLESHEET

      public static final GamevalType STYLESHEET
      Interface style sheets.

    • FONTMETRICS

      public static final GamevalType FONTMETRICS
      Font metrics.

    • UI_ANIM

      public static final GamevalType UI_ANIM
      Interface animations.

    • UI_ANIM_CURVE

      public static final GamevalType UI_ANIM_CURVE
      Interface animation curves.

    • VARP

      public static final GamevalType VARP
      Player variables. The game's var_player table.

    • VARBIT

      public static final GamevalType VARBIT
      Player variable bits.

    • VAR_CLIENT

      public static final GamevalType VAR_CLIENT
      Client variables.

    • VAR_NPC

      public static final GamevalType VAR_NPC
      NPC variables.

    • VARBIT_NPC

      public static final GamevalType VARBIT_NPC
      NPC variable bits.

    • VAR_OBJECT

      public static final GamevalType VAR_OBJECT
      Scenery variables.

    • VARBIT_OBJECT

      public static final GamevalType VARBIT_OBJECT
      Scenery variable bits.

    • VAR_CLAN

      public static final GamevalType VAR_CLAN
      Clan variables.

    • VARBIT_CLAN

      public static final GamevalType VARBIT_CLAN
      Clan variable bits.

    • VAR_CLAN_SETTING

      public static final GamevalType VAR_CLAN_SETTING
      Clan-setting variables.

    • VARBIT_CLAN_SETTING

      public static final GamevalType VARBIT_CLAN_SETTING
      Clan-setting variable bits.

    • VAR_PLAYER_GROUP

      public static final GamevalType VAR_PLAYER_GROUP
      Player-group variables.

    • MODEL

      public static final GamevalType MODEL
      Models.

    • MATERIAL

      public static final GamevalType MATERIAL
      Materials / textures.

    • SOUND

      public static final GamevalType SOUND
      Sound effects.

    • MIDI

      public static final GamevalType MIDI
      Music tracks.

    • BAS

      public static final GamevalType BAS
      Base animation sets.

  • Method Details

    • values

      public static GamevalType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static GamevalType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • wire

      public String wire()
      The etype key this type is stored under in the index.

    • fromWire

      public static Optional<GamevalType> fromWire(String wire)
      The type for a wire etype key, or empty when unknown.