connected-spaces-platform.web 5.16.0 → 5.17.1

package/connectedspacesplatform.ts

@@ -3242,7 +3242,7 @@ export namespace Multiplayer {
    * Add means the component is newly added, clients should ensure that this triggers appropriate instantiation of wrapping objects.
    * All properties for the component should be included.
    * Delete means the component has been marked for deletion. It is likely that some other clients will not have the component at the point this is
-   * recieved. Any wrapping data objects should be deleted when this is recieved, and clients should cease updating this component as any call would
+   * received. Any wrapping data objects should be deleted when this is received, and clients should cease updating this component as any call would
    * fail. The CSP representation of the component has been removed at this point.
    */
   export enum ComponentUpdateType {
@@ -4334,278 +4334,6 @@ export namespace Web {
   }
 }
 
-export namespace Multiplayer {
-  /**
-   * @description The serialiser is responsible for converting a SpaceEntity instance into a data structure that both SignalR
-   * and our servers can understand and use.
-   * /// To use the serialiser, Start with BeginEntity(), then use the write(bool, int, etc) functions to write data at the
-   * Entity level. Use BeginComponents() to start writing as the Server component data, with each BeginComponent and
-   * EndComponent brace dictating information written into a server component. Within a component, use WriteProperty()
-   * to write the individual data. Ensure you finish by closing out the relevant sections with the 'End' functions.
-   */
-  export interface IEntitySerialiser {
-    /**
-     * @description Start the serialisiation.
-     */
-    beginEntity: () => void;
-
-    /**
-     * @description End the serialisiation.
-     */
-    endEntity: () => void;
-
-    /**
-     * @description Write a boolean field of the entity.
-     * @param value - The value to write.
-     */
-    writeBool: (value: boolean) => void;
-
-    /**
-     * @description Write a byte field of the entity.
-     * @param value - The value to write.
-     */
-    writeByte: (value: number) => void;
-
-    /**
-     * @description Write a double field of the entity.
-     * @param value - The value to write.
-     */
-    writeDouble: (value: number) => void;
-
-    /**
-     * @description Write an int64_t field of the entity.
-     * @param value - The value to write.
-     */
-    writeInt64: (value: bigint) => void;
-
-    /**
-     * @description Write a uint64_t field of the entity.
-     * @param value - The value to write.
-     */
-    writeUInt64: (value: bigint) => void;
-
-    /**
-     * @description Write a string field of the entity.
-     * @param value - The value to write.
-     */
-    writeString: (value: string) => void;
-
-    /**
-     * @description Write a null field of the entity.
-     */
-    writeNull: () => void;
-
-    /**
-     * @description Start an array section.
-     */
-    beginArray: () => void;
-
-    /**
-     * @description Finish an array section.
-     */
-    endArray: () => void;
-
-    /**
-     * @description Start the components section.
-     */
-    beginComponents: () => void;
-
-    /**
-     * @description Finish the components section
-     */
-    endComponents: () => void;
-
-    /**
-     * @description Begin writing component with the given ID and type.
-     * @param id - The ID of the component.
-     */
-    beginComponent: (id: number, type: bigint) => void;
-
-    /**
-     * @description Finish a component section.
-     */
-    endComponent: () => void;
-
-    /**
-     * @description Write the given component property.
-     * @param id - ID of the component property.
-     * @param value - The value to be written.
-     */
-    writeProperty: (id: bigint, value: Multiplayer.ReplicatedValue) => void;
-
-    /**
-     * @description Specific handler for writing view components.
-     * /// View Components are data that is stored in specific keys on the server, it allows us to discretely update these
-     * singular data pieces, rather than replicating larger chunks of data, and also allows us to always know where
-     * in a data structure this data will be.
-     * /// @param Id uint16_t : The ID of the component
-     * @param value - The value of the component data to add
-     */
-    addViewComponent: (id: number, value: Multiplayer.ReplicatedValue) => void;
-  }
-}
-
-export namespace Multiplayer {
-  /**
-   * @description The deserialiser is used to take recieved signalr message data and turn it into values you can use to populate a SpaceEntity.
-   * /// This works similarly to the serialiser and you can refer to the serialiser for more details.
-   * It is expected that you will be using the data as you read it to populate either a newly created or currently existing SpaceEntity.
-   */
-  export interface IEntityDeserialiser {
-    /**
-     * @description Starts the deserialisation.
-     */
-    enterEntity: () => void;
-
-    /**
-     * @description Ends the deserialisation.
-     */
-    leaveEntity: () => void;
-
-    /**
-     * @description Reads a boolean from the deserialiser.
-     * @return The deserialised boolean.
-     */
-    readBool: () => boolean;
-
-    /**
-     * @description Reads a byte from the deserialiser.
-     * @return The deserialised byte.
-     */
-    readByte: () => number;
-
-    /**
-     * @description Reads a double from the deserialiser.
-     * @return The deserialised double.
-     */
-    readDouble: () => number;
-
-    /**
-     * @description Reads an int64_t from the deserialiser.
-     * @return The deserialised boolean.
-     */
-    readInt64: () => bigint;
-
-    /**
-     * @description Reads a uint64_t from the deserialiser.
-     * @return The deserialised uint64_t.
-     */
-    readUInt64: () => bigint;
-
-    /**
-     * @description Reads a string from the deserialiser.
-     * @return The deserialised string.
-     */
-    readString: () => string;
-
-    /**
-     * @description Reads a vector2 from the deserialiser.
-     * @return The deserialised vector2.
-     */
-    readVector2: () => Common.Vector2;
-
-    /**
-     * @description Reads a vector3 from the deserialiser.
-     * @return The deserialised vector3.
-     */
-    readVector3: () => Common.Vector3;
-
-    /**
-     * @description Reads a vector4 from the deserialiser.
-     * @return The deserialised vector4.
-     */
-    readVector4: () => Common.Vector4;
-
-    /**
-     * @description Checks if the next value is null.
-     * @return True if the next value is null, false otherwise.
-     */
-    nextValueIsNull: () => boolean;
-
-    /**
-     * @description Checks if the next value is an array.
-     * @return True if the next value is null, false otherwise.
-     */
-    nextValueIsArray: () => boolean;
-
-    /**
-     * @description Puts the deserialiser into array processing mode to begin reading from an array.
-     * @param outLength - A reference to variable to store the length of the array.
-     */
-    enterArray: (outLength: NativeRef) => void;
-
-    /**
-     * @description Completes reading from and array and leaves the array processing mode.
-     */
-    leaveArray: () => void;
-
-    /**
-     * @description Puts the deserialiser into component processing mode to begin reading from the components section of the serialised entity.
-     */
-    enterComponents: () => void;
-
-    /**
-     * @description Completes reading the components and exits that mode.
-     */
-    leaveComponents: () => void;
-
-    /**
-     * @description Gets the total number of components, including view components.
-     * /// If iterating components by this count, subtract number of view components.
-     * /// @return The number of components.
-     */
-    getNumComponents: () => bigint;
-
-    /**
-     * @description Gets the number of components that are not view components.
-     * @return The number of non-view components.
-     */
-    getNumRealComponents: () => bigint;
-
-    /**
-     * @description Begins the processes of deserialising a single component that is not a view component.
-     */
-    enterComponent: (outId: NativeRef, outType: NativeRef) => void;
-
-    /**
-     * @description Completes the deserialisation of a single component.
-     */
-    leaveComponent: () => void;
-
-    /**
-     * @description Gets the number of properties in the component that is currently being deserialised.
-     * @return The number of properties in the component.
-     */
-    getNumProperties: () => bigint;
-
-    /**
-     * @description Reads a property from the deserialiser, returning it as a ReplicatedValue.
-     * @param outId - A reference to a variable to store the ID of the property.
-     * @return The property value.
-     */
-    readProperty: (outId: NativeRef) => Multiplayer.ReplicatedValue;
-
-    /**
-     * @description Reads a view component from the deserialiser, returning it as a ReplicatedValue.
-     * /// Since view components are handled differently in the serialiser, they are similarly deserialised in their own way.
-     * /// @return The view component value.
-     */
-    getViewComponent: (id: number) => Multiplayer.ReplicatedValue;
-
-    /**
-     * @description Gets whether there is a view component with the given ID.
-     * @param id - The ID of the component.
-     * @return True if there is a view component, false otherwise.
-     */
-    hasViewComponent: (id: number) => boolean;
-
-    /**
-     * @description Skips a field when deserialising the SpaceEntity fields.
-     */
-    skip: () => void;
-  }
-}
-
 export namespace Multiplayer {
   /**
    * @description Controls whether a component is enabled or disabled.
@@ -21965,7 +21693,7 @@ export namespace Multiplayer {
 @ingroup Multiplayer
  * @description Handling of all network events.  
  */
-  export class EventBus extends NativeClassWrapper {
+  export class EventBus extends NativeClassWrapper implements INativeResource {
     /** @internal */
     constructor(pointer: NativePointer) {
       super(pointer);
@@ -22111,6 +21839,19 @@ export namespace Multiplayer {
         [this.pointer],
       );
     }
+
+    delete(): void {
+      if (this.ownsPointer && !this.disposed) {
+        Module.ccall(
+          "csp_multiplayer_EventBus_Dtor",
+          "void",
+          ["number"],
+          [this.pointer],
+        );
+
+        this.disposed = true;
+      }
+    }
   }
 }
 
@@ -22784,7 +22525,10 @@ export namespace Multiplayer {
 @ingroup Multiplayer
  * @description Handling of all multiplayer connection functionality, such as connect, disconnect, entity replication and network events.  
  */
-  export class MultiplayerConnection extends NativeClassWrapper {
+  export class MultiplayerConnection
+    extends NativeClassWrapper
+    implements INativeResource
+  {
     /** @internal */
     constructor(pointer: NativePointer) {
       super(pointer);
@@ -22908,7 +22652,7 @@ export namespace Multiplayer {
 
     /**
      * @description Sets the Self Messaging flag for this client.  
-     * This allows a client to declare that it wishes to recieve every patch and object message it sends.  
+     * This allows a client to declare that it wishes to receive every patch and object message it sends.  
     @warning Don't use this function if you aren't sure of the consequences, it's very unlikely that a client would want to use this!
      * @param allowSelfMessaging - True to allow and false to disallow.
      * @param callback - A callback with failure state.
@@ -22957,6 +22701,19 @@ export namespace Multiplayer {
 
       return _result;
     }
+
+    delete(): void {
+      if (this.ownsPointer && !this.disposed) {
+        Module.ccall(
+          "csp_multiplayer_MultiplayerConnection_Dtor",
+          "void",
+          ["number"],
+          [this.pointer],
+        );
+
+        this.disposed = true;
+      }
+    }
   }
 }
 
@@ -23910,8 +23667,8 @@ export namespace Multiplayer {
     }
 
     /**
-     * @description Get whether the space is transient or persistant.
-     * @return Returns true if the space is transient and false if it is marked as persistant.
+     * @description Get whether the space is transient or persistent.
+     * @return Returns true if the space is transient and false if it is marked as persistent.
      */
 
     getIsTransient(): boolean {
@@ -24196,7 +23953,7 @@ export namespace Multiplayer {
      * @description Set a callback to be executed when a patch message is received for this Entity. Only one callback can be set.
      * @param callback - Contains the SpaceEntity that updated, a set of flags to tell which parts updated
      * and an array of information to tell which components updated.
-     * When this callback is recieved, the flags and arrays should be used to determine which properties have updated data.
+     * When this callback is received, the flags and arrays should be used to determine which properties have updated data.
      */
     setUpdateCallback(
       callback: (
@@ -24357,70 +24114,6 @@ export namespace Multiplayer {
       );
     }
 
-    /**
-     * @description Serialise local changes into patch message format into the given serialiser. Does not send a patch.
-     * @param serialiser - The serialiser to use.
-     */
-
-    serialisePatch(serialiser: Multiplayer.IEntitySerialiser): void {
-      Module.ccall(
-        "csp_multiplayer_SpaceEntity_SerialisePatchC_void_IEntitySerialiserR",
-        "void",
-        ["number", "number"],
-        [this.pointer, (serialiser as unknown as NativeClassWrapper).pointer],
-      );
-    }
-
-    /**
-     * @description Serialise the entire SpaceEntity into object message format into the given serialiser. Does not send a message.
-     * @param serialiser - The serialiser to use.
-     */
-
-    serialise(serialiser: Multiplayer.IEntitySerialiser): void {
-      Module.ccall(
-        "csp_multiplayer_SpaceEntity_SerialiseC_void_IEntitySerialiserR",
-        "void",
-        ["number", "number"],
-        [this.pointer, (serialiser as unknown as NativeClassWrapper).pointer],
-      );
-    }
-
-    /**
-     * @description Serialises a given component into a consistent format for the given serialiser.
-     * @param serialiser - The serialiser to use.
-     * @param component - The component to be serialised.
-     */
-
-    serialiseComponent(
-      serialiser: Multiplayer.IEntitySerialiser,
-      component: Multiplayer.ComponentBase,
-    ): void {
-      Module.ccall(
-        "csp_multiplayer_SpaceEntity_SerialiseComponentC_void_IEntitySerialiserR_ComponentBaseP",
-        "void",
-        ["number", "number", "number"],
-        [
-          this.pointer,
-          (serialiser as unknown as NativeClassWrapper).pointer,
-          component.pointer,
-        ],
-      );
-    }
-
-    /**
-     * @description Using the given deserialiser, populate the SpaceEntity with the data in the deserialiser.
-     * @param deserialiser - The deserialiser to use.
-     */
-
-    deserialise(deserialiser: Multiplayer.IEntityDeserialiser): void {
-      Module.ccall(
-        "csp_multiplayer_SpaceEntity_Deserialise_void_IEntityDeserialiserR",
-        "void",
-        ["number", "number"],
-        [this.pointer, (deserialiser as unknown as NativeClassWrapper).pointer],
-      );
-    }
-
     /**
      * @description Gets the script associated with the space entity.
      * @return The EntityScript instance set on the entity.
@@ -24590,7 +24283,10 @@ export namespace Multiplayer {
    * can be registered for certain events that occur within the entity system so clients can
    * react appropriately.
    */
-  export class SpaceEntitySystem extends NativeClassWrapper {
+  export class SpaceEntitySystem
+    extends NativeClassWrapper
+    implements INativeResource
+  {
     /** @internal */
     constructor(pointer: NativePointer) {
       super(pointer);
@@ -25312,7 +25008,7 @@ export namespace Multiplayer {
      * \rst
      * .. note::
      * If disabling this feature, more requests will be made to Magnopus Connected Services,
-     * and consequntly more patch merges may occur on the server as a result.
+     * and consequently more patch merges may occur on the server as a result.
      * \endrst
      */
 
@@ -25326,7 +25022,7 @@ export namespace Multiplayer {
     }
 
     /**
-     * @description Retrieves all entites that exist at the root level (do not have a parent entity).
+     * @description Retrieves all entities that exist at the root level (do not have a parent entity).
      * @return A list of root entities.
      */
 
@@ -25348,6 +25044,19 @@ export namespace Multiplayer {
 
       return _nPtr;
     }
+
+    delete(): void {
+      if (this.ownsPointer && !this.disposed) {
+        Module.ccall(
+          "csp_multiplayer_SpaceEntitySystem_Dtor",
+          "void",
+          ["number"],
+          [this.pointer],
+        );
+
+        this.disposed = true;
+      }
+    }
   }
 }
 
@@ -26161,6 +25870,22 @@ export namespace Multiplayer {
       return _result;
     }
 
+    /**
+     * @description Checks if the entity has a script component.
+     * @return True if component exist, false otherwise.
+     */
+
+    hasEntityScriptComponent(): boolean {
+      let _result = Module.ccall(
+        "csp_multiplayer_EntityScript_HasEntityScriptComponent_bool",
+        "boolean",
+        ["number"],
+        [this.pointer],
+      );
+
+      return _result;
+    }
+
     /**
      * @description Gets the text of the last error if it is known or otherwise returns a default unknown error string.
      * @return Text of the last error.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "connected-spaces-platform.web",
   "displayName": "connected-spaces-platform.web",
-  "version": "5.16.0+592",
+  "version": "5.17.1+594",
   "description": "This package provides the binaries required to interface with the Connected Spaces Platform API.",
   "license": "Apache-2.0",
   "dependencies": {