Class Networkable<DataT, T, RoomType>

Represents a basic networkable object in Among Us.

See NetworkableEvents for events to listen to.

Type Parameters

DataT = any
T extends NetworkableEvents = NetworkableEvents
RoomType extends Hostable = Hostable

Hierarchy

EventEmitter<T>
- Networkable

Index

Methods

Awake

Awake(): void
Returns void
- 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
- Defined in node_modules/@skeldjs/core/dist/lib/Networkable.d.ts:58

Destroy

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

FixedUpdate

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

HandleRpc

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

PreSerialize

PreSerialize(): void
Returns void
- 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
- Defined in node_modules/@skeldjs/core/dist/lib/Networkable.d.ts:59

canBeManaged

canBeManaged(): boolean
Whether or not this object

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

despawn

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

Returns void
- 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>
Overrides EventEmitter.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>
Overrides EventEmitter.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
Overrides EventEmitter.emitSync
- Defined in node_modules/@skeldjs/core/dist/lib/Networkable.d.ts:57

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
- 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 EventEmitter.getListeners
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:32

off

off<EventName>(event: EventName, listener: Listener<T[EventName]>): void
Type Parameters
- EventName extends string | number | symbol
Parameters
- event: EventName
- listener: Listener<T[EventName]>
Returns void
Inherited from EventEmitter.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 EventEmitter.off
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:31

on

on<EventName>(event: EventName, listener: Listener<T[EventName]>): (() => void)
Type Parameters
- EventName extends string | number | symbol
Parameters
- event: EventName
- listener: Listener<T[EventName]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from EventEmitter.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 EventEmitter.on
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:23

once

once<EventName>(event: EventName, listener: Listener<T[EventName]>): (() => void)
Type Parameters
- EventName extends string | number | symbol
Parameters
- event: EventName
- listener: Listener<T[EventName]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from EventEmitter.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 EventEmitter.once
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:25

removeAllListeners

removeAllListeners(): void
Returns void
Inherited from EventEmitter.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 EventEmitter.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
- Defined in node_modules/@skeldjs/core/dist/lib/Networkable.d.ts:73

wait

wait<EventName>(event: EventName): Promise<T[EventName]>
Type Parameters
- EventName extends string | number | symbol
Parameters
- event: EventName
Returns Promise<T[EventName]>
Inherited from EventEmitter.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 EventEmitter.wait
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:27

waitf

waitf<EventName>(event: EventName, filter: ((ev: T[EventName]) => boolean | Promise<boolean>)): Promise<T[EventName]>
Type Parameters
- EventName extends string | number | symbol
Parameters
- event: EventName
- filter: ((ev: T[EventName]) => boolean | Promise<boolean>)
  - - (ev: T[EventName]): boolean | Promise<boolean>
    - Parameters
      
      ev: T[EventName]
      
      Returns boolean | Promise<boolean>
Returns Promise<T[EventName]>
Inherited from EventEmitter.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 EventEmitter.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.

`Optional` 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.

Constructors

constructor

new Networkable<DataT, T, RoomType>(room: RoomType, spawnType: SpawnType, netId: number, ownerId: number, flags: number, data?: DataT | HazelReader): Networkable<DataT, T, RoomType>
Type Parameters
- DataT = any
- T extends NetworkableEvents<Hostable<any>> = NetworkableEvents<Hostable<any>>
- RoomType extends Hostable<any, RoomType> = Hostable<any>
Parameters
- room: RoomType
- spawnType: SpawnType
- netId: number
- ownerId: number
- flags: number
- Optional data: DataT | HazelReader
Returns Networkable<DataT, T, RoomType>
Overrides EventEmitter<T>.constructor
- Defined in node_modules/@skeldjs/core/dist/lib/Networkable.d.ts:53

Accessors

owner

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

Class Networkable<DataT, T, RoomType>

Type Parameters

DataT = any

T extends NetworkableEvents = NetworkableEvents

RoomType extends Hostable = Hostable

Hierarchy

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

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

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

Parameters

event: string

Returns Listener<Event>[]

off

Type Parameters

EventName extends string | number | symbol

Parameters

event: EventName

listener: Listener<T[EventName]>

Returns void

Type Parameters

K extends BasicEvent<K>

Parameters

`Optional` spawn: boolean

`Optional` spawn: boolean