Class: BitFlags
Defined in: src/sdk/math/BitFlags.ts:4
Utility class for manipulating bit flags.
Constructors
Constructor
new BitFlags():
BitFlags
Returns
BitFlags
Methods
createFlag()
staticcreateFlag(index):number
Defined in: src/sdk/math/BitFlags.ts:11
Generates a bit flag with a boolean value of true at a specified index.
Parameters
| Parameter | Type | Description |
|---|---|---|
index | number | The index of the flag. Must be between 0 and 32, inclusive. |
Returns
number
a bit flag.
Throws
Error if index is out of bounds.
forEach()
staticforEach(flags,callback,valueFilter?,startIndex?,endIndex?):void
Defined in: src/sdk/math/BitFlags.ts:104
Iterates through a bit flag group and executes a callback function once for each flag.
Parameters
| Parameter | Type | Description |
|---|---|---|
flags | number | A bit flag group. |
callback | (value, index, flags) => void | A function which will be called once for each flag. |
valueFilter? | boolean | The value on which to filter. If defined, only flags with values equal to the filter will be iterated, otherwise all flags will be iterated regardless of their values. |
startIndex? | number | The index of the flag at which to start (inclusive). Defaults to 0. |
endIndex? | number | The index of the flag at which to end (exclusive). Defaults to 32. |
Returns
void
intersection()
staticintersection(...flags):number
Defined in: src/sdk/math/BitFlags.ts:50
Gets the intersection of zero or more bit flags.
Parameters
| Parameter | Type | Description |
|---|---|---|
...flags | number[] | A list of bit flags. |
Returns
number
the intersection of the bit flags.
isAll()
staticisAll(flags,conditions):boolean
Defined in: src/sdk/math/BitFlags.ts:91
Checks if a bit flag group meets all the conditions from a list of conditions.
Parameters
| Parameter | Type | Description |
|---|---|---|
flags | number | A bit flag group. |
conditions | number | The conditions to meet, as a bit flag group. |
Returns
boolean
whether the bit flag group meets all the conditions.
isAny()
staticisAny(flags,conditions):boolean
Defined in: src/sdk/math/BitFlags.ts:81
Checks if a bit flag group meets at least one condition from a list of conditions.
Parameters
| Parameter | Type | Description |
|---|---|---|
flags | number | A bit flag group. |
conditions | number | The conditions to meet, as a bit flag group. |
Returns
boolean
whether the bit flag group meets at least one condition.
not()
staticnot(flags,mask):number
Defined in: src/sdk/math/BitFlags.ts:27
Gets the inverse of some bit flags.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
flags | number | undefined | The bit flag group containing the flags to invert. |
mask | number | ~0 | An optional bit mask to use when applying the inverse operation. The operation will only be performed at the indexes where the mask has a value of 1 (true). If a mask is not specified, the operation will be performed at all indexes. |
Returns
number
the inverse
set()
staticset(flags,valuesToSet,mask):number
Defined in: src/sdk/math/BitFlags.ts:71
Changes a bit flag group by setting values at specific indexes.
Parameters
| Parameter | Type | Description |
|---|---|---|
flags | number | The bit flag group to change. |
valuesToSet | number | A bit flag group containing the values to set. |
mask | number | A mask defining the indexes to set. Only indexes at which the mask has a value of 1 (true) will be set. |
Returns
number
The result of changing flags using the specified values and indexes.
union()
staticunion(...flags):number
Defined in: src/sdk/math/BitFlags.ts:36
Gets the union of zero or more bit flags.
Parameters
| Parameter | Type | Description |
|---|---|---|
...flags | number[] | A list of bit flags. |
Returns
number
the union of the bit flags.