SetDiscordRichPresenceDetails: Difference between revisions
Jump to navigation
Jump to search
(Created page with "__NOTOC__ {{Client function}} The function sets own details text on Rich Presence. ==Syntax== <syntaxhighlight lang="lua"> bool setDiscordRichPresenceDetails(string details) </syntaxhighlight> {{OOP||DiscordRPC:setDetails}} ===Required arguments=== *'''details''': a string with details name ===Returns=== Returns ''true'' if function succeeds, ''false'' if the client has disabled synchronisation. ==Example== This example prints out if the application was succes...") |
No edit summary |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{Important Note|To use this function, you must set up your own application [[setDiscordApplicationID]]}} | |||
{{New feature/item|3.0161|1.6.0|22270| | |||
This function sets the details text of Discord Rich Presence. | |||
}} | |||
==Syntax== | ==Syntax== | ||
| Line 10: | Line 13: | ||
===Required arguments=== | ===Required arguments=== | ||
*'''details''': a string | *'''details''': a string containing the details text | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if function succeeds, ''false'' | Returns ''true'' if function succeeds, ''false'' otherwise. | ||
==Example== | ==Example== | ||
This example | This example shows how to change the state and details of the Discord Rich Presence application. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
local | local app_id = "YOUR_APPLICATION_ID" | ||
if setDiscordApplicationID( | if setDiscordApplicationID(app_id) then | ||
local name = getPlayerName(localPlayer) | local name = getPlayerName(localPlayer) | ||
setDiscordRichPresenceState("In-game") | setDiscordRichPresenceState("In-game") | ||
Latest revision as of 18:36, 24 October 2023
| Important Note: To use this function, you must set up your own application setDiscordApplicationID |
Syntax
bool setDiscordRichPresenceDetails(string details)
OOP Syntax Help! I don't understand this!
- Method: DiscordRPC:setDetails(...)
Required arguments
- details: a string containing the details text
Returns
Returns true if function succeeds, false otherwise.
Example
This example shows how to change the state and details of the Discord Rich Presence application.
local app_id = "YOUR_APPLICATION_ID"
if setDiscordApplicationID(app_id) then
local name = getPlayerName(localPlayer)
setDiscordRichPresenceState("In-game")
setDiscordRichPresenceDetails("currently as "..name)
end