connected-spaces-platform.web 6.14.0 → 6.16.0

package/connectedspacesplatform.d.ts

@@ -103,7 +103,6 @@ export declare namespace Common {
     enum ESequenceUpdateType {
         Create = 0,
         Update = 1,
-        Rename = 2,
         Delete = 3,
         Invalid = 4
     }
@@ -421,7 +420,11 @@ export declare namespace Multiplayer {
         ON_OBJECT_MESSAGE = 14,
         ON_OBJECT_PATCH = 15,
         ON_REQUEST_TO_SEND_OBJECT = 16,
-        ON_REQUEST_TO_DISCONNECT = 17
+        ON_REQUEST_TO_DISCONNECT = 17,
+        SEND_SCOPE_LEADER_HEARTBEAT = 18,
+        ASSUME_SCOPE_LEADERSHIP = 19,
+        ON_ELECTED_SCOPE_LEADER = 20,
+        ON_VACATED_AS_SCOPE_LEADER = 21
     }
 }
 export declare namespace Multiplayer {
@@ -5911,6 +5914,8 @@ export declare namespace Systems {
         set scopeId(value: string);
         get scopeLeaderUserId(): string;
         set scopeLeaderUserId(value: string);
+        get scopeClientId(): bigint;
+        set scopeClientId(value: bigint);
         get electionInProgress(): boolean;
         set electionInProgress(value: boolean);
     }
@@ -6734,6 +6739,16 @@ export declare namespace Multiplayer {
          * @param callback - The callback to execute.
          */
         setScriptLeaderReadyCallback(callback: (arg1: boolean) => void): void;
+        /**
+         * @description Binds the provided callback to receive events when a new scope leader has been elected.
+         * @param callback - Fired when a new scope leader is elected.
+         */
+        setOnElectedScopeLeaderCallback(callback: (scopeId: string, userId: string) => void): void;
+        /**
+         * @description Binds the provided callback to receive events when a scope leader has been vacated.
+         * @param callback - Fired when a scope leader is vacated.
+         */
+        setOnVacatedAsScopeLeaderCallback(callback: (scopeId: string, userId: string) => void): void;
         /**
          * @description Sets the script owner for the given entity to the current client
          * @param entity - A pointer to the entity
@@ -6745,6 +6760,7 @@ export declare namespace Multiplayer {
         enableLeaderElection(): void;
         /**
          * @description Disable Leader Election feature.
+        @pre SpaceSystem::EnterSpace should be called first for this to take affect.
          */
         disableLeaderElection(): void;
         /**
@@ -6754,6 +6770,7 @@ export declare namespace Multiplayer {
         isLeaderElectionEnabled(): boolean;
         /**
          * @description Debug helper to get the id of the currently elected script leader.
+         * This should be updated when we fully support scopes. We will need to pass in the scopeId we want the leader for.
          * @return The id of the leader.
          */
         getLeaderId(): bigint;

package/connectedspacesplatform.js

@@ -2077,7 +2077,6 @@ export var Common;
     (function (ESequenceUpdateType) {
         ESequenceUpdateType[ESequenceUpdateType["Create"] = 0] = "Create";
         ESequenceUpdateType[ESequenceUpdateType["Update"] = 1] = "Update";
-        ESequenceUpdateType[ESequenceUpdateType["Rename"] = 2] = "Rename";
         ESequenceUpdateType[ESequenceUpdateType["Delete"] = 3] = "Delete";
         ESequenceUpdateType[ESequenceUpdateType["Invalid"] = 4] = "Invalid";
     })(ESequenceUpdateType = Common.ESequenceUpdateType || (Common.ESequenceUpdateType = {}));
@@ -2415,6 +2414,10 @@ export var Systems;
         MultiplayerHubMethod[MultiplayerHubMethod["ON_OBJECT_PATCH"] = 15] = "ON_OBJECT_PATCH";
         MultiplayerHubMethod[MultiplayerHubMethod["ON_REQUEST_TO_SEND_OBJECT"] = 16] = "ON_REQUEST_TO_SEND_OBJECT";
         MultiplayerHubMethod[MultiplayerHubMethod["ON_REQUEST_TO_DISCONNECT"] = 17] = "ON_REQUEST_TO_DISCONNECT";
+        MultiplayerHubMethod[MultiplayerHubMethod["SEND_SCOPE_LEADER_HEARTBEAT"] = 18] = "SEND_SCOPE_LEADER_HEARTBEAT";
+        MultiplayerHubMethod[MultiplayerHubMethod["ASSUME_SCOPE_LEADERSHIP"] = 19] = "ASSUME_SCOPE_LEADERSHIP";
+        MultiplayerHubMethod[MultiplayerHubMethod["ON_ELECTED_SCOPE_LEADER"] = 20] = "ON_ELECTED_SCOPE_LEADER";
+        MultiplayerHubMethod[MultiplayerHubMethod["ON_VACATED_AS_SCOPE_LEADER"] = 21] = "ON_VACATED_AS_SCOPE_LEADER";
     })(MultiplayerHubMethod = Multiplayer.MultiplayerHubMethod || (Multiplayer.MultiplayerHubMethod = {}));
 })(Multiplayer || (Multiplayer = {}));
 (function (Multiplayer) {
@@ -14901,6 +14904,16 @@ export class CSPFoundation {
         set scopeLeaderUserId(value) {
             Module.ccall("csp_systems_ScopeLeader__Set_ScopeLeaderUserId", "void", ["number", "string"], [this.pointer, value]);
         }
+        get scopeClientId() {
+            let _result = Module.ccall("csp_systems_ScopeLeader__Get_ScopeClientId", "bigint", ["number"], [this.pointer]);
+            const _unfixedValue = _result;
+            let _fixedValue = _unfixedValue < 0 ? _unfixedValue + 2n ** 64n : _unfixedValue;
+            _result = _fixedValue;
+            return _result;
+        }
+        set scopeClientId(value) {
+            Module.ccall("csp_systems_ScopeLeader__Set_ScopeClientId", "void", ["number", "bigint"], [this.pointer, value]);
+        }
         get electionInProgress() {
             let _result = Module.ccall("csp_systems_ScopeLeader__Get_ElectionInProgress", "boolean", ["number"], [this.pointer]);
             return _result;
@@ -17100,6 +17113,48 @@ export class CSPFoundation {
             var _callbackPtr = Module.addFunction(_callback, "vii");
             Module.ccall("csp_multiplayer_OnlineRealtimeEngine_SetScriptLeaderReadyCallback_void_CallbackHandler", "void", ["number", "number", "number"], [this.pointer, _callbackPtr, 0]);
         }
+        /**
+         * @description Binds the provided callback to receive events when a new scope leader has been elected.
+         * @param callback - Fired when a new scope leader is elected.
+         */
+        setOnElectedScopeLeaderCallback(callback) {
+            var _callback = (_stateObject__, scopeId, userId) => {
+                {
+                    const _stringValue = Module.UTF8ToString(scopeId);
+                    free(scopeId);
+                    scopeId = _stringValue;
+                }
+                {
+                    const _stringValue = Module.UTF8ToString(userId);
+                    free(userId);
+                    userId = _stringValue;
+                }
+                callback(scopeId, userId);
+            };
+            var _callbackPtr = Module.addFunction(_callback, "viii");
+            Module.ccall("csp_multiplayer_OnlineRealtimeEngine_SetOnElectedScopeLeaderCallback_void_ScopeLeaderCallback", "void", ["number", "number", "number"], [this.pointer, _callbackPtr, 0]);
+        }
+        /**
+         * @description Binds the provided callback to receive events when a scope leader has been vacated.
+         * @param callback - Fired when a scope leader is vacated.
+         */
+        setOnVacatedAsScopeLeaderCallback(callback) {
+            var _callback = (_stateObject__, scopeId, userId) => {
+                {
+                    const _stringValue = Module.UTF8ToString(scopeId);
+                    free(scopeId);
+                    scopeId = _stringValue;
+                }
+                {
+                    const _stringValue = Module.UTF8ToString(userId);
+                    free(userId);
+                    userId = _stringValue;
+                }
+                callback(scopeId, userId);
+            };
+            var _callbackPtr = Module.addFunction(_callback, "viii");
+            Module.ccall("csp_multiplayer_OnlineRealtimeEngine_SetOnVacatedAsScopeLeaderCallback_void_ScopeLeaderCallback", "void", ["number", "number", "number"], [this.pointer, _callbackPtr, 0]);
+        }
         /**
          * @description Sets the script owner for the given entity to the current client
          * @param entity - A pointer to the entity
@@ -17115,6 +17170,7 @@ export class CSPFoundation {
         }
         /**
          * @description Disable Leader Election feature.
+        @pre SpaceSystem::EnterSpace should be called first for this to take affect.
          */
         disableLeaderElection() {
             Module.ccall("csp_multiplayer_OnlineRealtimeEngine_DisableLeaderElection_void", "void", ["number"], [this.pointer]);
@@ -17129,6 +17185,7 @@ export class CSPFoundation {
         }
         /**
          * @description Debug helper to get the id of the currently elected script leader.
+         * This should be updated when we fully support scopes. We will need to pass in the scopeId we want the leader for.
          * @return The id of the leader.
          */
         getLeaderId() {