Skip to content

API reference

These pages are made by scripts/gen-api.mjs reading the Lua files, not written by hand. If something is missing here its not registered with a plain string name (or it lives in a file the scanner skips).

Run it again after changing code:

Terminal window
npm run gen:api
# or
node scripts/gen-api.mjs "../resources/[beyond]"
ResourceWhat it isExportsCallbacksEventsCommands
bs_adminstaff menu33148
bs_assetsstreamed assets (models, textures, audio)0000
bs_atlasthe Node Atlas: a live, zoomable map of the zombie simulation0130
bs_bodilyInfrequent bodily needs and the N-key needs wheel0231
bs_boosterssingle-use personal buffs (3 slots, PvE only)7080
bs_buildingbarricades, campfires, workbenches and somewhere to wake up88121
bs_chatthe chat, replacing the stock one60113
bs_cinecamcinematic free camera and recording tools0133
bs_configF1 admin configuration console - live tunables, profiles, audit log5073
bs_corestandalone RPG / zombie survival framework core5353113
bs_drugsdrugs, cigarettes, addiction and withdrawal2090
bs_economyvendors, loot tables and gathering2140
bs_emotessurvivor actions, emotes and clothing2301016
bs_esx_bridgeCompatibility shim - lets ESX-authored scripts run against BeyondSurvival1070
bs_eventsscheduled world events: airdrops, supply stashes, convoys, horde waves02101
bs_extractionPVP City Zone: raid zones, extraction points, rogue/bounty5161
bs_faction_basesFaction flags, bases, permissions, reclaiming and storage131582
bs_factionsBeyondSurvival faction service42521912
bs_gadgetsdeployable gadgets (2 slots): drone, turret, medic beacon, decoy, riot shield70310
bs_guardanti-cheat DETECTION layer (log + alert staff only, never kicks/bans)63151
bs_interactionsdot targeting, world interactions, searchable containers12341
bs_inventorygrid inventory, containers, crafting and settings4323352
bs_loadingloading screen0000
bs_medicalgoing down instead of dying, bleeding out, and being picked up815261
bs_menuthe pause-style hub: inventory, stats, skills, settings3161
bs_mininggathering: mining rock and felling timber, loudly0321
bs_multicharcharacter select and creator with a live 3D preview1341
bs_radialthe radial menu every other resource opens6030
bs_recyclerRust-style recyclers: feed a machine loot, get materials back0461
bs_scenesnotes survivors leave on the world3346
bs_scoreboardwho is here, and who has done the most1122
bs_skillsskill trees, perks and the effects they actually apply19482
bs_stashburied stashes: a cache only the person who dug it knows about0663
bs_tradersSCUM-style NPC traders and mission givers120174
bs_uiHUD, notifications and shared NUI shell310157
bs_vehiclesvehicles that belong to somebody, wear out, and carry things2124236
bs_vipVIP: three cosmetic tiers. No gameplay advantage.32283
bs_weaponsweapon attachments as real items, on a wheel184135
bs_worlddead world: no traffic, no pedestrians, custom blackout9371
bs_zombiepedsstreamed zombie ped models0000
bs_zombiesserver-synced walkers: one list, one health pool, hosted AI, individual-zombie simulation4595536
bs_zombiesfxzombie vocal audio (replaces vanilla ped pain waves)0000
nodesthe sector map, served as a web panel0002