GetPlayerDiscordPresence: Difference between revisions
Document upcoming 0.1.9 Discord Rich Presence: server Lua functions, callback, opt-in and owner setup; not a release |
Release 0.1.9 / BUILD264 / Protocol42: availability and download setup; preserve experimental limits |
||
| Line 1: | Line 1: | ||
= getPlayerDiscordPresence = | = getPlayerDiscordPresence = | ||
'''Available from 0.1.9 | '''Available from 0.1.9. Use matching updated clients and server.''' | ||
'''Server-side only.''' Part of [[Discord Rich Presence]]. See [[Discord Presence configuration]] for the optional server-owner resource. | '''Server-side only.''' Part of [[Discord Rich Presence]]. See [[Discord Presence configuration]] for the optional server-owner resource. | ||
Latest revision as of 13:27, 20 October 2026
getPlayerDiscordPresence
Available from 0.1.9. Use matching updated clients and server.
Server-side only. Part of Discord Rich Presence. See Discord Presence configuration for the optional server-owner resource.
Syntax
local profile = getPlayerDiscordPresence(playerId)
Parameters and behavior
Numeric game player ID. Reads a copy of the currently requested server profile (not Discord's public display), including read-only applicationId and owner strings. Can inspect the owner of another resource's profile. Modifying the returned table does not change server state.
Returns
Fields table plus metadata, or nil if there is no active profile / the player is invalid or offline. Do not pass owner or applicationId back to set/update: they are not writable profile fields.
Examples, lifecycle and safety
See Discord Rich Presence for complete initialization, location/job updates, field removal, timestamps, counts, buttons and callback examples. Player launcher opt-in is off by default and cannot be overridden. No bot or token is needed; no Discord account identity is returned. Do not forward arbitrary client input to this server API.