Discord

Inherits: Object

Discord Social SDK integration for RPC rich presence, OAuth, invites, and relationships.

Description

The Discord singleton dynamically loads the Discord Partner SDK library at runtime. Use initialize_presence_only() for auth-less RPC rich presence, or initialize() for the full OAuth social layer (friends, invites, server auth).

Pump run_callbacks() each frame (or rely on the engine frame hook) while the client is active.

Methods

void	accept_activity_invite(invite: Dictionary)
void	accept_discord_friend_request(user_id: int)
void	accept_game_friend_request(user_id: int)
DiscordAuthResult	authenticate_with_server(url: String, access_token: String, client_id: int)
void	block_user(user_id: int)
void	cancel_discord_friend_request(user_id: int)
void	cancel_game_friend_request(user_id: int)
void	clear_debug_log()
void	clear_rich_presence()
void	create_or_join_lobby(secret: String)
String	get_access_token() const
AuthState	get_auth_state() const
ConnectionState	get_connection_state() const
Array	get_debug_log() const
String	get_default_communication_scopes() const
String	get_default_presence_scopes() const
Dictionary	get_game_activity()
String	get_granted_scopes() const
String	get_last_error() const
Dictionary	get_relationship(user_id: int)
Array	get_relationships()
Array	get_relationships_by_group(group: RelationshipGroupType)
int	get_relationships_count() const
String	get_requested_scopes() const
Dictionary	get_user(user_id: int)
int	get_user_id() const
String	get_username() const
Dictionary	get_version() const
Error	initialize(client_id: int = 0)
Error	initialize_presence_only(client_id: int)
bool	is_authorization_pending() const
bool	is_authorized() const
bool	is_available()
bool	is_client_active() const
bool	is_debug_logging_enabled() const
bool	is_frame_hook_connected() const
bool	is_initialized() const
bool	is_presence_only_mode() const
bool	is_ready_for_presence() const
void	refresh_relationships()
bool	register_launch_command(application_id: int, command: String)
bool	register_launch_steam_application(application_id: int, steam_app_id: int)
void	reject_discord_friend_request(user_id: int)
void	reject_game_friend_request(user_id: int)
void	remove_discord_and_game_friend(user_id: int)
void	remove_game_friend(user_id: int)
void	run_callbacks()
void	send_activity_invite(user_id: int, content: String = "")
void	send_activity_join_request(user_id: int)
void	send_activity_join_request_reply(invite: Dictionary)
void	send_discord_friend_request(username: String)
void	send_discord_friend_request_by_id(user_id: int)
void	send_game_friend_request(username: String)
void	send_game_friend_request_by_id(user_id: int)
void	set_debug_logging(enabled: bool)
void	shutdown()
void	unblock_user(user_id: int)
Error	update_rich_presence(activity: Dictionary)

Signals

activity_invite_accepted(join_secret: String) 🔗

Emitted when the local user accepts an activity invite.

activity_invite_created(invite: Dictionary) 🔗

Emitted when a new activity invite is received.

activity_invite_sent() 🔗

Emitted after send_activity_invite() completes successfully.

activity_invite_updated(invite: Dictionary) 🔗

Emitted when an existing activity invite is updated.

activity_join_requested(join_secret: String) 🔗

Emitted when another user requests to join via the Discord client Join button.

authorization_failed(error: String) 🔗

Emitted when OAuth authorization fails.

authorization_started() 🔗

Emitted when OAuth authorization begins and the user must approve access.

authorized() 🔗

Emitted when OAuth authorization succeeds before the client reaches ready state.

connection_state_changed(state: int, error: int, error_detail: int) 🔗

Emitted when the Discord client connection state changes.

lobby_joined(lobby_id: int) 🔗

Emitted when create_or_join_lobby() succeeds.

ready() 🔗

Emitted when Discord is ready for rich presence updates.

relationship_action_completed(action: String, user_id: int, success: bool, error: String) 🔗

Emitted when an OAuth relationship action completes.

relationship_created(user_id: int, is_discord: bool) 🔗

Emitted when a new relationship is created. OAuth only.

relationship_deleted(user_id: int, is_discord: bool) 🔗

Emitted when a relationship is removed. OAuth only.

relationship_groups_updated(user_id: int) 🔗

Emitted when unified friends list groups should be refreshed. OAuth only.

relationships_updated(count: int) 🔗

Emitted when the relationship count is refreshed after connect.

rich_presence_updated(success: bool, error: String) 🔗

Emitted when a rich presence update completes.

user_updated(user_id: int) 🔗

Emitted when a Discord user's profile or status changes. OAuth only.