VarType¶

Overview¶

A VarType config contains information about one of variables used by the game.

Variables belong to one of several different domains, such as:

All domain types other than VarClient exist on the server.

Variables can be one of many different value types:

• Integer (32-bit)
• Long (64-bit)
• String
• CoordGrid
• NPCType, LocType, etc config
• and more

See ValueType for a full list of all supported types.

These config types can be found within the var table, and then further within the domain sub-table:

var.VarClient.TOOLTIP_TIME
var.VarPlayer["COMBATV2_MELEE_DEFENCE"]
var.VarPlayer.FromID(456) -- var.VarPlayer.OPTION_CHAT

VarBit¶

The default data type for a variable is a 32-bit Integer, which allows for values from -2147483648 to 2147483647.
Some variables do not need this much value range, meaning that much of the underlying data space is wasted.

To improve efficiency, several VarBits can share one variable data space.
A VarBit reserves a sub-section of its base variable, using only the data it needs.

Below is an example of several VarBits sharing one base variable.

VarBit1 uses 8 bits (varBitMask = 255, 0xFF, 0b11111111), making its value range 0 -> 255
VarBit2 uses 5 bits (varBitMask = 7936, 0x1F00, 0b1111100000000), making its value range 0 -> 31
VarBit3 uses 12 bits (varBitMask = 1073479680, 0x3FFC0000, 0b111111111111000000000000000000), making its value range 0 -> 4095

VarBit values can only be positive (unsigned) Integers.
As shown, VarBits do not need to be contiguous, i.e. gaps can be left between the bits they use.

When a VarBit value is changed, it changes the data in the underlying base variable.
Additionally, when the base variable is changed, it can change the value of any VarBits that use it. This is often used to reset a number of VarBits at the same time.

    id.VarPlayer.OPTION_TOGGLE1 -- ID: 5967
    id.VarPlayer.FRIEND_SORT_MODE -- ID: -30174, uses bits 3-5 of VarPlayer.OPTION_TOGGLE1

Enumerations¶

ValueType¶

A list of all the possible value types and the data type they correspond to.

Examples¶

-- Access a VarType directly by using its name
local sortVar = var.VarPlayer.FRIEND_SORT_MODE
-- or by ID lookup
local sortVar = var.VarPlayer.FromID(id.VarPlayer.FRIEND_SORT_MODE)

-- Obtain the value and value type using
local sortValueType = sortVar.valueType
local sortMode = sortVar.value
-- or
local sortValueType = var.VarPlayer.FRIEND_SORT_MODE.valueType
local sortMode = var.VarPlayer.FRIEND_SORT_MODE.value

Constructors¶

Properties¶