Screen

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 addEvent function shows this.

Name	Type	Description
Screen.mainLog	String	Contains the information seen in the main log tab.
Screen.cityLog	String	Contains the information seen in the city Log tab.
Screen.reportLog	String	Contains the information seen in the Reports tab.
Screen.aChat	String	Contains the information seen in the Alliance chat tab.
Screen.pChat	String	Contains the information seen in the Private chat tab.
Screen.wChat	String	Contains the information seen in the World chat tab.
Screen.bChat	String	Contains the information seen in the Beginners chat tab.
Screen.sChat	String	Contains the information seen in the System chat tab.
Screen.commandLog	String	Contains the information seen in the commandLog tab.

MainLog

Usage:	Screen.mainlog.buffer
Example:	echo Screen.mainLog.buffer

Outputs the contents of the main Log.

CityLog

Usage:	Screen.cityLog.buffer
Example:	echo Screen.cityLog.buffer

Outputs the contents of the city Log.

ReportLog

Usage:	Screen.reportLog.buffer
Example:	echo Screen.reportLog.buffer

Outputs the contents of the report Log.

AllianceChat

Usage:	Screen.aChat.buffer
Example:	echo Screen.aChat.buffer

Outputs the contents of the alliance chat.

PrivateChat

Usage:	Screen.pChat.buffer
Example:	echo Screen.pChat.buffer

Outputs the contents of the private chat.

WorldChat

Usage:	Screen.wChat.buffer
Example:	echo Screen.wChat.buffer

Outputs the contents of the world chat.

BeginnersChat

Usage:	Screen.bChat.buffer
Example:	echo Screen.bChat.buffer

Outputs the contents of the beginners chat.

SystemChat

Usage:	Screen.sChat.buffer
Example:	echo Screen.sChat.buffer

Outputs the contents of the system chat.

CommandLog

Usage:	Screen.commandLog.buffer
Example:	echo Screen.commandLog.buffer

Outputs the contents of the command Log.

addEvent

Usage:	Screen.mainLog.addEvent("Contents")
Example:	Screen.mainLog.addEvent("<b>Why hello there.</b>")

Outputs the contents of the addEvent function to the specified Screen object.

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.

Example:

Note The addEvent() function only adds the event to the local client, meaning even if it looks like it posted to world-chat using Screen.wChat.addEvent("hi") it in-fact did NOT.

ScriptObjects

Screen (last edited 2015-09-04 16:51:45 by LKD70)

-  ⇤ ← Revision 2 as of 2015-09-04 16:31:42 → 
  Size: 7708
  Editor: LKD70
  Comment:
+   ← Revision 3 as of 2015-09-04 16:51:45 → ⇥
  Size: 9112
  Editor: LKD70
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 2:
-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.
+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 [[#addEvent|addEvent]] function shows this.
-Line 19:
+Line 18:
-||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;        " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;        ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Screen.mainlog.buffer ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;     ">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">echo Screen.mainLog.buffer ||
+||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;          " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;          ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Screen.mainlog.buffer ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;       ">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">echo Screen.mainLog.buffer ||
-Line 25:
+Line 24:
-Line 27:
+Line 25:
-||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;        " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;        ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Screen.cityLog.buffer ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;     ">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">echo Screen.cityLog.buffer ||
+||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;          " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;          ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Screen.cityLog.buffer ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;       ">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">echo Screen.cityLog.buffer ||
-Line 33:
+Line 31:
-Line 36:
+Line 32:
-||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;        " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;        ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Screen.reportLog.buffer ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;     ">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">echo Screen.reportLog.buffer ||
+||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;          " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;          ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Screen.reportLog.buffer ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;       ">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">echo Screen.reportLog.buffer ||
-Line 42:
+Line 38:
-Line 45:
+Line 39:
-||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;        " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;        ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Screen.aChat.buffer ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;     ">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">echo Screen.aChat.buffer ||
+||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;          " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;          ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Screen.aChat.buffer ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;       ">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">echo Screen.aChat.buffer ||
-Line 51:
+Line 45:
-Line 54:
+Line 46:
-||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;        " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;        ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Screen.pChat.buffer ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;     ">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">echo Screen.pChat.buffer ||
+||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;          " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;          ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Screen.pChat.buffer ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;       ">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">echo Screen.pChat.buffer ||
-Line 60:
+Line 52:
-Line 63:
+Line 53:
-||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;        " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;        ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Screen.wChat.buffer ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;     ">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">echo Screen.wChat.buffer ||
+||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;          " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;          ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Screen.wChat.buffer ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;       ">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">echo Screen.wChat.buffer ||
-Line 69:
+Line 59:
-Line 72:
+Line 60:
-||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;        " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;        ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Screen.bChat.buffer ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;     ">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">echo Screen.bChat.buffer ||
+||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;          " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;          ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Screen.bChat.buffer ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;       ">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">echo Screen.bChat.buffer ||
-Line 78:
+Line 66:
-Line 81:
+Line 67:
-||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;        " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;        ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Screen.sChat.buffer ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;     ">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">echo Screen.sChat.buffer ||
+||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;          " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;          ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Screen.sChat.buffer ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;       ">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">echo Screen.sChat.buffer ||
-Line 87:
+Line 73:
-Line 90:
+Line 74:
-||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;        " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;        ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Screen.commandLog.buffer ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;     ">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">echo Screen.commandLog.buffer ||
+||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;          " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;          ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Screen.commandLog.buffer ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;       ">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">echo Screen.commandLog.buffer ||
-Line 95:
+Line 79:
+----

== addEvent ==
||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;          " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;          ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Screen.mainLog.addEvent("Contents") ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;       ">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Screen.mainLog.addEvent("<b>Why hello there.</b>") ||


Outputs the contents of the addEvent function to the specified Screen object.

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.

Example:

 . {{http://s2.postimg.org/fjszrspax/8_MXMAg_J.png|Example Missing|align="position"}}

{{{#!wiki note
'''Note'''
The addEvent() function only adds the event to the local client, meaning even if it looks like it posted to world-chat using ''Screen.wChat.addEvent("hi")'' it in-fact did NOT.
}}}