bit.band Synchronous

Keep only bits present in every supplied 32-bit value. A mask is a common way to test or clear named flags in a packed integer.

Syntax

Luau

bit.band(...values: any) -> number

Parameters

Function parameters
Parameter	Type	Description
`...values`	`any`	Values to process in order. Finite numbers are truncated to unsigned 32-bit integers; nonnumeric and nonfinite values are skipped.

Returns

number

An unsigned 32-bit result represented as a Luau number.

Usage notes

Arithmetic wraps at 32 bits. With no valid numeric arguments the result is 0, including for AND and multiplication.

Differences from Volt

Volt documents its Bit Library setting as disabled by default. Kawaii enables bit by default. Disabling the setting removes the bit global and makes retained function references reject calls.

Availability

Bit is enabled by default. The bit global is removed when disabled, and its operations check the setting.

Example

Luau

local flags = 0x2D
print(bit.band(flags, 0x08) ~= 0) -- true