YAMF Library Documentation
"Yet Another Mouse Follower"

Function Description
YAMF This function will display a series of images on the browser display and animate them with the mouse movement in several ways, depending on passed argument settings.

function YAMF(String[, Options])                     
Parameters:
String

an arbitrary text string representing separate images to be display
Options Optional. Can be used to specify:

Type   banner | overlap | off
banner displays images side-by-side. Default
overlap displays images on top of each other
off turns off display images and resets all Options to their default values
Effect   dither | blink | marquee | pinwheel | rotate | lockstep
dither moves the images in a dithered fashion with the mouse cursor position based on the Justify setting. Default
blink moves the images in lockstep fashion with the mouse cursor position based on the Justify setting and makes them alternately visible and hidden
marquee moves the images in lockstep fashion with the mouse cursor position based on the Justify setting and scrolls them based on the Direction setting. The Message will continuously scroll within a 25 character display with a padding of 25 blanks (spaces) at the end
pinwheel rotates the images in a dithered fashion with the mouse cursor position based on the Justify setting and the rotation based on the Direction setting
rotate rotates the images in lockstep fashion with the mouse cursor position based on the Justify setting and the rotation based on the Direction
lockstep moves the images in a lockstep fashion with the mouse cursor position based on the Justify setting
Justify   left | center | right
left positions mouse cursor at the left-most image. Default
center positions mouse cursor at the center-most image
right positions mouse cursor at the right-most image
Direction   left | right
left for image motion effects, moves the images from left-to-right. Default
right for image motion effects, moves the images from right-to-left
View   visible | hidden
visible makes the images visible. Default
hidden makes the images invisible
Angle   0.0
  a decimal angular (degrees) value specifying the angle of the banner with 0.0 degrees being the horizontal right vector and increasing values rotating the banner in a clockwise direction. Default is 0.0
Rate   50
  an positive integer (milliseconds) value specifying the amount of delay between image position updates. Default is 50
Scale   1.0
  a decimal value specifying a scale factor to be applied to the true image dimensions to either increase of decrease their real size. Default is 1.0
XGapAdj   0
  an positive integer (pixels) value specifying the amount of extra pixels to add between images X direction. This can be used to provide extra spacing between images. Default is 0
YGapAdj   0
  an positive integer (pixels) value specifying the amount of extra pixels to add between images X direction. This can be used to provide extra spacing between images. Default is 0
IPath   images/
  the pathname (directory) specifying where the images are located. Default is images/
IPrefix   yamf
  the name value specifying the prefix portion of the images' filenames. Default is yamf
IExt   gif | jpg | jpeg | png
  the extension value specifying the image files filetype. Default is gif
Reverse   false | true
false displays the images in the order of the Message string characters. Default
true displays the images in the reverse order of the Message string characters
angAware   true | false
true automatically reverses the display order of the Message string characters when the Angle setting is between 90 and 270 degrees. Default
false ignores the Angle setting and displays the images in the order based solely on the Reverse setting
Examples: yamfReturn = YAMF("Hello World!","effect=marquee angle=30.0");     yields:
displays the images representing the "Hello World!" characters in a marquee fashion at an angle of 30.0 degrees.
  yamfReturn = YAMF("","effect=lockstep");     yields:
changes the existing images, "Hello World!", from a marquee effect to a lockstep effect and the angle remains at 30 degrees.
Formatting:
•  All characters in Message are case insensitive
•  All characters in Message that do not have a corresponding image file are culled (stripped) from the Message string and ignored
•  Name-Value pairs in Options are case insensitive
•  Name-Value pairs in Options are not order dependent
•  Unrecognized Name-Value pairs in Options are ignored
•  All non-keyboard characters are converted to blanks (spaces)
•  Calling YAMF with a null Message and with valid Options will immediately change the display that is currently in effect based on the Options specified and leaving all other Options unchanged
Return Value:
true  if all images were loaded successfully
false  if all images were not loaded successfully or if no values were passed on the call, e.g., yamfReturn = YAMF()
Calls:None
References:None
Compatiblity:Netscape 4+ , Internet Explorer 4+
Author:Pat Thompson
Last Modified:July 28, 2001
Copyright © 2001-2003, ProjectIt, All Rights Reserved Last Revised: