$IncStat: Difference between revisions
(Automatically generated page update) |
No edit summary |
||
| Line 13: | Line 13: | ||
==Syntax== | ==Syntax== | ||
<p class="syntax">%value = <span class="literal">$IncStat</span>(<span class="term">stat_num, value) | <p class="syntax"><span class="term">%value</span> = <span class="literal">$IncStat</span>(<span class="term">stat_num</span>, [<span class="term">value</span>]) | ||
</p> | </p> | ||
<p> | <p> | ||
< | <var class="term">%value</var> is set to either 0 or to the <var class="term">value</var> argument.</p> | ||
< | |||
==Example== | |||
<p class="code"> % | The code fragment | ||
<p class="code">%value = $IncStat(2) | |||
</p> | </p> | ||
| Line 30: | Line 31: | ||
<li>[[SirMon]] | <li>[[SirMon]] | ||
</ul> | </ul> | ||
[[Category:$Functions|$IncStat]] | [[Category:$Functions|$IncStat]] | ||
Revision as of 23:18, 12 April 2013
Increment local system statistic
Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $IncStat function.
This function allows a user to increment the current value of a local system statistic. There are 10 local system statistics that can be incremented with $IncStat. These stats can be examined via $SyStat under the names LOCAL0 through LOCAL9.
The $IncStat function accepts two arguments and returns either the new value of the appropriate local statistic or a 0 if there is an error.
The first argument is a number that indicates the local stat number to be incremented. This number must be 0 through 9. Otherwise, the $IncStat performs no action and returns a 0.
The second argument is a number that indicates the value that will be added to the local stat. This is an optional argument and defaults to 1.
Syntax
%value = $IncStat(stat_num, [value])
%value is set to either 0 or to the value argument.
Example
The code fragment
%value = $IncStat(2)
adds 1 to local stat number 2.