Class BitMask<T>

Bit Masker utility class.

Type Parameters

T

Hierarchy

BitMask

Index

Constructors

Properties

Methods

_get _set asArray asIndexArray fromIndexArray get set

Constructors

constructor

new BitMask<T>(value?: number, bits?: T[]): BitMask<T>
Type Parameters
- T
Parameters
- value: number = 0
  
  The current value of the bit mask, defaults to 0
- bits: T[] = []
  
  The array of names to use e.g. ['canOpen', 'canClose']
Returns BitMask<T>
- Defined in classes/bit-mask.ts:16

Properties

bits

bits: T[]

value

value: number

The current value of the mask

Methods

_get

_get(bit: number): boolean
Parameters
- bit: number
Returns boolean
- Defined in classes/bit-mask.ts:21

_set

_set(bit: number, value: boolean): void
Parameters
- bit: number
- value: boolean
Returns void
- Defined in classes/bit-mask.ts:25

asArray

asArray(): T[]
Returns T[]
- Defined in classes/bit-mask.ts:64

asIndexArray

asIndexArray(): number[]
Returns an array of indexes in the bits array that are currently true.

Returns number[]
- Defined in classes/bit-mask.ts:73

fromIndexArray

fromIndexArray(indexs: number[]): void
Sets all values in the mask to true if they are in the array and false if they are not.
Parameters
- indexs: number[]
  
  An array of indexes in the bits array that need to be true.1
Returns void
- Defined in classes/bit-mask.ts:84

get

get(name: T): boolean
Checks the given bit name for its boolean value.
Parameters
- name: T
  
  The name of the bit to check. e.g. canOpen
Returns boolean
- Defined in classes/bit-mask.ts:40

set

set(name: T, value: boolean): void
Sets the given bit to the supplied value.
Parameters
- name: T
  
  The name of the bit to set e.g. canClose
- value: boolean
  
  The boolean value to set it to.
Returns void
- Defined in classes/bit-mask.ts:56

Generated using TypeDoc