Pair: setRuleValue

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|nil getRuleValue ( )

Returns

• string|nil: rule value

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

Code Examples

server

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

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

See Also

Announcement Functions

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

Reference

• Scripting Functions