RichPresenceAssets
ClassOn this page
RichPresenceAssets is a DiscordLua class representing a Discord resource. Obtain it from a manager, an event payload, or the constructor when one is documented below.
Properties
- Name
activity- Type
any- Access
- readonly
- Description
- Instance field
RichPresenceAssets.activity. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RichPresenceAssets.
- Name
largeImage- Type
any- Access
- readonly
- Description
- Instance field
RichPresenceAssets.largeImage. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RichPresenceAssets.
- Name
largeText- Type
any- Access
- readonly
- Description
- Instance field
RichPresenceAssets.largeText. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RichPresenceAssets.
- Name
raw- Type
any- Access
- readonly
- Description
- Instance field
RichPresenceAssets.raw. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RichPresenceAssets.
- Name
smallImage- Type
any- Access
- readonly
- Description
- Instance field
RichPresenceAssets.smallImage. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RichPresenceAssets.
- Name
smallText- Type
any- Access
- readonly
- Description
- Instance field
RichPresenceAssets.smallText. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RichPresenceAssets.
Methods
RichPresenceAssets:largeImageURL()
#Performs large image url on this RichPresenceAssets. Call it from bot code when you need that operation on the current object.
Signature
RichPresenceAssets:largeImageURL(options) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
options |
table |
optional | Lua option table. Field names match the corresponding DiscordLua option type when one exists. |
Returns
RichPresenceAssets — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a RichPresenceAssets
object:largeImageURL({})RichPresenceAssets:smallImageURL()
#Performs small image url on this RichPresenceAssets. Call it from bot code when you need that operation on the current object.
Signature
RichPresenceAssets:smallImageURL(options) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
options |
table |
optional | Lua option table. Field names match the corresponding DiscordLua option type when one exists. |
Returns
RichPresenceAssets — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a RichPresenceAssets
object:smallImageURL({})Examples
Obtain this object from a manager, wrap helper, or event payload — it is not constructed directly in typical bot code.
Related APIs
ActionRow · Activity · ActivityInstance · ActivityLocation · AnonymousGuild · ApplicationCommand · ApplicationRoleConnectionMetadata · Attachment
Version: discord 1.2.4 · runtime 1.0.0