Add FoCAPI docus
This commit is contained in:
39
.luadefs/focapi-functions-emmyluadoc.lua
Normal file
39
.luadefs/focapi-functions-emmyluadoc.lua
Normal file
@@ -0,0 +1,39 @@
|
||||
---@diagnostic disable
|
||||
|
||||
-- ==================================================
|
||||
-- I/O
|
||||
-- ==================================================
|
||||
|
||||
---@public
|
||||
---Appends the text to file.
|
||||
---@param file string The file name.
|
||||
---@param text string The text to append.
|
||||
function WriteToFile(file, text) end
|
||||
|
||||
-- ==================================================
|
||||
-- Finders
|
||||
-- ==================================================
|
||||
|
||||
---Finds all Players in the game.
|
||||
---@return PlayerObject[]
|
||||
function Get_All_Players() end
|
||||
|
||||
-- ==================================================
|
||||
-- UI
|
||||
-- ==================================================
|
||||
|
||||
---@public
|
||||
---Adds the specified text to the tutorial text box.
|
||||
---@param key string The key to use.
|
||||
---@param text string The text to add.
|
||||
---@param duration number The duration to keep text on screen, defaults to -1 (infinite).
|
||||
---@param r number The red color component.
|
||||
---@param g number The green color component.
|
||||
---@param b number The blue color component.
|
||||
---@param a number The alpha channel component.
|
||||
function Add_Tutorial_Text(key, text, duration, r, g, b, a) end
|
||||
|
||||
---@public
|
||||
---Removes the specified text key from the tutorial text box.
|
||||
---@param key string The key to remove.
|
||||
function Remove_Tutorial_Text(key) end
|
||||
Reference in New Issue
Block a user