Skip to content

Sticker

Implementation of the Discord Sticker class in Luau

https://discord.com/developers/docs/resources/sticker#sticker-object

Properties

id

Sticker.id  :: string

The unique identifier for this sticker.

packId

Sticker.packId  :: string?

The ID of the sticker pack this sticker belongs to.

name

Sticker.name  :: string

The name of this sticker.

description

Sticker.description  :: string?

The description of this sticker.

tags

Sticker.tags  :: string?

The tags associated with this sticker.

type

Sticker.type  :: apiTypes.StickerType

The type of this sticker.

formatType

Sticker.formatType  :: apiTypes.StickerFormatType

The format type of this sticker.

available

Sticker.available  :: boolean?

Whether this sticker is available for use.

guildId

Sticker.guildId  :: string?

The ID of the guild this sticker belongs to.

user

Sticker.user  :: Classes.User?

The user who uploaded this sticker.

sortValue

Sticker.sortValue  :: number?

The sort value of this sticker within its pack.

Methods

The Sticker instance has no set methods!

Functions

sync

Sticker . sync (

     self: Sticker
     stickerData: apiTypes.StickerObject
)  -> ()

Responsible for syncing data to this sticker object. This is typically called by the API when this object is created or updated.

new

Sticker . new (

     stickerData: apiTypes.StickerObject
)  -> ()

Responsible for constructing this class.