effect <number>,<number>(,<number>(,<character string>))

Assigns an Effect Number to a pack-in effect.
Once you have an Effect Number assigned, you can use it in image display commands
From left to right, the variables are: effect number, pack-in effect index, effect runtime (in milliseconds), pattern image filename.
However, if you are using a pack-in effect, you may omit the last two variables.

As an effect slotted in Effect Number 0 will display immediately with the next image display command, please start your effects at 1.
Or, if you are going to use 0, please remember to call an image display command as soon as you can.

By default, pack-in effect index 1 is not an effect at all, but sets the effect runtime to 0 -- an instantaneous display.

<pack-in effect index>

  1. Instantaneous display. No runtime variable needed.
  2. Left-sided shutter
  3. Right-sided shutter
  4. Upwards shutter
  5. Downwards shutter
  6. Left-sided curtain
  7. Right-sided curtain
  8. Upwards curtain
  9. Downwards curtain
  10. Pixelwise crossfade
  11. Left-sided scroll
  12. Right-sided scroll
  13. Upwards scroll
  14. Downwards scroll
  15. Fade via mask pattern. You must set a filename with this, pointing to a mask bmp (of either 256 colors or full color). In this mask bmp, the white areas fade slowly, and the black areas fade quickly.
  16. Mosaic out. After this effect is called, the state of the screen will be as uncertain as if you used Effect Number 0, so please call a display command, like print, immediately afterwards.
  17. Mosaic in
  18. Crossfade via mask. This works similarly to 15, except it is far more processor intensive, so do use this effect with care.
    effect 1,1
    effect 2,4,1000
    effect 3,15,2000,"m3.bmp"