Class NetworkedObject<RoomType, T>`Abstract`

Represents a basic networked object in Among Us.

See NetworkedObjectEvents for events to listen to.

Type Parameters

RoomType extends StatefulRoom
T extends EventData = {}

Hierarchy (View Summary)

EventEmitter<NetworkedObjectEvents<RoomType> & T>
- NetworkedObject

Index

Constructors

constructor

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

Properties

components

components: NetworkedObject<RoomType, any>[]

`Readonly`flags

flags: number

`Readonly`netId

netId: number

`Readonly`ownerId

ownerId: number

pendingDataState

pendingDataState: DataState

player

player: undefined | Player<RoomType>

The player that this component belongs to.

`Readonly`room

room: RoomType

`Readonly`spawnType

spawnType: SpawnType

Accessors

owner

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

Methods

cancelDataState

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

`Abstract`createData

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

emit

emit<Event extends BasicEvent>(event: Event): Promise<Event>
Type Parameters
- Event extends BasicEvent
Parameters
- event: Event
Returns Promise<Event>
Overrides EventEmitter.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>
Overrides EventEmitter.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
Overrides EventEmitter.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
- 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 EventEmitter.getListeners
- Defined in packages/events/lib/EventEmitter.ts:150

`Abstract`handleData

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

`Abstract`handleRemoteCall

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

off

off<EventName extends string | number | symbol>(
event: EventName,
listener: Listener<(NetworkedObjectEvents<RoomType> & T)[EventName]>,
): void
Type Parameters
- EventName extends string | number | symbol
Parameters
- event: EventName
- listener: Listener<(NetworkedObjectEvents<RoomType> & T)[EventName]>
Returns void
Inherited from EventEmitter.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 EventEmitter.off
- Defined in packages/events/lib/EventEmitter.ts:141

on

on<EventName extends string | number | symbol>(
event: EventName,
listener: Listener<(NetworkedObjectEvents<RoomType> & T)[EventName]>,
): () => void
Type Parameters
- EventName extends string | number | symbol
Parameters
- event: EventName
- listener: Listener<(NetworkedObjectEvents<RoomType> & T)[EventName]>
Returns () => void
Inherited from EventEmitter.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 EventEmitter.on
- Defined in packages/events/lib/EventEmitter.ts:90

once

once<EventName extends string | number | symbol>(
event: EventName,
listener: Listener<(NetworkedObjectEvents<RoomType> & T)[EventName]>,
): () => void
Type Parameters
- EventName extends string | number | symbol
Parameters
- event: EventName
- listener: Listener<(NetworkedObjectEvents<RoomType> & T)[EventName]>
Returns () => void
Inherited from EventEmitter.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 EventEmitter.once
- Defined in packages/events/lib/EventEmitter.ts:102

`Abstract`parseData

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

`Abstract`parseRemoteCall

parseRemoteCall(rpcTag: number, reader: HazelReader): undefined | BaseRpcMessage
Parameters
- rpcTag: number
- reader: HazelReader
Returns undefined | BaseRpcMessage
- Defined in packages/core/lib/NetworkedObject.ts:109

`Abstract`processAwake

processAwake(): Promise<void>
Returns Promise<void>
- Defined in packages/core/lib/NetworkedObject.ts:113

`Abstract`processFixedUpdate

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

pushDataState

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

removeAllListeners

removeAllListeners(): void
Returns void
Inherited from EventEmitter.removeAllListeners
- Defined in packages/events/lib/EventEmitter.ts:164

removeListeners

removeListeners(event: string): void
Parameters
- event: string
Returns void
Inherited from EventEmitter.removeListeners
- Defined in packages/events/lib/EventEmitter.ts:159

resetDataState

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

wait

wait<EventName extends string | number | symbol>(
event: EventName,
): Promise<(NetworkedObjectEvents<RoomType> & T)[EventName]>
Type Parameters
- EventName extends string | number | symbol
Parameters
- event: EventName
Returns Promise<(NetworkedObjectEvents<RoomType> & T)[EventName]>
Inherited from EventEmitter.wait
- Defined in packages/events/lib/EventEmitter.ts:111
wait(event: string): Promise<BasicEvent>
Parameters
- event: string
Returns Promise<BasicEvent>
Inherited from EventEmitter.wait
- Defined in packages/events/lib/EventEmitter.ts:114

waitf

waitf<EventName extends string | number | symbol>(
    event: EventName,
    filter: (
        ev: (NetworkedObjectEvents<RoomType> & T)[EventName],
    ) => boolean | Promise<boolean>,
): Promise<(NetworkedObjectEvents<RoomType> & T)[EventName]>
Type Parameters
- EventName extends string | number | symbol
Parameters
- event: EventName
- filter: (
  ev: (NetworkedObjectEvents<RoomType> & T)[EventName],
  ) => boolean | Promise<boolean>
Returns Promise<(NetworkedObjectEvents<RoomType> & T)[EventName]>
Inherited from EventEmitter.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 EventEmitter.waitf
- Defined in packages/events/lib/EventEmitter.ts:125

Class NetworkedObject<RoomType, T>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns NetworkedObject<RoomType, T>

Properties

components

Readonlyflags

ReadonlynetId

ReadonlyownerId

pendingDataState

player

Readonlyroom

ReadonlyspawnType

Accessors

owner

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

Methods

cancelDataState

Parameters

Returns void

AbstractcreateData

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

AbstracthandleData

Parameters

Returns Promise<void>

AbstracthandleRemoteCall

Parameters

Returns Promise<void>

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

Parameters

Returns () => void

Type Parameters

Parameters

Returns () => void

AbstractparseData

Class NetworkedObject<RoomType, T>`Abstract`

`Readonly`flags

`Readonly`netId

`Readonly`ownerId

`Readonly`room

`Readonly`spawnType

`Abstract`createData

`Abstract`handleData

`Abstract`handleRemoteCall

`Abstract`parseData

`Abstract`parseRemoteCall

`Abstract`processAwake

`Abstract`processFixedUpdate