diff options
author | madmaxoft <github@xoft.cz> | 2013-10-18 23:22:26 +0200 |
---|---|---|
committer | madmaxoft <github@xoft.cz> | 2013-10-18 23:22:26 +0200 |
commit | be996c16626e6f7c8a7c43595f5c6efaacf668eb (patch) | |
tree | 458548dc0680dc4adf53579e8b4ef994f2cdfd16 /MCServer/Plugins/APIDump/APIDesc.lua | |
parent | APIDump: Offline prettify is working. (diff) | |
download | cuberite-be996c16626e6f7c8a7c43595f5c6efaacf668eb.tar cuberite-be996c16626e6f7c8a7c43595f5c6efaacf668eb.tar.gz cuberite-be996c16626e6f7c8a7c43595f5c6efaacf668eb.tar.bz2 cuberite-be996c16626e6f7c8a7c43595f5c6efaacf668eb.tar.lz cuberite-be996c16626e6f7c8a7c43595f5c6efaacf668eb.tar.xz cuberite-be996c16626e6f7c8a7c43595f5c6efaacf668eb.tar.zst cuberite-be996c16626e6f7c8a7c43595f5c6efaacf668eb.zip |
Diffstat (limited to 'MCServer/Plugins/APIDump/APIDesc.lua')
-rw-r--r-- | MCServer/Plugins/APIDump/APIDesc.lua | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua index 544e02049..a57a7a342 100644 --- a/MCServer/Plugins/APIDump/APIDesc.lua +++ b/MCServer/Plugins/APIDump/APIDesc.lua @@ -1003,6 +1003,34 @@ cFile:Delete("/usr/bin/virus.exe"); Constants = { }, + AdditionalInfo = + { + { + Header = "Practical usage", + Contents = [[ + If you want to use cIniFile you need to know a couple of things; what is the key name and what + is the value name. Below is a demonstration of what is what.</p> +<pre class="prettyprint lang-ini"> +; Comment line +[KeyName1] +ValueName1=Value1 +ValueName2=Value2 + +[KeyName2] +ValueName1=Value3 +</pre></p> + <p> + cIniFile is very easy to use. For example, you can find out what port the server is supposed to + use according to settings.ini by using this little snippet: +<pre class="prettyprint lang-lua"> +local IniFile = cIniFile("settings.ini"); +if (IniFile:ReadFile()) then + ServerPort = IniFile:GetValueI("Server", "Port"); +end +</pre> + ]], + }, + }, }, cInventory = |