Class: MockFlags32

Mock of the X-Ray engine flags32 bit-flags object.

Implements

• flags32

Constructors

Constructor

new MockFlags32(): MockFlags32;

Returns

MockFlags32

Methods

and()

Call Signature

and(source: flags32, mask: number): MockFlags32;

Replace this mask with source & mask.

Parameters

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

Returns

MockFlags32

This mask.

Implementation of

flags32.and

Call Signature

and(mask: number): MockFlags32;

Apply bitwise AND to this mask.

Parameters

Parameter	Type	Description
mask	number	Bits to keep.

Returns

MockFlags32

This mask.

Implementation of

flags32.and

---

assign()

assign(value: number | flags32): MockFlags32;

Copy another flag mask.

Parameters

Parameter	Type	Description
value	number | flags32	Source mask.

Returns

MockFlags32

This mask.

Implementation of

flags32.assign

---

equal()

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

Compare this mask with another mask.

Parameters

Parameter	Type	Description
value	Readonly<flags32>	Mask to compare.
mask?	number	-

Returns

boolean

Whether masks are equal.

Implementation of

flags32.equal

---

get()

get(): number;

Get raw mask value.

Returns

number

Raw mask value.

Implementation of

flags32.get

---

invert()

invert(value?: number | flags32): MockFlags32;

Invert all bits in this mask.

Parameters

Parameter	Type
value?	number | flags32

Returns

MockFlags32

This mask.

Implementation of

flags32.invert

---

is()

Call Signature

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

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

Parameters

Parameter	Type	Description
value	flags32	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.

Implementation of

flags32.is

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.

Implementation of

flags32.is

---

is_any()

Call Signature

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

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

Parameters

Parameter	Type	Description
value	flags32	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().

Implementation of

flags32.is_any

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().

Implementation of

flags32.is_any

---

one()

one(): MockFlags32;

Set all bits.

Returns

MockFlags32

This mask.

Remarks

Sets all 32 bits to 1.

Implementation of

flags32.one

---

or()

Call Signature

or(source: flags32, mask: number): MockFlags32;

Replace this mask with source | mask.

Parameters

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

Returns

MockFlags32

This mask.

Implementation of

flags32.or

Call Signature

or(mask: number): MockFlags32;

Apply bitwise OR to this mask.

Parameters

Parameter	Type	Description
mask	number	Bits to set.

Returns

MockFlags32

This mask.

Implementation of

flags32.or

---

set()

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

Set or clear selected bits.

Parameters

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

Returns

MockFlags32

This mask.

Implementation of

flags32.set

---

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).

Implementation of

flags32.test

---

zero()

zero(): MockFlags32;

Clear all bits.

Returns

MockFlags32

This mask.

Implementation of

flags32.zero

---

create()

static create(value?: number): MockFlags32;

Parameters

Parameter	Type	Default value
value	number	0

Returns

MockFlags32

---

mock()

static mock(value?: number): flags32;

Parameters

Parameter	Type	Default value
value	number	0

Returns

flags32