@hytopia.com/server-protocol 1.4.54 → 1.4.56-dev1

package/package.json

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

package/schemas/Entity.ts

@@ -1,9 +1,11 @@
 import { rgbColorSchema } from './RgbColor';
+import { modelAnimationSchema } from './ModelAnimation';
 import { modelNodeOverrideSchema } from './ModelNodeOverride';
 import { outlineSchema } from './Outline';
 import { quaternionSchema } from './Quaternion';
 import { vectorSchema } from './Vector';
 import type { JSONSchemaType } from 'ajv';
+import type { ModelAnimationSchema } from './ModelAnimation';
 import type { ModelNodeOverrideSchema } from './ModelNodeOverride';
 import type { OutlineSchema } from './Outline';
 import type { QuaternionSchema } from './Quaternion';
@@ -12,29 +14,24 @@ 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
   bh?: VectorSchema;              // block half extents
   bt?: string;                    // block texture uri
   e?: boolean;                    // environmental
   ec?: RgbColorSchema;            // emissive color
   ei?: number;                    // emissive intensity
-  h?: string[];                   // model nodes to hide by partial case insensitive match of gltf node names - merge into node overrides?
   m?: string;                     // model uri
+  ma?: ModelAnimationSchema[];    // model animations
   mo?: ModelNodeOverrideSchema[]; // model node overrides
   mt?: string;                    // model texture uri (custom override)
   n?: string;                     // name
   o?: number;                     // opacity
-  ol?: OutlineSchema;      // outline options
+  ol?: OutlineSchema;             // outline options
   p?: VectorSchema;               // position
   pe?: number;                    // parent entity id
   pn?: string;                    // parent node name
   r?: QuaternionSchema;           // rotation
   rm?: boolean;                   // removed/remove
   s?: number;                     // model scale - Deprecated as of 0.11.10, use sv
-  sn?: string[];                  // model nodes to show by partial case insensitive match of gltf node names - merge into node overrides?
   sv?: VectorSchema;              // model scale vector for each axis
   t?: RgbColorSchema;             // tint color
 }
@@ -43,17 +40,13 @@ 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 },
     bh: { ...vectorSchema, nullable: true },
     bt: { type: 'string', nullable: true },
     e: { type: 'boolean', nullable: true },
     ec: { ...rgbColorSchema, nullable: true },
     ei: { type: 'number', nullable: true },
-    h: { type: 'array', items: { type: 'string' }, nullable: true },
     m: { type: 'string', nullable: true },
+    ma: { type: 'array', items: { ...modelAnimationSchema }, nullable: true },
     mo: { type: 'array', items: { ...modelNodeOverrideSchema }, nullable: true },
     mt: { type: 'string', nullable: true },
     n: { type: 'string', nullable: true },
@@ -65,7 +58,6 @@ export const entitySchema: JSONSchemaType<EntitySchema> = {
     r: { ...quaternionSchema, nullable: true },
     rm: { type: 'boolean', nullable: true },
     s: { type: 'number', nullable: true },
-    sn: { type: 'array', items: { type: 'string' }, nullable: true },
     sv: { ...vectorSchema, nullable: true },
     t: { ...rgbColorSchema, nullable: true },
   },

package/schemas/ModelAnimation.ts

@@ -0,0 +1,32 @@
+import { JSONSchemaType } from 'ajv';
+
+export type ModelAnimationSchema = {
+  n: string;    // animation name
+  b?: number;   // blend mode enum index
+  c?: boolean;  // clamp when finished
+  l?: number;   // loop mode enum index
+  p?: boolean;  // play
+  pa?: boolean; // pause
+  pr?: number;  // playback rate
+  r?: boolean;  // restart
+  s?: boolean;  // stop
+  w?: number;   // weight
+}
+
+export const modelAnimationSchema: JSONSchemaType<ModelAnimationSchema> = {
+  type: 'object',
+  properties: {
+    n: { type: 'string' },
+    b: { type: 'number', nullable: true },
+    c: { type: 'boolean', nullable: true },
+    l: { type: 'number', nullable: true },
+    p: { type: 'boolean', nullable: true },
+    pa: { type: 'boolean', nullable: true },
+    pr: { type: 'number', nullable: true },
+    r: { type: 'boolean', nullable: true },
+    s: { type: 'boolean', nullable: true },
+    w: { type: 'number', nullable: true },
+  },
+  required: [ 'n' ],
+  additionalProperties: false,
+}

package/schemas/ModelNodeOverride.ts

@@ -6,6 +6,7 @@ export type ModelNodeOverrideSchema = {
   n: string;           // node name match
   ec?: RgbColorSchema; // emissive color
   ei?: number;         // emissive intensity
+  h?: boolean;         // hidden
 }
 
 export const modelNodeOverrideSchema: JSONSchemaType<ModelNodeOverrideSchema> = {
@@ -14,6 +15,7 @@ export const modelNodeOverrideSchema: JSONSchemaType<ModelNodeOverrideSchema> =
     n: { type: 'string' },
     ec: { ...rgbColorSchema, nullable: true },
     ei: { type: 'number', nullable: true },
+    h: { type: 'boolean', nullable: true },
   },
   required: [ 'n' ],
   additionalProperties: false,

package/schemas/ParticleEmitter.ts

@@ -26,7 +26,7 @@ export type ParticleEmitterSchema = {
   o?: VectorSchema;     // offset
   oe?: number;          // opacity end
   oev?: number;         // opacity end variance
-  or?: number;          // orientation mode: 0=billboard, 1=billboardY, 2=fixed
+  or?: number;          // orientation mode: 0=billboard, 1=billboardY, 2=fixed, 3=velocity
   ofr?: VectorSchema;   // orientation fixed rotation in degrees (x, y, z)
   os?: number;          // opacity start
   osv?: number;         // opacity start variance

package/schemas/index.ts

@@ -18,6 +18,7 @@ export * from './HexColor';
 export * from './Input';
 export * from './Light';
 export * from './Lights';
+export * from './ModelAnimation';
 export * from './ModelNodeOverride';
 export * from './NotificationPermissionRequest';
 export * from './Outline';