@4players/odin-nodejs 0.8.0 → 0.9.0

package/cppsrc/odinroom.cpp

@@ -331,6 +331,8 @@ Napi::Object OdinRoom::Init(Napi::Env env, Napi::Object exports) {
     Napi::Function func = DefineClass(env, "OdinRoom", {
         InstanceMethod<&OdinRoom::Join>("join", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
         InstanceMethod<&OdinRoom::UpdatePeerUserData>("updateOwnUserData", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
+        InstanceMethod<&OdinRoom::UpdatePosition>("updatePosition", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
+        InstanceMethod<&OdinRoom::SetPositionScale>("setPositionScale", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
         InstanceMethod<&OdinRoom::SendMessage>("sendMessage", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
         InstanceMethod<&OdinRoom::SetEventListener>("setEventListener", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
         InstanceMethod<&OdinRoom::AddEventListener>("addEventListener", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
@@ -365,6 +367,50 @@ Napi::Object OdinRoom::Init(Napi::Env env, Napi::Object exports) {
     return exports;
 }
 
+/**
+ * Updates the position of this room. Requires x, y and z coordinates as parameters.
+ * @param info Napi::CallbackInfo
+ */
+void OdinRoom::UpdatePosition(const Napi::CallbackInfo &info)
+{
+    Napi::Env env = info.Env();
+
+    if (info.Length() != 3 || !info[0].IsNumber() || !info[1].IsNumber() || !info[2].IsNumber()) {
+        Napi::TypeError::New(env, "Provide x, y and z coordinates as numbers").ThrowAsJavaScriptException();
+    }
+
+    float x = info[0].ToNumber();
+    float y = info[1].ToNumber();
+    float z = info[2].ToNumber();
+
+    OdinReturnCode error = odin_room_update_position(_roomHandle, x, y, z);
+    if (odin_is_error(error))
+    {
+        OdinUtilities::ThrowNapiException(env, error, "Failed to update position");
+    }
+}
+
+/**
+ * Sets the position scale for this room. Requires a scale as a parameter.
+ * @param info Napi::CallbackInfo
+ */
+void OdinRoom::SetPositionScale(const Napi::CallbackInfo &info)
+{
+    Napi::Env env = info.Env();
+
+    if (info.Length() != 1 || !info[0].IsNumber()) {
+        Napi::TypeError::New(env, "Provide scale as number").ThrowAsJavaScriptException();
+    }
+
+    float scale = info[0].ToNumber();
+
+    OdinReturnCode error = odin_room_set_position_scale(_roomHandle, scale);
+    if (odin_is_error(error))
+    {
+        OdinUtilities::ThrowNapiException(env, error, "Failed to set position scale");
+    }
+}
+
 /**
  * Joins the Odin room. Requires a gateway URL as a parameter and optionally initial peer data.
  * @param info Napi::CallbackInfo

package/cppsrc/odinroom.h

@@ -56,6 +56,8 @@ private:
     EventData* PrepareEventData(OdinEvent* event);
     static uint16_t GetMediaIdFromHandle(OdinMediaStreamHandle handle);
     void HandleAudioData();
+    void UpdatePosition(const Napi::CallbackInfo &info);
+    void SetPositionScale(const Napi::CallbackInfo &info);
 
     Napi::Value CreateAudioStream(const Napi::CallbackInfo &info);
 };

package/odin.room.d.ts

@@ -445,6 +445,34 @@ export declare class OdinRoom {
      */
     updateOwnUserData(userData: Uint8Array): void;
 
+    /**
+     * Updates the three-dimensional position of the current peer in this room.
+     * The server utilizes the provided coordinates to perform automatic culling among peers in the same
+     * room, based on unit circles with a radius of `1.0`. This feature is particularly beneficial in
+     * scenarios involving a large number of peers within the same room, enabling peers to interact or
+     * 'see' each other only when in close proximity. To modify the distance sensitivity for position
+     * updates, use `setPositionScale`.
+     *
+     * Note: Use this before calling `join` to set the initial peer position upon connect.
+     *
+     * @param x - The new x position of the peer.
+     * @param y - The new y position of the peer.
+     * @param z - The new z position of the peer.
+     */
+    updatePosition(x: number, y: number, z: number): void;
+
+    /**
+     * Sets the scaling factor for coordinates supplied to `updatePosition`, facilitating
+     * adaptation to your game's unique coordinate system requirements. Peers are visible to each other
+     * only within a unit circle of radius `1.0`. When altering a peer's position, ensure the position
+     * is scaled such that the maximum distance remains one or less. This scaling can be performed
+     * manually or by specifying the multiplicative scale here.
+     *
+     * Note: It's crucial to maintain consistent scaling across all client applications.
+     * @param scale - The new scaling factor to use.
+     */
+    setPositionScale(scale: number);
+
     /**
      * Closes the room and disconnects from the server.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@4players/odin-nodejs",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "NodeJS bindings for the ODIN SDK. Use for AI enhanced human interactions, content moderation and audio processing features in a backend.",
   "main": "index.cjs",
   "types": "index.d.ts",