GetRuleValue: Difference between revisions

Latest revision as of 22:22, 27 May 2017

This function gets a rule value. A rule value is a string that can be viewed by server browsers and used for filtering the server list.

string getRuleValue ( string key )

Returns a string containing the value set for the specified key, false if invalid arguments were specified.

This example shows how you can check if a rule is set.

if getRuleValue ( "myScriptRunning" ) then
    -- the value is set
end

@@ Line 1: / Line 1: @@
-[[Category:Incomplete]]
+{{Server function}}
-[[Category:Need Syntax]]
+__NOTOC__
+This function gets a rule value. A rule value is a string that can be viewed by server browsers and used for filtering the server list.
-__NOTOC__
-This function is for blahblah.. not defined yet
 ==Syntax==
 <syntaxhighlight lang="lua">
-INSERT SYNTAX HERE
+string getRuleValue ( string key )
 </syntaxhighlight>
 ===Required Arguments===
-*'''argumentName:''' description
+*'''key:''' The name of the rule
-===Optional Arguments===
-{{OptionalArg}}
-*'''argumentName2:''' descriptiona
-*'''argumentName3:''' description
 ===Returns===
-Returns ''true'' if blah, ''false'' otherwise.
+Returns a string containing the value set for the specified ''key'', ''false'' if invalid arguments were specified.
 ==Example==
-This example does...
+This example shows how you can check if a rule is set.
 <syntaxhighlight lang="lua">
---This line does...
+if getRuleValue ( "myScriptRunning" ) then
-blabhalbalhb --abababa
+    -- the value is set
---This line does this...
+end
-mooo
 </syntaxhighlight>
 ==See Also==
-{{FunctionArea_Functions}}
+{{Announce functions}}