Class PlayerPhysics<RoomType>

Represents a player object for handling vent entering and exiting.

See PlayerPhysicsEvents for events to listen to.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

NetworkedObject<RoomType, PlayerPhysicsEvents<RoomType>>
- PlayerPhysics

Constructors

constructor

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

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.

`Readonly`room

room: RoomType

`Readonly`spawnType

spawnType: SpawnType

ventId

ventId: number = -1

The ID of the vent that the player is currently in.

Accessors

isInVent

get isInVent(): boolean
Returns boolean
- Defined in packages/core/lib/objects/PlayerPhysics.ts:68

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

bootFromVent

bootFromVent(ventId: number): Promise<void>
Parameters
- ventId: number
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerPhysics.ts:274

cancelDataState

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

cancelPet

cancelPet(): Promise<void>
Stop petting your or another player's pet.

Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerPhysics.ts:356

climbLadder

climbLadder(ladderid: number): Promise<void>
Climb a ladder on the map by its ID.

Emits a player.climbladder event.
Parameters
- ladderid: number
  The ID of the ladder to climb.
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerPhysics.ts:245

createData

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

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

enterVent

enterVent(ventId: number): void
Enter a vent on the map by its ID.

Emits a player.entervent event.
Parameters
- ventId: number
  The ID of the vent to enter.
Returns void
Example
```
client.me.physics.enterVent(PolusVent.Office);
```
- Defined in packages/core/lib/objects/PlayerPhysics.ts:150

exitVent

exitVent(ventId: number): void
Exit a vent (Does not have to be the same vent or in the same network as the vent you entered).

Emits a player.exitvent event.
Parameters
- ventId: number
  The ID of the vent to exit.
Returns void
Example
```
client.me.physics.enterVent(PolusVent.Office);
```
- Defined in packages/core/lib/objects/PlayerPhysics.ts:201

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/PlayerPhysics.ts:84

handleRemoteCall

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

off

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

parseData

parseData(state: DataState, reader: HazelReader): undefined | BaseSystemMessage
Parameters
- state: DataState
- reader: HazelReader
Returns undefined | BaseSystemMessage
Overrides NetworkedObject.parseData
- Defined in packages/core/lib/objects/PlayerPhysics.ts:80

parseRemoteCall

parseRemoteCall(
rpcTag: RpcMessageTag,
reader: HazelReader,
): undefined | BaseRpcMessage
Parameters
- rpcTag: RpcMessageTag
- reader: HazelReader
Returns undefined | BaseRpcMessage
Overrides NetworkedObject.parseRemoteCall
- Defined in packages/core/lib/objects/PlayerPhysics.ts:92

petPet

petPet(playerPos: Vector2, petPos: Vector2): Promise<void>
Visibly pet your pet or another player's pet.

Unfortunately, due to technical limitations (as SkeldJS doesn't implement various Unity physics/transform mechanics), there is no good way to get the position of the pet except through manual scuffing, which is out of scope of SkeldJS.
Parameters
- playerPos: Vector2
  The position of the player while petting.
- petPos: Vector2
  The position of the pet to pet.
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerPhysics.ts:317

processAwake

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

processFixedUpdate

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

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

wait

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

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PlayerPhysics<RoomType>

Properties

components

Readonlyflags

ReadonlynetId

ReadonlyownerId

pendingDataState

player

Readonlyroom

ReadonlyspawnType

ventId

Accessors

isInVent

Returns boolean

owner

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

Methods

bootFromVent

Parameters

Returns Promise<void>

cancelDataState

Parameters

Returns void

cancelPet

Returns Promise<void>

climbLadder

Parameters

Returns Promise<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

enterVent

Parameters

Returns void

Example

exitVent

Parameters

Returns void

Example

getComponentSafe

Type Parameters

Parameters

Returns undefined | T

getListeners

Type Parameters

Parameters

Returns Listener<Event>[]

handleData

Parameters

Returns Promise<void>

handleRemoteCall

Parameters

Returns Promise<void>

off

Type Parameters

Parameters

`Readonly`flags

`Readonly`netId

`Readonly`ownerId

`Readonly`room

`Readonly`spawnType

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

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