SetDiscordRichPresencePartySize: Difference between revisions
Jump to navigation
Jump to search
(Created page with "__NOTOC__ {{Client function}} {{Important Note|To use this function, you must set up your own application setDiscordApplicationID}} {{Note|For the party size to be displayed, the state must be set setDiscordRichPresenceState}} {{New feature/item|3.0161|1.6.0|22270| This function sets the party size of Discord Rich Presence. }} ==Syntax== <syntaxhighlight lang="lua"> bool setDiscordRichPresencePartySize(int size, int max) </syntaxhighlight> {{OOP||DiscordRPC...") |
No edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
{{Important Note|To use this function, you must set up your own application [[setDiscordApplicationID]]}} | {{Important Note|To use this function, you must set up your own application [[setDiscordApplicationID]]}} | ||
{{Note|For the party size to be displayed, the state must be set [[setDiscordRichPresenceState]]}} | {{Note|For the party size to be displayed, the state must be set [[setDiscordRichPresenceState]]}} | ||
{{New feature/item|3.0161|1.6.0| | {{New feature/item|3.0161|1.6.0|22276| | ||
This function sets the party size of Discord Rich Presence. | This function sets the party size of Discord Rich Presence. | ||
}} | }} | ||
| Line 16: | Line 16: | ||
*'''size''': an integer representing the current party size. | *'''size''': an integer representing the current party size. | ||
*'''max''': an integer representing the maximum party size. | *'''max''': an integer representing the maximum party size. | ||
'''If both values are 0, the party size will not be displayed''' | |||
===Returns=== | ===Returns=== | ||
| Line 23: | Line 25: | ||
This example shows how to change the party size of the Discord Rich Presence application. | This example shows how to change the party size 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("In-game") | setDiscordRichPresenceState("In-game") | ||
setDiscordRichPresencePartySize(1, 32) | setDiscordRichPresencePartySize(1, 32) | ||
Latest revision as of 18:35, 24 October 2023
| Important Note: To use this function, you must set up your own application setDiscordApplicationID |
| Note: For the party size to be displayed, the state must be set setDiscordRichPresenceState |
Syntax
bool setDiscordRichPresencePartySize(int size, int max)
OOP Syntax Help! I don't understand this!
- Method: DiscordRPC:setPartySize(...)
Required arguments
- size: an integer representing the current party size.
- max: an integer representing the maximum party size.
If both values are 0, the party size will not be displayed
Returns
Returns true if function succeeds, false otherwise.
Example
This example shows how to change the party size of the Discord Rich Presence application.
local app_id = "YOUR_APPLICATION_ID"
if setDiscordApplicationID(app_id) then
setDiscordRichPresenceState("In-game")
setDiscordRichPresencePartySize(1, 32)
end