PermissionsBitField
bitfieldOn this page
PermissionsBitField is a DiscordLua bitfield representing a Discord resource. Obtain it from a manager, an event payload, or the constructor when one is documented below.
Constructor
PermissionsBitField.new(bits) The class table is callable, so PermissionsBitField(bits) is the same as .new.
| Name | Type | Required | Behavior |
|---|---|---|---|
bits |
any |
required | Passed through to the implementation as written. |
local discord = require("discord")
local object = discord.PermissionsBitField({})Properties
- Name
bitfield- Type
any- Access
- readonly
- Description
- Instance field
PermissionsBitField.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 PermissionsBitField.
- Name
flags- Type
any- Access
- readonly
- Description
- Instance field
PermissionsBitField.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 PermissionsBitField.
Methods
PermissionsBitField:any()
#Performs any on this PermissionsBitField. Call it from bot code when you need that operation on the current object.
Signature
PermissionsBitField:any(bit, checkAdmin) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
bit |
any |
required | Passed through to the implementation as written. |
checkAdmin |
any |
required | Passed through to the implementation as written. |
Returns
PermissionsBitField — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a PermissionsBitField
object:any(bit, checkAdmin)PermissionsBitField:has()
#Performs has on this PermissionsBitField. Call it from bot code when you need that operation on the current object.
Signature
PermissionsBitField:has(bit, checkAdmin) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
bit |
any |
required | Passed through to the implementation as written. |
checkAdmin |
any |
required | Passed through to the implementation as written. |
Returns
PermissionsBitField — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a PermissionsBitField
object:has(bit, checkAdmin)PermissionsBitField:missing()
#Performs missing on this PermissionsBitField. Call it from bot code when you need that operation on the current object.
Signature
PermissionsBitField:missing(bit, checkAdmin) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
bit |
any |
required | Passed through to the implementation as written. |
checkAdmin |
any |
required | Passed through to the implementation as written. |
Returns
PermissionsBitField — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a PermissionsBitField
object:missing(bit, checkAdmin)Resolve a snowflake, object, or mention to a cached instance.
Signature
PermissionsBitField.resolve(bits) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
bits |
any |
required | Passed through to the implementation as written. |
Returns
PermissionsBitField — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a PermissionsBitField
PermissionsBitField.resolve(bits)PermissionsBitField:toArray()
#Performs to array on this PermissionsBitField. Call it from bot code when you need that operation on the current object.
Signature
PermissionsBitField:toArray() Parameters
No parameters.
Returns
PermissionsBitField — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a PermissionsBitField
object:toArray()Static members
-
PermissionsBitField.All -
PermissionsBitField.Default -
PermissionsBitField.Flags -
PermissionsBitField.StageModerator
Examples
local discord = require("discord")
local object = discord.PermissionsBitField({})Related APIs
ActivityFlagsBitField · ApplicationFlagsBitField · AttachmentFlagsBitField · BitField · ChannelFlagsBitField · GuildMemberFlagsBitField · IntentsBitField · InviteFlagsBitField
Version: discord 1.2.4 · runtime 1.0.0