SetDiscordRichPresenceState: Difference between revisions
Jump to navigation
Jump to search
(Created page with "__NOTOC__ {{Client function}} The function sets own state text on Rich Presence. ==Syntax== <syntaxhighlight lang="lua"> bool setDiscordRichPresenceState(string state) </syntaxhighlight> {{OOP||DiscordRPC:setState}} ===Required arguments=== *'''state''': a string with state name ===Returns=== Returns ''true'' if function succeeds, ''false'' if the client has disabled synchronisation. ==Example== This example prints out if the application was successfully set u...") |
No edit summary |
||
| (8 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 status of the Discord Rich Presence application. | |||
}} | |||
==Syntax== | ==Syntax== | ||
| Line 10: | Line 13: | ||
===Required arguments=== | ===Required arguments=== | ||
*'''state''': a string | *'''state''': a string containing the status 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 set the state 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 | ||
setDiscordRichPresenceState("waiting in lobby") | |||
setDiscordRichPresenceState(" | |||
end | end | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 28: | Line 30: | ||
{{Client_Discord_functions}} | {{Client_Discord_functions}} | ||
[[ar: | [[ar:setDiscordRichPresenceState]] | ||
[[de: | [[de:setDiscordRichPresenceState]] | ||
[[hu: | [[hu:setDiscordRichPresenceState]] | ||
[[pl: | [[pl:setDiscordRichPresenceState]] | ||
[[ro: | [[ro:setDiscordRichPresenceState]] | ||
[[ru: | [[ru:SetDiscordRichPresenceState]] | ||
[[PT-BR: | [[PT-BR:SetDiscordRichPresenceState]] | ||
Latest revision as of 18:35, 24 October 2023
| Important Note: To use this function, you must set up your own application setDiscordApplicationID |
Syntax
bool setDiscordRichPresenceState(string state)
OOP Syntax Help! I don't understand this!
- Method: DiscordRPC:setState(...)
Required arguments
- state: a string containing the status text
Returns
Returns true if function succeeds, false otherwise.
Example
This example shows how to set the state of the Discord Rich Presence application.
local app_id = "YOUR_APPLICATION_ID"
if setDiscordApplicationID(app_id) then
setDiscordRichPresenceState("waiting in lobby")
end