home *** CD-ROM | disk | FTP | other *** search
- !Help file for NewsFlash script file compiler
- =============================================
-
- Compiler Commands
- -----------------
-
- Command: Description:
-
- Output commands:
-
- - CLS Clear the screen
- - PRINT <exp> Output to the screen (no new line
- sent)
- - FG <exp> Set foreground colour
- - BFG <exp> Set bold foreground colour
- - BG <exp> Set background colour
- - BOLD Set bold foreground
- - FLASH Set flashing foreground
- - STD Set standard cols (white on black)
- - NL Send a newline
- - CLL Clear line
- - LOCATE <x>,<y> Set cursor xy coords
- - TAB <x> Set cursor x coord on current line
- - ATTR <fg>,<bg> Set colour attributes
- - BATTR <fg>,<bg> Set colour attributes with bold
- - STARTMORE Mark the start of more prompting
- - ENDMORE Mark the end of more prompting
- - FORMATNUM <num>,<format>,<len> TO <dest> Format a number and convert to a
- string.
-
- Formats:
-
- 0 - Decimal
- 1 - Hex
- 2 - Binary
- 3 - Spaced decimal
- (length ignored)
- 4 - Risc OS file size
- (length =0 or 1)
-
- - FLUSHIN Flush input
- - FLUSHOUT Flush output
-
- Input commands:
-
- - INPUT <destvar>[,<maxlen>[,<mask>]] Get input from the user
- - GET[D] <destvar>[,<filter>] Get a single char from the user
- (and use first letter of filter as
- default)
- - INKEY <destvar> Get a char but dont wait
- - ANYKEY Wait for keypress
-
- IO commands:
-
- OPENDEVICE <Device type>,<Info> TO <handle> Create a new IO device
- CLOSEDEVICE <handle> Close an IO device
- SETDEVICE <handle> Set current IO device
- RESETDEVICE Set to default IO device
- OUTPUTBYTE <handle>,<byte> TO <Failed> Output to specific IO device
- INPUTBYTE <handle> TO <byte> Read from specific IO device
-
- Flow commands:
-
- - IF <exp> [THEN] ... [ELSE ...] Single line IF statement
- - IF <exp> THEN Multi line IF statement
- ...
- [ELSE
- ...]
- ENDIF
- - LABEL <label> Set a label
- - JUMP <label> Jump to label
- - RUN <filename> Run a file and return
- - GOTO <filename> Run a file
- - REPEAT Start a REPEAT UNTIL loop
- ...
- UNTIL <exp>
- - END End current program.
- - GOSUB <label> Call a subroutine
- - SUB <label> Mark the start of a subroutine
- - ENDSUB Mark the end of a subroutine
- - INCLUDE Compile a file but don't run it
- - SCRIPT <name> Run uncompiled script
-
- Variable commands:
-
- - LET <variable> = <exp> Assign a value to a variable
- - LEFT <dest> FROM <variable>,<offset> LEFT$ function
- - CREATEBLOCK <size> TO <dest>
- - RESIZEBLOCK <block>,<newsize> TO <newsize>
- - LOSEBLOCK <block>
-
- File commands: Description:
-
- - SEND <filename>,<datatype> Output a file to the screen.
- Data types:
-
- 0 - Raw data (no conversion)
- 1 - ASCII data (LF signals new
- line)
- 2 - ANSI data (filter esc codes
- if not supported)
- 3 - ArcBBS 'TYPE' file.
- 4 - Uncompiled script
-
- - CLEARRECORD Clear current serial record.
- - RECORDPRINT <string> Write a string to the record.
- - WRITERECORD <filename> Write the record to disk
- - OSCLI <command> Perform *COMMAND
- - LOG <string> Log a string to the NF log file
-
- BBS commands:
-
- - FINDUSER <exp> Search for the specified user and
- set user number. User number is
- set to 0 if user could not be
- found.
- - CREATEUSER Create a new user.
- - HASCALLED Increment number of times a user
- has called and reset logon times
- - REPORT <exp> Set the current activity of the
- user.
- - UPLOAD <filenumber>,<protocol> Allow the user to upload a file
- to the BBS.
- - DOWNLOAD <filenumber>,<protocol> Allow the user to download a file
- from the BBS.
- - SYSOPCHAT <destvar> FROM <reason>,<timeout>Request a chat with the sysop and
- store the result.
- - SETCHAT <name>,<tfg>,<tbg>,<mfg>,<mbg>,<bfg>,<bbg>
- - LOGOFF Disconnect the user
- - CHECKPASSWORD <dest> Allows the user to enter their
- password. Returns a non-zero
- number to indicate it was entered
- correctly.
- - CHANGEPASSWORD Allows the user to change their
- password
- - SETPASSWORD Allows the a new user to enter their
- password
-
- Filebase commands:
-
- - OPENFILEBASE Open file base to allow operations.
- - CLOSEFILEBASE Close file base
- - READFAREA <areanumber> Set relevent variables.
- - READFILE <filenumber> Set relevent variables.
- - CLEARTAG Clear users taglist
- - TAGFILE <filenumber> Add a file to tag list.
- - READTAG <tag> TO <dest> Read in the details of a tagged file.
- - REMOVETAG <tag> Remove a tagged file.
- - SHOWDESCRIPTION <pointer> Show file description
- - SETLONGDESCRIPTION <filenumber> Set's the long description of a file
- - SETSHORTDESCRIPTION <filenumber> <exp> Set's the short description of a file
- - FILESEARCH <filearea/0>,<code>,<# of files to
- search>,<search string>,<filename/keyword (flag)>
- TO <dst. files searched>,<result>,<next call>
- - FINDFILE <dest> FROM <filearea>,<filename/num>
- - DELETEFILE <filenum> Delete's a file (permenantly!!)
- - BATCHSTART <protocol> Start a batch transfer
- - BATCHSEND <filenum> <protocol> TO <res> Send a file
- - BATCHFINISH <protocol> Finish a batch transfer
- - READFILEBASE <filebase> Read file base details
- - READMESSAGEBASE <messagebase> Read message base details
-
- Door commands:
-
- - RUNAPP <exp> Perform *<exp> <linenumber>
- - STARTDOOR <exp> Signal a door (already loaded) to
- start using numeric or text ID.
- - STARTARCBBSDOOR <exp> Start an ArcBBS door.
- - STARTRISCBBSDOOR <exp> Start a RiscBBS door.
- - RUNTASK <exp> Same as RBBS's 'runtask'
-
- Misc commands:
-
- - READLINE <line> TO <dest1>,<dest2>,<dest3>Read the baud rate, user number
- and action of and user online.
- - READUSER <usernum>,<id> TO <dest> Read any info about any user.
- - READTASK <code> TO <dest1>,<dest2>,<dest3>Enumerate all wimp tasks
- (also READUSERTASK and READMODULETASK).
- - RANDOMIZE <seed> Set the random number seed
-
- - SENDFILE <filename>,<protocol>,<fname> Send a file
- - SCANDIR <pathname> Allow user to download files
-
- Message base commands:
-
- - OPENMESSAGEBASE Open message base to allow operations.
- - CLOSEMESSAGEBASE Close message base
- - READMAREA <areanumber> Set relevent variables.
- - READMESSAGE <filenumber> Set relevent variables.
-
- - WRITEMESSAGE <style> Allows the user to write a message
- - POSTMESSAGE <area>,<subject>,<from>,<user>,[<add>] Posts a message
- - LOADMESSAGE <number> Loads a message into memory
- - SHOWMESSAGE <filter> Shows current message
- - DELETEMESSAGE <number> Delete a message
- - MESSAGEOP <number> <op> Performs some ops on message
-
- Op:
-
- 0 - Message has been read (by anyone)
- 1 - Message has been read by recipient
-
- - ATTACHFILE <message> <file> Attach a file to a message
- - SETADDRESS <address> Set fido address of BBS.
- - QUOTEMESSAGE <number> Load in a message for quoting
- - CQUOTEMESSAGE <number> Copy and quote a message
- - CLEARQUOTE Clear the current quoted message
- - CLEARMESSAGE Clear the current message
- - CLEARLIST Clear list of scanned messages
- - SCANAREA <area>,<usernumber> Scan for messages
- - READSCANNED <number> TO <dest> Read the number of a scanned
- message
- - CLEARSCANNED <number> Clear a message from the list
-
- Temporary commands:
-
- - FREETYPE Echo text to screen (to allow a chat)
- - ONLINEUSERLIST List all users online.
-
- System variables:
-
- - USERNAME User name of user logged on.
- - USERNUMBER User number of user logged on.
- - PASSWORD Password of user logged on.
- - AREANAME Current action/area of user (can
- be set with REPORT command).
- - BAUDRATE DCE rate of user logged on.
- - LINE Line number
- - USERLEVEL User level of user logged on.
- - LOGONTIME Max logon time of user logged on.
- (in mins)
- - TERMINAL Terminal type of user logged on.
- - CLEARING User has screen clearing?
- - MORE User has more prompting?
- - REGISTERED User is registered?
- - CALLED Number of times user has called
- - TIMELEFT Number of cs left
- - TIMEONLINE Amount of time user has been on
- this call. (in cs)
- - LASTCALLED Date user last called.
- - MSGAREA Current message area
- - MESSAGEBASE Current message base number
- - FILEBASE Current file base number
- - FILEAREA Current file area
- - TRUE Non-zero integer (-1)
- - FALSE Zero integer (0)
- - DLINES Number of display lines.
- - ULOADF Number of files uploaded
- - ULOADK Number of K's uploaded.
- - DLOADF Number of file downloaded.
- - DLOADK Number of K's downloaded.
- - ULOADR Number of files user can upload
- for every...
- - DLOADR ...files downloaded.
- - ADDLINE1 Address of user..
- - ADDLINE2
- - ADDLINE3
- - POSTCODE Postcode of user.
- - VOICEPHONE Voice phone number of user.
- - DATAPHONE Data phone number of user.
- - RND Random number (limit set by
- RND=limit)
- - TASKLOAD Number of tasks running
- - FREEMEM Amount of free memory
- - USEDMEM Amount of used memory
-
- - TIMER 100Hz timer
- - TIME System time
- - DATE System date
- - XPOS Current x position of cursor
- - STYLE Menu style (0-15)
- - RATING User rating (0-15)
-
- - NFVERSION Version of NewsFlash
- - ASSMDATE Date of assembly
- - OSVERSION Version of OS
- - FEVERSION Version of NF front end
- - RBHAND Risc BBS Task Handle
- - PAGER Sysop chat pager
- - SYSOPNAME Sysops name
- - FNAME Users first name
- - LNAME Users last name
- - INITIALS Users initials
-
- - CANKNOW Constant (2^0)
- - CANVIEW Constant (2^1)
- - CANWRITE Constant (2^2)
- - CANREAD Constant (2^3)
-
- - SYSOP User is a sysop
- - LOCAL Indicates a local logon
-
- File base variables:
-
- - FILEAREAS Number of file areas
- - CURRENTFILEBASE Flag for current file area
- - FILEBASEACCESS File base access flags
- - FILEBASENAME
-
- - FILEAREANAME Name of current filearea
- - FILEAREAFILES Number of files in this filearea
- - FILEAREASIZE Size (in bytes) of this filearea
- - FILEAREAACCESS Access rights for user
- - FILEAREABASES File bases area belongs to
-
- - FILEBASENAME Name of current file
- - FILEBASESIZE Size of current file (K)
- - FILEBASEUSER User number of who uploaded
- - FILEBASETIMES Number of times downloaded
- - FILEBASEDATE Date file was uploaded on
- - FILEBASEFLAGS Flags for file
- - FILEBASEAREA File area of file
-
- - FIRSTFILE First file in current file area
- - LASTFILE Last file in current file area
- - NEXTFILE Next file in current file area
- - PREVFILE Previous file in current file area
- - SHORTD Pointer to short description
- - LONGD Pointer to long description
-
- - TAGGEDFILES Number of tagged files.
-
- Message base variables:
-
- - MESSAGEAREAS Number of message areas
- - CURRENTMESSAGEBASE Flag for current message base
-
- - MESSAGEBASEACCESS Message base access flags
- - MESSAGEBASENAME
-
- - MESSAGEAREANAME Name of current messagearea
- - MESSAGEAREAMAIL Number of messages in this message area
- - MESSAGEAREASIZE Size (in bytes) of this message area
- - MESSAGEAREAACCESS Access rights for user
- - MESSAGEAREABASES Message bases area belongs to
-
- - MESSAGESIZE Size of current message
- - MESSAGETYPE Type of current message
- - MESSAGEFILE File attached to current message
- (0 for none)
-
- - MESSAGEAUTHORNUM Author number of current message
- (local only)
- - MESSAGERECIPIENTNUM User number of recipient
- (local only)
-
- - MESSAGEAUTHOR Author name of current message
- - MESSAGERECIPIENT Name of recipient
-
- - MESSAGEREAD Non-zero if read by recipient
- - MESSAGEDOWNLOADED Non-zero if downloaded by recipient
- - MESSAGETIMESREAD Number of times message has been read
-
- - MESSAGEDATE Date message was written on
-
- - NEXTMESSAGE Next message in this area
- - PREVMESSAGE Previous message in this area
-
- - MESSAGEFROM Address of message
- - MESSAGETO Dest. address
- - MESSAGEFROMAREA Message area of this message
-
- - BBSADDRESS Address of this BBS
-
- - SCANNEDMESSAGES Number of messages scanned
-
-
-
