GetRuleValue: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Reverted edits by Antymed (talk) to last revision by Talidan)
 
(4 intermediate revisions by 3 users not shown)
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.


Line 16: Line 17:
This example shows how you can check if a rule is set.
This example shows how you can check if a rule is set.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
if ( getRuleValue ( "myScriptRunning" ) ~= false )
if getRuleValue ( "myScriptRunning" ) then
     -- the value is set
     -- the value is set
end
end
Line 22: Line 23:


==See Also==
==See Also==
{{ASE_functions}}
{{Announce functions}}

Latest revision as of 22:22, 27 May 2017

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