Home
CBM
  ASCII-X
  BASIC
    Disk Commands
    Enter RUN mode
    Program Format
    Secret Variables
    Variable Format
    Expressions
    Keywords
      (divide)
      (equal)
      (less)
      (minus)
      (more)
      (multiply)
      (plus)
      (power)
      Abs
      And
      Append
      Asc
      Atn
      Auto
      Backup
      Bank
      Begin
      Bend
      Bload
      Boot
      Box
      Bsave
      Bump
      Catalog
      Char
      Chr
      Circle
      Close
      Clr
      Cmd
      Collect
      Collision
      Color
      Concat
      Cont
      Copy
      Cos
      Data
      Dclear
      Dclose
      Dec
      Def
      Delete
      Dim
      Directory
      Dispose
      Dload
      Do
      Dopen
      Draw
      Ds
      Ds string
      Dsave
      Dverify
      El
      Else
      End
      Envelope
      Er
      Err
      Exit
      Exp
      Fast
      Fetch
      Filter
      Fn
      For
      Fre
      Get
      Get num
      Getkey
      Go
      Gosub
      Goto
      Graphic
      Gshape
      Header
      Help
      Hex
      If
      Input
      Input num
      Instr
      Int
      Joy
      Key
      Left
      Len
      Let
      List
      Load
      Locate
      Log
      Loop
      Mid
      Monitor
      Movspr
      New
      Next
      Not
      Off
      On
      Open
      Or
      Paint
      Peek
      Pen
      Pi
      Play
      Pointer
      Poke
      Pos
      Pot
      Print
      Print num
      Pudef
      Quit
      Rclr
      Rdot
      Read
      Record
      Rem
      Rename
      Renumber
      Restore
      Resume
      Return
      Rgr
      Right
      Rlum
      Rnd
      Rreg
      Rspcolor
      Rsppos
      Rsprite
      Run
      Rwindow
      Save
      Scale
      Scnclr
      Scratch
      Sgn
      Sin
      Sleep
      Slow
      Sound
      Spc
      Sprcolor
      Sprdef
      Sprite
      Sprsav
      Sqr
      Sshape
      St
      Stash
      Step
      Stop
      Str
      Swap
      Sys
      Tab
      Tan
      Tempo
      Then
      Ti
      Ti string
      To
      Trap
      Troff
      Tron
      Until
      Using
      Usr
      Val
      Verify
      Vol
      Wait
      While
      Width
      Window
      Xor
    Syntax
    Tokens
  C128
  D64plus
  Disk
  Escape Codes
  Hardware
  PCxface
  PETSCII
  Pet2asc
Futurama
IBM PC-AT
Contact
Games
Glossary
Hall of fame
Hall of shame
Miscellaneous
Privacy policy
Programming
Twisty puzzles
KeywordAbbreviationToken (hex)Version(s)Classification
JOYJ{Shift+O}CF3.5,7.0Function
RECORDRE{Shift+C}CF4.xCommand and Statement

 Syntax 
JOY gamePort )
 
ParametersTypeLegal Value(s)Note(s)
gamePortNumeric
1 or 2
 
ReturnsTypeValue(s)Note(s)
joyFlagsInteger
0 ~ 8 (direction)
+128 (fire button)
 
 Purpose 
Return a value indicating the state of a joystick.
 
 Remarks 
The JOY function is used for "commuicating" with a joystick.  Similar to the screen and keyboard in that the direction is one-way and you don't need to OPEN a "file" to communicate.  Unlike the screen and keyboard, you can't open a file to a joystick.  By the way, the JOY function is for reading a digital joystick, which are almost always used with Commodore computers.  For example the Commodore 1311 Joystick.  I hear these are terrible.  Fortunately many other joysticks were made.  Those for Atari 2600 also work on Commodores.  Well except for the TED series; for them, look at the Commodore 1341 Joystick.
 
The parameter gamePort selects which of two possible physical connectors on the computer should be read for a joystick value.  On the TED series and the C128 (the only released machines supporting JOY), most of the lines used by the gamePort are also used by the keyboard.  So pressing keys on the keyboard may generate false JOY values and, likewise, moving the joystick or pressing some of its buttons may interfere with reading the keyboard (GET/INPUT).  The computer has no way to know if a joystick is actually connected.  Some devices that can plug into the game port, like a mouse, paddles, and light pen may trigger some values which can be "detected" by JOY, but the meaning of these other devices has nothing to do with real joystick values described below.
 
The value returned, joyFlags consists of a low-order 4 bits which holds a direction (described below), and bit 7 (value 128) is set when the "fire" button is pressed.  Some joysticks (or other "game controllers") may have multiple buttons.  They may all trigger the "fire" button read by JOY, or only some of them.  It wouldn't be very useful joystick if none of them worked.
 
The direction is zero if the joystick is cenetered.  Otherwise, the direction is similar to the polar coordinates used in bitmap graphics and MOVSPR: the angle is measured clockwise starting from the "12 o'clock" (north) position.  While the polar coordinates use degrees, a relatively common unit of angular measurement that ranges from 0 to 359, the JOY direction ranges from 1 to 8.  So you'll need to do a little math if you want to convert back and forth.  To spare you the math, here is a simple table.
 
joyFlagsdirectionBASIC angleDescription
00n/aCentered
11Up
2245°Up + Right
3390°Right
44135°Down + Right
55180°Down
66225°Down + Left
77270°Left
88315°Up + Left
1280n/aButton + Centered
1291Button + Up
130245°Button + Up + Right
131390°Button + Right
1324135°Button + Down + Right
1335180°Button + Down
1346225°Button + Down + Left
1357270°Button + Left
1368315°Button + Up + Left
 
You can extract the direction from the joyFlags with the BASIC expression JOY(gamePort) AND 15.  You can extract the state of the "fire" button with JOY(gamePort) AND 128.  Once you have the direction you can convert it to a BASIC graphic angle with the expression A = ( direction - 1 ) * 45.  If the result (A) is less than zero then no direction was pressed at all.
 
If gamePort is omitted or is not a valid expression, SYNTAX ERROR occurs.  If gamePort is a string, TYPE MISMATCH ERROR occurs; you can use VAL to make a string numeric.  Otherwise the gamePort is converted with INT.  If the result is neither 1 or 2 then ILLEGAL QUANTITY ERROR occurs.
 
Examples:
PRINT JOY(1)
 128                  button is pressed, but stick is centered

READY.
PRINT JOY("1") 

?TYPE MISMATCH ERROR 
READY.
 
 Compare With 
 
 Contrast With 
 
 See Also 

© H2Obsession, 2014