GetRuleValue: Difference between revisions

Revision as of 11:07, 12 September 2006

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.

strig getRuleValue ( string key )

Returns true if the rule value was set, false if invalid arguments were specified.

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

if ( getRuleValue ( "myScriptRunning" ) ~= false )
    -- the value is set
end

@@ Line 1: / Line 1: @@
-[[Category:Incomplete]]
-[[Category:Need Syntax]]
 __NOTOC__
-This function is for blahblah.. not defined yet
+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.
 ==Syntax==
 <syntaxhighlight lang="lua">
-INSERT SYNTAX HERE
+strig getRuleValue ( string key )
 </syntaxhighlight>
 ===Required Arguments===
-*'''argumentName:''' description
+*'''key:''' The name of the rule
+*'''value:'''The value you wish to set for the rule
-===Optional Arguments===
-{{OptionalArg}}
-*'''argumentName2:''' descriptiona
-*'''argumentName3:''' description
 ===Returns===
-Returns ''true'' if blah, ''false'' otherwise.
+Returns ''true'' if the rule value was set, ''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" ) ~= false )
-blabhalbalhb --abababa
+    -- the value is set
---This line does this...
+end
-mooo
 </syntaxhighlight>
 ==See Also==
-{{FunctionArea_Functions}}
+{{ASE_functions}}