diff options
| author | Kae <80987908+Novaenia@users.noreply.github.com> | 2023-06-20 14:33:09 +1000 |
|---|---|---|
| committer | Kae <80987908+Novaenia@users.noreply.github.com> | 2023-06-20 14:33:09 +1000 |
| commit | 6352e8e3196f78388b6c771073f9e03eaa612673 (patch) | |
| tree | e23772f79a7fbc41bc9108951e9e136857484bf4 /doc/lua/playercompanions.md | |
| parent | 6741a057e5639280d85d0f88ba26f000baa58f61 (diff) | |
everything everywhere
all at once
Diffstat (limited to 'doc/lua/playercompanions.md')
| -rw-r--r-- | doc/lua/playercompanions.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/lua/playercompanions.md b/doc/lua/playercompanions.md new file mode 100644 index 0000000..298a85a --- /dev/null +++ b/doc/lua/playercompanions.md @@ -0,0 +1,13 @@ +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. |