Class NetworkSync

Entity component that bridges the Entity system with StateSync. Automatically registers/unregisters the entity and syncs position.

Hierarchy (View Summary)

Component
- NetworkSync

Index

Constructors

Properties

Accessors

isLocal networkId

Methods

onAttach onDetach reset update

Constructors

constructor

new NetworkSync(
    stateSync: StateSync,
    entityId: string,
    isLocal: boolean,
): NetworkSync
Parameters
- stateSync: StateSync
  The StateSync instance to register with
- entityId: string
  Unique network ID for this entity
- isLocal: boolean
  True if this entity is controlled locally (sends state); false for remote entities (receives state)
Returns NetworkSync
Overrides Component.constructor
- Defined in packages/clik-engine/src/entity/components/NetworkSync.ts:18

Properties

enabled

enabled: boolean = true

entity

entity: Entity

Accessors

isLocal

get isLocal(): boolean
Returns boolean
- Defined in packages/clik-engine/src/entity/components/NetworkSync.ts:44

networkId

get networkId(): string
Returns string
- Defined in packages/clik-engine/src/entity/components/NetworkSync.ts:48

Methods

onAttach

onAttach(): void
Called when the component is added to an entity

Returns void
Overrides Component.onAttach
- Defined in packages/clik-engine/src/entity/components/NetworkSync.ts:25

onDetach

onDetach(): void
Called when the component is removed or entity is destroyed

Returns void
Overrides Component.onDetach
- Defined in packages/clik-engine/src/entity/components/NetworkSync.ts:40

reset

reset(): void
Called when the owning entity is recycled from a pool. Reset internal state to defaults.

Returns void
Inherited from Component.reset
- Defined in packages/clik-engine/src/entity/Component.ts:17

update

update(_delta: number): void
Called every frame
Parameters
- _delta: number
Returns void
Overrides Component.update
- Defined in packages/clik-engine/src/entity/components/NetworkSync.ts:33