Skip to content

BaseFlags


Properties


BaseFlags.value : number

Flags combined as a bitfield.



Methods


BaseFlags.fromBitfield(value : number) : BaseFlags

This method returns a new BaseFlags object.

Warning

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

Parameters

  • value: Default bitfield.



BaseFlags:hasFlag(flag : number) : boolean

This method will check whether the bitfield contains the passed flag.

Parameters

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



BaseFlags:setFlag(flag : number, toggle : boolean) : nil

This method will toggle a flag in the bitfield either to true or false.

Parameters

  • flag: A flag.
  • toggle: If true the flag will be added to bitfield, otherwise the flag will be removed from the bitfield.