diff -r 7c0b4029caa1 -r bd781e19a52d LuaLibraryParams.wiki --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/LuaLibraryParams.wiki Wed May 02 23:47:33 2018 +0200 @@ -0,0 +1,32 @@ +#summary Lua library documentation: Params +#labels LuaLibrary + += Lua library: `Params` = +The Params library is a small library introduced in 0.9.21. It provides a function to parse the parameter string `ScriptParam` and it is intended to simplify using this string. + +This library requires the parameter string to be in a certain format. It must be a comma-seperated list of kev-value pairs in the `key=value` format. Examples: + +speed=1 +health=100, ammo=5 +param1=hello, param2=whatever, param3=5325.4 + +Using this library is by no means neccessary, you could use practically whatever syntax you wish if you write your own code for parsing. + +== `parseParams()` == +Parses `ScriptParam` and writes the result into the global table `params`. The table will follow the `key=value` pattern. Both keys and pairs are stored as string. + +=== Example === + +function onParameters() + parseParams() + if params["myparam1"] == "hello" then + WriteLnToConsole("Hello World!") + end +end + +If the key-value pair `myparam1=hello` is present, this script writes “Hello World!” in the console. All these inputs would trigger the event: + +myparam1=hello +myparam2=whatever, myparam1=hello +g=4, f=56, m=56, myparam1=hello +