bs_core

standalone RPG / zombie survival framework core.

Generated from the Lua sources in resources/[beyond]/bs_core/. 102 entries. The description column is the comment above the line in the code, so if it’s empty nobody wrote one yet.

Exports

Call with exports.bs_core:Name(...) from the same side.

Name	Side	Where	Description
AdjustStamina	client	client/cl_needs.lua:234	WHY A SETTER, NOT JUST GetNeeds().
ApplyAppearanceTo	client	client/cl_spawn.lua:165
ApplyOutfit	client	client/cl_outfit.lua:145
AwaitCallback	client	client/cl_callback.lua:61 (not in fxmanifest)
CaptureOutfit	client	client/cl_outfit.lua:144
Crumb	client	client/cl_crumbs.lua:20
Crumbs	client	client/cl_crumbs.lua:32
CrumbsOn	client	client/cl_crumbs.lua:21
GetData	client	client/cl_player.lua:70
GetNeeds	client	client/cl_needs.lua:226
GetSessionState	client	client/cl_bootstrap.lua:153	The current session state, for resources that may start (or restart) AFTER the state event has already been sent.
IsLoaded	client	client/cl_player.lua:69
RegisterClientCallback	client	client/cl_callback.lua:62 (not in fxmanifest)
Unstick	client	client/cl_unstick.lua:161
AddMoney	server	server/sv_player.lua:481
AddXP	server	server/sv_player.lua:466
AppearanceSchema	server	server/sv_characters.lua:400
AwaitClientCallback	server	server/sv_callback.lua:72 (not in fxmanifest)
AwardAction	server	server/sv_rewards.lua:53
AwardActionTimes	server	server/sv_rewards.lua:56	Bulk version for things that happen in batches (a horde wipe).
ChangeInfection	server	server/sv_needs.lua:68
ClassList	server	server/sv_player.lua:564
CreateCharacterFor	server	server/sv_characters.lua:319	Creates a character for a connected player.
GetPlayer	server	server/sv_player.lua:377
GetPlayerByCharId	server	server/sv_player.lua:379
GetPlayerMeta	server	server/sv_player.lua:524	Character metadata, for resources that need to remember something about a character without owning a table of their own (bs_inventory’s starting loadout flag, for one).
GetPlayers	server	server/sv_player.lua:378
GetPlayerSummary	server	server/sv_player.lua:436	Everything a UI needs about a player, already flattened.
GetSkillPoints	server	server/sv_player.lua:416
GrantSkillPoints	server	server/sv_player.lua:405	Staff and respec use this; it never goes negative.
ListCharacters	server	server/sv_characters.lua:329	Character slots for a connected player, shaped for the select screen.
PrimaryIdentifier	server	server/sv_player.lua:370	The account key for a connected source: license2, falling back to license, prefixed - the exact string bs_users rows are stored under.
RegisterCallback	server	server/sv_callback.lua:71 (not in fxmanifest)
RemoveMoney	server	server/sv_player.lua:488
RestoreNeeds	server	server/sv_needs.lua:53
SavePlayer	server	server/sv_player.lua:537
SetCharacterAppearance	server	server/sv_characters.lua:404	Sets the loaded character’s appearance (sanitised) and saves it.
SetCharacterOutfit	server	server/sv_characters.lua:336	Writes a starting outfit into a character’s metadata.
SetCharacterPendingEquip	server	server/sv_characters.lua:376	Queues real clothing ITEMS to be equipped the first time this character spawns - bs_inventory’s ‘pendingEquip’ handling in its bs:hook:player:spawned listener is the consumer,…
SetClass	server	server/sv_player.lua:547	Staff tool (bs_admin “Change class”): swaps a live character’s class.
SetLevel	server	server/sv_player.lua:495
SetNeedsFor	server	server/sv_player.lua:514
SetPlayerMeta	server	server/sv_player.lua:530
SpendSkillPoints	server	server/sv_player.lua:390
SpendXP	server	server/sv_player.lua:475	Returns false (spends nothing) if the player doesn’t have enough banked XP to cover it - see the note on Player:SpendXP above.
GetConfig	shared	shared/sh_framework.lua:145
GetEvents	shared	shared/sh_framework.lua:143
GetFramework	shared	shared/sh_framework.lua:141
GetVersion	shared	shared/sh_framework.lua:144
HasService	shared	shared/sh_services.lua:218
IsReady	shared	shared/sh_framework.lua:146
RegisterModule	shared	shared/sh_framework.lua:142
Use	shared	shared/sh_services.lua:217

Callbacks

Server callbacks are called from a client with BSB.Await(name, timeoutMs, ...). Client callbacks are called from the server with BSB.AwaitClient(src, name, timeoutMs, ...).

Name	Direction	Where	Description
characters:create	client -> server	server/sv_characters.lua:271
characters:delete	client -> server	server/sv_characters.lua:279
characters:list	client -> server	server/sv_characters.lua:260
characters:select	client -> server	server/sv_characters.lua:287
core:saveHudSettings	client -> server	server/sv_needs.lua:71	HUD preference storage, so a player’s layout follows their character.

Events

“net” means the handler is registered with RegisterNetEvent, so the other side can trigger it. “local” is AddEventHandler only (same side, or game events).

Name	Side	Type	Where	Description
bs:callback:clientRequest	client	net	client/cl_callback.lua:50 (not in fxmanifest)
bs:callback:clientResponse	server	net	server/sv_callback.lua:66 (not in fxmanifest)
bs:callback:request	server	net	server/sv_callback.lua:20 (not in fxmanifest)
bs:callback:response	client	net	client/cl_callback.lua:40 (not in fxmanifest)
bs:characters:logout	server	net	server/sv_bootstrap.lua:103
bs:characters:spawned	server	net	server/sv_characters.lua:303	The client reports a completed spawn.
bs:core:safeSpawn	client	local	client/cl_spawn.lua:81
bs:db:insert	server	local	server/sv_database.lua:94
bs:db:update	server	local	server/sv_database.lua:102
bs:hook:player:unloaded	client	local	client/cl_spawn.lua:490	And it goes false again the moment the character leaves.
bs:needs:setInfection	client	net	client/cl_needs.lua:285	Server-side infection change (zombie bites, cures).
bs:outfit:push	client	local	client/cl_outfit.lua:142	Anything that changes what the player is wearing raises this, and the server gets the new outfit without that resource needing to know how it is stored.
bs:player:dataSet	client	net	client/cl_player.lua:29
bs:player:levelUp	client	net	client/cl_player.lua:64
bs:player:loaded	client	net	client/cl_player.lua:15
bs:player:money	client	net	client/cl_player.lua:48
bs:player:needs	client	net	client/cl_needs.lua:131
bs:player:unloaded	client	net	client/cl_player.lua:23
bs:player:updateNeeds	server	net	server/sv_needs.lua:8
bs:player:updateOutfit	server	net	server/sv_outfit.lua:103
bs:player:updatePosition	server	net	server/sv_bootstrap.lua:133
bs:player:xp	client	net	client/cl_player.lua:59
bs:session:clientReady	server	net	server/sv_bootstrap.lua:80	Client finished loading and is ready to receive the character list.
bs:session:state	client	net	client/cl_bootstrap.lua:68
onResourceStart	server	local	server/sv_bootstrap.lua:10
onResourceStop	client	local	client/cl_bootstrap.lua:155
onResourceStop	server	local	server/sv_bootstrap.lua:188
playerConnecting	server	local	server/sv_bootstrap.lua:52
playerDropped	server	local	server/sv_bootstrap.lua:97
playerDropped	shared	local	shared/sh_bridge.lua:107
txAdmin:events:serverShuttingDown	server	local	server/sv_bootstrap.lua:197

Commands

Command	Side	Where	Description
/bs	server	server/sv_commands.lua:25
/bs_crumbs	client	client/cl_crumbs.lua:51
/characters	client	client/cl_spawn.lua:529
/delchar	client	client/cl_spawn.lua:575
/givemoney	server	server/sv_commands.lua:78
/givexp	server	server/sv_commands.lua:69
/logout	server	server/sv_commands.lua:56
/newchar	client	client/cl_spawn.lua:546
/play	client	client/cl_spawn.lua:561
/savechar	server	server/sv_commands.lua:63
/setneeds	server	server/sv_commands.lua:87
/unstick	client	client/cl_unstick.lua:176	And a command, because a player who is stuck should not have to wait for a watchdog to notice.
/whoami	server	server/sv_commands.lua:40

Files not loaded

These Lua files are on disk but no pattern in fxmanifest.lua loads them (or they are only pulled in with @bs_core/... by another resource). Anything listed from them above is not live in this resource.

• client/cl_callback.lua
• server/sv_callback.lua