plusBASIC Programmer's Reference Old TOC - fvdhoef/aquarius-plus GitHub Wiki

Old table of contents

:warning: denotes functions and statements that require detailed documentation created.

:orange_circle: marks functions and statements that have had stubs created, but requires documentation.

:green_circle: entry migrated to Table of Contents

:x: denotes functions and statements that have not yet been implemented.
PLEASE NOTE THESE HAVE BEEN MOVED TO THE END OF THE LIST

  • :green_circle: ABS() - Return absolute value of expression.
  • AND - Bitwise AND or logical AND operator.
  • :green_circle: APPEND - Append memory or string to a file.
  • ARGS - Get the number of arguments to RUN or GOSUB.
  • ARGS - Pass arguments to RUN or GOSUB.
  • ARGS$() - Get argument string at index.
  • :green_circle: ASC() - Convert string to ASCII code.
  • :green_circle: ASC$() - Convert hex_string to an ASCII string.
  • :green_circle: ATN() - Return arctangent of argument.
  • :warning: BIT - Return status of bit in integer.
  • BYTE() - Convert character in string to signed byte.
  • CALL - Execute machine language routine at address, optionally passing arguments into the associated registers.
  • :green_circle: CD - Change directory, or display current directory.
  • :green_circle: CD$ - Return a string containing the current directory.
  • :green_circle: CHR$() - Convert ASCII value to string.
  • :green_circle: CLEAR - Clear BASIC workspace or array data.
  • :warning: CLEAR BITMAP - Clear bloxel or bitmap screens.
  • :green_circle: CLEAR CURSOR - Temporarily remove cursor from screen.
  • CLOAD and CSAVE - Load, verify or save program or load array data from or to cassette.
  • :orange_circle: CLS - Clear the text screen.
  • COLOR - Set or return default bitmap colors.
  • :green_circle: COMPARE() - Compare numeric arrays or blocks of memory.
  • CONT - Resume program execution after STOP, Ctrl-C/Escape, or error.
  • :green_circle: COPY - Copy text screen to serial printer or memory, or bytes from one block of memory to another.
  • COS() - Return cosine of argument.
  • DATA - Define data for READ statement.
  • :green_circle: DATE$ - Return the current date or date.
  • :green_circle: DATETIME$ - Return the current date and time.
  • :green_circle: DEF ATTRLIST - Create a string list of sprite and/or tile attributes.
  • :warning: DEF FN - Define user-defined function.
  • :green_circle: DEF INTLIST - Create a string list of integers.
  • :green_circle: DEF PALETTELIST - Create a string list of palette numbers.
  • :green_circle: DEF RGBLIST - Create a string list of RGB values.
  • :green_circle: DEF SPRITE - Create a sprite definition.
  • BASIC-DEF-PALETTELIST-Statement**DEF TILELIST** - Create a string list of palatte indexes.
  • :orange_circle: DEF USR and DEF USRINT - Set USR() and user interrupt routine addresses.
  • DIM - Create and allocates one or more arrays.
  • :green_circle: DIR - Display disk directory.
  • END - Terminate program execution.
  • :warning: ERASE - Remove array from memory.
  • :warning: EVAL() - Evaluate expression in string.
  • :green_circle: EXP() - Return argument to the power of mathematical constant e.
  • :green_circle: FILEDIR$() and FILEEXT$() - Extract path or extension from filespec.
  • :warning: FILL BYTE - Fill block of memory with byte.
  • :warning: FILL WORD - Fill block of memory with two-byte integer.
  • :warning: FILL COLORMAP - Fill color map with specified bytes.
  • :warning: FILL SCREEN - Fill screen with character and/or colors.
  • FILL TILEMAP - Fill tilemap with specified tile, attributes and palette.
  • FOR ... TO ... STEP and NEXT - Initiate, iterate, and end a FOR loop.
  • :warning: FRE() - Return amount of unused variable and array or string space (after forcing garage collection).
  • GET SCREEN - Copy text screen to array of string variable.
  • GET TILEMAP - Copy tilemap clip to array or string variable.
  • GETARGS - Parses arguments passed into subroutine.
  • :green_circle: GETKEY and GETKEY$ - Wait for key and return as ASCII code or string.
  • GETPALETTE$ - Return palette content.
  • :orange_circle: GETSPEED - Return turbo mode status.
  • :green_circle: GETSPRITE$ - Return sprite attributes.
  • GETTILE$ - Return tile data.
  • GOSUB and RETURN - Execute subroutine.
  • GOTO - Branch to line or label.
  • HEX$() and DEC() - Convert byte, integer or ASCII string into hexadecimal string or hexadecimal string into integer,
  • IF ... THEN - Branch to line or execute statements if expression evaluates to true.
  • IN() and OUT - Read or write one or more bytes from or to one or more Z80 ports.
  • :warning: INDEX(), INMEM(), and INSTR() - Search for string in array, memory, or string.
  • :green_circle: INKEY and INKEY$ - Return most recently pressed key as integer or string.
  • INPUT - Prompt for keyboard input and assigns entries to variables.
  • :green_circle: INT() - Return expression rounded down to nearest integer.
  • :warning: JOIN - Join strings into a string array.
  • :green_circle: JOY() - Read one or both game controllers.
  • :green_circle: JOY$() - Read X-box controller.
  • KEY() - Check if key is currently pressed.
  • :green_circle: LEFT$() - Return or replace substring.
  • :green_circle: LEN() - Return length of string.
  • LET - Define and assigns value to variable.
  • LIST - Print program lines to screen.
  • :orange_circle: LIST$() - Detokenize program line.
  • :orange_circle: LLIST - Print program lines to printer.
  • LOAD - Load BASIC program, binary file, or array data into memory.
  • :green_circle: LOAD BITMAP - Loads bitmap file into Video RAM.
  • :warning: LOAD CHRSET - Load character RAM from file.
  • :warning: LOAD DIR - Load disk directory into string array.
  • LOAD FNKEYS - Load function key definitions from file.
  • LOAD PALETTE - Load file data ino palette.
  • :warning: LOAD TRACK - Load tracker file into PT player buffer.
  • :warning: LOAD SCREEN - Load text screen, character matrix, or color matrix from file.
  • :warning: LOAD TILEMAP - Loads timemap file into RAM.
  • :green_circle: LOCATE - Move text cursor to specified position.
  • :green_circle: LOG() - Return natural logarithm of argument.
  • :warning: LOOP TRACK - Play specified or previously loaded track repeatedly.
  • :warning: LPOS - Return current column position of printer.
  • :green_circle: MID$() - Return or replace substring.
  • :warning: MKDIR - Create directory.
  • MOUSEX, MOUSEY, MOUSEB, and MOUSEW - Return mouse x-position, y-position, button status, and wheel delta.
  • NEW - Delete program and clears all variables.
  • NEXT - Iterate the next increment for the matching FOR statement.
  • NOT - Bitwise NOT or logical NOT operator.
  • ON GOSUB, ON GOTO, and ON ERROR - Branch to line or subroutine specified by expression or error condition.
  • OR - Bitwise OR or logical OR operator.
  • PAD$() - Return padded string.
  • PAUSE - Halt program execution until key is pressed.
  • :warning: PAUSE TRACK - Pause currently playing track.
  • PEEK(), PEEK$(), and DEEK() - Read byte, string, or word from memory.
  • :orange_circle: PEEKSCREEN(), PEEKSCREEN$(), PEEKCOLOR(), and PEEKCOLOR$() - Read byte or string from screen or color RAM.
  • PLAY TRACK - Play music track.
  • PLAY SAMPLE - Play digitized sound.
  • POKE and DOKE - Write byte, integer, or string to memory.
  • POKE COLOR - Write byte or string to color RAM.
  • POKE SCREEN - Write byte or string to screen RAM.
  • :green_circle: POS() - Return current cursor column.
  • :orange_circle: POSX and POSY - Return last draw position.
  • PSET, PRESET, and POINT - Draw, erase, or return status of bloxel or pixel.
  • PRINT and LPRINT - Print text to screen or printer.
  • :warning: PSG - Write bytes to PSG register
  • :warning: TRACKFAST, TRACKLOOP and TRACKSTATUS - Return track player loop flag and play/pause status.
  • PUT SCREEN - Copy clip from array or string variable to text screen.
  • PUT TILEMAP - Copy clip from array or string variable to tilemap.
  • READ - Read values from data statements into variables.
  • REM - Denotes comment.
  • :warning: RENAME - Rename file or directory
  • :warning: RESET - Set all array elements to 0 or empty string and collect garbage if string array.
  • :warning: RESET PALETTE - Reset palette to default RGB values.
  • :warning: RESET SCREEN - Reset current text screen to default settings.
  • RESTORE - Reset READ/DATA pointer to beginning of program or specified line.
  • RESUME - Clear error condition and continues program execution at specified line
  • RESUME TRACK - Resume playing paused track.
  • :green_circle: RGB() and RGB$() - Return integer or string representing a single palette entry.
  • RIGHT$() - Return or replace substring.
  • :green_circle: RND() - Return new or previous psuedo-random number or seeds the random number generator.
  • RUN - Execute current basic program or load and execute program, cartridge image, or FPGA core.
  • :green_circle: SAVE - Write BASIC program, memory, or array data to file.
  • :green_circle: SAVE BITMAP - Save bitmap screen data from Video RAM to file.
  • :warning: SAVE FNKEYS filespec - Save function key definitions to file.
  • SAVE PALETTE - Save palette contents to file.
  • SAVE SCREEN - Save text screen to file.
  • :warning: SAVE TILEMAP - Save tilemap to file.
  • SCREEN - Set screen mode.
  • :warning: SET CHRDEF and GETCHRDEF() - Redifine character or get character definition.
  • :green_circle: SET COLOR - Enable or disable color printing mode
  • SET FNKEY - Set auto-typed text when function key is pressed.
  • SET KEY - Set alternate keyboard port mode.
  • :green_circle: SET PALETTE - Set palette entries.
  • :warning: SET TRACK - Set track player options.
  • SET SAVE - Enable or disable forced saving of BASIC programs in ASCII format.
  • :orange_circle: SET SPEED and SET FAST - Enable or disables turbo mode.
  • :green_circle: SET SPRITE - Set sprite properties.
  • SET TILE - Write tile definition video RAM.
  • SET TILEMAP and SET TILEMAP OFFSET - Set tilemap cell attributes or scroll tilemap.
  • :orange_circle: SET USRINT -Enable or disable and user interrupt routine addresses.
  • :green_circle: SGN() - Return signum of expression.
  • :green_circle: SIN() - Return sine of argument.
  • :warning: SOUND () - Generate a tone through the television speaker.
  • SPC() - Output a number of space characters.
  • :warning: SPLIT - Split delimited string into string array elements..
  • :green_circle: SQR() - Return square root of argument.
  • :warning: STASH SCREEN, RESTORE SCREEN, and SWAP SCREEN - Copy current text screen to or from or swap with respective screen buffer.
  • STOP - Interrupt program execution.
  • :warning: STOP TRACK - Stop currently playing track.
  • :green_circle: STR$() - Convert floating point number to ASCII string.
  • :green_circle: STRING$() - Create string of repeated character.
  • :warning: STRPTR() - Return address of text for string variable.
  • :warning: SWAP VARS - Swap contents of two variables.
  • TAB() - Moves cursor to a relative position on screen.
  • :green_circle: TAN() - Return tangent of argument in radians.
  • :orange_circle: TILEMAP(), TILEMAPX TILEMAPY, TILEOFFSET, and TILEOFFSET - Return tilemap cell properties, X-offset or Y-offset of tilemap, or first available tile.
  • :green_circle: TIME$ - Return the current time.
  • TIMER - Set and start jiffy timer or return timer count.
  • :green_circle: TRIM$(), TRIML$(), and TRIMR$() - Remove characters from left, right, or both ends of string.
  • :green_circle: TRIMDIR$() and TRIMEXT$() - Remove path or extension from filespec.
  • :warning: TRON and TROFF - Enable or disable line number tracing.
  • USE CHRSET, GETCHRSET, LOAD CHRSET, and SAVE CHRSET - Load character, acivate and query current character set.
  • USR() - Call user-defined machine language routine passing argument and returning result.
  • :green_circle: VAL() - Convert ASCII string to floating point number.
  • :warning: VARPTR() - Return address of variable, array element, or array
  • :warning: VER() and VER$() - Return System or plusBASIC version as integer or printable string.
  • :x: CIRCLE - Not implemented
  • :x: CLOSE - Not implemented
  • :x: DEF USR - Not implemented
  • :x: EDIT - Not implemented
  • :x: FILL BITMAP - Syntax changing soon
  • :x: LINE - Not implemented
  • :x: LINEH - Not implemented
  • :x: LINEV - Not implemented
  • :x: MENU - Not implemented
  • :x: OPEN - Not implemented
  • :x: RESTORE BITMAP|TILEMAP|PALETTE palette{,...} - Not implemented
  • :x: STASH BITMAP|TILEMAP|PALETTE palette{,...} - Not implemented
  • :x: SWAP BITMAP|TILEMAP - Not implemented
  • :x: WRITE - Not implemented