UserFlagsBitField

bitfield

On this page

UserFlagsBitField is a DiscordLua bitfield representing a Discord resource. Obtain it from a manager, an event payload, or the constructor when one is documented below.

bitfield Module 1.2.4 Source

Constructor

UserFlagsBitField.new(bits)

The class table is callable, so UserFlagsBitField(bits) is the same as .new.

Name	Type	Required	Behavior
`bits`	`any`	required	Passed through to the implementation as written.

lua

local discord = require("discord")
local object = discord.UserFlagsBitField({})

Properties

UserFlagsBitField.bitfield

# readonly

Name: bitfield
Type: any
Access: readonly
Description: Instance field UserFlagsBitField.bitfield. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability: Populated from the Gateway/REST payload or constructor for this UserFlagsBitField.

UserFlagsBitField.flags

# readonly

Name: flags
Type: any
Access: readonly
Description: Instance field UserFlagsBitField.flags. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability: Populated from the Gateway/REST payload or constructor for this UserFlagsBitField.

Methods

UserFlagsBitField.resolve()

# static

Resolve a snowflake, object, or mention to a cached instance.

Signature

UserFlagsBitField.resolve(bits)

Parameters

Name	Type	Required	Behavior
`bits`	`any`	required	Passed through to the implementation as written.

Returns

UserFlagsBitField — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a UserFlagsBitField
UserFlagsBitField.resolve(bits)

Static members

UserFlagsBitField.Flags

Examples

lua

local discord = require("discord")
local object = discord.UserFlagsBitField({})

ActivityFlagsBitField · ApplicationFlagsBitField · AttachmentFlagsBitField · BitField · ChannelFlagsBitField · GuildMemberFlagsBitField · IntentsBitField · InviteFlagsBitField

Version: discord 1.2.4 · runtime 1.0.0