Modding:Lua/Tables/Playercompanions

The playerCompanions table contains bindings used to manage player companions such as pets and crew members.

---

JsonArray playerCompanions.getCompanions(String companionType)

Returns a list of configurations for all companions of the specified type.

---

void playerCompanions.setCompanions(String companionType, JsonArray companions)

Sets the player's companions of the specified type to the specified list of companion configurations.

Quick Navigation

Modding

Portal - Basics - JSON - Lua - Assets - Guides

---

Tables - Hooks - Tips & Tricks - Libraries - All Pages

Activeitem	Commandprocessor	Message	Physics	Scriptpane	Utility
Activeitemanimation	Config	Monster	Player	Stagehand	Vehicle
Actormovementcontroller	Containerpane	Movementcontroller	Playercompanions	Statuscontroller	Widget
Animationconfig	Entity	Npc	Projectile	Statuseffect	World
Animator	Item	Object	Quest	Tech
Celestial	Localanimator	Objectanimator	Root	Updatablescript

Modding