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

Constructors

constructor

new CustomNetworkTransform<
    RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>,
>(
    room: RoomType,
    spawnType: SpawnType,
    netId: number,
    ownerId: number,
    flags: number,
): CustomNetworkTransform<RoomType>
Type Parameters
- RoomType extends StatefulRoom<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/CustomNetworkTransform.ts:53

Properties

components

components: NetworkedObject<RoomType, any>[]

`Readonly`flags

flags: number

`Readonly`netId

netId: number

`Readonly`ownerId

ownerId: number

pendingDataState

pendingDataState: DataState

player

player: Player<RoomType>

The player that this component belongs to.

position

position: Vector2 = Vector2.null

The current position of the player.

`Readonly`room

room: RoomType

seqId

seqId: number = 0

The current sequence ID.

`Readonly`spawnType

spawnType: SpawnType

Accessors

owner

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

Methods

cancelDataState

cancelDataState(state: DataState): void
Parameters
- state: DataState
Returns void
Inherited from NetworkedObject.cancelDataState
- Defined in packages/core/lib/NetworkedObject.ts:121

createData

createData(state: DataState): undefined | BaseSystemMessage
Parameters
- state: DataState
Returns undefined | BaseSystemMessage
Overrides NetworkedObject.createData
- Defined in packages/core/lib/objects/CustomNetworkTransform.ts:100

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:75

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:85

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:95

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:135

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

handleData

handleData(data: BaseSystemMessage): Promise<void>
Parameters
- data: BaseSystemMessage
Returns Promise<void>
Overrides NetworkedObject.handleData
- Defined in packages/core/lib/objects/CustomNetworkTransform.ts:81

handleRemoteCall

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

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/CustomNetworkTransform.ts:130

off

off<
    EventName extends
        | "component.spawn"
        | "component.despawn"
        | "player.move"
        | "player.snapto",
>(
    event: EventName,
    listener: Listener<
        (
            NetworkedObjectEvents<RoomType> & CustomNetworkTransformEvents<
                RoomType,
            >
        )[EventName],
    >,
): void
Type Parameters
- EventName extends "component.spawn" | "component.despawn" | "player.move" | "player.snapto"
Parameters
- event: EventName
- listener: Listener<
      (
          NetworkedObjectEvents<RoomType> & 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<
        (
            NetworkedObjectEvents<RoomType> & CustomNetworkTransformEvents<
                RoomType,
            >
        )[EventName],
    >,
): () => void
Type Parameters
- EventName extends "component.spawn" | "component.despawn" | "player.move" | "player.snapto"
Parameters
- event: EventName
- listener: Listener<
      (
          NetworkedObjectEvents<RoomType> & 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<
        (
            NetworkedObjectEvents<RoomType> & CustomNetworkTransformEvents<
                RoomType,
            >
        )[EventName],
    >,
): () => void
Type Parameters
- EventName extends "component.spawn" | "component.despawn" | "player.move" | "player.snapto"
Parameters
- event: EventName
- listener: Listener<
      (
          NetworkedObjectEvents<RoomType> & 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

processFixedUpdate

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

pushDataState

pushDataState(state: DataState): void
Parameters
- state: DataState
Returns void
Inherited from NetworkedObject.pushDataState
- Defined in packages/core/lib/NetworkedObject.ts:115

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

resetDataState

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

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/CustomNetworkTransform.ts:205
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/CustomNetworkTransform.ts:218

wait

wait<
    EventName extends
        | "component.spawn"
        | "component.despawn"
        | "player.move"
        | "player.snapto",
>(
    event: EventName,
): Promise<
    (
        NetworkedObjectEvents<RoomType> & CustomNetworkTransformEvents<
            RoomType,
        >
    )[EventName],
>
Type Parameters
- EventName extends "component.spawn" | "component.despawn" | "player.move" | "player.snapto"
Parameters
- event: EventName
Returns Promise<
    (
        NetworkedObjectEvents<RoomType> & 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: (
            NetworkedObjectEvents<RoomType> & CustomNetworkTransformEvents<
                RoomType,
            >
        )[EventName],
    ) => boolean
    | Promise<boolean>,
): Promise<
    (
        NetworkedObjectEvents<RoomType> & CustomNetworkTransformEvents<
            RoomType,
        >
    )[EventName],
>
Type Parameters
- EventName extends "component.spawn" | "component.despawn" | "player.move" | "player.snapto"
Parameters
- event: EventName
- filter: (
      ev: (
          NetworkedObjectEvents<RoomType> & CustomNetworkTransformEvents<
              RoomType,
          >
      )[EventName],
  ) => boolean
  | Promise<boolean>
Returns Promise<
    (
        NetworkedObjectEvents<RoomType> & 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

Readonlyflags

ReadonlynetId

ReadonlyownerId

pendingDataState

player

position

Readonlyroom

seqId

ReadonlyspawnType

Accessors

owner

Returns undefined | StatefulRoom<StatefulRoom<any, {}>, {}> | Player<RoomType>

Methods

cancelDataState

Parameters

Returns void

createData

Parameters

Returns undefined | BaseSystemMessage

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>[]

handleData

Parameters

Returns Promise<void>

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

`Readonly`flags

`Readonly`netId

`Readonly`ownerId

`Readonly`room

`Readonly`spawnType

Returns Promise<
(
NetworkedObjectEvents<RoomType> & CustomNetworkTransformEvents<
RoomType,
>
)[EventName],
>

Returns Promise<
(
NetworkedObjectEvents<RoomType> & CustomNetworkTransformEvents<
RoomType,
>
)[EventName],
>