fix Game docs

This commit is contained in:
Evil Factory
2022-05-16 13:27:24 -03:00
parent 73d5edfafa
commit cb29c27752
+18 -14
View File
@@ -9,48 +9,48 @@ Class providing game related things, Access fields and functions like that: Game
local Game = {} local Game = {}
--- Is the round started? --- Is the round started?
-- @realm shared -- @realm shared
Game.RoundStarted = true Game.RoundStarted = true
--- Is dedicated server? --- Is dedicated server?
-- @realm server -- @realm server
Game.IsDedicated = true Game.IsDedicated = true
--- Server settings. --- Server settings.
-- @realm server -- @realm server
Game.ServerSettings = true Game.ServerSettings = true
--- Send chat message to every client. --- Send chat message to every client.
-- @realm server -- @realm server
function Game.SendMessage(msg, messageType, sender, character) end function Game.SendMessage(msg, messageType, sender, character) end
--- Send traitor message. --- Send traitor message.
-- @realm server -- @realm server
function Game.SendTraitorMessage(client, msg, missionid, type) end function Game.SendTraitorMessage(client, msg, missionid, type) end
--- Send direct message. --- Send direct message.
-- @realm server -- @realm server
function Game.SendDirectChatMessage(sendername, text, senderCharacter, chatMessageType, client, iconStyle) end function Game.SendDirectChatMessage(sendername, text, senderCharacter, chatMessageType, client, iconStyle) end
--- Send direct message. --- Send direct message.
-- @realm server -- @realm server
function Game.SendDirectChatMessage(chatMessage, client) end function Game.SendDirectChatMessage(chatMessage, client) end
--- True to override traitors. --- True to override traitors.
-- @realm server -- @realm server
function Game.OverrideTraitors(override) end function Game.OverrideTraitors(override) end
--- True to override respawn sub, stops players from being respawned. --- True to override respawn sub, stops players from being respawned.
-- @realm server -- @realm server
function Game.OverrideRespawnSub(override) end function Game.OverrideRespawnSub(override) end
--- True to make wifi chat always work. --- True to make wifi chat always work.
-- @realm server -- @realm server
function Game.AllowWifiChat(override) end function Game.AllowWifiChat(override) end
--- True to prevent headsets from transmitting wifi signals. --- True to prevent headsets from transmitting wifi signals.
-- @realm server -- @realm server
function Game.OverrideSignalRadio(override) end function Game.OverrideSignalRadio(override) end
--- True to disable spam filter. --- True to disable spam filter.
@@ -66,11 +66,11 @@ function Game.DisableDisconnectCharacter(override) end
function Game.EnableControlHusk(override) end function Game.EnableControlHusk(override) end
--- Log message to server logs. --- Log message to server logs.
-- @realm server -- @realm server
function Game.Log(message, ServerLogMessageType) end function Game.Log(message, ServerLogMessageType) end
--- Spawn explosion. --- Spawn explosion.
-- @realm server -- @realm shared
function Game.Explode(pos, range, force, damage, structureDamage, itemDamage, empStrength, ballastFloraStrength) end function Game.Explode(pos, range, force, damage, structureDamage, itemDamage, empStrength, ballastFloraStrength) end
--- Get respawn sub submarine. --- Get respawn sub submarine.
@@ -83,13 +83,17 @@ function Game.GetRespawnSub() end
function Game.DispatchRespawnSub() end function Game.DispatchRespawnSub() end
--- Execute console command. --- Execute console command.
-- @realm server -- @realm shared
function Game.ExecuteCommand(command) end function Game.ExecuteCommand(command) end
--- Starts the game. --- Starts the game.
-- @realm server -- @realm server
function Game.StartGame() end function Game.StartGame() end
--- Ends the game.
-- @realm server
function Game.EndGame() end
--- Gets all enabled content packages. --- Gets all enabled content packages.
--@treturn table Table containing ContentPackages --@treturn table Table containing ContentPackages
-- @realm shared -- @realm shared