Overwrite

Implementation of discords Permission Overwrite object as a Luau builder.

See permissions for more information about the allow and deny fields.

https://discord.com/developers/docs/topics/permissions#permissions https://discord.com/developers/docs/resources/channel#overwrite-object

Properties

id

Overwrite.id :: string

The ID of the role or user that the overwrite belongs to.

Methods

The Overwrite instance has no set methods!

Functions

allowPermissions

Overwrite . allowPermissions (

self: Overwrite
...: apiTypes.Permissions
) -> ()

Responsible for allowing specific permissions to be set on either a Role of a Member.

denyPermissions

Overwrite . denyPermissions (

self: Overwrite
...: apiTypes.Permissions
) -> ()

Responsible for denying specific permissions to be set on either a Role of a Member.

setPermissionType

Overwrite . setPermissionType (

self: Overwrite
type: PermissionOverwriteType
) -> ()

Sets the permission type for this builder.

build

Overwrite . build (

self: Overwrite
) -> ()

Responsible for building the OverwriteObject JSON that can be parsed by the Discord API.

new

Overwrite . new (

     resource: {
       permissionType: PermissionOverwriteType,
       allowFlags: { apiTypes.Permissions,
    }
) -> ()

Responsible for creating a new Overwrite.

fromId

Overwrite . fromId (

     resource: {
       permissionId: apiTypes.Snowflake,
       permissionType: PermissionOverwriteType,
       allowFlags: { apiTypes.Permissions,
    }
) -> ()

Responsible for creating a new Overwrite from an existing ID/Object.

Supports properties that the .new constructor doesn’t support. (id)