Skip to content

MessageFlags


Properties


MessageFlags.value : number

Flags combined as a bitfield.



Methods


MessageFlags.fromBitfield(value : number) : MessageFlags

This method returns a new MessageFlags object.

Parameters:

  • value: Default bitfield.



MessageFlags.fromFlags(flags : {number}) : MessageFlags

This method returns a new MessageFlags object from a table of flags.

Tip

You can use Enum.MessageFlags to fill out the flags parameter.

Parameters

  • flags: A table of message flags.



MessageFlags:hasFlag(flag : number) : boolean

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

Tip

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

Parameters

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



MessageFlags: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.MessageFlags 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.



MessageFlags:getFlags() : { number }

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