GetRuleValue: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 4: | Line 4: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
string getRuleValue ( string key ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''key:''' The name of the rule | *'''key:''' The name of the rule | ||
===Returns=== | ===Returns=== | ||
Returns '' | Returns a string containing the value set for the specified ''key'', ''false'' if invalid arguments were specified. | ||
==Example== | ==Example== | ||
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.
Syntax
string getRuleValue ( string key )
Required Arguments
- key: The name of the rule
Returns
Returns a string containing the value set for the specified key, false if invalid arguments were specified.
Example
This example shows how you can check if a rule is set.
if ( getRuleValue ( "myScriptRunning" ) ~= false )
-- the value is set
end