MessageFlags

Represents a message's flags.

Properties

---

Value

A number containing flags combined as a bitfield.

---

Constructors

---

fromBitfield(value)

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

Parameters

• value : number - A bitfield.

---

fromFlags(flags)

Constructs a new MessageFlags instance from a table of flags. Returns a new MessageFlags instance.

Tip

You can use the MessageFlag enum to fill out the flags parameter.

Parameters

• flags : { number } - A table of numbers that represent message flags.

---

Methods

---

HasFlag(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)

This method will toggle 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.

---

GetFlags()

Returns a table of numbers that contain flags found in the bitfield.

---