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 NetworkedObjectEvents<RoomType> = NetworkedObjectEvents<RoomType>

Hierarchy (View Summary)

EventEmitter<T>
- NetworkedObject

Index

Constructors

constructor

new NetworkedObject<
    RoomType extends StatefulRoom<any>,
    T extends NetworkedObjectEvents<RoomType> = NetworkedObjectEvents<RoomType>,
>(
    room: RoomType,
    spawnType: SpawnType,
    netId: number,
    ownerId: number,
    flags: number,
): NetworkedObject<RoomType, T>
Type Parameters
- RoomType extends StatefulRoom<any>
- T extends NetworkedObjectEvents<RoomType> = NetworkedObjectEvents<RoomType>
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:77

Properties

components

components: NetworkedObject<RoomType, any>[]

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.

`Optional`player

player?: Player<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.

Accessors

owner

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

Methods

`Abstract`deserializeFromReader

deserializeFromReader(reader: HazelReader, spawn: boolean): void
Parameters
- reader: HazelReader
- spawn: boolean
Returns void
- Defined in packages/core/lib/NetworkedObject.ts:131

Destroy

Destroy(): void
Returns void
- Defined in packages/core/lib/NetworkedObject.ts:136

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:101

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:111

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:121

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:142

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`handleRemoteCall

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

off

off<EventName extends string | number | symbol>(
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 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<T[EventName]>,
): () => void
Type Parameters
- EventName extends string | number | symbol
Parameters
- event: EventName
- listener: Listener<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<T[EventName]>,
): () => void
Type Parameters
- EventName extends string | number | symbol
Parameters
- event: EventName
- listener: Listener<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`processAwake

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

`Abstract`processFixedUpdate

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

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

`Abstract`serializeToWriter

serializeToWriter(writer: HazelWriter, spawn: boolean): boolean
Parameters
- writer: HazelWriter
- spawn: boolean
Returns boolean
- Defined in packages/core/lib/NetworkedObject.ts:132

wait

wait<EventName extends string | number | symbol>(
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 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: 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>
Returns Promise<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

dirtyBit

flags

netId

ownerId

Optionalplayer

room

spawnType

Accessors

owner

Returns undefined | StatefulRoom<any> | Player<RoomType>

Methods

AbstractdeserializeFromReader

Parameters

Returns void

Destroy

Returns void

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

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

AbstractprocessAwake

Returns Promise<void>

AbstractprocessFixedUpdate

Parameters

Returns Promise<void>

Class NetworkedObject<RoomType, T>`Abstract`

`Optional`player

`Abstract`deserializeFromReader

`Abstract`handleRemoteCall

`Abstract`processAwake

`Abstract`processFixedUpdate

`Abstract`serializeToWriter