PlayerPhysics | SkeldJS

Represents a player object for handling vent entering and exiting.

See PlayerPhysicsEvents for events to listen to.

Type parameters

RoomType: Hostable

Hierarchy

Networkable<PlayerPhysicsData, PlayerPhysicsEvents, RoomType>
- PlayerPhysics

Implements

PlayerPhysicsData

Index

Methods

Properties

Constructors

constructor

Accessors

Methods

Awake

Awake(): void

Inherited from Networkable.Awake
- Defined in core/lib/Networkable.ts:172
Returns void

Deserialize

Deserialize(reader: HazelReader, spawn?: boolean): void

Inherited from Networkable.Deserialize
- Defined in core/lib/Networkable.ts:160
Parameters
- reader: HazelReader
- spawn: boolean = false
Returns void

Destroy

Destroy(): void

Inherited from Networkable.Destroy
- Defined in core/lib/Networkable.ts:174
Returns void

FixedUpdate

FixedUpdate(delta: number): void

Inherited from Networkable.FixedUpdate
- Defined in core/lib/Networkable.ts:170
Parameters
- delta: number
Returns void

HandleRpc

HandleRpc(rpc: BaseRpcMessage): Promise<void>

Overrides Networkable.HandleRpc
- Defined in core/lib/objects/component/PlayerPhysics.ts:85
Parameters
- rpc: BaseRpcMessage
Returns Promise<void>

PreSerialize

PreSerialize(): void

Inherited from Networkable.PreSerialize
- Defined in core/lib/Networkable.ts:166
Returns void

Serialize

Serialize(writer: HazelWriter, spawn?: boolean): boolean

Inherited from Networkable.Serialize
- Defined in core/lib/Networkable.ts:162
Parameters
- writer: HazelWriter
- spawn: boolean = false
Returns boolean

canBeManaged

canBeManaged(): boolean

Inherited from Networkable.canBeManaged
- Defined in core/lib/Networkable.ts:209
Whether or not this object

Returns boolean

climbLadder

climbLadder(ladderid: number): Promise<void>

- Defined in core/lib/objects/component/PlayerPhysics.ts:238
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>

despawn

despawn(): void

Inherited from Networkable.despawn
- Defined in core/lib/Networkable.ts:202
Despawns the component from the room it belongs in.

Returns void

emit

emit<Event>(event: Event): Promise<Event>

Inherited from Networkable.emit
- Defined in core/lib/Networkable.ts:129
Type parameters
- Event: BasicEvent<Event>
Parameters
- event: Event
Returns Promise<Event>

emitSerial

emitSerial<Event>(event: Event): Promise<Event>

Inherited from Networkable.emitSerial
- Defined in core/lib/Networkable.ts:139
Type parameters
- Event: BasicEvent<Event>
Parameters
- event: Event
Returns Promise<Event>

emitSync

emitSync<Event>(event: Event): Event

Inherited from Networkable.emitSync
- Defined in core/lib/Networkable.ts:149
Type parameters
- Event: BasicEvent<Event>
Parameters
- event: Event
Returns Event

enterVent

enterVent(ventId: number): void

- Defined in core/lib/objects/component/PlayerPhysics.ts:137
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

exitVent

exitVent(ventId: number): void

- Defined in core/lib/objects/component/PlayerPhysics.ts:188
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

getComponent

getComponent<T>(component: NetworkableConstructor<T>): undefined | T

Inherited from Networkable.getComponent
- Defined in core/lib/Networkable.ts:180
Get a certain component from the object.

Type parameters
- T: Networkable<any, NetworkableEvents<Hostable<any>>, Hostable<any>, T>
Parameters
- component: NetworkableConstructor<T>
  
  The component class to get.
Returns undefined | T

getListeners

getListeners<Event>(event: string): Listener<Event>[]

Inherited from Networkable.getListeners
- Defined in events/lib/EventEmitter.ts:138
Type parameters
- Event: BasicEvent<Event>
Parameters
- event: string
Returns Listener<Event>[]

off

off<EventName>(event: EventName, listener: Listener<PlayerPhysicsEvents<Hostable<any>>[EventName]>): void
off<K>(event: string, listener: Listener<K>): void

Inherited from Networkable.off
- Defined in events/lib/EventEmitter.ts:125
Type parameters
- EventName: "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 events/lib/EventEmitter.ts:129
Type parameters
- K: BasicEvent<K>
Parameters
- event: string
- listener: Listener<K>
Returns void

on

on<EventName>(event: EventName, listener: Listener<PlayerPhysicsEvents<Hostable<any>>[EventName]>): () => void
on<K>(event: string, listener: Listener<K>): () => void

Inherited from Networkable.on
- Defined in events/lib/EventEmitter.ts:74
Type parameters
- EventName: "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 events/lib/EventEmitter.ts:78
Type parameters
- K: BasicEvent<K>
Parameters
- event: string
- listener: Listener<K>
Returns () => void
- - (): void
  - Returns void

once

once<EventName>(event: EventName, listener: Listener<PlayerPhysicsEvents<Hostable<any>>[EventName]>): () => void
once<K>(event: string, listener: Listener<K>): () => void

Inherited from Networkable.once
- Defined in events/lib/EventEmitter.ts:86
Type parameters
- EventName: "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 events/lib/EventEmitter.ts:90
Type parameters
- K: BasicEvent<K>
Parameters
- event: string
- listener: Listener<K>
Returns () => void
- - (): void
  - Returns void

removeAllListeners

removeAllListeners(): void

Inherited from Networkable.removeAllListeners
- Defined in events/lib/EventEmitter.ts:152
Returns void

removeListeners

removeListeners(event: string): void

Inherited from Networkable.removeListeners
- Defined in events/lib/EventEmitter.ts:147
Parameters
- event: string
Returns void

spawn

spawn(): void

Inherited from Networkable.spawn
- Defined in core/lib/Networkable.ts:195
Spawn this component if does not exist in the room it belongs in.

Returns void

wait

wait<EventName>(event: EventName): Promise<PlayerPhysicsEvents<Hostable<any>>[EventName]>
wait(event: string): Promise<BasicEvent>

Inherited from Networkable.wait
- Defined in events/lib/EventEmitter.ts:99
Type parameters
- EventName: "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 events/lib/EventEmitter.ts:102
Parameters
- event: string
Returns Promise<BasicEvent>

waitf

waitf<EventName>(event: EventName, filter: (ev: PlayerPhysicsEvents<Hostable<any>>[EventName]) => boolean | Promise<boolean>): Promise<PlayerPhysicsEvents<Hostable<any>>[EventName]>
waitf<K>(event: string, filter: (ev: K) => boolean | Promise<boolean>): Promise<BasicEvent>

Inherited from Networkable.waitf
- Defined in events/lib/EventEmitter.ts:109
Type parameters
- EventName: "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 events/lib/EventEmitter.ts:113
Type parameters
- K: 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>

Properties

components

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

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: 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?: HazelReader | PlayerPhysicsData, playerControl?: PlayerControl<RoomType>): PlayerPhysics<RoomType>

Overrides Networkable<PlayerPhysicsData,PlayerPhysicsEvents,RoomType>.constructor
- Defined in core/lib/objects/component/PlayerPhysics.ts:60
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- room: RoomType
- spawnType: SpawnType
- netId: number
- ownerid: number
- flags: number
- Optional data: HazelReader | PlayerPhysicsData
- Optional playerControl: PlayerControl<RoomType>
Returns PlayerPhysics<RoomType>

Accessors

isInVent

get isInVent(): boolean

- Defined in core/lib/objects/component/PlayerPhysics.ts:81
Returns boolean

owner

get owner(): undefined | Hostable<any> | PlayerData<RoomType>

- Defined in core/lib/Networkable.ts:84
Returns undefined | Hostable<any> | PlayerData<RoomType>

Type parameters

RoomType: Hostable

Hierarchy

Implements

Index

Methods

Properties

Constructors

Accessors

Methods

Awake

Returns void

Deserialize

Parameters

reader: HazelReader

spawn: boolean = false

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

spawn: boolean = false

Returns boolean

canBeManaged

Returns boolean

climbLadder

Parameters

ladderid: number

Returns Promise<void>

despawn

Returns void

emit

Type parameters

Event: BasicEvent<Event>

Parameters

event: Event

Returns Promise<Event>

emitSerial

Type parameters

Event: BasicEvent<Event>

Parameters

event: Event

Returns Promise<Event>

emitSync

Type parameters

Event: BasicEvent<Event>

Parameters

event: Event

Returns Event

enterVent

Parameters

ventId: number

Returns void

exitVent

Parameters

ventId: number

Returns void

getComponent

Type parameters

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

Parameters

component: NetworkableConstructor<T>

Returns undefined | T

getListeners

Type parameters

Event: BasicEvent<Event>

Parameters

event: string

Returns Listener<Event>[]