From 98cdafa094c3fbb7c35b5c1a4815f7f4141ebb9e Mon Sep 17 00:00:00 2001 From: Drew C Date: Mon, 9 Mar 2026 22:26:21 -0500 Subject: [PATCH] Update README.md for new functions --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 176c9b3..304f73f 100644 --- a/README.md +++ b/README.md @@ -9,5 +9,17 @@ Currently only works with the debug kit `StarWarsI.exe`; `StarWarsG.exe` support ## Functions -- Global `WriteToFile(str a, str b)` - Appends a line of text `b` to the file name `a` in the game directory. +- Global `WriteToFile(file, text)` - Appends a line of text specified file in the game directory. + - Parameter `file` string - The file name to append. + - Parameter `text` string - The text line to append. - Global `Get_All_Players()` - Returns a 1-based Lua table of all active players, iterable with `ipairs()`. Each entry is the same PlayerWrapper type returned by `Find_Player()`. +- Global `Add_Tutorial_Text(key, text, duration, r, g, b, a)` - Adds a line to the tutorial text pane. + - Parameter `key`: string - The key used to identify this line, later can be used to update or remove the text. + - Parameter `text`: string - The text to display. + - Parameter `duration` number? - The duration to display the text. Default: -1 (infinite) + - Parameter `r` number? - The red color component. Default: 1 + - Parameter `g` number? - The green color component. Default: 1 + - Parameter `b` number? - The blue color component. Default: 1 + - Parameter `a` number? - The alpha component. Default: 1 +- Global `Remove_Tutorial_Text(key)` - Removes the line associated with the key. + - Parameter `key` string - The key used to identify the line when it was added. \ No newline at end of file