SetDiscordRichPresenceState: Difference between revisions

From Multi Theft Auto: Wiki
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
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
The function sets own state text on Rich Presence.
The function sets own status text on Rich Presence.


==Syntax==  
==Syntax==  
Line 10: Line 10:


===Required arguments===
===Required arguments===
*'''state''': a string with state name
*'''state''': a string with status name


===Returns===
===Returns===

Revision as of 19:51, 10 October 2023

The function sets own status text on Rich Presence.

Syntax

bool setDiscordRichPresenceState(string state)

OOP Syntax Help! I don't understand this!

Method: DiscordRPC:setState(...)


Required arguments

  • state: a string with status 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 up and set custom asset image.

local app_key = "YOUR_APPLICATION_KEY"
if setDiscordApplicationID(app_key) then 
    local name = getPlayerName(localPlayer)
    setDiscordRichPresenceState("currently as "..name)
end 

See Also

ADDED/UPDATED IN VERSION 1.6.0 r22342: