allow positions to be a tuple

Author: luludotdev

src/client/client.ts

@@ -5,7 +5,7 @@ import type { Buffer } from 'node:buffer'
 import type { SetOptional } from 'type-fest'
 import { deserializeMessage, serializeMessage } from '../codec.js'
 import { Instruction } from '../index.js'
-import type { Message, Vector3 } from '../interfaces.js'
+import type { Message, Vector3Arg } from '../interfaces.js'
 import { Replication } from '../worldql-fb/index.js'
 import type { ClientEvents as Events, MessagePayload } from './interfaces.js'
 
@@ -154,7 +154,7 @@ export class Client extends EventEmitter<Events> {
    */
   public localMessage(
     worldName: string,
-    position: Readonly<Vector3>,
+    position: Vector3Arg,
     replication = Replication.ExceptSelf,
     payload?: Readonly<MessagePayload>
   ): void {
@@ -196,7 +196,7 @@ export class Client extends EventEmitter<Events> {
    * @param worldName World Name
    * @param position Area Position
    */
-  public areaSubscribe(worldName: string, position: Readonly<Vector3>): void {
+  public areaSubscribe(worldName: string, position: Vector3Arg): void {
     this.sendRawMessage({
       instruction: Instruction.AreaSubscribe,
       worldName,
@@ -209,7 +209,7 @@ export class Client extends EventEmitter<Events> {
    * @param worldName World Name
    * @param position Area Position
    */
-  public areaUnsubscribe(worldName: string, position: Readonly<Vector3>): void {
+  public areaUnsubscribe(worldName: string, position: Vector3Arg): void {
     this.sendRawMessage({
       instruction: Instruction.AreaUnsubscribe,
       worldName,

src/codec.ts

@@ -5,6 +5,7 @@ import type {
   Message,
   Record,
   Vector3,
+  Vector3Arg,
 } from './interfaces.js'
 import {
   EntityT,
@@ -34,7 +35,13 @@ const decodeFlex: (flex: number[]) => Uint8Array = flex => {
 // #endregion
 
 // #region Vector3
-const encodeVector3: (vec: Vector3) => Vec3dT = vec => {
+const encodeVector3: (vec: Vector3Arg) => Vec3dT = vec => {
+  // Handle tuples
+  if (Array.isArray(vec)) {
+    const [x, y, z] = vec
+    return new Vec3dT(x, y, z)
+  }
+
   return new Vec3dT(vec.x, vec.y, vec.z)
 }
 

src/index.ts

@@ -3,6 +3,8 @@ export type { ClientOptions } from './client/client.js'
 export type { ClientEvents } from './client/interfaces.js'
 export type {
   Vector3,
+  Vector3Arg,
+  Vector3Tuple,
   Record,
   Entity,
   Message,

src/interfaces.ts

@@ -6,6 +6,9 @@ export interface Vector3 {
   z: number
 }
 
+export type Vector3Tuple = [x: number, y: number, z: number]
+export type Vector3Arg = Vector3 | Vector3Tuple
+
 export interface Record {
   uuid: string
   position: Vector3
@@ -29,10 +32,11 @@ export interface Message {
   replication: Replication
   records?: Record[]
   entities?: Entity[]
-  position?: Vector3
+  position?: Vector3Arg
   flex?: Uint8Array
 }
 
 export interface IncomingMessage extends Message {
   senderUuid: string
+  position?: Vector3
 }