@hytopia.com/server-protocol 1.3.38 → 1.3.40

package/package.json

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

package/packets/PacketCore.ts

@@ -32,7 +32,7 @@ export enum PacketId {
   BLOCK_TYPES = 35,
   CHAT_MESSAGES = 36,
   CHUNKS = 37,
-  ENTITIES = 38,
+  MODELS = 38,
   WORLD = 39,
   CAMERA = 40,
   UI = 41,

package/packets/outbound/Models.ts

@@ -0,0 +1,12 @@
+import { definePacket, PacketId } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
+import { modelsSchema } from '../../schemas/Models';
+import type { ModelsSchema } from '../../schemas/Models';
+import type { WorldTick } from '../PacketCore';
+
+export type ModelsPacket = IPacket<typeof PacketId.MODELS, ModelsSchema> & [WorldTick];
+
+export const modelsPacketDefinition = definePacket(
+  PacketId.MODELS,
+  modelsSchema,
+);

package/packets/outbound/index.ts

@@ -4,8 +4,8 @@ export * from './BlockTypes';
 export * from './Camera';
 export * from './ChatMessages';
 export * from './Chunks';
-export * from './Entities';
 export * from './Lights';
+export * from './Models';
 export * from './PhysicsDebugRender';
 export * from './PhysicsDebugRaycasts';
 export * from './SceneUIs';

package/schemas/Model.ts

@@ -0,0 +1,44 @@
+import { quaternionSchema } from './Quaternion';
+import { modelNodeSchema } from './ModelNode';
+import { vectorSchema } from './Vector';
+import type { JSONSchemaType } from 'ajv';
+import type { QuaternionSchema } from './Quaternion';
+import type { ModelNodeSchema } from './ModelNode';
+import type { VectorSchema } from './Vector';
+
+export type ModelSchema = {
+  i: number;             // model id
+  al?: string[];         // animations looped 
+  ao?: string[];         // animations one shot
+  ap?: number;           // animations playback rate
+  as?: string[];         // animations stop
+  bh?: VectorSchema;     // block model half extents
+  bt?: string;           // block model texture uri
+  n?: ModelNodeSchema[]; // model node custom configurations
+  p?: VectorSchema;      // position
+  pm?: number;           // parent model id (When model is attached to another model)
+  pn?: string;           // parent node name (Optional node attached to when model is attached to another model)
+  r?: QuaternionSchema;  // rotation
+  u?: string;            // model uri
+}
+
+export const modelSchema: JSONSchemaType<ModelSchema> = {
+  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 },
+    n: { type: 'array', items: { ...modelNodeSchema }, nullable: true },
+    p: { ...vectorSchema, nullable: true },
+    pm: { type: 'number', nullable: true },
+    pn: { type: 'string', nullable: true },
+    r: { ...quaternionSchema, nullable: true },
+    u: { type: 'string', nullable: true },
+  },
+  required: [ 'i' ],
+  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,
+}

package/schemas/Models.ts

@@ -0,0 +1,10 @@
+import { modelSchema } from './Model';
+import type { JSONSchemaType } from 'ajv';
+import type { ModelSchema } from './Model';
+
+export type ModelsSchema = ModelSchema[];
+
+export const modelsSchema: JSONSchemaType<ModelsSchema> = {
+  type: 'array',
+  items: { ...modelSchema },
+}

package/packets/outbound/Entities.ts

@@ -1,12 +0,0 @@
-import { definePacket, PacketId } from '../PacketCore';
-import type { IPacket } from '../PacketCore';
-import { entitiesSchema } from '../../schemas/Entities';
-import type { EntitiesSchema } from '../../schemas/Entities';
-import type { WorldTick } from '../PacketCore';
-
-export type EntitiesPacket = IPacket<typeof PacketId.ENTITIES, EntitiesSchema> & [WorldTick];
-
-export const entitiesPacketDefinition = definePacket(
-  PacketId.ENTITIES,
-  entitiesSchema,
-);

package/schemas/Entities.ts

@@ -1,10 +0,0 @@
-import { entitySchema } from './Entity';
-import type { JSONSchemaType } from 'ajv';
-import type { EntitySchema } from './Entity';
-
-export type EntitiesSchema = EntitySchema[];
-
-export const entitiesSchema: JSONSchemaType<EntitiesSchema> = {
-  type: 'array',
-  items: { ...entitySchema },
-}

package/schemas/Entity.ts

@@ -1,50 +0,0 @@
-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 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
-  h?: string[];         // model parts to hide
-  m?: string;           // model uri
-  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 },
-    bh: { ...vectorSchema, nullable: true },
-    bt: { type: 'string', nullable: true },
-    h: { type: 'array', items: { type: 'string' }, nullable: true },
-    m: { type: 'string', 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,
-}