SNAPLIMD parameter: Difference between revisions
Jump to navigation
Jump to search
m (→Description) |
m (→Description) |
||
| Line 15: | Line 15: | ||
==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. The default value is 3. | 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. | ||
===Usage notes=== | |||
<ul> | <ul> | ||
<li>The <code>*SNAP</code> snap title is not subject to <var>SNAPLIMD</var>, thus, whenever either | <li>The <code>*SNAP</code> snap title is not subject to <var>SNAPLIMD</var>, thus, whenever either | ||
| Line 21: | Line 21: | ||
command is issued, each snap thus created is considered unique, and will not be suppressed due to <var>SNAPLIMD</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>. | ||
<li>When the value of <var>SNAPLIMD</var> is greater than 0, the overall count of snaps (that is, the | <li>When the value of <var>SNAPLIMD</var> is greater than 0, the overall count of snaps (that is, the | ||
value of the <var>SNAPID</var> parameter) and the count for | value of the <var>SNAPID</var> parameter) and the count for | ||
each snap title reflect snaps that were <b>actually produced</b>; snaps which are suppressed either due to <var>SNAPLIM</var> | each snap title reflect snaps that were <b>actually produced</b>; snaps which are suppressed either due to <var>SNAPLIM</var> | ||
or <var>SNAPLIMD</var> do not increment those counts. | or <var>SNAPLIMD</var> do not increment those counts. | ||
<p> | |||
One useful consequence of this is that, as long as <var>SNAPLIMD</var> had not been zero whenever any snaps occurred, | 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 | 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: | allow an additional snap after <var>SNAPLIM</var> has been reached, you can simply: | ||
</p> | |||
<p class="code">RESET SNAPLIM 1+</p> | <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 | <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 | which is produced or which is suppressed, but the count for each | ||
each snap title reflects snaps that were actually produced. | each snap title reflects only 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), | <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: | to capture additional snaps for those which have already reached the value of <var>SNAPLIMD</var>, you can increase its value, for example: | ||
| Line 43: | Line 40: | ||
<li>The <var>RESET</var> examples above | <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"]]. | use the feature described in [[Relative values for Model 204 numeric parameters|"Relative values for Model 204 numeric parameters"]]. | ||
<li>The table of snap titles used by the <var>SNAPLIMD</var> parameter can be viewed or re-initialized using the | |||
<var>[[SNAPLIMD command|SNAPLIMD]]</var> command. | |||
</ul> | </ul> | ||
[[Category:System parameters]] | [[Category:System parameters]] | ||
[[Category:Parameters]] | [[Category:Parameters]] | ||
Revision as of 17:34, 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.
Usage notes
- The
*SNAPsnap 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.
- 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 only 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".
- The table of snap titles used by the SNAPLIMD parameter can be viewed or re-initialized using the SNAPLIMD command.