osb/doc/lua/playercompanions.md

14 lines
463 B
Markdown
Raw Permalink Normal View History

2023-06-20 04:33:09 +00:00
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.