class Discord (client-side)
Available since version: 0.3.0
This class exposes static methods for updating the user's Discord activity from the game client.
Properties
No properties.
Methods
static setActivity
This function updates the Discord Rich Presence activity. Missing fields keep their last-set values.
void setActivity({...} Activity)
Parameters:
{...}Activity: configuration table.
static setState
This function will update the activity state text.
void setState(string state)
Parameters:
stringstate:
static setDetails
This function will update the activity details text.
void setDetails(string details)
Parameters:
stringdetails:
static setLargeImage
This function will update the large image entry for the activity.
void setLargeImage(string key, string text)
Parameters:
stringkey: Asset key for the large image.stringtext: Optional tooltip text for the large image.
static setSmallImage
This function will update the small image entry for the activity.
void setSmallImage(string key, string text)
Parameters:
stringkey: Asset key for the small image.stringtext: Optional tooltip text for the small image.
static clearActivity
This function will clear the current activity and stored values.
void clearActivity()
Callbacks
No callbacks.