connected-spaces-platform.web 6.20.0 → 6.22.0

package/connectedspacesplatform.d.ts

@@ -257,6 +257,16 @@ export declare namespace Multiplayer {
         SpaceUserLimitExceeded = 4
     }
 }
+export declare namespace Multiplayer {
+    /**
+     * @description Enum representing the failure reason of an entity modification operation returned from IRealtimeEngine::IsEntityModifiable.
+     */
+    enum ModifiableStatus {
+        Modifiable = 0,
+        EntityLocked = 1,
+        EntityNotOwnedAndUntransferable = 2
+    }
+}
 export declare namespace Systems {
     /**
      * @description Indicates special handling for any thirdparty platform
@@ -4151,6 +4161,19 @@ export declare namespace Common {
          * entity fetch
          */
         setEntityFetchCompleteCallback(callback: (arg1: number) => void): void;
+        /**
+         * @description Checks if the given entity can be modified by this client.
+        @details Modification in this context can mean any of the following:
+         * - Updating an entity property
+         * - Sending an entity patch
+         * - Creating a component
+         * - Deleting a component
+         * - Updating a component property
+         * @param spaceEntity - The entity we are checking can be modified.
+         * @return The result of this operation signifying if the entity can be modified.
+         * Will return ModifiableStatus::Modifiable if the entity can be modified.
+         */
+        isEntityModifiable(spaceEntity: Multiplayer.SpaceEntity): Multiplayer.ModifiableStatus;
     }
 }
 export declare namespace Common {
@@ -4694,11 +4717,11 @@ export declare namespace Multiplayer {
          */
         deselect(): boolean;
         /**
-         * @description Checks if the entity can be modified.
-         * Specifically whether the local client already owns the entity or can take ownership of the entity.
-         * @return True if the entity can be modified, False if not.
+         * Checks if the entity can be modified, with a failure reason if the entity isn't modifiable.
+         * The criteria for failures can be found on specific RealtimeEngine IsEntityModifiable overridden functions.
+         * @return ModifiableStatus::Modifiable on success.
          */
-        isModifiable(): boolean;
+        isModifiable(): Multiplayer.ModifiableStatus;
         /**
          * @description Locks the entity if it hasn't been locked already.
         @pre The entity must not already be locked.
@@ -5860,7 +5883,7 @@ export declare namespace Systems {
 export declare namespace Systems {
     /**
   @ingroup HotspotSequence System
-   * @description A basic class abstraction for a Hot Spot Group, including name, and items within the group.
+   * @description A basic class abstraction for a Hotspot Group, including the Name and Items within the group.
    */
     class HotspotGroup extends NativeClassWrapper implements INativeResource {
         /** @internal */
@@ -6612,6 +6635,13 @@ export declare namespace Multiplayer {
          * @return A list of root entities containing non-owning pointers to entities.
          */
         getRootHierarchyEntities(): Common.List<Multiplayer.SpaceEntity>;
+        /**
+         * @description Returns a ModifiableStatus enum containing ModifiableStatus::Modifiable if the entity can be modified.
+        @details This result will contain ModifiableStatus::EntityLocked if the given entities LockType is equal to UserAgnostic.
+         * @param spaceEntity - The space entity to check its modfiable state.
+         * @return This will contain a failure reason if the entity isn't modifiable.
+         */
+        isEntityModifiable(spaceEntity: Multiplayer.SpaceEntity): Multiplayer.ModifiableStatus;
         /**
          * @description The client ID of the local client. An arbitrary unchanging value.
          * @return INT53_MAX, the maximum number expressible in all our interop languages (you can thank javascript for the weird sizing).
@@ -6740,6 +6770,15 @@ export declare namespace Multiplayer {
          * @return A list of root entities containing non-owning pointers to entities.
          */
         getRootHierarchyEntities(): Common.List<Multiplayer.SpaceEntity>;
+        /**
+         * @description Returns a ModifiableStatus enum containing ModifiableStatus::Modifiable if the entity can be modified.
+        @detail This entity is considered non-modifiable in the following circumstances:
+         * - The given entities LockType is equal to UserAgnostic, and we dont have an unprocessed patch updating the lock type.
+         * - The entities owner id doesn't match this clients id, and the entity is not transferable.
+         * @param spaceEntity - The space entity to check its modfiable state.
+         * @return This will contain a failure reason if the entity isn't modifiable.
+         */
+        isEntityModifiable(spaceEntity: Multiplayer.SpaceEntity): Multiplayer.ModifiableStatus;
         /**
          * @description Adds an entity to a list of entities to be updated when ProcessPendingEntityOperations is called.
          * From a client perspective, ProcessPendingEntityOperations is normally called via the CSPFoundation::Tick method.
@@ -11889,6 +11928,15 @@ export declare namespace Systems {
          * @param callback - Callback when asynchronous task finishes
          */
         getTierFeatureProgressForSpace(spaceId: string, featureNames: Common.Array<Systems.TierFeatures>): Promise<Systems.FeaturesLimitResult>;
+        /**
+         * @description Set the tier of the user. Tiers effect things such as limits of users inside spaces, among other quota restrictions
+         * @param tier - Tier to set.
+         * @param userId - Id of the user to set the tier for.
+         * @param callback - Callback when asynchronous task finishes.
+        @pre This method should only be called when logged in as an administrator tier account.
+         * If called when not an administrator, you will receive a 403 error (Forbidden)
+         */
+        setUserTier(tier: Systems.TierNames, userId: string): Promise<Systems.UserTierResult>;
         /**
          * @description Get current users tier information
          * @param callback - Callback when asynchronous task finishes

package/connectedspacesplatform.js

@@ -312,6 +312,11 @@ function csp_multiplayer_ErrorCodeFactory(nativePointer) {
 }
 ProxyClassFactories["csp_multiplayer_ErrorCode"] =
     csp_multiplayer_ErrorCodeFactory;
+function csp_multiplayer_ModifiableStatusFactory(nativePointer) {
+    return nativePointer.pointer;
+}
+ProxyClassFactories["csp_multiplayer_ModifiableStatus"] =
+    csp_multiplayer_ModifiableStatusFactory;
 function csp_systems_EThirdPartyPlatformFactory(nativePointer) {
     return nativePointer.pointer;
 }
@@ -2240,6 +2245,17 @@ export var Multiplayer;
         ErrorCode[ErrorCode["SpaceUserLimitExceeded"] = 4] = "SpaceUserLimitExceeded";
     })(ErrorCode = Multiplayer.ErrorCode || (Multiplayer.ErrorCode = {}));
 })(Multiplayer || (Multiplayer = {}));
+(function (Multiplayer) {
+    /**
+     * @description Enum representing the failure reason of an entity modification operation returned from IRealtimeEngine::IsEntityModifiable.
+     */
+    let ModifiableStatus;
+    (function (ModifiableStatus) {
+        ModifiableStatus[ModifiableStatus["Modifiable"] = 0] = "Modifiable";
+        ModifiableStatus[ModifiableStatus["EntityLocked"] = 1] = "EntityLocked";
+        ModifiableStatus[ModifiableStatus["EntityNotOwnedAndUntransferable"] = 2] = "EntityNotOwnedAndUntransferable";
+    })(ModifiableStatus = Multiplayer.ModifiableStatus || (Multiplayer.ModifiableStatus = {}));
+})(Multiplayer || (Multiplayer = {}));
 export var Systems;
 (function (Systems) {
     /**
@@ -10841,6 +10857,22 @@ export class CSPFoundation {
             var _callbackPtr = Module.addFunction(_callback, "vii");
             Module.ccall("csp_common_IRealtimeEngine_SetEntityFetchCompleteCallback_void_EntityFetchCompleteCallback", "void", ["number", "number", "number"], [this.pointer, _callbackPtr, 0]);
         }
+        /**
+         * @description Checks if the given entity can be modified by this client.
+        @details Modification in this context can mean any of the following:
+         * - Updating an entity property
+         * - Sending an entity patch
+         * - Creating a component
+         * - Deleting a component
+         * - Updating a component property
+         * @param spaceEntity - The entity we are checking can be modified.
+         * @return The result of this operation signifying if the entity can be modified.
+         * Will return ModifiableStatus::Modifiable if the entity can be modified.
+         */
+        isEntityModifiable(spaceEntity) {
+            let _result = Module.ccall("csp_common_IRealtimeEngine_IsEntityModifiableC_ModifiableStatus_SpaceEntityPC", "number", ["number", "number"], [this.pointer, spaceEntity.pointer]);
+            return _result;
+        }
     }
     Common.IRealtimeEngine = IRealtimeEngine;
 })(Common || (Common = {}));
@@ -11949,12 +11981,12 @@ export class CSPFoundation {
             return _result;
         }
         /**
-         * @description Checks if the entity can be modified.
-         * Specifically whether the local client already owns the entity or can take ownership of the entity.
-         * @return True if the entity can be modified, False if not.
+         * Checks if the entity can be modified, with a failure reason if the entity isn't modifiable.
+         * The criteria for failures can be found on specific RealtimeEngine IsEntityModifiable overridden functions.
+         * @return ModifiableStatus::Modifiable on success.
          */
         isModifiable() {
-            let _result = Module.ccall("csp_multiplayer_SpaceEntity_IsModifiableC_bool", "boolean", ["number"], [this.pointer]);
+            let _result = Module.ccall("csp_multiplayer_SpaceEntity_IsModifiableC_ModifiableStatus", "number", ["number"], [this.pointer]);
             return _result;
         }
         /**
@@ -14703,7 +14735,7 @@ export class CSPFoundation {
 (function (Systems) {
     /**
   @ingroup HotspotSequence System
-   * @description A basic class abstraction for a Hot Spot Group, including name, and items within the group.
+   * @description A basic class abstraction for a Hotspot Group, including the Name and Items within the group.
    */
     class HotspotGroup extends NativeClassWrapper {
         /** @internal */
@@ -16762,6 +16794,16 @@ export class CSPFoundation {
             Module._free(_ret);
             return _nPtr;
         }
+        /**
+         * @description Returns a ModifiableStatus enum containing ModifiableStatus::Modifiable if the entity can be modified.
+        @details This result will contain ModifiableStatus::EntityLocked if the given entities LockType is equal to UserAgnostic.
+         * @param spaceEntity - The space entity to check its modfiable state.
+         * @return This will contain a failure reason if the entity isn't modifiable.
+         */
+        isEntityModifiable(spaceEntity) {
+            let _result = Module.ccall("csp_multiplayer_OfflineRealtimeEngine_IsEntityModifiableC_ModifiableStatus_SpaceEntityPC", "number", ["number", "number"], [this.pointer, spaceEntity.pointer]);
+            return _result;
+        }
         /**
          * @description The client ID of the local client. An arbitrary unchanging value.
          * @return INT53_MAX, the maximum number expressible in all our interop languages (you can thank javascript for the weird sizing).
@@ -17079,6 +17121,18 @@ export class CSPFoundation {
             Module._free(_ret);
             return _nPtr;
         }
+        /**
+         * @description Returns a ModifiableStatus enum containing ModifiableStatus::Modifiable if the entity can be modified.
+        @detail This entity is considered non-modifiable in the following circumstances:
+         * - The given entities LockType is equal to UserAgnostic, and we dont have an unprocessed patch updating the lock type.
+         * - The entities owner id doesn't match this clients id, and the entity is not transferable.
+         * @param spaceEntity - The space entity to check its modfiable state.
+         * @return This will contain a failure reason if the entity isn't modifiable.
+         */
+        isEntityModifiable(spaceEntity) {
+            let _result = Module.ccall("csp_multiplayer_OnlineRealtimeEngine_IsEntityModifiableC_ModifiableStatus_SpaceEntityPC", "number", ["number", "number"], [this.pointer, spaceEntity.pointer]);
+            return _result;
+        }
         /**
          * @description Adds an entity to a list of entities to be updated when ProcessPendingEntityOperations is called.
          * From a client perspective, ProcessPendingEntityOperations is normally called via the CSPFoundation::Tick method.
@@ -27536,6 +27590,33 @@ export class CSPFoundation {
             Module.ccall("csp_systems_QuotaSystem_GetTierFeatureProgressForSpace_void_StringRC_ArrayRC_FeaturesLimitCallback", "void", ["number", "string", "number", "number", "number"], [this.pointer, spaceId, featureNames.pointer, _callbackPtr, 0]);
             return _promise;
         }
+        /**
+         * @description Set the tier of the user. Tiers effect things such as limits of users inside spaces, among other quota restrictions
+         * @param tier - Tier to set.
+         * @param userId - Id of the user to set the tier for.
+         * @param callback - Callback when asynchronous task finishes.
+        @pre This method should only be called when logged in as an administrator tier account.
+         * If called when not an administrator, you will receive a 403 error (Forbidden)
+         */
+        async setUserTier(tier, userId) {
+            var _resolve;
+            var _promise = new Promise((_r) => {
+                _resolve = _r;
+            });
+            var _callbackPtr;
+            var _callback = (_stateObject__, result) => {
+                var _resultPtr = getNativePointer(result);
+                var _resultInstance = new Systems.UserTierResult(_resultPtr);
+                if (_resultInstance.getResultCode() == Systems.EResultCode.InProgress) {
+                    return;
+                }
+                _resolve(_resultInstance);
+                Module.removeFunction(_callbackPtr);
+            };
+            _callbackPtr = Module.addFunction(_callback, "vii");
+            Module.ccall("csp_systems_QuotaSystem_SetUserTier_void_TierNames_StringRC_UserTierCallback", "void", ["number", "number", "string", "number", "number"], [this.pointer, tier, userId, _callbackPtr, 0]);
+            return _promise;
+        }
         /**
          * @description Get current users tier information
          * @param callback - Callback when asynchronous task finishes