Files
FoC-GameManager/.luadefs/focapi-functions-emmyluadoc.lua

54 lines
1.7 KiB
Lua

---@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.
---A new text key will be appended as a new line.
---An existing text key will be overwritten.
---@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
-- ==================================================
-- GameObjectType extensions
-- ==================================================
---@class GameObjectType
---A generic GameObjectType that represents a C++ GameObjectTypeClass
local GameObjectType = {}
---@public
---Returns the display name for the object type.
---@return string
function GameObjectType.Get_Display_Name() end