Skip to content

PublicUserFlags


Properties


PublicUserFlags.value : number

Flags combined as a bitfield.



Methods


PublicUserFlags.fromBitfield(value : number) : PublicUserFlags

This method returns a new PublicUserFlags object.

Warning

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

Parameters

  • value: A bitfield.



PublicUserFlags:hasFlag(flag : number) : boolean

This method will check whether the bitfield contains a specific flag.

Tip

You can use Enum.UserPublicFlags to fill out the flag parameter.

Parameters

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



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

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

Tip

You can use Enum.UserPublicFlags to fill out the flag parameter.

Parameters

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



PublicUserFlags:getFlags() : {[number] : number}

This method will return a table of flags that are in the bitfield.