SetDiscordRichPresenceSmallAsset: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{Important Note|To use this function, you must set up own application [[setDiscordApplicationID]]}} | {{Important Note|To use this function, you must set up your own application [[setDiscordApplicationID]]}} | ||
{{New feature/item|3.0162|1.6.0|22269| | |||
Using this function, you can set the small image asset of the application. The maximum size of assets is ''1024x1024'', the minimum ''512x512''. | |||
}} | |||
==Syntax== | ==Syntax== | ||
| Line 11: | Line 13: | ||
===Required arguments=== | ===Required arguments=== | ||
*'''assetImage''': a string | *'''assetImage''': a string containing the key of the small image asset you uploaded to your application's asset list. | ||
*'''text''': a string | *'''text''': a string containing the hover text of the small image asset. | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if function succeeds, ''false'' | Returns ''true'' if function succeeds, ''false'' otherwise. | ||
==Example== | ==Example== | ||
The example sets the image to my_logo. | The example sets the small image asset to my_logo. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
addCommandHandler("setsmalllogo", | addCommandHandler("setsmalllogo", | ||
Revision as of 01:04, 11 October 2023
| Important Note: To use this function, you must set up your own application setDiscordApplicationID |
Syntax
bool setDiscordRichPresenceSmallAsset(string assetImage, string text)
OOP Syntax Help! I don't understand this!
- Method: DiscordRPC:setSmallAsset(...)
Required arguments
- assetImage: a string containing the key of the small image asset you uploaded to your application's asset list.
- text: a string containing the hover text of the small image asset.
Returns
Returns true if function succeeds, false otherwise.
Example
The example sets the small image asset to my_logo.
addCommandHandler("setsmalllogo",
function ()
if isDiscordRichPresenceConnected() then
setDiscordRichPresenceSmallAsset("my_small_logo", "This is my small logo!")
end
end
)