Skip to content

BaseFlags

A base class for any flags.


Properties



Value

A number containing flags combined as a bitfield.




Constructors



fromBitfield(value)

Constructs a new BaseFlags instance from a bitfield. Returns a new BaseFlags instance.

Internal Code warning

This method is not meant to be used outside of Voyager's internal code.

Parameters

  • value : number - A bitfield.




Methods


HasFlag(flag)

Checks whether the bitfield contains a flag. Returns a boolean that represents whether the bitfield contains the flag.

Parameters

  • flag : number - The flag that'll be looked for.




SetFlag(flag, toggle)

Toggles a flag in the bitfield either to true or false. Returns nil.

Parameters

  • flag : number - A flag.
  • toggle : boolean - Whether to add or remove the flag from the bitfield.