summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/APIDesc.lua
diff options
context:
space:
mode:
authorSTRWarrior <niels.breuker@hotmail.nl>2013-09-27 15:10:55 +0200
committerSTRWarrior <niels.breuker@hotmail.nl>2013-09-27 15:10:55 +0200
commit271bbdd7ac15c5fa8de90797016243747b000231 (patch)
treecaee617ad2e80b1695608d5515bcacdcbb2fde26 /MCServer/Plugins/APIDump/APIDesc.lua
parentAPIDump: Completed cCuboid docs. (diff)
downloadcuberite-271bbdd7ac15c5fa8de90797016243747b000231.tar
cuberite-271bbdd7ac15c5fa8de90797016243747b000231.tar.gz
cuberite-271bbdd7ac15c5fa8de90797016243747b000231.tar.bz2
cuberite-271bbdd7ac15c5fa8de90797016243747b000231.tar.lz
cuberite-271bbdd7ac15c5fa8de90797016243747b000231.tar.xz
cuberite-271bbdd7ac15c5fa8de90797016243747b000231.tar.zst
cuberite-271bbdd7ac15c5fa8de90797016243747b000231.zip
Diffstat (limited to '')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua7
1 files changed, 6 insertions, 1 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index c628efbc7..7f10b0072 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -1402,10 +1402,15 @@ cPluginManager.AddHook(cPluginManager.HOOK_CHAT, OnChatMessage);
cServer =
{
- Desc = [[cServer is typically only used by plugins to broadcast a chat message to all players in the server. Natively however, cServer accepts connections from clients and adds those clients to the game.
+ Desc = [[cServer is typically only used by plugins to broadcast a chat message(Now replaced by the {{cRoot|cRoot}} BroadcastChat function) to all players in the server. Natively however, cServer accepts connections from clients and adds those clients to the game.
]],
Functions =
{
+ GetDescription = { Return = "string", Notes = "Returns the server description set in the settings.ini." },
+ GetMaxPlayers = { Return = "number", Notes = "Returns the max amount of players who can join the server." },
+ SetMaxPlayers = { Params = "number", Notes = "Sets the max amount of players who can join." },
+ GetNumPlayers = { Return = "number", Notes = "Returns the amount of players online." },
+ GetServerID = { Return = "string", Notes = "Returns the ID of the server?" },
},
Constants =
{