Options
All
  • Public
  • Public/Protected
  • All
Menu

Module core

@skeldjs/core

This package contains internal APIs for important structures in Among Us, and while you can install it on its own with npm install --save @skeldjs/core or yarn add @skeldjs/core, it is one package of a bigger project, skeldjs.

You can view auto-updating documentation for this package hosted at github pages at https://skeld.js.org/modules/core.html

Index

Classes

Enumerations

Type aliases

Interfaces

Variables

Functions

Type aliases

AnyNetworkable

AnyNetworkable<RoomType>: AirshipStatus<RoomType> | AprilShipStatus<RoomType> | CustomNetworkTransform<RoomType> | GameData<RoomType> | MiraShipStatus<RoomType> | LobbyBehaviour<RoomType> | MeetingHud<RoomType> | PolusShipStatus<RoomType> | PlayerControl<RoomType> | PlayerPhysics<RoomType> | SkeldShipStatus<RoomType> | VoteBanSystem<RoomType>

Type parameters

  • RoomType: Hostable

AnySystem

AnySystem<RoomType>: AutoDoorsSystem<RoomType> | DeconSystem<RoomType> | DoorsSystem<RoomType> | HeliSabotageSystem<RoomType> | HqHudSystem<RoomType> | HudOverrideSystem<RoomType> | LifeSuppSystem<RoomType> | MedScanSystem<RoomType> | ReactorSystem<RoomType> | SabotageSystem<RoomType> | SecurityCameraSystem<RoomType> | SwitchSystem<RoomType>

Type parameters

  • RoomType: Hostable

AutoDoorsSystemEvents

AutoDoorsSystemEvents<RoomType>: SystemStatusEvents & DoorEvents<RoomType> & ExtractEventTypes<[]>

Type parameters

  • RoomType: Hostable

CustomNetworkTransformEvents

CustomNetworkTransformEvents<RoomType>: NetworkableEvents<RoomType> & ExtractEventTypes<[PlayerMoveEvent<RoomType>, PlayerSnapToEvent<RoomType>]>

Type parameters

  • RoomType: Hostable

DeconSystemEvents

Type parameters

  • RoomType: Hostable

DoorEvents

DoorEvents<RoomType>: ExtractEventTypes<[DoorsDoorOpenEvent<RoomType>, DoorsDoorCloseEvent<RoomType>]>

Type parameters

  • RoomType: Hostable

DoorsSystemEvents

DoorsSystemEvents<RoomType>: SystemStatusEvents & DoorEvents<RoomType> & ExtractEventTypes<[]>

Type parameters

  • RoomType: Hostable

ElectricalDoorsSystemEvents

ElectricalDoorsSystemEvents<RoomType>: SystemStatusEvents & DoorEvents<RoomType> & ExtractEventTypes<[]>

Type parameters

  • RoomType: Hostable

GameDataEvents

GameDataEvents<RoomType>: NetworkableEvents<RoomType> & ExtractEventTypes<[GameDataAddPlayerEvent<RoomType>, GameDataRemovePlayerEvent<RoomType>, GameDataSetTasksEvent<RoomType>]>

Type parameters

  • RoomType: Hostable

GetHostableEvents

GetHostableEvents<T>: T extends Hostable<infer X> ? X : never

Type parameters

  • T: Hostable<HostableEvents>

HeliSabotageSystemEvents

Type parameters

  • RoomType: Hostable

HostableEvents

HostableEvents<RoomType>: NetworkableEvents<RoomType> & PlayerDataEvents<RoomType> & GameDataEvents<RoomType> & LobbyBehaviourEvents<RoomType> & MeetingHudEvents<RoomType> & ShipStatusEvents<RoomType> & VoteBanSystemEvents<RoomType> & ExtractEventTypes<[RoomEndGameIntentEvent<RoomType>, RoomFixedUpdateEvent<RoomType>, RoomGameEndEvent<RoomType>, RoomGameStartEvent<RoomType>, RoomSetPrivacyEvent<RoomType>]>

Type parameters

  • RoomType: Hostable

HqHudSystemEvents

HqHudSystemEvents<RoomType>: SystemStatusEvents<RoomType> & ExtractEventTypes<[HqHudConsolesResetEvent<RoomType>, HqHudConsoleOpenEvent<RoomType>, HqHudConsoleCloseEvent<RoomType>, HqHudConsoleCompleteEvent<RoomType>]>

Type parameters

  • RoomType: Hostable

HudOverrideSystemEvents

HudOverrideSystemEvents<RoomType>: SystemStatusEvents<RoomType> & ExtractEventTypes<[]>

Type parameters

  • RoomType: Hostable

LifeSuppSystemEvents

LifeSuppSystemEvents<RoomType>: SystemStatusEvents<RoomType> & ExtractEventTypes<[O2ConsolesClearEvent<RoomType>, O2ConsolesCompleteEvent<RoomType>]>

Type parameters

  • RoomType: Hostable

LobbyBehaviourEvents

LobbyBehaviourEvents<RoomType>: NetworkableEvents<RoomType> & ExtractEventTypes<[]>

Type parameters

  • RoomType: Hostable

MedScanSystemEvents

MedScanSystemEvents<RoomType>: SystemStatusEvents<RoomType> & ExtractEventTypes<[MedScanJoinQueueEvent<RoomType>, MedScanLeaveQueueEvent<RoomType>]>

Type parameters

  • RoomType: Hostable

MeetingHudEvents

MeetingHudEvents<RoomType>: NetworkableEvents<RoomType> & ExtractEventTypes<[MeetingHudVoteCastEvent<RoomType>, MeetingHudClearVoteEvent<RoomType>, MeetingHudVotingCompleteEvent<RoomType>, MeetingHudCloseEvent<RoomType>]>

Type parameters

  • RoomType: Hostable

MovingPlatformSystemEvents

MovingPlatformSystemEvents<RoomType>: SystemStatusEvents<RoomType> & ExtractEventTypes<[MovingPlatformPlayerUpdateEvent<RoomType>]>

Type parameters

  • RoomType: Hostable

NetworkableConstructor

NetworkableConstructor<T>: {} | {}

Type parameters

  • T

NetworkableEvents

NetworkableEvents<RoomType>: ExtractEventTypes<[ComponentSpawnEvent<RoomType>, ComponentDespawnEvent<RoomType>]>

Type parameters

  • RoomType: Hostable

PlayerControlEvents

Type parameters

  • RoomType: Hostable

PlayerDataEvents

PlayerDataEvents<RoomType>: NetworkableEvents<RoomType> & PlayerControlEvents<RoomType> & PlayerPhysicsEvents<RoomType> & CustomNetworkTransformEvents<RoomType> & ExtractEventTypes<[PlayerReadyEvent<RoomType>, PlayerJoinEvent<RoomType>, PlayerLeaveEvent<RoomType>, PlayerSetHostEvent<RoomType>, PlayerSceneChangeEvent<RoomType>, PlayerSpawnEvent<RoomType>]>

Type parameters

  • RoomType: Hostable

PlayerDataResolvable

PlayerDataResolvable: number | PlayerData | PlayerControl | PlayerPhysics | CustomNetworkTransform

PlayerIDResolvable

PlayerIDResolvable: number | PlayerData | PlayerControl | PlayerInfo | PlayerVoteState

PlayerOutfits

PlayerOutfits: Partial<Record<PlayerOutfitType, PlayerOutfit>>

PlayerPhysicsEvents

PlayerPhysicsEvents<RoomType>: NetworkableEvents<RoomType> & ExtractEventTypes<[PlayerEnterVentEvent<RoomType>, PlayerExitVentEvent<RoomType>, PlayerClimbLadderEvent<RoomType>]>

Type parameters

  • RoomType: Hostable

PrivacyType

PrivacyType: "public" | "private"

ReactorSystemEvents

ReactorSystemEvents<RoomType>: SystemStatusEvents<RoomType> & ExtractEventTypes<[ReactorConsoleAddEvent<RoomType>, ReactorConsoleRemoveEvent<RoomType>, ReactorConsolesResetEvent<RoomType>]>

Type parameters

  • RoomType: Hostable

RoomID

RoomID: string | number

SabotageSystemEvents

SabotageSystemEvents<RoomType>: SystemStatusEvents<RoomType> & ExtractEventTypes<[]>

Type parameters

  • RoomType: Hostable

SecurityCameraSystemEvents

SecurityCameraSystemEvents<RoomType>: SystemStatusEvents<RoomType> & ExtractEventTypes<[SecurityCameraJoinEvent<RoomType>, SecurityCameraLeaveEvent<RoomType>]>

Type parameters

  • RoomType: Hostable

ShipStatusEvents

ShipStatusEvents<RoomType>: NetworkableEvents<RoomType> & DoorsSystemEvents<RoomType> & SystemStatusEvents<RoomType> & AutoDoorsSystemEvents<RoomType> & DeconSystemEvents<RoomType> & ElectricalDoorsSystemEvents<RoomType> & HqHudSystemEvents<RoomType> & HeliSabotageSystemEvents<RoomType> & LifeSuppSystemEvents<RoomType> & MedScanSystemEvents<RoomType> & MovingPlatformSystemEvents<RoomType> & ReactorSystemEvents<RoomType> & SabotageSystemEvents<RoomType> & SecurityCameraSystemEvents<RoomType> & SwitchSystemEvents<RoomType> & ExtractEventTypes<[RoomAssignRolesEvent<RoomType>]>

Type parameters

  • RoomType: Hostable

ShipStatusType

SwitchSystemEvents

SwitchSystemEvents<RoomType>: SystemStatusEvents<RoomType> & ExtractEventTypes<[ElectricalSwitchFlipEvent<RoomType>]>

Type parameters

  • RoomType: Hostable

SystemStatusEvents

SystemStatusEvents<RoomType>: DoorEvents<RoomType> & ExtractEventTypes<[SystemSabotageEvent<RoomType>, SystemRepairEvent<RoomType>]>

Type parameters

  • RoomType: Hostable

VoteBanSystemEvents

VoteBanSystemEvents<RoomType>: NetworkableEvents<RoomType> & ExtractEventTypes<[]>

Type parameters

  • RoomType: Hostable

Variables

Const DeconState

DeconState: { Closed: number; Enter: number; Exit: number; HeadingUp: number; Idle: number } = ...

Type declaration

  • Closed: number
  • Enter: number
  • Exit: number
  • HeadingUp: number
  • Idle: number

Const HeliSabotageSystemRepairTag

HeliSabotageSystemRepairTag: { ActiveBit: 64; DamageBit: 128; DeactiveBit: 32; FixBit: 16 } = ...

Type declaration

  • ActiveBit: 64
  • DamageBit: 128
  • DeactiveBit: 32
  • FixBit: 16

Const HqHudSystemRepairTag

HqHudSystemRepairTag: { CloseConsole: 32; CompleteConsole: 16; OpenConsole: 64 } = ...

Type declaration

  • CloseConsole: 32
  • CompleteConsole: 16
  • OpenConsole: 64

Functions

UnknownRole

  • UnknownRole(roleType: RoleType): typeof __class

Generated using TypeDoc