RemoveRuleValue: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (fix typo in example comment)
 
Line 15: Line 15:


==Example==  
==Example==  
This example shows how you could set a rule that shows that your script is running on the server.
This example shows how you could '''unset/remove a rule''' that shows that your script is running on the server.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
removeRuleValue ( "myScriptRunning" )
removeRuleValue ( "myScriptRunning" )

Latest revision as of 09:29, 3 October 2024

This function removes a set rule value that can be viewed by server browsers.

Syntax

bool removeRuleValue ( string key )              

Required Arguments

  • key: The name of the rule you wish to remove

Returns

Returns true if the rule value was removed, false if it failed.

Example

This example shows how you could unset/remove a rule that shows that your script is running on the server.

removeRuleValue ( "myScriptRunning" )

See Also