GetRuleValue

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" ) then
    -- the value is set
end

See Also

• getGameType
• getMapName
• getRuleValue
• removeRuleValue
• setGameType
• setMapName
• setRuleValue