Class VoteBanSystem<RoomType>

Represents a room object for handling vote kicks.

See VoteBanSystemEvents for events to listen to.

Type Parameters

RoomType extends Hostable = Hostable

Hierarchy

Networkable<VoteBanSystemData, VoteBanSystemEvents, RoomType>
- VoteBanSystem

Index

Methods

Awake

Awake(): void
Returns void
Inherited from Networkable.Awake
- 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
Overrides Networkable.Deserialize
- Defined in node_modules/@skeldjs/core/dist/lib/objects/component/VoteBanSystem.d.ts:25

Destroy

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

FixedUpdate

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

HandleRpc

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

PreSerialize

PreSerialize(): void
Returns void
Inherited from Networkable.PreSerialize
- 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
Overrides Networkable.Serialize
- Defined in node_modules/@skeldjs/core/dist/lib/objects/component/VoteBanSystem.d.ts:26

addVote

addVote(voter: PlayerDataResolvable, target: PlayerDataResolvable): void
Add the vote of a player to vote for another player to be kicked.

Example
```
room.votebansystem.addVote(client.me, player);
```
Parameters
- voter: PlayerDataResolvable
  
  The player to count the vote as.
- target: PlayerDataResolvable
  
  The player to vote to be kicked.
Returns void
- Defined in node_modules/@skeldjs/core/dist/lib/objects/component/VoteBanSystem.d.ts:40

canBeManaged

canBeManaged(): boolean
Whether or not this object

Returns boolean
Inherited from Networkable.canBeManaged
- 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
Inherited from Networkable.despawn
- 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>
Inherited from Networkable.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>
Inherited from Networkable.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
Inherited from Networkable.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
Inherited from Networkable.getComponent
- 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 Networkable.getListeners
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:32

off

off<EventName>(event: EventName, listener: Listener<VoteBanSystemEvents<Hostable<any>>[EventName]>): void
Type Parameters
- EventName extends "component.spawn" | "component.despawn"
Parameters
- event: EventName
- listener: Listener<VoteBanSystemEvents<Hostable<any>>[EventName]>
Returns void
Inherited from Networkable.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 Networkable.off
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:31

on

on<EventName>(event: EventName, listener: Listener<VoteBanSystemEvents<Hostable<any>>[EventName]>): (() => void)
Type Parameters
- EventName extends "component.spawn" | "component.despawn"
Parameters
- event: EventName
- listener: Listener<VoteBanSystemEvents<Hostable<any>>[EventName]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from Networkable.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 Networkable.on
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:23

once

once<EventName>(event: EventName, listener: Listener<VoteBanSystemEvents<Hostable<any>>[EventName]>): (() => void)
Type Parameters
- EventName extends "component.spawn" | "component.despawn"
Parameters
- event: EventName
- listener: Listener<VoteBanSystemEvents<Hostable<any>>[EventName]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from Networkable.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 Networkable.once
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:25

removeAllListeners

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

wait

wait<EventName>(event: EventName): Promise<VoteBanSystemEvents<Hostable<any>>[EventName]>
Type Parameters
- EventName extends "component.spawn" | "component.despawn"
Parameters
- event: EventName
Returns Promise<VoteBanSystemEvents<Hostable<any>>[EventName]>
Inherited from Networkable.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 Networkable.wait
- Defined in node_modules/@skeldjs/events/dist/lib/EventEmitter.d.ts:27

waitf

waitf<EventName>(event: EventName, filter: ((ev: VoteBanSystemEvents<Hostable<any>>[EventName]) => boolean | Promise<boolean>)): Promise<VoteBanSystemEvents<Hostable<any>>[EventName]>
Type Parameters
- EventName extends "component.spawn" | "component.despawn"
Parameters
- event: EventName
- filter: ((ev: VoteBanSystemEvents<Hostable<any>>[EventName]) => boolean | Promise<boolean>)
  - - (ev: VoteBanSystemEvents<Hostable<any>>[EventName]): boolean | Promise<boolean>
    - Parameters
      
      ev: VoteBanSystemEvents<Hostable<any>>[EventName]
      
      Returns boolean | Promise<boolean>
Returns Promise<VoteBanSystemEvents<Hostable<any>>[EventName]>
Inherited from Networkable.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 Networkable.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.

voted

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

The accumulated votes.

Constructors

constructor

new VoteBanSystem<RoomType>(room: RoomType, spawnType: SpawnType, netId: number, ownerid: number, flags: number, data?: HazelReader | VoteBanSystemData, gameData?: GameData<RoomType>): VoteBanSystem<RoomType>
Type Parameters
- RoomType extends Hostable<any, RoomType> = Hostable<any>
Parameters
- room: RoomType
- spawnType: SpawnType
- netId: number
- ownerid: number
- flags: number
- Optional data: HazelReader | VoteBanSystemData
- Optional gameData: GameData<RoomType>
Returns VoteBanSystem<RoomType>
Overrides Networkable.constructor
- Defined in node_modules/@skeldjs/core/dist/lib/objects/component/VoteBanSystem.d.ts:23

Accessors

owner

get owner(): RoomType
Returns RoomType
Overrides Networkable.owner
- Defined in node_modules/@skeldjs/core/dist/lib/objects/component/VoteBanSystem.d.ts:24

Class VoteBanSystem<RoomType>

Type Parameters

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

addVote

Example

Parameters

voter: PlayerDataResolvable

target: PlayerDataResolvable

Returns void

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 "component.spawn" | "component.despawn"

Parameters

event: EventName

listener: Listener<VoteBanSystemEvents<Hostable<any>>[EventName]>

`Optional` spawn: boolean

`Optional` spawn: boolean