GetRuleValue: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | {{Server function}} | ||
__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. | 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. | ||
Revision as of 19:42, 17 August 2007
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