~~META:
creator       = Dewin
&description abstract = Lets you display arbitrary text on screen.
~~
~~NOCACHE~~
====== Text (1.01) ======


===== Plugin Information =====

^   Information  ^^
^   Developer:| [[:user/Dewin|Dewin]] |
^   Download:| [[http://windower.net/plugins/Text.dll | Text]]|
^   Download Count:| [dlcount]text[/dlcount] |
^   Release Date:| May 07, 2008 |

===== What is Text =====

Text is a plugin that allows you to create 'text objects' via windower console commands.

Text objects at their most basic level are some text, a font for said text, and a location onscreen to draw said text.  They are used extensively by many plugins, such as TParty, Recast, Distance, and Expwatch.

You can use Text, for instance, to display a list of macros that are changed on-the-fly.  One instance might be macros to choose an avatar and to choose a bloodpact on the selected avatar.


===== Usage =====

[[Text]] can be loaded by opening your Windower console and typing //load text//. [[Text]] is autoload friendly, one can add the //load text// command to their **init.txt** file in the **scripts** folder where Windower resides. See the [[#Commands]] section for further usage details.


===== Commands =====

<code>verbose <level></code>
Adjusts message spam. 
  * Verbosity 0 suppresses all messages except errors
  * Verbosity 1 (default) only reports when a wildcard match didn't match anything
  * Verbosity 2 reports all actions

<code>create <name></code>
Creates a text object named <name> using default settings.  The textobject will be initially invisible.
delete <names>	Deletes text object(s)

<code>set <names> fg <red> <green> <blue> [<alpha>]</code>
Sets the foreground color (red, green, blue, and optional alpha).  Alpha defaults to 255 if omitted.

<code>set <names> bg <red> <green> <blue> [<alpha>]</code>
Sets the background color (red, green, blue, and optional alpha).  Alpha defaults to 255 if omitted.

<code>set <names> position <x> <y></code>
Shortcut to setting x and y at the same time.

<code>set <names> show</code>
Show the text object(s).

<code>set <names> hide</code>
Hide the text object(s).

<code>set <names> showbg</code>
Show the background for the text object(s).

<code>set <names> hidebg</code>
Hide the background for the text object(s).

<code>set <names> text "<text>"</code>
Sets text displayed by the text object(s).  Quotes are mandatory if the text includes any space.  You can display multiline text by separating multiple lines with '\n'

<code>set <names> align {left|right}</code>
Changes text alignment.

<code>set <names> font <fontname> <fontsize></code>
Changes font and font size.

<code>set <names> bold 0/1</code>
Changes whether the text is bolded or not.

<code>set <names> italic 0/1</code>
Changes whether the text is italicized or not. 

To save time, you may chain multiple 'set' commands together:
<code>text set MyTextObject fg 255 255 255 255 bg 0 0 0 192 text "White text on a translucent black background"</code>

To change the defaults applied to new text objects, replace 'set <names>' with 'setdefault'.  e.g. to ensure all newly created text objects are in 10 point Courier New:
<code>text setdefault font "Courier New" 10</code>

To modify text objects not created by the Text plugin, replace ''set <names>'' with ''devset <name>''.  **Note that devset is case sensitive, does not support wildcards, and is not supported.  If devset breaks your plugins, well, you've been warned.**

Text object names are case-insensitive (internally they are converted to lowercase).  In addition, all names are modified slightly to avoid a possible conflict with textobjects created by Windower or its plugins.

Most commands can apply to multiple text objects.  There is limited support for wildcards: 
  * A name of 'Group1*' will match all names starting with 'Group1'.  Note that this can only occur at the END of the name for performance reasons.
  * You can list multiple names, e.g. 'Group1A,Group1B,Group1C'
  * You can mix wildcards and lists: 'Group1*,Group2*,Group3A,Group3B'

Note that commands that take multiple objects only work on objects already created with 'text create'.







===== TextObject Names of Other Plugins =====
This list is for 'text devset'.  It is not guarunteed to be accurate, and 'text devset' is not supported

^Plugin/Feature   ^Textobject name  ^Notes  ^
|//Console//|not modifiable|
|//FPS Display//|not modifiable|
|[[Distance]]    |TargetDecimal, TargetDot, TargetInt |
|[[ExpWatch]]    |ewText           |
|[[Precognition]]      |Precognition    |
|[[Recast]]      |RecastDisplay    |
|[[StatusTimer]]|//n/a//|Use StatusTimer's console commands|
|[[Tickle]]      |TickCount        |
|[[TParty]]      |PartyTP0..PartyTP17, AllianceMP0..AllianceMP17, TargetHP | Color changes to PartyTP won't stick.  Visibility changes are likely to be lost upon party member list changes.|
|[[Yarnball]]    |YarnTimers|
|[[ZoneTimer]]   |//n/a//|Use ZoneTimer's console commands|
|