@hytopia.com/server-protocol 1.3.38 → 1.3.39

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hytopia.com/server-protocol",
-  "version": "1.3.38",
+  "version": "1.3.39",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

package/schemas/Entity.ts

@@ -1,49 +1,35 @@
+import { modelSchema } from './Model';
 import { quaternionSchema } from './Quaternion';
-import { rgbColorSchema } from './RgbColor';
 import { vectorSchema } from './Vector';
 import type { JSONSchemaType } from 'ajv';
+import type { ModelSchema } from './Model';
 import type { QuaternionSchema } from './Quaternion';
-import type { RgbColorSchema } from './RgbColor';
 import type { VectorSchema } from './Vector';
 
 export type EntitySchema = {
   i: number;            // entity id
-  al?: string[];        // model animations looped
-  ao?: string[];        // model animations one shot
-  ap?: number;          // model animations playback rate
-  as?: string[];        // model animations stop
+  am?: ModelSchema[];   // attached models
   bh?: VectorSchema;    // block half extents
   bt?: string;          // block texture uri
-  h?: string[];         // model parts to hide
-  m?: string;           // model uri
+  m?: ModelSchema;      // model
   n?: string;           // name
-  o?: number;           // opacity
   p?: VectorSchema;     // position
   r?: QuaternionSchema; // rotation
   rm?: boolean;         // removed/remove
-  s?: number;           // model scale
-  t?: RgbColorSchema;   // tint color
 }
 
 export const entitySchema: JSONSchemaType<EntitySchema> = {
   type: 'object',
   properties: {
     i: { type: 'number' },
-    al: { type: 'array', items: { type: 'string' }, nullable: true },
-    ao: { type: 'array', items: { type: 'string' }, nullable: true },
-    ap: { type: 'number', nullable: true },
-    as: { type: 'array', items: { type: 'string' }, nullable: true },
+    am: { type: 'array', items: { ...modelSchema }, nullable: true },
     bh: { ...vectorSchema, nullable: true },
     bt: { type: 'string', nullable: true },
-    h: { type: 'array', items: { type: 'string' }, nullable: true },
-    m: { type: 'string', nullable: true },
+    m: { ...modelSchema, nullable: true },
     n: { type: 'string', nullable: true },
-    o: { type: 'number', minimum: 0, maximum: 1, nullable: true },
     p: { ...vectorSchema, nullable: true },
     r: { ...quaternionSchema, nullable: true },
     rm: { type: 'boolean', nullable: true },
-    s: { type: 'number', nullable: true },
-    t: { ...rgbColorSchema, nullable: true },
   },
   required: [ 'i' ],
   additionalProperties: false,

package/schemas/Model.ts

@@ -0,0 +1,27 @@
+import { modelNodeSchema } from './ModelNode';
+import type { JSONSchemaType } from 'ajv';
+import type { ModelNodeSchema } from './ModelNode';
+
+export type ModelSchema = {
+  al?: string[];         // animations looped 
+  ao?: string[];         // animations one shot
+  ap?: number;           // animations playback rate
+  as?: string[];         // animations stop
+  n?: ModelNodeSchema[]; // node custom configurations
+  pn?: string;           // parent node name (When model is attached to another model)
+  u?: string;            // uri
+}
+
+export const modelSchema: JSONSchemaType<ModelSchema> = {
+  type: 'object',
+  properties: {
+    al: { type: 'array', items: { type: 'string' }, nullable: true },
+    ao: { type: 'array', items: { type: 'string' }, nullable: true },
+    ap: { type: 'number', nullable: true },
+    as: { type: 'array', items: { type: 'string' }, nullable: true },
+    n: { type: 'array', items: { ...modelNodeSchema }, nullable: true },
+    pn: { type: 'string', nullable: true },
+    u: { type: 'string', nullable: true },
+  },
+  additionalProperties: false,
+}

package/schemas/ModelNode.ts

@@ -0,0 +1,32 @@
+import { quaternionSchema } from './Quaternion';
+import { rgbColorSchema } from './RgbColor';
+import { vectorSchema } from './Vector';
+import type { JSONSchemaType } from 'ajv';
+import type { QuaternionSchema } from './Quaternion';
+import type { RgbColorSchema } from './RgbColor';
+import type { VectorSchema } from './Vector';
+
+export type ModelNodeSchema = {
+  n: string;            // node name matcher, supporting wildcards (*), ie *-hand should match left-hand, right-hand nodes.
+  o?: number;           // opacity
+  p?: VectorSchema;     // relative position
+  r?: QuaternionSchema; // relative rotation
+  s?: number;           // scale
+  t?: RgbColorSchema;   // tint color
+  v?: boolean;          // visible
+}
+
+export const modelNodeSchema: JSONSchemaType<ModelNodeSchema> = {
+  type: 'object',
+  properties: {
+    n: { type: 'string' },
+    o: { type: 'number', minimum: 0, maximum: 1, nullable: true },
+    p: { ...vectorSchema, nullable: true },
+    r: { ...quaternionSchema, nullable: true },
+    s: { type: 'number', nullable: true },
+    t: { ...rgbColorSchema, nullable: true },
+    v: { type: 'boolean', nullable: true },
+  },
+  required: [ 'n' ],
+  additionalProperties: false,
+}