summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/APIDesc.lua
diff options
context:
space:
mode:
authorMattes D <github@xoft.cz>2014-09-07 22:35:22 +0200
committerMattes D <github@xoft.cz>2014-09-07 22:35:22 +0200
commitc5cd75fae83a61920a9a5d50b94b09ae25d87430 (patch)
treeb76f91c1c427ad2ea3c6688564730b3ee8225faa /MCServer/Plugins/APIDump/APIDesc.lua
parentWebadmin: Added default ports to auto-generated ini file. (diff)
downloadcuberite-c5cd75fae83a61920a9a5d50b94b09ae25d87430.tar
cuberite-c5cd75fae83a61920a9a5d50b94b09ae25d87430.tar.gz
cuberite-c5cd75fae83a61920a9a5d50b94b09ae25d87430.tar.bz2
cuberite-c5cd75fae83a61920a9a5d50b94b09ae25d87430.tar.lz
cuberite-c5cd75fae83a61920a9a5d50b94b09ae25d87430.tar.xz
cuberite-c5cd75fae83a61920a9a5d50b94b09ae25d87430.tar.zst
cuberite-c5cd75fae83a61920a9a5d50b94b09ae25d87430.zip
Diffstat (limited to 'MCServer/Plugins/APIDump/APIDesc.lua')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua1
1 files changed, 1 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index 718cb4e98..c23120600 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -524,6 +524,7 @@ end
Functions =
{
GenerateOfflineUUID = { Params = "Username", Return = "string", Notes = "(STATIC) Generates an UUID based on the player name provided. This is used for the offline (non-auth) mode, when there's no UUID source. Each username generates a unique and constant UUID, so that when the player reconnects with the same name, their UUID is the same. Returns a 32-char UUID (no dashes)." },
+ GetIPString = { Params = "", Return = "string", Notes = "Returns the IP address of the connection, as a string. Only the address part is returned, without the port number." },
GetLocale = { Params = "", Return = "Locale", Notes = "Returns the locale string that the client sends as part of the protocol handshake. Can be used to provide localized strings." },
GetPing = { Params = "", Return = "number", Notes = "Returns the ping time, in ms" },
GetPlayer = { Params = "", Return = "{{cPlayer|cPlayer}}", Notes = "Returns the player object connected to this client. Note that this may be nil, for example if the player object is not yet spawned." },