**********
ANIMATIONS AND ANIMATION SPEED [KEEN]
**********

This document outlines several animation related properties of sprites. They are:

1.) Left/right sprites used: This is simply the animation used by the sprite when
it is facing left or right. ALL sprites have these two values, even if both are
the same. (Sometimes it depends whether the sprite is left or right of Keen say.)
There are two 'special' values; the first, '$0000W' is used when the animation
is not meant to change the sprite's animation; items for example use this; their
animations are preprogrammed and don't need to be changed. The second is '$FFFFW'
and is used when a sprite must become invisible for a moment, it erases the animation
being used, but not the sprite. The Q.E.D is invisible, but not nothing.

The sprite used when going left is listed first, then the one for going right. In some
cases these are the same, in others, different. Feel free to experiment. (Remember, left
sprite is on the left, right sprite is on the right.) Both values are as 'words';
$3C $00 = $003CW, but you can write them however you like.

The number USED in each patch is the sprite number plus 102, in hex. This can get a
bit confusing when you want to change them, but you'll soon get the hang of it, or
learn to do it by trial and error.

2.) Animation speed: Simply enough, this is how long a sprite takes to animate 1-FRAME
it is how long an animation is held for. There is a special value; '$0000W' which means
'never change' (Used often by shot or waiting sprites.) Note that some animation speeds
are 'reaction times' For example, Keen standing has a reaction time of $0004, that is, if
you press a key, it takes him that long to respond (Stop animating as standing Keen.) This
can be useful if you want to change gameplay a bit.

There is also a list of sprite caches; never make a sprite use a sprite frame not cached by
itself or another sprite in the level! (See '7.) Cache') Keen's aniamtions, for conveience
are stored in the next section.





###
#Map Keen
###

%patch $316BA $FFFFW $FFFFW #Standing (Clear animation)
%patch $316C4 $0006W        #Reaction speed

%patch $316D8 $0000W $0000W #Wait (Hold animation)
%patch $316E2 $0168W        #Pause before waving
%patch $316F6 $010AW $010AW #Wave
%patch $31700 $0014W        #Animation speed
%patch $31714 $010BW $010BW #Wave
%patch $3171E $0014W        #Animation speed
%patch $31732 $010AW $010AW #Wave
%patch $3173C $0014W        #Animation speed
%patch $31750 $010BW $010BW #Wave
%patch $3175A $0014W        #Animation speed
%patch $3176E $010AW $010AW #Wave
%patch $31778 $0014W        #Animation speed

%patch $3178C $0000W $0000W #Moving (Hold animation)
%patch $31796 $0004W        #Reaction speed

%patch $317CA $0113W $0113W #Keen K flag waving
%patch $317D4 $000AW        #Animation speed
%patch $317E8 $0114W $0114W #Keen K flag waving
%patch $317F2 $000AW        #Animation speed
%patch $31806 $0115W $0115W #Keen K flag waving
%patch $31810 $000AW        #Animation speed
%patch $31824 $0116W $0116W #Keen K flag waving
%patch $3182E $000AW        #Animation speed



###
#Normal Keen
###


%patch $30BC8 $0074W $006CW #Keen standing
%patch $30BD2 $0004W        #Reaction speed

%patch $30BE6 $008BW $008BW #Keen on platforms
%patch $30BF0 $0004W        #Reaction speed

#Keen shrug-blink
%patch $30C04 $007CW $007CW #Look up
%patch $30C0E $003CW        #Animation speed
%patch $30C22 $007EW $007EW #Face player
%patch $30C2C $005AW        #Animation speed
%patch $30C40 $007DW $007DW #Blink
%patch $30C4A $000AW        #Animation speed
%patch $30C5E $007EW $007EW #Face player
%patch $30C68 $005AW        #Animation speed
%patch $30C7C $007DW $007DW #Blink 2
%patch $30C86 $000AW        #Animation speed
%patch $30C9A $007EW $007EW #Face player
%patch $30CA4 $005AW        #Animation speed
%patch $30CB8 $007FW $007FW #Shrug
%patch $30CC2 $0046W        #Animation speed

#Reading
%patch $30CD6 $0080W $0080W #Start reading
%patch $30CE0 $0010W        #Animation speed
%patch $30CF4 $0081W $0081W #Start reading
%patch $30CFE $0010W        #Animation speed
%patch $30D12 $0082W $0082W #Start reading
%patch $30D1C $0010W        #Animation speed
%patch $30D30 $0083W $0083W #Start reading
%patch $30D3A $0010W        #Animation speed

%patch $30D4E $0084W $0084W #Read
%patch $30D58 $012CW        #Animation speed
%patch $30D6C $0085W $0085W #Read
%patch $30D76 $0010W        #Animation speed
%patch $30D8A $0086W $0086W #Read
%patch $30D94 $0010W        #Animation speed

%patch $30DA8 $0087W $0087W #Stop reading
%patch $30DB2 $000CW        #Animation speed
%patch $30DC6 $0088W $0088W #Stop reading
%patch $30DD0 $000CW        #Animation speed
%patch $30DE4 $0081W $0081W #Stop reading
%patch $30DEE $000CW        #Animation speed

#Look up
%patch $30E02 $007CW $007CW #Look up
%patch $30E0C $001EW        #Pause before screen moves
%patch $30E20 $007CW $007CW #Look up
%patch $30E2A $0000W        #Animation speed

#Look down
%patch $30E3E $0089W $0089W #Look down
%patch $30E48 $0006W        #Pause before ducking
%patch $30E5C $008AW $008AW #Look down-duck
%patch $30E66 $0018W        #Pause before screen moves
%patch $30E7A $008AW $008AW #Look down-duck
%patch $30E84 $0000W        #Wait for keypress
%patch $30E98 $0089W $0089W #Look down
%patch $30EA2 $0006W        #Pause before 'un-ducking'
%patch $30EB6 $0089W $0089W #Look down
%patch $30EC0 $0000W        #Wait
%patch $30ED4 $FFFFW $FFFFW #Stop looking down (odd)
%patch $30EDE $000AW        #Reaction speed

#Dead
%patch $30EF2 $008CW $008CW #Sprawled
%patch $30EFC $0064W        #Animation speed
%patch $30F10 $008DW $008DW #Clutched
%patch $30F1A $0064W        #Animation speed

#Shoot l/r
%patch $30F2E $0092W $0097W #Shoot l/r
%patch $30F38 $0009W        #Pause before shot
%patch $30F4C $0092W $0097W #Shoot l/r
%patch $30F56 $0006W        #Pause before stop shooting

#Shoot up
%patch $30F6A $0096W $0096W #Shoot up
%patch $30F74 $0009W        #Pause before shot
%patch $30F88 $0096W $0096W #Shoot up
%patch $30F92 $0006W        #Pause before stop shooting

#Flicking switches
%patch $30FA6 $00AFW $00AFW #Face away from player
%patch $30FB0 $0008W        #Pause before switch flipped
%patch $30FC4 $00AFW $00AFW #Face away from player
%patch $30FCE $0008W        #Pause before return to standing

#Placing gem
%patch $30FE2 $00AFW $00AFW #Face away from player
%patch $30FEC $0006W        #Pause before door starts to open
%patch $31000 $00AFW $00AFW #Face away from player
%patch $3100A $0000W        #Wait until door opens

#Entering doors
%patch $3101E $00AFW $00AFW #Enter doors
%patch $31028 $002DW        #Pause before entering door
%patch $3103C $007EW $007EW #Enter doors
%patch $31046 $0000W        #Animation speed
%patch $3105A $00AFW $00AFW #Enter doors
%patch $31064 $0009W        #Animation speed
%patch $31078 $00B0W $00B0W #Enter doors
%patch $31082 $0009W        #Animation speed
%patch $31096 $00B1W $00B1W #Enter doors
%patch $310A0 $0009W        #Animation speed
%patch $310B4 $00B2W $00B2W #Enter doors
%patch $310BE $0009W        #Animation speed
%patch $310D2 $00B3W $00B3W #Enter doors
%patch $310DC $0009W        #Animation speed
%patch $310F0 $FFFFW $FFFFW #Vanish (Reappear at door exit)
%patch $310FA $0009W        #Pause before reappearance

#Sit on pole
%patch $3110E $00A6W $009FW #Sit on pole
%patch $31118 $0000W        #Wait for Keypress

#Go up pole
%patch $3112C $00A6W $009FW #Go up pole
%patch $31136 $0008W        #Animation speed
%patch $3114A $00A7W $00A0W #Go up pole
%patch $31154 $0008W        #Animation speed
%patch $31168 $00A8W $00A1W #Go up pole
%patch $31172 $0008W        #Animation speed

#Go down pole
%patch $31186 $00A2W $00A2W #Go down pole
%patch $31190 $0008W        #Animation speed
%patch $311A4 $00A3W $00A3W #Go down pole
%patch $311AE $0008W        #Animation speed
%patch $311C2 $00A4W $00A4W #Go down pole
%patch $311CC $0008W        #Animation speed
%patch $311E0 $00A5W $00A5W #Go down pole
%patch $311EA $0008W        #Animation speed

#Pole shoot l/r
%patch $311FE $00ADW $00AEW #Pole shoot l/r
%patch $31208 $0009W        #Pause before shot
%patch $3121C $00ADW $00AEW #Pole shoot l/r
%patch $31226 $0006W        #Pause before stop shooting

#Pole shoot up
%patch $3123A $00A9W $00AAW #Pole shoot up
%patch $31244 $0009W        #Pause before shot
%patch $31258 $00A9W $00AAW #Pole shoot up
%patch $31262 $0006W        #Pause before stop shooting

#Pole shoot down
%patch $31276 $00ACW $00ABW #Pole shoot down
%patch $31280 $0009W        #Pause before shot
%patch $31294 $00ACW $00ABW #Pole shoot down
%patch $3129E $0006W        #Pause before stop shooting

#Walking
%patch $312B2 $0075W $006DW #Walking
%patch $312BC $0006W        #Animation speed
%patch $312D0 $0076W $006EW #Walking
%patch $312DA $0006W        #Animation speed
%patch $312EE $0077W $006FW #Walking
%patch $312F8 $0006W        #Animation speed
%patch $3130C $0078W $0070W #Walking
%patch $31316 $0006W        #Animation speed

#Pogoing
%patch $3132A $00C1W $00BFW #Start pogo
%patch $31334 $0001W        #Bounce speed
%patch $31348 $00C1W $00BFW #Pogoing
%patch $31352 $0000W        #Wait
%patch $31366 $00C0W $00BEW #Pogoing
%patch $31370 $0000W        #Wait

#Jump/fall
%patch $31384 $0079W $0071W #Jumping
%patch $3138E $0000W        #Wait till top of jump
%patch $313A2 $007AW $0072W #Jump/fall
%patch $313AC $0000W        #Wait to fall
%patch $313C0 $007BW $0073W #fall
%patch $313CA $0032W        #Animation speed
%patch $313DE $007AW $0072W #fall
%patch $313E8 $0028W        #Animation speed

#Shoot l/r in air
%patch $313FC $0093W $0098W #Shoot l/r in air
%patch $31406 $0009W        #Pause before shot
%patch $3141A $0093W $0098W #Shoot l/r in air
%patch $31424 $0001W        #Pause before stop shooting
%patch $31438 $0093W $0098W #Shoot l/r in air
%patch $31442 $0006W        #Pause before keep falling

#Shoot up in air
%patch $31456 $0095W $0095W #Shoot up in air
%patch $31460 $0009W        #Pause before shot
%patch $31474 $0095W $0095W #Shoot up in air
%patch $3147E $0001W        #Pause before stop shooting
%patch $31492 $0095W $0095W #Shoot up in air
%patch $3149C $0006W        #Pause before keep falling

#Shoot d in air
%patch $314B0 $0094W $0094W #Shoot d in air
%patch $314BA $0009W        #Pause before shot
%patch $314CE $0094W $0094W #Shoot d in air
%patch $314D8 $0001W        #Pause before stop shooting
%patch $314EC $0094W $0094W #Shoot d in air
%patch $314F6 $0006W        #Pause before keep falling

#Ledgegripping
%patch $3150A $00B4W $00B5W #Ledgegripping
%patch $31514 $000CW        #Pause to grab ledge
%patch $31528 $00B4W $00B5W #Ledgegripping
%patch $31532 $0000W        #Wait for keypress
%patch $31546 $00B6W $00BAW #Keen pulls himself up from ledgegripping
%patch $31550 $000AW        #Animation speed
%patch $31564 $00B7W $00BBW #Keen pulls himself up from ledgegripping
%patch $3156E $000AW        #Animation speed
%patch $31582 $00B8W $00BCW #Keen pulls himself up from ledgegripping
%patch $3158C $000AW        #Animation speed
%patch $315A0 $00B9W $00BDW #Keen pulls himself up from ledgegripping
%patch $315AA $000AW        #Animation speed
%patch $315BE $0074W $006CW #Keen pulls himself up from ledgegripping
%patch $315C8 $0006W        #Animation speed

#Keen's shot
%patch $31842 $0099W $0099W #Keen's shot
%patch $3184C $0006W        #Animation speed
%patch $31860 $009AW $009AW #Keen's shot
%patch $3186A $0006W        #Animation speed
%patch $3187E $009BW $009BW #Keen's shot
%patch $31888 $0006W        #Animation speed
%patch $3189C $009CW $009CW #Keen's shot
%patch $318A6 $0006W        #Animation speed

#Keen's shot smash
%patch $318BA $009DW $009DW #Keen's shot smash
%patch $318C4 $000CW        #Animation speed
%patch $318D8 $009EW $009EW #Keen's shot smash
%patch $318E2 $000CW        #Animation speed

#Open doors
%patch $318F6 $0000W $0000W #No animation
%patch $31900 $000AW        #Open speed
%patch $31914 $0000W $0000W #No animation
%patch $3191E $000AW        #Open speed
%patch $31932 $0000W $0000W #No animation
%patch $3193C $000AW        #Open speed