gamepad_hat_value

With this function you can get the current value of a gamepad "hat". The returned hat value is a bitmask for the different directions where:

• Up = 1 (binary 0b0001)
• Right = 2 (binary 0b0010)
• Down = 4 (binary 0b0100)
• Left = 8 (binary 0b1000)

Note that these can be combined; e.g. a hat value of 3 would be checking up and right (the sum of 1 and 2). You can also use the bitwise operator |to combine the values of various directions to get the same result, e.g. 0b0001 | 0b0010. A value of 0 means no direction is set.

NOTE Only values where at most 2 bits are set can be returned (e.g. a value of 7 will never be returned because it is impossible to press up (1), right (2) and down (4) all at the same time).

NOTE This function also returns a bitmask for gamepads that support analog input for hats.

Syntax:

gamepad_hat_value(device, hatindex);

Returns:

Real (hat value as a bitmask)

Example:

var _dir = gamepad_hat_value(global.PadIndex, 0);
switch (_dir)
{
    case 1: y -= 3; break;
    case 2: x += 3; break;
    case 3: y -= 3; x += 3; break;
    case 4: x -= 3; break;
    case 6: y += 3; x += 3; break;
    case 8: y += 3; break;
    case 9: y -= 3; x -= 3; break;
    case 12: y += 3; x -= 3; break;
}

The above code stores the state of the hat with index 0 on gamepad device slot global.PadIndex in a local variable _dir, then checks to see what the returned hat value is and acts accordingly.