Class CustomNetworkTransform<RoomType>

Represents player component for networking movement.

See CustomNetworkTransformEvents for events to listen to.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

NetworkedObject<RoomType, CustomNetworkTransformEvents<RoomType>>
- CustomNetworkTransform

Index

Constructors

constructor

new CustomNetworkTransform<RoomType extends StatefulRoom<any>>(
    room: RoomType,
    spawnType: SpawnType,
    netId: number,
    ownerId: number,
    flags: number,
): CustomNetworkTransform<RoomType>
Type Parameters
- RoomType extends StatefulRoom<any>
Parameters
- room: RoomType
- spawnType: SpawnType
- netId: number
- ownerId: number
- flags: number
Returns CustomNetworkTransform<RoomType>
Overrides NetworkedObject.constructor
- Defined in packages/core/lib/objects/component/CustomNetworkTransform.ts:49

Properties

components

components: NetworkedObject<RoomType, any>[]

dirtyBit

dirtyBit: number = 0

The dirty state of this component.

flags

flags: number

Flags for this object, see SpawnFlag.

netId

netId: number

The net ID of this component.

ownerId

ownerId: number

The ID of the owner of this component.

player

player: Player<RoomType>

The player that this component belongs to.

position

position: Vector2

The current position of the player.

room

room: RoomType

The room that this component belongs to.

seqId

seqId: number

The current sequence ID.

spawnType

spawnType: SpawnType

The type of object that this component belongs to.

Accessors

owner

get owner(): undefined | StatefulRoom<any> | Player<RoomType>
Returns undefined | StatefulRoom<any> | Player<RoomType>
Inherited from NetworkedObject.owner
- Defined in packages/core/lib/NetworkedObject.ts:69

Methods

deserializeFromReader

deserializeFromReader(reader: HazelReader, spawn?: boolean): void
Parameters
- reader: HazelReader
- spawn: boolean = false
Returns void
Overrides NetworkedObject.deserializeFromReader
- Defined in packages/core/lib/objects/component/CustomNetworkTransform.ts:73

Destroy

Destroy(): void
Returns void
Inherited from NetworkedObject.Destroy
- Defined in packages/core/lib/NetworkedObject.ts:136

emit

emit<Event extends BasicEvent>(event: Event): Promise<Event>
Type Parameters
- Event extends BasicEvent
Parameters
- event: Event
Returns Promise<Event>
Inherited from NetworkedObject.emit
- Defined in packages/core/lib/NetworkedObject.ts:101

emitSerial

emitSerial<Event extends BasicEvent>(event: Event): Promise<Event>
Type Parameters
- Event extends BasicEvent
Parameters
- event: Event
Returns Promise<Event>
Inherited from NetworkedObject.emitSerial
- Defined in packages/core/lib/NetworkedObject.ts:111

emitSync

emitSync<Event extends BasicEvent>(event: Event): Event
Type Parameters
- Event extends BasicEvent
Parameters
- event: Event
Returns Event
Inherited from NetworkedObject.emitSync
- Defined in packages/core/lib/NetworkedObject.ts:121

getComponentSafe

getComponentSafe<T>(
index: number,
ComponentType: NetworkedObjectConstructor<T>,
): undefined | T
Get a certain component from the object.
Type Parameters
- T
Parameters
- index: number
- ComponentType: NetworkedObjectConstructor<T>
  The component class to get.
Returns undefined | T
Inherited from NetworkedObject.getComponentSafe
- Defined in packages/core/lib/NetworkedObject.ts:142

getListeners

getListeners<Event extends BasicEvent = BasicEvent>(
event: string,
): Listener<Event>[]
Type Parameters
- Event extends BasicEvent = BasicEvent
Parameters
- event: string
Returns Listener<Event>[]
Inherited from NetworkedObject.getListeners
- Defined in packages/events/lib/EventEmitter.ts:150

handleRemoteCall

handleRemoteCall(rpc: BaseRpcMessage): Promise<void>
Parameters
- rpc: BaseRpcMessage
Returns Promise<void>
Overrides NetworkedObject.handleRemoteCall
- Defined in packages/core/lib/objects/component/CustomNetworkTransform.ts:110

move

move(position: Vector2): Promise<void>
Move to a position (lerps towards).
Parameters
- position: Vector2
  The position to move towards.
Returns Promise<void>
Example
```
// Follow the host
host.transform.on("player.move", ev => {
  player.transform.move(ev.position);
});
```
- Defined in packages/core/lib/objects/component/CustomNetworkTransform.ts:129

off

off<
    EventName extends
        | "component.spawn"
        | "component.despawn"
        | "player.move"
        | "player.snapto",
>(
    event: EventName,
    listener: Listener<CustomNetworkTransformEvents<RoomType>[EventName]>,
): void
Type Parameters
- EventName extends "component.spawn" | "component.despawn" | "player.move" | "player.snapto"
Parameters
- event: EventName
- listener: Listener<CustomNetworkTransformEvents<RoomType>[EventName]>
Returns void
Inherited from NetworkedObject.off
- Defined in packages/events/lib/EventEmitter.ts:137
off<K extends BasicEvent>(event: string, listener: Listener<K>): void
Type Parameters
- K extends BasicEvent
Parameters
- event: string
- listener: Listener<K>
Returns void
Inherited from NetworkedObject.off
- Defined in packages/events/lib/EventEmitter.ts:141

on

on<
    EventName extends
        | "component.spawn"
        | "component.despawn"
        | "player.move"
        | "player.snapto",
>(
    event: EventName,
    listener: Listener<CustomNetworkTransformEvents<RoomType>[EventName]>,
): () => void
Type Parameters
- EventName extends "component.spawn" | "component.despawn" | "player.move" | "player.snapto"
Parameters
- event: EventName
- listener: Listener<CustomNetworkTransformEvents<RoomType>[EventName]>
Returns () => void
Inherited from NetworkedObject.on
- Defined in packages/events/lib/EventEmitter.ts:86
on<K extends BasicEvent>(event: string, listener: Listener<K>): () => void
Type Parameters
- K extends BasicEvent
Parameters
- event: string
- listener: Listener<K>
Returns () => void
Inherited from NetworkedObject.on
- Defined in packages/events/lib/EventEmitter.ts:90

once

once<
    EventName extends
        | "component.spawn"
        | "component.despawn"
        | "player.move"
        | "player.snapto",
>(
    event: EventName,
    listener: Listener<CustomNetworkTransformEvents<RoomType>[EventName]>,
): () => void
Type Parameters
- EventName extends "component.spawn" | "component.despawn" | "player.move" | "player.snapto"
Parameters
- event: EventName
- listener: Listener<CustomNetworkTransformEvents<RoomType>[EventName]>
Returns () => void
Inherited from NetworkedObject.once
- Defined in packages/events/lib/EventEmitter.ts:98
once<K extends BasicEvent>(event: string, listener: Listener<K>): () => void
Type Parameters
- K extends BasicEvent
Parameters
- event: string
- listener: Listener<K>
Returns () => void
Inherited from NetworkedObject.once
- Defined in packages/events/lib/EventEmitter.ts:102

processAwake

processAwake(): Promise<void>
Returns Promise<void>
Overrides NetworkedObject.processAwake
- Defined in packages/core/lib/objects/component/CustomNetworkTransform.ts:68

processFixedUpdate

processFixedUpdate(delta: number): Promise<void>
Parameters
- delta: number
Returns Promise<void>
Overrides NetworkedObject.processFixedUpdate
- Defined in packages/core/lib/objects/component/CustomNetworkTransform.ts:64

removeAllListeners

removeAllListeners(): void
Returns void
Inherited from NetworkedObject.removeAllListeners
- Defined in packages/events/lib/EventEmitter.ts:164

removeListeners

removeListeners(event: string): void
Parameters
- event: string
Returns void
Inherited from NetworkedObject.removeListeners
- Defined in packages/events/lib/EventEmitter.ts:159

serializeToWriter

serializeToWriter(writer: HazelWriter, spawn?: boolean): boolean
Parameters
- writer: HazelWriter
- spawn: boolean = false
Returns boolean
Overrides NetworkedObject.serializeToWriter
- Defined in packages/core/lib/objects/component/CustomNetworkTransform.ts:97

snapTo

snapTo(position: Vector2, rpc?: boolean): Promise<void>
Instantly snap to a position without lerping.
Parameters
- position: Vector2
  The position to snap to.
- Optionalrpc: boolean
Returns Promise<void>
Example
```
// Instantly teleport to wherever the host moves.
host.transform.on("player.move", ev => {
  client.me.transform.snapTo(ev.position);
});
```
- Defined in packages/core/lib/objects/component/CustomNetworkTransform.ts:209
snapTo(x: number, y: number, rpc?: boolean): Promise<void>
Instantly snap to a position without lerping.
Parameters
- x: number
  The X position to snap to.
- y: number
  The Y position to snap to.
- Optionalrpc: boolean
Returns Promise<void>
Example
```
// Instantly teleport to wherever the host moves.
host.transform.on("player.move", ev => {
  client.me.transform.snapTo(ev.position.x, ev.position.y);
});
```
- Defined in packages/core/lib/objects/component/CustomNetworkTransform.ts:222

wait

wait<
    EventName extends
        | "component.spawn"
        | "component.despawn"
        | "player.move"
        | "player.snapto",
>(
    event: EventName,
): Promise<CustomNetworkTransformEvents<RoomType>[EventName]>
Type Parameters
- EventName extends "component.spawn" | "component.despawn" | "player.move" | "player.snapto"
Parameters
- event: EventName
Returns Promise<CustomNetworkTransformEvents<RoomType>[EventName]>
Inherited from NetworkedObject.wait
- Defined in packages/events/lib/EventEmitter.ts:111
wait(event: string): Promise<BasicEvent>
Parameters
- event: string
Returns Promise<BasicEvent>
Inherited from NetworkedObject.wait
- Defined in packages/events/lib/EventEmitter.ts:114

waitf

waitf<
    EventName extends
        | "component.spawn"
        | "component.despawn"
        | "player.move"
        | "player.snapto",
>(
    event: EventName,
    filter: (
        ev: CustomNetworkTransformEvents<RoomType>[EventName],
    ) => boolean | Promise<boolean>,
): Promise<CustomNetworkTransformEvents<RoomType>[EventName]>
Type Parameters
- EventName extends "component.spawn" | "component.despawn" | "player.move" | "player.snapto"
Parameters
- event: EventName
- filter: (
  ev: CustomNetworkTransformEvents<RoomType>[EventName],
  ) => boolean | Promise<boolean>
Returns Promise<CustomNetworkTransformEvents<RoomType>[EventName]>
Inherited from NetworkedObject.waitf
- Defined in packages/events/lib/EventEmitter.ts:121
waitf<K extends BasicEvent>(
event: string,
filter: (ev: K) => boolean | Promise<boolean>,
): Promise<BasicEvent>
Type Parameters
- K extends BasicEvent
Parameters
- event: string
- filter: (ev: K) => boolean | Promise<boolean>
Returns Promise<BasicEvent>
Inherited from NetworkedObject.waitf
- Defined in packages/events/lib/EventEmitter.ts:125

Class CustomNetworkTransform<RoomType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CustomNetworkTransform<RoomType>

Properties

components

dirtyBit

flags

netId

ownerId

player

position

room

seqId

spawnType

Accessors

owner

Returns undefined | StatefulRoom<any> | Player<RoomType>

Methods

deserializeFromReader

Parameters

Returns void

Destroy

Returns void

emit

Type Parameters

Parameters

Returns Promise<Event>

emitSerial

Type Parameters

Parameters

Returns Promise<Event>

emitSync

Type Parameters

Parameters

Returns Event

getComponentSafe

Type Parameters

Parameters

Returns undefined | T

getListeners

Type Parameters

Parameters

Returns Listener<Event>[]

handleRemoteCall

Parameters

Returns Promise<void>

move

Parameters

Returns Promise<void>

Example

off

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns () => void

Type Parameters

Parameters

Returns () => void

once

Type Parameters

Parameters

Returns () => void

Type Parameters

Parameters