TextParse System

==============READ-ME================

* TextParse System - Version 1.20

* Compiled on February 23, 2009

* Created by Ammorth

* Uses Table by Vexorian

* Requires JassHelper

=============Installation============

1) Copy the trigger/library "TextParse" to your map.
2) Save your map using JassHelper

================About================

TextParse takes a string and will format it to fit to a certain width.  This can be used to display
text messages on multiboards.

The system supports new lines "|n", color codes "|cAARRGGBB" and color ends "|r".  It will wrap color
to the lines below automatically.

================Usage================

To use, simple pass the string to be parsed to the function TextParse_ParseString, where it will output
a TextParse (struct).  You can then display the lines of text using either method DisplayString or
method DisplayAllStrings.  You can also use method GetNumberStrings to find out the number of lines of
the parsed string.

Example code with comments:

function PlayerChat takes nothing returns nothing
    local real width = 15. // the width the text should be.  This is really the percentage of the screen when using a multiboard.
    local string s = GetEventPlayerChatString() // the string that will be parsed
    local TextParse t = TextParse_ParseString(s, width) // parse the string with the width and set it to t
    local integer i = t.GetNumberStrings // get the number of strings so we can loop through them all and display them
    local integer n = 1 // our counter for the loop
    loop
        exitwhen n > i
        call MultiboardSetItemValueBJ(SomeMultiboard, 1, n, t.DisplayString(n)) // set the text of each line to the multiboard
        set n = n + 1
    endloop
    call t.destroy() // destroy the parsed string so it doesn't leak.
endfunction

    
===========List of Functions=========

function TextParse_ParseString takes string s, real width returns TextParse (outside library)
    or
public function ParseString takes string s, real width returns TextParse (in library)

    - string s - the string that will be parsed
    - real width - the max width each line can only be (must be between 2 and 100)
    - returns TextParse - the final parsed text that is output
    
    
    
SomeParse.DisplayString takes integer line returns string (with variable SomeParse)
    or
method DisplayString takes integer line returns string (inside struct)

    - integer line - the line number that should be displayed
    - returns string - the string of that line.  will return "" if the line doesnt exist
    
    
    
SomeParse.DisplayAllStrings takes nothing returns string (with variable SomeParse)
    or
method DisplayAllStrings takes nothing returns string (inside struct)

    - returns string - returns the entire parsed string with line separation between each line ("|n")
                       and formated color codes.

                       
                       
SomeParse.GetNumberLines takes nothing returns integer (with variable SomeParse)
    or
method GetNumberLines takes nothing returns integer (inside struct)

    - returns integer - the number of lines the current parsed string has.
    
    
    
SomeParse.destroy takes nothing returns nothing (with variable SomeParse)
    or
method onDestroy takes nothing returns nothing (inside struct)

    - destroys the TextParse so it doesnt leak.
    - Note: strings do not leak, it is the TextParse struct that leaks if you do not destroy it.
    
    
=============Change-Log==============

    Version 1.20
        - Fixed database values (now only works correctly with multiboards)
        - Updated to use Table
        - Refined some functions

    Version 1.10
        - Updated to vJass
        - Included support for color-codes
        - Improved parsing function
        - Converted to CSCache to generalize storage method
        

    Version 1.00
        - First Public Release