Class VoteBanSystem<RoomType>

Represents a room object for handling vote kicks.

See VoteBanSystemEvents for events to listen to.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

NetworkedObject<RoomType, VoteBanSystemEvents<RoomType>>
- VoteBanSystem

Index

Constructors

constructor

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

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

voted

voted: Map<
    number,
    [
        undefined
        | Player<RoomType>,
        undefined | Player<RoomType>,
        undefined | Player<RoomType>,
    ],
>

The accumulated votes.

Accessors

owner

get owner(): RoomType
Returns RoomType
Overrides NetworkedObject.owner
- Defined in packages/core/lib/objects/VoteBanSystem.ts:44

Methods

addVote

addVote(voter: PlayerResolvable, target: PlayerResolvable): Promise<void>
Add the vote of a player to vote for another player to be kicked.
Parameters
- voter: PlayerResolvable
  The player to count the vote as.
- target: PlayerResolvable
  The player to vote to be kicked.
Returns Promise<void>
Example
```
room.votebansystem.addVote(client.me, player);
```
- Defined in packages/core/lib/objects/VoteBanSystem.ts:147

cancelDataState

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

createData

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

emit

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

handleData

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

handleRemoteCall

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

off

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

on

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

once

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

parseData

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

parseRemoteCall

parseRemoteCall(
rpcTag: RpcMessageTag,
reader: HazelReader,
): undefined | BaseRpcMessage
Parameters
- rpcTag: RpcMessageTag
- reader: HazelReader
Returns undefined | BaseRpcMessage
Overrides NetworkedObject.parseRemoteCall
- Defined in packages/core/lib/objects/VoteBanSystem.ts:90

processAwake

processAwake(): Promise<void>
Returns Promise<void>
Overrides NetworkedObject.processAwake
- Defined in packages/core/lib/objects/VoteBanSystem.ts:52

processFixedUpdate

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

pushDataState

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

removeAllListeners

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

removeListeners

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

resetDataState

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

wait

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

waitf

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

Class VoteBanSystem<RoomType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns VoteBanSystem<RoomType>

Properties

components

Readonlyflags

ReadonlynetId

ReadonlyownerId

pendingDataState

player

Readonlyroom

ReadonlyspawnType

voted

Accessors

owner

Returns RoomType

Methods

addVote

Parameters

Returns Promise<void>

Example

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>

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

`Readonly`flags

`Readonly`netId

`Readonly`ownerId

`Readonly`room

`Readonly`spawnType

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

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