From adf61fd0df78cc7a2f1d40cacfe6cfd745d37b40 Mon Sep 17 00:00:00 2001 From: emmaker Date: Mon, 2 Jun 2025 18:45:57 -0400 Subject: Document codex binds --- doc/lua/player.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/doc/lua/player.md b/doc/lua/player.md index fd8ebd4..f5908ee 100644 --- a/doc/lua/player.md +++ b/doc/lua/player.md @@ -527,3 +527,39 @@ Returns uuid, type, and orbits for all system objects in the specified system; #### `List` player.collectables(`String` collectionName) Returns a list of names of the collectables the player has unlocked in the specified collection. + +--- + +#### `bool` player.isCodexKnown(`String` codexId) + +Returns `true` if the player knows the specified codexId, and `false` otherwise. + +--- + +#### `bool` player.isCodexRead(`String` codexId) + +Returns `true` if the player has read the specified codexId, and `false` otherwise. + +--- + +#### `bool` player.markCodexRead(`String` codexId) + +Marks the specified codexId as read by the player. Returns `true` if the codex is known by the player and was marked as unread and `false` otherwise. + +--- + +#### `bool` player.markCodexUnread(`String` codexId) + +Marks the specified codexId as not read by the player. Returns `true` if the codex is known by the player and was marked as read and `false` otherwise. + +--- + +#### `void` player.learnCodex(`String` codexId, [`bool` markRead]) + +Make the player learn the specified codexId. If markRead is `true`, then the codex will be marked as read by default. + +--- + +#### `Json` player.getCodexes() + +Returns a JSON object where the keys are the codex ID, and the values are if the codex is marked as read. \ No newline at end of file -- cgit v1.2.3