Class HideAndSeekManager<RoomType>

Represents a class for managing various events for the Hide'N'Seek gamemode.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

GameManager<RoomType>
- HideAndSeekManager

Constructors

constructor

new HideAndSeekManager<RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>>(
    room: RoomType,
    spawnType: SpawnType,
    netId: number,
    ownerId: number,
    flags: number,
): HideAndSeekManager<RoomType>
Type Parameters
- RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>
Parameters
- room: RoomType
- spawnType: SpawnType
- netId: number
- ownerId: number
- flags: number
Returns HideAndSeekManager<RoomType>
Inherited from GameManager.constructor
- Defined in packages/core/lib/NetworkedObject.ts:55

Properties

`Readonly`flags

flags: number

flow

flow: HideNSeekFlowLogicComponent<RoomType>

logicComponents

logicComponents: GameLogicComponent<any, RoomType>[] = []

minigame

minigame: HideNSeekMinigameLogicComponent<RoomType>

music

music: HideNSeekMusicLogicComponent<RoomType>

`Readonly`netId

netId: number

options

options: HideNSeekOptionsLogicComponent<RoomType>

`Readonly`ownerId

ownerId: number

pendingDataState

pendingDataState: DataState

ping

ping: HideNSeekPingLogicComponent<RoomType>

player

player: undefined | Player<RoomType>

The player that this component belongs to.

roleSelection

roleSelection: HideNSeekRoleSelectionLogicComponent<RoomType>

`Readonly`room

room: RoomType

`Readonly`spawnType

spawnType: SpawnType

usables

usables: HideNSeekUsablesLogicComponent<RoomType>

Accessors

owner

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

Methods

cancelDataState

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

createData

createData(state: DataState): undefined | BaseSystemMessage
Parameters
- state: DataState
Returns undefined | BaseSystemMessage
Inherited from GameManager.createData
- Defined in packages/core/lib/objects/GameManager.ts:56

emit

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

handleData

handleData(data: BaseSystemMessage): Promise<void>
Parameters
- data: BaseSystemMessage
Returns Promise<void>
Inherited from GameManager.handleData
- Defined in packages/core/lib/objects/GameManager.ts:40

handleRemoteCall

handleRemoteCall(rpc: BaseRpcMessage): Promise<void>
Parameters
- rpc: BaseRpcMessage
Returns Promise<void>
Inherited from GameManager.handleRemoteCall
- Defined in packages/core/lib/objects/GameManager.ts:20

initComponents

initComponents(): Promise<void>
Returns Promise<void>
Overrides GameManager.initComponents
- Defined in packages/core/lib/objects/HideAndSeekManager.ts:21

off

off<EventName extends "component.spawn" | "component.despawn">(
    event: EventName,
    listener: Listener<
        (NetworkedObjectEvents<RoomType> & InnerGameManagerEvents<RoomType>)[EventName],
    >,
): void
Type Parameters
- EventName extends "component.spawn" | "component.despawn"
Parameters
- event: EventName
- listener: Listener<
  (NetworkedObjectEvents<RoomType> & InnerGameManagerEvents<RoomType>)[EventName],
  >
Returns void
Inherited from GameManager.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 GameManager.off
- Defined in packages/events/lib/EventEmitter.ts:141

on

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

once

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

onGameStart

onGameStart(): Promise<void>
Returns Promise<void>
Inherited from GameManager.onGameStart
- Defined in packages/core/lib/objects/GameManager.ts:76

onPlayerDeath

onPlayerDeath(
playerControl: PlayerControl<RoomType>,
assignGhostRole: boolean,
): Promise<void>
Parameters
- playerControl: PlayerControl<RoomType>
- assignGhostRole: boolean
Returns Promise<void>
Overrides GameManager.onPlayerDeath
- Defined in packages/core/lib/objects/HideAndSeekManager.ts:37

parseData

parseData(state: DataState, reader: HazelReader): undefined | BaseSystemMessage
Parameters
- state: DataState
- reader: HazelReader
Returns undefined | BaseSystemMessage
Inherited from GameManager.parseData
- Defined in packages/core/lib/objects/GameManager.ts:32

parseRemoteCall

parseRemoteCall(
rpcTag: RpcMessageTag,
reader: HazelReader,
): undefined | BaseRpcMessage
Parameters
- rpcTag: RpcMessageTag
- reader: HazelReader
Returns undefined | BaseRpcMessage
Inherited from GameManager.parseRemoteCall
- Defined in packages/core/lib/objects/GameManager.ts:16

processAwake

processAwake(): Promise<void>
Returns Promise<void>
Inherited from GameManager.processAwake
- Defined in packages/core/lib/objects/GameManager.ts:28

processFixedUpdate

processFixedUpdate(delta: number): Promise<void>
Parameters
- delta: number
Returns Promise<void>
Inherited from GameManager.processFixedUpdate
- Defined in packages/core/lib/objects/GameManager.ts:24

pushDataState

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

removeAllListeners

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

removeListeners

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

resetDataState

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

wait

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

waitf

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

Class HideAndSeekManager<RoomType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns HideAndSeekManager<RoomType>

Properties

components

dangerLevels

deathPopup

Readonlyflags

flow

logicComponents

minigame

music

ReadonlynetId

options

ReadonlyownerId

pendingDataState

ping

player

roleSelection

Readonlyroom

ReadonlyspawnType

usables

Accessors

owner

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

Methods

cancelDataState

Parameters

Returns void

createData

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

handleData

Parameters

Returns Promise<void>

handleRemoteCall

Parameters

Returns Promise<void>

initComponents

Returns Promise<void>

off

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

`Readonly`flags

`Readonly`netId

`Readonly`ownerId

`Readonly`room

`Readonly`spawnType

Returns Promise<
(NetworkedObjectEvents<RoomType> & InnerGameManagerEvents<RoomType>)[EventName],
>

Returns Promise<
(NetworkedObjectEvents<RoomType> & InnerGameManagerEvents<RoomType>)[EventName],
>