<?xml version="1.0" encoding="utf-8"?><!DOCTYPE article  PUBLIC '-//OASIS//DTD DocBook XML V4.4//EN'  'http://www.docbook.org/xml/4.4/docbookx.dtd'><article><articleinfo><title>Screen</title><revhistory><revision><revnumber>3</revnumber><date>2015-09-04 16:51:45</date><authorinitials>LKD70</authorinitials></revision><revision><revnumber>2</revnumber><date>2015-09-04 16:31:42</date><authorinitials>LKD70</authorinitials></revision><revision><revnumber>1</revnumber><date>2015-09-04 16:30:59</date><authorinitials>LKD70</authorinitials></revision></revhistory></articleinfo><section><title>Screen</title><para>The Screen object contains the content as you see it on your screen. This means certain things you see in the bot can be referenced through scripts. Below I've included a collection of references that will assist you to grab data from certain Screen elements. As well as referencing these elements, you can also add values to some of them. the <link linkend="addEvent">addEvent</link> function shows this. </para><informaltable><tgroup cols="3"><colspec colname="col_0"/><colspec colname="col_1"/><colspec colname="col_2"/><tbody><row rowsep="1"><entry colsep="1" rowsep="1"><para><emphasis role="strong">Name</emphasis> </para></entry><entry colsep="1" rowsep="1"><para><emphasis role="strong">Type</emphasis> </para></entry><entry colsep="1" rowsep="1"><para><emphasis role="strong">Description </emphasis> </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para><link linkend="MainLog">Screen.mainLog</link> </para></entry><entry colsep="1" rowsep="1"><para>String </para></entry><entry colsep="1" rowsep="1"><para>Contains the information seen in the main log tab. </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para><link linkend="CityLog">Screen.cityLog</link> </para></entry><entry colsep="1" rowsep="1"><para>String </para></entry><entry colsep="1" rowsep="1"><para>Contains the information seen in the city Log tab. </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para><link linkend="ReportLog">Screen.reportLog</link> </para></entry><entry colsep="1" rowsep="1"><para>String </para></entry><entry colsep="1" rowsep="1"><para>Contains the information seen in the Reports tab. </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para><link linkend="AllianceChat">Screen.aChat</link> </para></entry><entry colsep="1" rowsep="1"><para>String </para></entry><entry colsep="1" rowsep="1"><para>Contains the information seen in the Alliance chat tab. </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para><link linkend="PrivateChat">Screen.pChat</link> </para></entry><entry colsep="1" rowsep="1"><para>String </para></entry><entry colsep="1" rowsep="1"><para>Contains the information seen in the Private chat tab. </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para><link linkend="WorldChat">Screen.wChat</link> </para></entry><entry colsep="1" rowsep="1"><para>String </para></entry><entry colsep="1" rowsep="1"><para>Contains the information seen in the World chat tab. </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para><link linkend="BeginnersChat">Screen.bChat</link> </para></entry><entry colsep="1" rowsep="1"><para>String </para></entry><entry colsep="1" rowsep="1"><para>Contains the information seen in the Beginners chat tab. </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para><link linkend="SystemChat">Screen.sChat</link> </para></entry><entry colsep="1" rowsep="1"><para>String </para></entry><entry colsep="1" rowsep="1"><para>Contains the information seen in the System chat tab. </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para><link linkend="CommandLog">Screen.commandLog</link> </para></entry><entry colsep="1" rowsep="1"><para>String </para></entry><entry colsep="1" rowsep="1"><para>Contains the information seen in the commandLog tab. </para></entry></row></tbody></tgroup></informaltable><section><title>MainLog</title><informaltable><tgroup cols="2"><colspec colname="col_0"/><colspec colname="col_1"/><tbody><row rowsep="1"><entry colsep="1" rowsep="1"><para>Usage: </para></entry><entry colsep="1" rowsep="1"><para>Screen.mainlog.buffer </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para>Example: </para></entry><entry colsep="1" rowsep="1"><para>echo Screen.mainLog.buffer </para></entry></row></tbody></tgroup></informaltable><para>Outputs the contents of the main Log. </para></section><section><title>CityLog</title><informaltable><tgroup cols="2"><colspec colname="col_0"/><colspec colname="col_1"/><tbody><row rowsep="1"><entry colsep="1" rowsep="1"><para>Usage: </para></entry><entry colsep="1" rowsep="1"><para>Screen.cityLog.buffer </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para>Example: </para></entry><entry colsep="1" rowsep="1"><para>echo Screen.cityLog.buffer </para></entry></row></tbody></tgroup></informaltable><para>Outputs the contents of the city Log. </para></section><section><title>ReportLog</title><informaltable><tgroup cols="2"><colspec colname="col_0"/><colspec colname="col_1"/><tbody><row rowsep="1"><entry colsep="1" rowsep="1"><para>Usage: </para></entry><entry colsep="1" rowsep="1"><para>Screen.reportLog.buffer </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para>Example: </para></entry><entry colsep="1" rowsep="1"><para>echo Screen.reportLog.buffer </para></entry></row></tbody></tgroup></informaltable><para>Outputs the contents of the report Log. </para></section><section><title>AllianceChat</title><informaltable><tgroup cols="2"><colspec colname="col_0"/><colspec colname="col_1"/><tbody><row rowsep="1"><entry colsep="1" rowsep="1"><para>Usage: </para></entry><entry colsep="1" rowsep="1"><para>Screen.aChat.buffer </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para>Example: </para></entry><entry colsep="1" rowsep="1"><para>echo Screen.aChat.buffer </para></entry></row></tbody></tgroup></informaltable><para>Outputs the contents of the alliance chat. </para></section><section><title>PrivateChat</title><informaltable><tgroup cols="2"><colspec colname="col_0"/><colspec colname="col_1"/><tbody><row rowsep="1"><entry colsep="1" rowsep="1"><para>Usage: </para></entry><entry colsep="1" rowsep="1"><para>Screen.pChat.buffer </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para>Example: </para></entry><entry colsep="1" rowsep="1"><para>echo Screen.pChat.buffer </para></entry></row></tbody></tgroup></informaltable><para>Outputs the contents of the private chat. </para></section><section><title>WorldChat</title><informaltable><tgroup cols="2"><colspec colname="col_0"/><colspec colname="col_1"/><tbody><row rowsep="1"><entry colsep="1" rowsep="1"><para>Usage: </para></entry><entry colsep="1" rowsep="1"><para>Screen.wChat.buffer </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para>Example: </para></entry><entry colsep="1" rowsep="1"><para>echo Screen.wChat.buffer </para></entry></row></tbody></tgroup></informaltable><para>Outputs the contents of the world chat. </para></section><section><title>BeginnersChat</title><informaltable><tgroup cols="2"><colspec colname="col_0"/><colspec colname="col_1"/><tbody><row rowsep="1"><entry colsep="1" rowsep="1"><para>Usage: </para></entry><entry colsep="1" rowsep="1"><para>Screen.bChat.buffer </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para>Example: </para></entry><entry colsep="1" rowsep="1"><para>echo Screen.bChat.buffer </para></entry></row></tbody></tgroup></informaltable><para>Outputs the contents of the beginners chat. </para></section><section><title>SystemChat</title><informaltable><tgroup cols="2"><colspec colname="col_0"/><colspec colname="col_1"/><tbody><row rowsep="1"><entry colsep="1" rowsep="1"><para>Usage: </para></entry><entry colsep="1" rowsep="1"><para>Screen.sChat.buffer </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para>Example: </para></entry><entry colsep="1" rowsep="1"><para>echo Screen.sChat.buffer </para></entry></row></tbody></tgroup></informaltable><para>Outputs the contents of the system chat. </para></section><section><title>CommandLog</title><informaltable><tgroup cols="2"><colspec colname="col_0"/><colspec colname="col_1"/><tbody><row rowsep="1"><entry colsep="1" rowsep="1"><para>Usage: </para></entry><entry colsep="1" rowsep="1"><para>Screen.commandLog.buffer </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para>Example: </para></entry><entry colsep="1" rowsep="1"><para>echo Screen.commandLog.buffer </para></entry></row></tbody></tgroup></informaltable><para>Outputs the contents of the command Log. </para><!--rule (<hr>) is not applicable to DocBook--></section><section><title>addEvent</title><informaltable><tgroup cols="2"><colspec colname="col_0"/><colspec colname="col_1"/><tbody><row rowsep="1"><entry colsep="1" rowsep="1"><para>Usage: </para></entry><entry colsep="1" rowsep="1"><para>Screen.mainLog.addEvent(&quot;Contents&quot;) </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para>Example: </para></entry><entry colsep="1" rowsep="1"><para>Screen.mainLog.addEvent(&quot;&lt;b&gt;Why hello there.&lt;/b&gt;&quot;) </para></entry></row></tbody></tgroup></informaltable><para>Outputs the contents of the addEvent function to the specified Screen object. </para><para>This addEvent method also allows you to use HTML markup within the event. This means you're able to (somewhat) use styling within the logs. </para><para>Example: </para><itemizedlist><listitem override="none"><para><inlinemediaobject><imageobject><imagedata fileref="http://s2.postimg.org/fjszrspax/8_MXMAg_J.png"/></imageobject><textobject><phrase>Example Missing</phrase></textobject></inlinemediaobject> </para></listitem></itemizedlist><note><para><emphasis role="strong">Note</emphasis> The addEvent() function only adds the event to the local client, meaning even if it looks like it posted to world-chat using <emphasis>Screen.wChat.addEvent(&quot;hi&quot;)</emphasis> it in-fact did NOT. </para></note><!--rule (<hr>) is not applicable to DocBook--><para> <ulink url="http://guide.neatportal.com/wiki/Screen/wiki/ScriptObjects#">ScriptObjects</ulink> </para></section></section></article>