Reference
Wherever the API takes a key that names something of the game - an item, a soul, a buff, a perk, a mesh, a preset, an animation clip, a door - the thing comes from one of these lists. They are the same for every scripting language; the API pages link into them.
The lists in the first table are generated from the installed game’s own files - the tables, the animation databases, the levels - by the same tool that writes the server’s tables export, so the ids in them are exactly the ids the server resolves. An id is a row number of a name-sorted export: stable for one export of one game build, shifted by a game patch that adds things - keep the name or the GUID in anything durable.
| List | What is in it | The API that takes it |
|---|---|---|
| Items | every item class by category: id, name, English name, weight, price, GUID | GivePlayerItem, CreatePickup, GetItemInfo, /give, /item |
| Souls | every soul by archetype - horses, dogs, people, animals: id, name, GUID | CreateHorse, CreateDog, CreateActor, CreateAnimal, SetSpawnInfo’s appearance, /horse, /dog |
| Looks | every face, hair style and color, beard and skin a look may name, with its traits | SetPlayerLook, SetActorLook, GetLookParts |
| Horse looks | every coat, mane and tail the game draws on a horse - patterns, builds, its named horses’ coats, curly and braided manes and tails - and the ten ready coats with their parts | SetHorseLook, GetHorseLookParts, SetHorseCoat |
| Buffs | every buff by class: id, name, English name, duration, GUID | GivePlayerBuff, ClaimBuffClasses, [combat] claimed_buffs |
| Meshes | every static mesh of the object files by folder: id, name, path | CreateProp, /prop |
| Consumables | every food, drink, potion, poison and ointment with its health, alcohol, buff and regeneration | OnPlayerUseItem |
| Clothing presets | every outfit by gender, with its pieces and GUID | SetSpawnInfo, CreateActor, [spawn] clothing_preset |
| Weapon presets | every set of arms with its weapons and GUID | SetSpawnInfo, CreateActor, [spawn] weapon_preset |
| Stats and skills | the character’s stats and skills by name, and a horse’s stats | SetPlayerStat, SetPlayerSkill, SetHorseStat |
| Perks | the game’s perks by skill and stat: English name, name, level, GUID | AddPlayerPerk, RemovePlayerPerk, GetPerkName |
| Codex entries | every Codex entry by page: its perk GUID and name, its title’s and its page’s text keys | SetPlayerCodexEntry, SetCodexEntryHidden, SetTextOverride |
| Map texts | the world map’s place names, its legend’s lines and the fast travel’s questions by key, with the English text | SetTextOverride, LoadTextOverrides |
| Animations | every clip of the male animation set by fragment family | SetActorAnim |
| Particle effects | every particle effect by library | SpawnEffect |
| Audio triggers | every sound trigger by set | PlaySound |
| Decal materials | every decal material | SpawnDecal |
| Levels, doors and containers | the three levels and every door and stash placed in each, with the key and the position | SetDoorState, GetContainerItems, [server] level |
| Voice lines | the game’s spoken lines, barks, conversations and voices an NPC actor says them in | PlayActorVoice, PlayActorBark, PlayActorConversation, SetActorVoice |
| Activities | what the game’s people do at benches, beds and work spots, and the pair animations | SetActorUse, SetActorUseAt, PlayActorPairAnim |
| Herbs and mushrooms | every kind a player can pick from the ground: the item, what a pick gives, how long it takes to grow back, its meshes | SetHerbRegrowTime, SetHerbsEnabled, CreateHerb |
| Recipes | every alchemy and blacksmithing recipe: the key, the name, the document that teaches it, what it makes | GivePlayerRecipe, SetPlayerRecipes, OnPlayerLearnRecipe |
| Map icons | the world map’s icon types, and every level’s own shop and service icons with their ids and places | CreateMapIcon, HideLevelMapIcons |
Three pages follow the server’s code rather than the game’s files:
| Page | |
|---|---|
| Weather | the presets and the level sky profiles they stand for - SetWeather, /weather |
| Chat commands | the commands the server answers in every game mode, and who may use each |
| Lanterns | the two lanterns KCD:MP adds to the game, carried like the torch - GivePlayerItem, SetActorTorch |
The lists are the server’s own export of the game: Exporting the game’s tables makes the same
file for your server, so the ids here are the ids it resolves. Every key of server.toml is on
Server configuration.
