SNAPLIMD parameter: Difference between revisions

From m204wiki
Jump to navigation Jump to search
Line 14: Line 14:
</dl>
</dl>
==Description==
==Description==
This parameter limits the number of snaps which can be issued with any given snap title.  That is, it prevents some bug from using up the snaps available as specified by the <var>SNAPLIM</var> parameter. The minimum value of <var>SNAPLIMD</var> is 0, which indicates that there is no limit (other than <var>SNAPLIM</var>, of course) to the number of snaps for any given snap title, and the maximum value is 32767.
This parameter limits the number of snaps which can be issued with any given snap title.  That is, it prevents some bug from using up the snaps available as specified by the <var>SNAPLIM</var> parameter. The minimum value of <var>SNAPLIMD</var> is 0, which indicates that there is no limit (other than <var>SNAPLIM</var>, of course) to the number of snaps for any given snap title, and the maximum value is 32767. The default value is 3.
 
The <code>*SNAP</code> snap title is not subject to <var>SNAPLIMD</var>, thus:
<ul>
<ul>
<li>When the <var>*SNAP</var> command is issued, each snap thus created is considered unique, and will not be suppressed due to <var>SNAPLIMD</var>.
<li>The <code>*SNAP</code> snap title is not subject to <var>SNAPLIMD</var>, thus, whenever either
the <var>*SNAP</var> or <var>[[SIRIUS command#SNAPLMOD|SIRIUS SNAPLMOD]]</var>
command is issued, each snap thus created is considered unique, and will not be suppressed due to <var>SNAPLIMD</var>.
<li>When the <var>BUMPSNAP</var> command is issued, each snap thus created is considered unique, and will not be suppressed due to <var>SNAPLIMD</var>.
<li>When the <var>BUMPSNAP</var> command is issued, each snap thus created is considered unique, and will not be suppressed due to <var>SNAPLIMD</var>.
</ul>
</ul>
 
Note that
Note that
<ul>
<ul>
<li>When a snap is suppressed due to exceeding the <var>SNAPLIM</var> parameter, the <var>SNAPID</var> parameter is incremented.
<li>When the value of <var>SNAPLIMD</var> is greater than 0, the overall count of snaps (that is, the
<li>If that is not the case (that is, if the <var>SNAPLIM</var> parameter is less than the <var>SNAPID</var> parameter), if there have already been at least as many snaps <b>actually produced</b> for the given snap title as the value of the <var>SNAPLIMD</var> parameter:
value of the <var>SNAPID</var> parameter) and the count for
<ul>
each snap title reflect snaps that were <b>actually produced</b>; snaps which are suppressed either due to <var>SNAPLIM</var>
<li>The snap is suppressed and the <var>SNAPID</var> parameter is <b>not</b> incremented (otherwise, the purpose of <var>SNAPLIMD</var> would be circumvented).
or <var>SNAPLIMD</var> do not increment those counts.
One useful consequence of this is that, as long as <var>SNAPLIMD</var> had not been zero whenever any snaps occurred,
you can be sure that <var>SNAPID</var> will always be less than or equal to the value of <var>SNAPLIM</var>, and so, to
allow an additional snap after <var>SNAPLIM</var> has been reached, you can simply:
<p class="code">RESET SNAPLIM 1+</p>
<li>When the value of <var>SNAPLIMD</var> is 0, the value of the <var>SNAPID</var> parameter is incremented for each snap
which is produced or which is suppressed, but the count for each
each snap title reflects snaps that were actually produced.
<li>If <var>SNAPLIMD</var> is (and has always been) greater than 0 (and so is used to limit duplicate snaps),
to capture additional snaps for those which have already reached the value of <var>SNAPLIMD</var>, you can increase its value, for example:
<p class="code">RESET SNAPLIMD 3+</p>
In order to capture these additional snaps, of course, you may also need to increase the value of the <var>SNAPLIM</var> parameter.
<li>The <var>RESET</var> examples above
use the feature described in [[Relative values for Model 204 numeric parameters|"Relative values for Model 204 numeric parameters"]].
</ul>
</ul>
</ul>
To suppress the action due to <var>SNAPLIMD</var>, set it to 0.  Note that when it is 0 it does not prevent snaps from occurring, but it still counts snaps for each snap title, so if you subsequently change it to a positive value, the next snap for any given snap title will be suppressed if the number of occurrences of that snap had already been as large as the new <var>SNAPLIMD</var>.
To capture additional snaps for those which have already reached the value of <var>SNAPLIMD</var>, you can increase its value, for example:
<p class="code">RESET SNAPLIMD 3+</p>
Note:
<ul>
<li>In order to capture these additional snaps, of course, you may also need to increase the value of the <var>SNAPLIM</var> parameter, so that it is less than the value of the <var>SNAPID</var> parameter.
<li>This example uses the feature described in [[Relative values for Model 204 numeric parameters|"Relative values for Model 204 numeric parameters"]].
[[Category:System parameters]]
[[Category:System parameters]]
[[Category:Parameters]]
[[Category:Parameters]]

Revision as of 16:53, 20 September 2012

0 or max number of occurrences of any particular snap

Summary

Default value
3
Parameter type
System
Where set
System manager resettable
Related products
All
Introduced
Sirius Mods 8.1 (and by zap in 8.0)

Description

This parameter limits the number of snaps which can be issued with any given snap title. That is, it prevents some bug from using up the snaps available as specified by the SNAPLIM parameter. The minimum value of SNAPLIMD is 0, which indicates that there is no limit (other than SNAPLIM, of course) to the number of snaps for any given snap title, and the maximum value is 32767. The default value is 3.

  • The *SNAP snap title is not subject to SNAPLIMD, thus, whenever either the *SNAP or SIRIUS SNAPLMOD command is issued, each snap thus created is considered unique, and will not be suppressed due to SNAPLIMD.
  • When the BUMPSNAP command is issued, each snap thus created is considered unique, and will not be suppressed due to SNAPLIMD.

Note that

  • When the value of SNAPLIMD is greater than 0, the overall count of snaps (that is, the value of the SNAPID parameter) and the count for each snap title reflect snaps that were actually produced; snaps which are suppressed either due to SNAPLIM or SNAPLIMD do not increment those counts. One useful consequence of this is that, as long as SNAPLIMD had not been zero whenever any snaps occurred, you can be sure that SNAPID will always be less than or equal to the value of SNAPLIM, and so, to allow an additional snap after SNAPLIM has been reached, you can simply:

    RESET SNAPLIM 1+

  • When the value of SNAPLIMD is 0, the value of the SNAPID parameter is incremented for each snap which is produced or which is suppressed, but the count for each each snap title reflects snaps that were actually produced.
  • If SNAPLIMD is (and has always been) greater than 0 (and so is used to limit duplicate snaps), to capture additional snaps for those which have already reached the value of SNAPLIMD, you can increase its value, for example:

    RESET SNAPLIMD 3+

    In order to capture these additional snaps, of course, you may also need to increase the value of the SNAPLIM parameter.

  • The RESET examples above use the feature described in "Relative values for Model 204 numeric parameters".
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=SNAPLIMD_parameter&oldid=51880"