From 9d5b0be992deb474d01cecf6d8b796020c350357 Mon Sep 17 00:00:00 2001 From: Infiland Date: Tue, 1 Sep 2026 17:03:46 +0200 Subject: [PATCH] Document Networking Messages state-change event --- docs/networking_messages.js | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/networking_messages.js b/docs/networking_messages.js index 9fb308b5..77fdf306 100644 --- a/docs/networking_messages.js +++ b/docs/networking_messages.js @@ -10,6 +10,8 @@ * * * `steam_net_message_on_session_request` * * `steam_net_message_on_session_failed` + * + * Networking Messages establishes its underlying connections implicitly. Those connections can also emit `steam_net_message_on_state_change` events through the extension's shared Networking Sockets connection-status callback. That callback is separate from the callbacks registered by this function. * * @returns {bool} * @@ -40,6 +42,16 @@ * @member {string} description Debug description. This includes the connection handle, connection type (and peer information), and the app name. This string is used in various internal logging messages. * @member {string} debug Human-readable, but non-localized explanation for connection termination or problem. This is intended for debugging / diagnostic purposes only, not to display to users. It might have some details specific to the issue. * @event_end + * + * @event steam + * @desc This event is triggered whenever a connection established implicitly by Networking Messages is created, destroyed, or changes state. It is emitted by the extension's shared Networking Sockets connection-status callback. + * @member {string} event_type The string `"steam_net_message_on_state_change"` + * @member {real} connection The connection handle + * @member {constant.steam_net_connection_state} state The current state + * @member {constant.steam_net_connection_state} old_state The previous state + * @member {real} end_reason The end reason (one of [ESteamNetConnectionEnd](https://partner.steamgames.com/doc/api/steamnetworkingtypes#ESteamNetConnectionEnd)) + * @member {string} debug A debug message + * @event_end * * @func_end */ @@ -188,4 +200,4 @@ * @section_end * * @module_end - */ \ No newline at end of file + */