Function addSyncTransport

Returns {
    binaryMessageBus: {
        __processMessages: ((messages: Uint8Array[]) => void);
        emit: (<K>(message: K, value: Uint8Array, toPeerAddress?: string[]) => void);
        on: (<K>(message: K, callback: ((value: Uint8Array, sender: string) => void)) => void);
    };
    eventBus: Room<EventSchemaRegistry>;
    getChildren: ((parent: Entity) => Iterable<Entity>);
    getFirstChild: ((entity: Entity) => Entity);
    getParent: ((child: Entity) => Entity | undefined);
    isRoomReadyAtom: Atom<boolean>;
    isStateSyncronized: (() => boolean);
    myProfile: IProfile;
    parentEntity: ((entity: Entity, parent: Entity) => void);
    removeParent: ((entity: Entity) => void);
    syncEntity: ((entityId: Entity, componentIds: number[], entityEnumId?: number) => void);
}

• binaryMessageBus: {
      __processMessages: ((messages: Uint8Array[]) => void);
      emit: (<K>(message: K, value: Uint8Array, toPeerAddress?: string[]) => void);
      on: (<K>(message: K, callback: ((value: Uint8Array, sender: string) => void)) => void);
  }

  • __processMessages: ((messages: Uint8Array[]) => void)

    • • (messages: Uint8Array[]): void

      • Parameters

        • messages: Uint8Array[]

        Returns void

  • emit: (<K>(message: K, value: Uint8Array, toPeerAddress?: string[]) => void)

    • • <K>(message: K, value: Uint8Array, toPeerAddress?: string[]): void

      • Type Parameters

        • K extends CommsMessage

        Parameters

        • message: K

        • value: Uint8Array

        • Optional toPeerAddress: string[]

        Returns void

  • on: (<K>(message: K, callback: ((value: Uint8Array, sender: string) => void)) => void)

    • • <K>(message: K, callback: ((value: Uint8Array, sender: string) => void)): void

      • Type Parameters

        • K extends CommsMessage

        Parameters

        • message: K

        • callback: ((value: Uint8Array, sender: string) => void)

          • • (value: Uint8Array, sender: string): void

            • Parameters

              • value: Uint8Array

              • sender: string

              Returns void

        Returns void

• eventBus: Room<EventSchemaRegistry>

• getChildren: ((parent: Entity) => Iterable<Entity>)

  • • (parent: Entity): Iterable<Entity>

    • Returns an iterable of all the childrens of the given entity. for (const children of getChildren(parent)) { console.log(children) } or just => const childrens: Entity[] = Array.from(getChildren(parent))

      Parameters

      • parent: Entity

      Returns Iterable<Entity>

• getFirstChild: ((entity: Entity) => Entity)

  • • (entity: Entity): Entity

    • Parameters

      • entity: Entity

      Returns Entity

• getParent: ((child: Entity) => Entity | undefined)

  • • (child: Entity): Entity | undefined

    • Returns the parent entity of the given entity.

      Parameters

      • child: Entity

      Returns Entity | undefined

• isRoomReadyAtom: Atom<boolean>

• isStateSyncronized: (() => boolean)

  • • (): boolean

    • Returns boolean

• myProfile: IProfile

• parentEntity: ((entity: Entity, parent: Entity) => void)

  • • (entity: Entity, parent: Entity): void

    • Adds the network parenting to sync entities. Equivalent to Transform.parent for local entities

      Parameters

      • entity: Entity

      • parent: Entity

      Returns void

• removeParent: ((entity: Entity) => void)

  • • (entity: Entity): void

    • Removes the network parenting from an entity

      Parameters

      • entity: Entity

      Returns void

• syncEntity: ((entityId: Entity, componentIds: number[], entityEnumId?: number) => void)

  • • (entityId: Entity, componentIds: number[], entityEnumId?: number): void

    • Create a network entity (sync) through comms, and sync the received components

      Parameters

      • entityId: Entity

      • componentIds: number[]

      • Optional entityEnumId: number

      Returns void