Class PlayerPhysics<RoomType>

Represents a player object for handling vent entering and exiting.

See PlayerPhysicsEvents for events to listen to.

Type Parameters

RoomType extends Hostable = Hostable

Hierarchy

Networkable<PlayerPhysicsData, PlayerPhysicsEvents, RoomType>
- PlayerPhysics

Implements

PlayerPhysicsData

Index

Methods

Awake

Awake(): void
Returns void
Inherited from Networkable.Awake
- Defined in node_modules/@skeldjs/core/dist/lib/Networkable.d.ts:63

Deserialize

Deserialize(reader: HazelReader, spawn?: boolean): void
Parameters
- reader: HazelReader
- Optional spawn: boolean
Returns void
Inherited from Networkable.Deserialize
- Defined in node_modules/@skeldjs/core/dist/lib/Networkable.d.ts:58

Destroy

Destroy(): void
Returns void
Inherited from Networkable.Destroy
- Defined in node_modules/@skeldjs/core/dist/lib/Networkable.d.ts:64

FixedUpdate

FixedUpdate(delta: number): void
Parameters
- delta: number
Returns void
Inherited from Networkable.FixedUpdate
- Defined in node_modules/@skeldjs/core/dist/lib/Networkable.d.ts:62

HandleRpc

HandleRpc(rpc: BaseRpcMessage): Promise<void>
Parameters
- rpc: BaseRpcMessage
Returns Promise<void>
Overrides Networkable.HandleRpc
- Defined in node_modules/@skeldjs/core/dist/lib/objects/component/PlayerPhysics.d.ts:35

PreSerialize

PreSerialize(): void
Returns void
Inherited from Networkable.PreSerialize
- Defined in node_modules/@skeldjs/core/dist/lib/Networkable.d.ts:60

Serialize

Serialize(writer: HazelWriter, spawn?: boolean): boolean
Parameters
- writer: HazelWriter
- Optional spawn: boolean
Returns boolean
Inherited from Networkable.Serialize
- Defined in node_modules/@skeldjs/core/dist/lib/Networkable.d.ts:59

canBeManaged

canBeManaged(): boolean
Whether or not this object

Returns boolean
Inherited from Networkable.canBeManaged
- Defined in node_modules/@skeldjs/core/dist/lib/Networkable.d.ts:81

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 node_modules/@skeldjs/core/dist/lib/objects/component/PlayerPhysics.d.ts:76

despawn

despawn(): void
Despawns the component from the room it belongs in.

Returns void
Inherited from Networkable.despawn
- Defined in node_modules/@skeldjs/core/dist/lib/Networkable.d.ts:77

emit

emit<Event>(event: Event): Promise<Event>
Type Parameters
- Event extends BasicEvent<Event>
Parameters
- event: Event
Returns Promise<Event>
Inherited from Networkable.emit
- Defined in node_modules/@skeldjs/core/dist/lib/Networkable.d.ts:55

emitSerial

emitSerial<Event>(event: Event): Promise<Event>
Type Parameters
- Event extends BasicEvent<Event>
Parameters
- event: Event
Returns Promise<Event>
Inherited from Networkable.emitSerial
- Defined in node_modules/@skeldjs/core/dist/lib/Networkable.d.ts:56

emitSync

emitSync<Event>(event: Event): Event
Type Parameters
- Event extends BasicEvent<Event>
Parameters
- event: Event
Returns Event
Inherited from Networkable.emitSync
- Defined in node_modules/@skeldjs/core/dist/lib/Networkable.d.ts:57

enterVent

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

Emits a player.entervent event.

Example
```
client.me.physics.enterVent(PolusVent.Office);
```
Parameters
- ventId: number
  
  The ID of the vent to enter.
Returns void
- Defined in node_modules/@skeldjs/core/dist/lib/objects/component/PlayerPhysics.d.ts:50

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.

Example
```
client.me.physics.enterVent(PolusVent.Office);
```
Parameters
- ventId: number
  
  The ID of the vent to exit.
Returns void
- Defined in node_modules/@skeldjs/core/dist/lib/objects/component/PlayerPhysics.d.ts:66

getComponent

getComponent<T>(component: NetworkableConstructor<T>): undefined | T
Get a certain component from the object.
Type Parameters
- T extends Networkable<any, NetworkableEvents<Hostable<any>>, Hostable<any>, T>
Parameters
- component: NetworkableConstructor<T>
  
  The component class to get.
Returns undefined | T
Inherited from Networkable.getComponent
- Defined in node_modules/@skeldjs/core/dist/lib/Networkable.d.ts:69

getListeners

getListeners<Event>(event: string): Listener<Event>[]
Type Parameters
- Event extends BasicEvent<Event> = BasicEvent
Parameters
- event: string
Returns Listener<Event>[]
Inherited from Networkable.getListeners
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:32

off

off<EventName>(event: EventName, listener: Listener<PlayerPhysicsEvents<Hostable<any>>[EventName]>): void
Type Parameters
- EventName extends "component.spawn" | "component.despawn" | "player.entervent" | "player.exitvent" | "player.climbladder"
Parameters
- event: EventName
- listener: Listener<PlayerPhysicsEvents<Hostable<any>>[EventName]>
Returns void
Inherited from Networkable.off
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:30
off<K>(event: string, listener: Listener<K>): void
Type Parameters
- K extends BasicEvent<K>
Parameters
- event: string
- listener: Listener<K>
Returns void
Inherited from Networkable.off
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:31

on

on<EventName>(event: EventName, listener: Listener<PlayerPhysicsEvents<Hostable<any>>[EventName]>): (() => void)
Type Parameters
- EventName extends "component.spawn" | "component.despawn" | "player.entervent" | "player.exitvent" | "player.climbladder"
Parameters
- event: EventName
- listener: Listener<PlayerPhysicsEvents<Hostable<any>>[EventName]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from Networkable.on
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:22
on<K>(event: string, listener: Listener<K>): (() => void)
Type Parameters
- K extends BasicEvent<K>
Parameters
- event: string
- listener: Listener<K>
Returns (() => void)
- - (): void
  - Returns void
Inherited from Networkable.on
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:23

once

once<EventName>(event: EventName, listener: Listener<PlayerPhysicsEvents<Hostable<any>>[EventName]>): (() => void)
Type Parameters
- EventName extends "component.spawn" | "component.despawn" | "player.entervent" | "player.exitvent" | "player.climbladder"
Parameters
- event: EventName
- listener: Listener<PlayerPhysicsEvents<Hostable<any>>[EventName]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from Networkable.once
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:24
once<K>(event: string, listener: Listener<K>): (() => void)
Type Parameters
- K extends BasicEvent<K>
Parameters
- event: string
- listener: Listener<K>
Returns (() => void)
- - (): void
  - Returns void
Inherited from Networkable.once
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:25

removeAllListeners

removeAllListeners(): void
Returns void
Inherited from Networkable.removeAllListeners
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:34

removeListeners

removeListeners(event: string): void
Parameters
- event: string
Returns void
Inherited from Networkable.removeListeners
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:33

spawn

spawn(): void
Spawn this component if does not exist in the room it belongs in.

Returns void
Inherited from Networkable.spawn
- Defined in node_modules/@skeldjs/core/dist/lib/Networkable.d.ts:73

wait

wait<EventName>(event: EventName): Promise<PlayerPhysicsEvents<Hostable<any>>[EventName]>
Type Parameters
- EventName extends "component.spawn" | "component.despawn" | "player.entervent" | "player.exitvent" | "player.climbladder"
Parameters
- event: EventName
Returns Promise<PlayerPhysicsEvents<Hostable<any>>[EventName]>
Inherited from Networkable.wait
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:26
wait(event: string): Promise<BasicEvent>
Parameters
- event: string
Returns Promise<BasicEvent>
Inherited from Networkable.wait
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:27

waitf

waitf<EventName>(event: EventName, filter: ((ev: PlayerPhysicsEvents<Hostable<any>>[EventName]) => boolean | Promise<boolean>)): Promise<PlayerPhysicsEvents<Hostable<any>>[EventName]>
Type Parameters
- EventName extends "component.spawn" | "component.despawn" | "player.entervent" | "player.exitvent" | "player.climbladder"
Parameters
- event: EventName
- filter: ((ev: PlayerPhysicsEvents<Hostable<any>>[EventName]) => boolean | Promise<boolean>)
  - - (ev: PlayerPhysicsEvents<Hostable<any>>[EventName]): boolean | Promise<boolean>
    - Parameters
      
      ev: PlayerPhysicsEvents<Hostable<any>>[EventName]
      
      Returns boolean | Promise<boolean>
Returns Promise<PlayerPhysicsEvents<Hostable<any>>[EventName]>
Inherited from Networkable.waitf
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:28
waitf<K>(event: string, filter: ((ev: K) => boolean | Promise<boolean>)): Promise<BasicEvent>
Type Parameters
- K extends BasicEvent<K>
Parameters
- event: string
- filter: ((ev: K) => boolean | Promise<boolean>)
  - - (ev: K): boolean | Promise<boolean>
    - Parameters
      
      ev: K
      
      Returns boolean | Promise<boolean>
Returns Promise<BasicEvent>
Inherited from Networkable.waitf
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:29

Properties

components

components: Networkable<any, NetworkableEvents<Hostable<any>>, RoomType>[]

dirtyBit

dirtyBit: number

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: PlayerData<RoomType>

The player that this component belongs to.

room

room: RoomType

The room that this component belongs to.

spawnType

spawnType: SpawnType

The type of object that this component belongs to.

ventId

ventId: number

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

Constructors

constructor

new PlayerPhysics<RoomType>(room: RoomType, spawnType: SpawnType, netId: number, ownerid: number, flags: number, data?: PlayerPhysicsData | HazelReader, playerControl?: PlayerControl<RoomType>): PlayerPhysics<RoomType>
Type Parameters
- RoomType extends Hostable<any, RoomType> = Hostable<any>
Parameters
- room: RoomType
- spawnType: SpawnType
- netId: number
- ownerid: number
- flags: number
- Optional data: PlayerPhysicsData | HazelReader
- Optional playerControl: PlayerControl<RoomType>
Returns PlayerPhysics<RoomType>
Overrides Networkable.constructor
- Defined in node_modules/@skeldjs/core/dist/lib/objects/component/PlayerPhysics.d.ts:33

Accessors

isInVent

get isInVent(): boolean
Returns boolean
- Defined in node_modules/@skeldjs/core/dist/lib/objects/component/PlayerPhysics.d.ts:34

owner

get owner(): undefined | Hostable<any> | PlayerData<RoomType>
Returns undefined | Hostable<any> | PlayerData<RoomType>
Inherited from Networkable.owner
- Defined in node_modules/@skeldjs/core/dist/lib/Networkable.d.ts:52

Class PlayerPhysics<RoomType>

Type Parameters

RoomType extends Hostable = Hostable

Hierarchy

Implements

Index

Methods

Properties

Constructors

Accessors

Methods

Awake

Returns void

Deserialize

Parameters

reader: HazelReader

Optional spawn: boolean

Returns void

Destroy

Returns void

FixedUpdate

Parameters

delta: number

Returns void

HandleRpc

Parameters

rpc: BaseRpcMessage

Returns Promise<void>

PreSerialize

Returns void

Serialize

Parameters

writer: HazelWriter

Optional spawn: boolean

Returns boolean

canBeManaged

Returns boolean

climbLadder

Parameters

ladderid: number

Returns Promise<void>

despawn

Returns void

emit

Type Parameters

Event extends BasicEvent<Event>

Parameters

event: Event

Returns Promise<Event>

emitSerial

Type Parameters

Event extends BasicEvent<Event>

Parameters

event: Event

Returns Promise<Event>

emitSync

Type Parameters

Event extends BasicEvent<Event>

Parameters

event: Event

Returns Event

enterVent

Example

Parameters

ventId: number

Returns void

exitVent

Example

Parameters

ventId: number

Returns void

getComponent

Type Parameters

T extends Networkable<any, NetworkableEvents<Hostable<any>>, Hostable<any>, T>

Parameters

component: NetworkableConstructor<T>

Returns undefined | T

getListeners

Type Parameters

Event extends BasicEvent<Event> = BasicEvent

`Optional` spawn: boolean

`Optional` spawn: boolean