User Tools

Site Tools


text_file_screens
      Text file screen's are used by Iniquity to display information to the
 user. All of the file's explained below are hard coded in Iniquity and are
 automatically recognized for use. There are also six type's of codes that can
 be used with the screen's to display variable information, or to move the
 cursor to a desired location without effecting anything else. Below is a
 brief explanation of each type of code.

   %xx  - MCI Code     - These code's are use to display variable text
                         information, in other words each user will have      
                         different information that will, be displayed due to 
                         their activities on the system.

   |xx  - Control Code - These code's are used to physically move the cursor, 
                         or change a colour, or to cause a delay in the screens 
                         display.

   ~xx  - Wave Code    - These code's are used in modifiable text files for a 
                         variety of things, all of which are dependant on the 
                         type of file used.

   @xx  - At Code      - These codes are used to place the cursor at the      
                         exact location of 'xx' without moving up, or down.

   &xx  - At Row Code  - This code creates row movement of up and down to a   
                         new row on the screen. This code will not move left  
                         or right.

   {xx  - Limit Code   - These code's are used to limit all of the following  
                         MCI codes in the current text file to 'xx' character's 
                         long.

   }xx  - Pad Code     - These code's are used to ensure that all of the MCI  
                         codes in the current text file will be 'xx' characters 
                         in length.
 
   There are also three types of files that can be used to display information
   to the screen, depending on the type of call used. You must be extremely
   careful not to cross these types over, or you might end up with some pretty
   weird screen results.

   Normal - These files are used to display all type's of MCI, Control, AT,   
            Limit and Pad codes, these are not file dependant and can be used 
            freely to create elaborate screens that can dazzle the eye.
    
   Repeat - Repeat files are actually a set of three, sometimes four, text    
            files, consisting of a top text file (header file), a middle text 
            file (using wave codes), and a bottom text file (footer file). The 
            fourth file can be used for only a few other screens, message     
            listing is one type, this file is nick named a high lighter file. 
            All repeat set's MUST have three files, the top, middle, and bottom 
            files or else Iniquity will just ignore them. Repeat files can use 
            MCI, Control, AT, Limit and Pad codes to display the necessary    
            information.

   Wave   - Wave files are identical to the normal text files, except that    
            they each have their own set of wave codes. Each file uses different 
            codes mainly because each file is used in a different area. Each  
            code MUST not be crossed over to another wave file, mainly because 
            it may cause weird results.

   I must also explain a little bit about the wave code types, there are
   currently four types as are shown below.

   [txt] - These wave codes will display something as soon as Iniquity        
           interprets the code, usually in the current colour attribute.

   [pos] - These wave codes are used to mark a certain colour attribute and   
           cursor position for later use. This is used for things like the split 
           screen chat windows, and input prompts. The colour of the code is  
           important in some cases.

   [lit] - These wave codes are used to mark the position of a 'light', which 
           should be in a blinking attribute for the best effect. The light will 
           be displayed in this position and colour when a certain operation  
           begin's, then will be 'unlit' when the operation has ended.

   [col] - These wave codes are used to change to the default colours setup in 
           the user's default colour configuration.

   I will explain each of the defined file's broken down into their respective
   categories, Normal text files first, then the Repeat text files, and finally
   the Wave text files.
text_file_screens.txt · Last modified: by admin

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki