Class: flags16

Mutable 16-bit flag mask.

Source

C++ class flags16

Custom Constructor

flags16

Remarks

Use zero(), one(), or assign() when you need an explicit initial state.

Constructors

Constructor

new flags16(): flags16;

Create a flag mask.

Returns

flags16

Methods

and()

Call Signature

and(source: flags16, mask: number): flags16;

Replace this mask with source & mask.

Parameters

Parameter	Type	Description
source	flags16	Source mask.
mask	number	Bits to keep.

Returns

flags16

This mask.

Call Signature

and(mask: number): flags16;

Apply bitwise AND to this mask.

Parameters

Parameter	Type	Description
mask	number	Bits to keep.

Returns

flags16

This mask.

---

assign()

Call Signature

assign(value: flags16): flags16;

Copy another flag mask.

Parameters

Parameter	Type	Description
value	flags16	Source mask.

Returns

flags16

This mask.

Call Signature

assign(value: number): flags16;

Replace this mask with a raw value.

Parameters

Parameter	Type	Description
value	number	Raw mask value.

Returns

flags16

This mask.

---

equal()

Call Signature

equal(value: Readonly<flags16>): boolean;

Compare this mask with another mask.

Parameters

Parameter	Type	Description
value	Readonly<flags16>	Mask to compare.

Returns

boolean

Whether masks are equal.

Call Signature

equal(value: Readonly<flags16>, mask: number): boolean;

Compare selected bits with another mask.

Parameters

Parameter	Type	Description
value	Readonly<flags16>	Mask to compare.
mask	number	Bits to compare.

Returns

boolean

Whether selected bits are equal.

---

get()

get(): number;

Get raw mask value.

Returns

number

Raw mask value.

---

invert()

Call Signature

invert(): flags16;

Invert all bits in this mask.

Returns

flags16

This mask.

Call Signature

invert(value: flags16): flags16;

Replace this mask with inverted source mask.

Parameters

Parameter	Type	Description
value	flags16	Source mask.

Returns

flags16

This mask.

Call Signature

invert(value: number): flags16;

Toggle selected bits in this mask.

Parameters

Parameter	Type	Description
value	number	Bits to toggle.

Returns

flags16

This mask.

---

is()

Call Signature

is(value: flags16, mask: number): boolean;

Check whether all selected bits are set in a source mask.

Parameters

Parameter	Type	Description
value	flags16	Source mask.
mask	number	Bits to test.

Returns

boolean

Whether all bits are set.

Remarks

This is stricter than is_any() and test(): every bit from mask must be present.

Call Signature

is(mask: number): boolean;

Check whether all selected bits are set in this mask.

Parameters

Parameter	Type	Description
mask	number	Bits to test.

Returns

boolean

Whether all bits are set.

Remarks

This is stricter than is_any() and test(): every bit from mask must be present.

---

is_any()

Call Signature

is_any(value: flags16, mask: number): boolean;

Check whether any selected bit is set in a source mask.

Parameters

Parameter	Type	Description
value	flags16	Source mask.
mask	number	Bits to test.

Returns

boolean

Whether any bit is set.

Remarks

Use this for overlap checks. For an all-bits check, use is().

Call Signature

is_any(mask: number): boolean;

Check whether any selected bit is set in this mask.

Parameters

Parameter	Type	Description
mask	number	Bits to test.

Returns

boolean

Whether any bit is set.

Remarks

Use this for overlap checks. For an all-bits check, use is().

---

one()

one(): flags16;

Set all bits.

Returns

flags16

This mask.

Remarks

Sets all 16 bits to 1.

---

or()

Call Signature

or(source: flags16, mask: number): flags16;

Replace this mask with source | mask.

Parameters

Parameter	Type	Description
source	flags16	Source mask.
mask	number	Bits to set.

Returns

flags16

This mask.

Call Signature

or(mask: number): flags16;

Apply bitwise OR to this mask.

Parameters

Parameter	Type	Description
mask	number	Bits to set.

Returns

flags16

This mask.

---

set()

set(mask: number, enabled: boolean): flags16;

Set or clear selected bits.

Parameters

Parameter	Type	Description
mask	number	Bits to update.
enabled	boolean	Whether bits should be set.

Returns

flags16

This mask.

---

test()

test(mask: number): boolean;

Test whether any selected bit is set.

Parameters

Parameter	Type	Description
mask	number	Bits to test.

Returns

boolean

Whether any selected bit is set.

Remarks

Equivalent to is_any(mask).

---

zero()

zero(): flags16;

Clear all bits.

Returns

flags16

This mask.