SetRuleValue: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
m (added MAX 200 characters according to ASE.h constants)
 
Line 9: Line 9:


===Required Arguments===  
===Required Arguments===  
*'''key:''' The name of the rule
*'''key:''' The name of the rule '''(MAX 200 characters)'''
*'''value:''' The value you wish to set for the rule
*'''value:''' The value you wish to set for the rule '''(MAX 200 characters)'''


===Returns===
===Returns===

Latest revision as of 09:29, 3 October 2024

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

Syntax

bool setRuleValue ( string key, string value )              

Required Arguments

  • key: The name of the rule (MAX 200 characters)
  • value: The value you wish to set for the rule (MAX 200 characters)

Returns

Returns true if the rule value was set, false if invalid arguments were specified.

Example

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

setRuleValue ( "myScriptRunning", "yes" )

See Also