:orphan:

========
TKE_Text
========

Opcode
======

.. csv-table::

	"ASCII", "T"
	"Hexadecimal", "54"
	"Decimal", "84"


Operands
========

| Point position, Variable length, (length)xByte string, 
| Byte options, [Byte region_options,  Byte region_count,  
| (region_count)xPoint region]

.. raw:: html

	<table BORDER =1 WIDTH="530">
	  <TR> 
		<TD height=21 width=131>position</TD>
		<TD height=21 width=390>reference point of the text</TD>
	  </TR>
	  <TR> 
		<TD height=21 width=131>length</TD>
		<TD height=21 width=390>length of the string. Value is a <strong>Byte</strong>, 
		  but if the value is 254, the real length follows as an additional <strong>Short</strong>, 
		  or if 255 as an additional <strong>Long</strong>.</TD>
	  </TR>
	  <tr> 
		<td WIDTH="131" HEIGHT="21">string</td>
		<td WIDTH="390" HEIGHT="21">text string</td>
	  </tr>
	  <tr> 
		<td WIDTH="131" HEIGHT="21">options</td>
		<td WIDTH="390" HEIGHT="21">additional text options</td>
	  </tr>
	  <tr> 
		<td WIDTH="131" HEIGHT="21">region_options</td>
		<td WIDTH="390" HEIGHT="21">text region options</td>
	  </tr>
	  <tr> 
		<td WIDTH="131" HEIGHT="21">region_count</td>
		<td WIDTH="390" HEIGHT="21">number of points defining the text region</td>
	  </tr>
	  <tr> 
		<td WIDTH="131" HEIGHT="21">region</td>
		<td WIDTH="390" HEIGHT="21">points defining the text region</td>
	  </tr>
	</table>
	
	
Notes
=====

Text string is inserted into the currently open segment. For multi-byte character strings :doc:`TKE_Text_With_Encoding </general/hsf/opcodes/TKE_Text_With_Encoding>` should be used.


Options
-------

.. raw:: html

	<table BORDER =1 WIDTH="500">
	<TR> 
	<TD height=21 width=50>0x01</TD>
	<TD height=21 width=390>Text Region, <em>region_options, region_count, 
	  region</em> present if <em>on</em> </TD>
	</TR>
	</table>
	<h4>Region Options:</h4>
	<table BORDER =1 WIDTH="500">
	<TR> 
	<TD height=21 width=50>0x01</TD>
	<TD height=21 width=390>World Space, coordinates are points in modelling 
	  coordinates, rather than window coordinates, if <em>on</em></TD>
	</TR>
	<tr> 
	<td WIDTH=50 HEIGHT=21>0x02</td>
	<td WIDTH=390 HEIGHT=21>Relative Coordinates, region is specified relative 
	  to the text insertion point, rather than absolute coordinates, if <em>on</em></td>
	</tr>
	</table>

Version 6.00 and before only supported a simple ``Byte length``. Options and Text Region added in 10.02.
