SetRuleValue: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Fernando187 (talk | contribs) m (added MAX 200 characters according to ASE.h constants) |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | |||
{{Server function}} | |||
This function sets a rule value that can be viewed by server browsers. | |||
This function | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool setRuleValue ( string key, string value ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===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=== | ||
Returns ''true'' if | Returns ''true'' if the rule value was set, ''false'' if invalid arguments were specified. | ||
==Example== | ==Example== | ||
This example | This example shows how you could set a rule that shows that your script is running on the server. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
setRuleValue ( "myScriptRunning", "yes" ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{ | {{Announce functions}} | ||
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