@hytopia.com/server-protocol 1.4.9 → 1.4.10-dev2

package/package.json

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

package/packets/PacketCore.ts

@@ -40,6 +40,7 @@ export enum PacketId {
   SCENE_UIS = 43,
   LIGHTS = 44,
   PLAYERS = 45,
+  PARTICLE_EMITTERS = 46,
 
   // Standard Bi-Directional Packet Types: 116 - 127 range
   CONNECTION = 116,

package/packets/outbound/ParticleEmitters.ts

@@ -0,0 +1,12 @@
+import { definePacket, PacketId } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
+import { particleEmittersSchema } from '../../schemas/ParticleEmitters';
+import type { ParticleEmittersSchema } from '../../schemas/ParticleEmitters';
+import type { WorldTick } from '../PacketCore';
+
+export type ParticleEmittersPacket = IPacket<typeof PacketId.PARTICLE_EMITTERS, ParticleEmittersSchema> & [WorldTick];
+
+export const particleEmittersPacketDefinition = definePacket(
+  PacketId.PARTICLE_EMITTERS,
+  particleEmittersSchema,
+);

package/packets/outbound/index.ts

@@ -6,6 +6,7 @@ export * from './ChatMessages';
 export * from './Chunks';
 export * from './Entities';
 export * from './Lights';
+export * from './ParticleEmitters';
 export * from './PhysicsDebugRender';
 export * from './PhysicsDebugRaycasts';
 export * from './Players';

package/schemas/ParticleEmitter.ts

@@ -0,0 +1,72 @@
+import { rgbColorSchema } from './RgbColor';
+import { vectorSchema } from './Vector';
+import type { JSONSchemaType } from 'ajv';
+import type { RgbColorSchema } from './RgbColor';
+import type { VectorSchema } from './Vector';
+
+export type ParticleEmitterSchema = {
+  i: number;            // particle emitter id
+  at?: number;          // alpha test, 0 to 1
+  ce?: RgbColorSchema;  // color end, rgb color
+  cev?: RgbColorSchema; // color end variance, rgb color
+  cs?: RgbColorSchema;  // color start, rgb color
+  csv?: RgbColorSchema; // color start variance, rgb color
+  e?: number;           // entity attachment, follows entity id
+  en?: string;          // entity attachment node name, follows entity node name
+  g?: VectorSchema;     // gravity per axis as vector3
+  l?: number;           // lifetime, in seconds
+  lv?: number;          // lifetime variance, in seconds
+  mp?: number;          // max particles
+  o?: VectorSchema;     // offset
+  oe?: number;          // opacity end
+  oev?: number;         // opacity end variance
+  os?: number;          // opacity start
+  osv?: number;         // opacity start variance
+  p?: VectorSchema;     // spatial position
+  pv?: VectorSchema;    // particle spatial variance relative to attachment or position
+  r?: number;           // rate, in particles per second
+  rv?: number;          // rate variance, in particles per second
+  rm?: boolean;         // remove/removed
+  s?: number;           // size, in pixels
+  sv?: number;          // size variance, in pixels
+  t?: boolean;          // transparent
+  tu?: string;          // texture uri
+  v?: VectorSchema;     // velocity per axis as vector3
+  vv?: VectorSchema;    // velocity variance per axis as vector3
+}
+
+export const particleEmitterSchema: JSONSchemaType<ParticleEmitterSchema> = {
+  type: 'object',
+  properties: {
+    i: { type: 'number' },
+    at: { type: 'number', nullable: true },
+    ce: { ...rgbColorSchema, nullable: true },
+    cev: { ...rgbColorSchema, nullable: true },
+    cs: { ...rgbColorSchema, nullable: true },
+    csv: { ...rgbColorSchema, nullable: true },
+    e: { type: 'number', nullable: true },
+    en: { type: 'string', nullable: true },
+    g: { ...vectorSchema, nullable: true },
+    l: { type: 'number', nullable: true },
+    lv: { type: 'number', nullable: true },
+    mp: { type: 'number', nullable: true },
+    o: { ...vectorSchema, nullable: true },
+    oe: { type: 'number', nullable: true },
+    oev: { type: 'number', nullable: true },
+    os: { type: 'number', nullable: true },
+    osv: { type: 'number', nullable: true },
+    p: { ...vectorSchema, nullable: true },
+    pv: { ...vectorSchema, nullable: true },
+    r: { type: 'number', nullable: true },
+    rv: { type: 'number', nullable: true },
+    rm: { type: 'boolean', nullable: true },
+    s: { type: 'number', nullable: true },
+    sv: { type: 'number', nullable: true },
+    t: { type: 'boolean', nullable: true },
+    tu: { type: 'string', nullable: true },
+    v: { ...vectorSchema, nullable: true },
+    vv: { ...vectorSchema, nullable: true },
+  },
+  required: ['i'],
+  additionalProperties: false,
+}

package/schemas/ParticleEmitters.ts

@@ -0,0 +1,10 @@
+import { particleEmitterSchema } from './ParticleEmitter';
+import type { JSONSchemaType } from 'ajv';
+import type { ParticleEmitterSchema } from './ParticleEmitter';
+
+export type ParticleEmittersSchema = ParticleEmitterSchema[];
+
+export const particleEmittersSchema: JSONSchemaType<ParticleEmittersSchema> = {
+  type: 'array',
+  items: { ...particleEmitterSchema },
+}

package/schemas/index.ts

@@ -19,6 +19,8 @@ export * from './Input';
 export * from './Light';
 export * from './Lights';
 export * from './ModelNodeOverride';
+export * from './ParticleEmitter';
+export * from './ParticleEmitters';
 export * from './PhysicsDebugRaycast';
 export * from './PhysicsDebugRaycasts';
 export * from './PhysicsDebugRender';