mmo-ref/polserver
1
0
Fork 0
mirror of https://github.com/polserver/polserver synced 2026-08-13 08:23:08 -04:00
Code Issues Projects Releases Packages Wiki Activity
polserver/docs/docs.polserver.com/pol100/basicioem.xml

30 lines
1.5 KiB
XML
Raw Permalink Normal View History

Documentation: sync EScript Modules documentation with em files Also added a new tool checkem.py in "doctools" folder: it helps checking wether em and xml files are in sync or no. This is a quite accurate job: I'm almost 100% sure (thanks to checkem.py) that: - All the functions defined in .em files are now mentioned in docs (except of deprecated ones that i omitted on purpose) - Function prototypes are the same in .em files and their doc - All the function arguments have at least a basic doc element - All the constants defined in .em files are in the docs A 2nd round of review would be probably useful tought, expecially on uoem.xml, who had the major changes: I didn't go deep into what every function does and maybe some slightly changed their behaviour during these years. This should be a more than good start anyway: if there are some errors left, hope somebody will notice and report them :)
2015-09-02 03:06:36 +02:00
<?xml version='1.0' encoding="iso-8859-1"?>
<?xml-stylesheet type="text/xsl" href="escript.xslt" ?>
<!DOCTYPE ESCRIPT SYSTEM "escript.dtd">
<ESCRIPT>
<fileheader fname="basicio.em">
<filedesc>Basic I/O functions.</filedesc>
extended print and syslog with color support (#544) * extended print and syslog with color support needs linux or atleast windows11 * added pol.cfg setting to disable colored output * added docs
2023-10-18 15:18:06 +02:00
<datemodified>10/17/2023</datemodified>
<constant>const CONSOLE_COLOR_RED := "\x1b[31m";</constant>
<constant>const CONSOLE_COLOR_GREEN := "\x1b[32m";</constant>
<constant>const CONSOLE_COLOR_YELLOW := "\x1b[33m";</constant>
<constant>const CONSOLE_COLOR_BLUE := "\x1b[34m";</constant>
<constant>const CONSOLE_COLOR_MAGENTA := "\x1b[35m";</constant>
<constant>const CONSOLE_COLOR_CYAN := "\x1b[36m";</constant>
Documentation: sync EScript Modules documentation with em files Also added a new tool checkem.py in "doctools" folder: it helps checking wether em and xml files are in sync or no. This is a quite accurate job: I'm almost 100% sure (thanks to checkem.py) that: - All the functions defined in .em files are now mentioned in docs (except of deprecated ones that i omitted on purpose) - Function prototypes are the same in .em files and their doc - All the function arguments have at least a basic doc element - All the constants defined in .em files are in the docs A 2nd round of review would be probably useful tought, expecially on uoem.xml, who had the major changes: I didn't go deep into what every function does and maybe some slightly changed their behaviour during these years. This should be a more than good start anyway: if there are some errors left, hope somebody will notice and report them :)
2015-09-02 03:06:36 +02:00
</fileheader>
<function name="Print">
extended print and syslog with color support (#544) * extended print and syslog with color support needs linux or atleast windows11 * added pol.cfg setting to disable colored output * added docs
2023-10-18 15:18:06 +02:00
<prototype>Print(anything, console_color:="")</prototype>
Documentation: sync EScript Modules documentation with em files Also added a new tool checkem.py in "doctools" folder: it helps checking wether em and xml files are in sync or no. This is a quite accurate job: I'm almost 100% sure (thanks to checkem.py) that: - All the functions defined in .em files are now mentioned in docs (except of deprecated ones that i omitted on purpose) - Function prototypes are the same in .em files and their doc - All the function arguments have at least a basic doc element - All the constants defined in .em files are in the docs A 2nd round of review would be probably useful tought, expecially on uoem.xml, who had the major changes: I didn't go deep into what every function does and maybe some slightly changed their behaviour during these years. This should be a more than good start anyway: if there are some errors left, hope somebody will notice and report them :)
2015-09-02 03:06:36 +02:00
<parameter name="anything" value="Any object, or primitive." />
extended print and syslog with color support (#544) * extended print and syslog with color support needs linux or atleast windows11 * added pol.cfg setting to disable colored output * added docs
2023-10-18 15:18:06 +02:00
<parameter name="console_color" value="xterm text formatting string e.g. one of the CONSOLE_COLOR constants"/>
Documentation: sync EScript Modules documentation with em files Also added a new tool checkem.py in "doctools" folder: it helps checking wether em and xml files are in sync or no. This is a quite accurate job: I'm almost 100% sure (thanks to checkem.py) that: - All the functions defined in .em files are now mentioned in docs (except of deprecated ones that i omitted on purpose) - Function prototypes are the same in .em files and their doc - All the function arguments have at least a basic doc element - All the constants defined in .em files are in the docs A 2nd round of review would be probably useful tought, expecially on uoem.xml, who had the major changes: I didn't go deep into what every function does and maybe some slightly changed their behaviour during these years. This should be a more than good start anyway: if there are some errors left, hope somebody will notice and report them :)
2015-09-02 03:06:36 +02:00
<explain>
Prints 'anything' to the console. If it's a string or number, it will show the value. If it's an array, struct or dictionary, it will show the contents of the structure fairly nicely. On Packets it will show the content. Else, it shows the type of object, i.e. 'ItemRef'.
</explain>
extended print and syslog with color support (#544) * extended print and syslog with color support needs linux or atleast windows11 * added pol.cfg setting to disable colored output * added docs
2023-10-18 15:18:06 +02:00
<explain>
Parameter console_color needs linux or windows 11, when given ends the line with resetting the formatting ("\x1b[0m"). Via pol.cfg EnableColoredOutput color prints can be disabled.
</explain>
Documentation: sync EScript Modules documentation with em files Also added a new tool checkem.py in "doctools" folder: it helps checking wether em and xml files are in sync or no. This is a quite accurate job: I'm almost 100% sure (thanks to checkem.py) that: - All the functions defined in .em files are now mentioned in docs (except of deprecated ones that i omitted on purpose) - Function prototypes are the same in .em files and their doc - All the function arguments have at least a basic doc element - All the constants defined in .em files are in the docs A 2nd round of review would be probably useful tought, expecially on uoem.xml, who had the major changes: I didn't go deep into what every function does and maybe some slightly changed their behaviour during these years. This should be a more than good start anyway: if there are some errors left, hope somebody will notice and report them :)
2015-09-02 03:06:36 +02:00
<return>Nothing</return>
</function>
</ESCRIPT>
Reference in a new issue Copy permalink