drew/FoCAPI
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 5 Wiki Activity

Update README.md for new functions

Browse Source
This commit is contained in:
Drew C
2026-03-09 22:26:21 -05:00
parent 14f02697be
commit 98cdafa094
1 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -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.