Resource Element (Data) - Revision history

Rob: /* The "font" Element{{anchor|font}} */

2008-12-04T09:09:24Z

The "font" Element{{anchor|font}}

← Older revision		Revision as of 09:09, 4 December 2008
Line 80:		Line 80:
	<li>315 – Text is rotated 315 degrees.</li>		<li>315 – Text is rotated 315 degrees.</li>
	<li>Default: "0"</li>		<li>Default: "0"</li>
			</ul>
	\|-		\|-
	\|}		\|}

Rob: /* The "font" Element{{anchor|font}} */

2008-12-04T09:09:05Z

The "font" Element{{anchor|font}}

← Older revision		Revision as of 09:09, 4 December 2008
Line 70:		Line 70:
	\|rotation		\|rotation
	\|(Optional) Set – Designates the rotation angle at which the text will be drawn in this font. Note that rotated text is not always supported in all situations. In addition, all default sizing of portals assumes no rotation is employed, so you'll need to perform your own proper sizing when you use rotated text. Must be one of the following:		\|(Optional) Set – Designates the rotation angle at which the text will be drawn in this font. Note that rotated text is not always supported in all situations. In addition, all default sizing of portals assumes no rotation is employed, so you'll need to perform your own proper sizing when you use rotated text. Must be one of the following:
	0 – No rotation is applied.		<ul class="sets">
	45 – Text is rotated 45 degrees.		<li>0 – No rotation is applied.</li>
	90 – Text is rotated 90 degrees.		<li>45 – Text is rotated 45 degrees.</li>
	135 – Text is rotated 135 degrees.		<li>90 – Text is rotated 90 degrees.</li>
	180 – Text is rotated 180 degrees.		<li>135 – Text is rotated 135 degrees.</li>
	225 – Text is rotated 225 degrees.		<li>180 – Text is rotated 180 degrees.</li>
	270 – Text is rotated 270 degrees.		<li>225 – Text is rotated 225 degrees.</li>
	315 – Text is rotated 315 degrees.		<li>270 – Text is rotated 270 degrees.</li>
	Default: "0"		<li>315 – Text is rotated 315 degrees.</li>
			<li>Default: "0"</li>
	\|-		\|-
	\|}		\|}

Rob at 11:31, 25 November 2008

2008-11-25T11:31:57Z

← Older revision		Revision as of 11:31, 25 November 2008
Line 1:		Line 1:
	{{~~context~~\|Kit ~~Reference\|Structural File~~ Reference}}		{{contextmulti\|Kit Reference}}

	==The "resource" Element==		==The "resource" Element==

	Everything associated with fonts, colors, bitmaps and borders is [[Using Visual Resources\|managed via resources]]. Each visual attribute used within your data files is specified through the use of a "resource" element. The complete list of attributes for this element is below.		Everything associated with fonts, colors, bitmaps and borders is [[Using Visual Resources\|managed via resources]]. Resources can be defined as top-level elements within structural files. However, they can also be defined as child elements within styles. This latter technique will be more commonly used for bitmaps, since those bitmaps can be defined in conjunction with the style that uses the bitmap (e.g. portals used as buttons and icons).

			Each visual attribute used within your data files is specified through the use of a "resource" element. The complete list of attributes for this element is below.

	:{\| class="infotable"		:{\| class="infotable"

Rob: /* Example */

2008-11-25T11:28:17Z

Example

← Older revision		Revision as of 11:28, 25 November 2008
Line 200:		Line 200:
	<resource id="border">		<resource id="border">
	<border>		<border>
	<topleft bitmap="~~brd_topleft~~.bmp"/>		<topleft bitmap="topleft.bmp"/>
	<topright bitmap="~~brd_topright~~.bmp"/>		<topright bitmap="topright.bmp"/>
	<bottomleft bitmap="~~brd_bottomleft~~.bmp"/>		<bottomleft bitmap="bottomleft.bmp"/>
	<bottomright bitmap="~~brd_bottomright~~.bmp"/>		<bottomright bitmap="bottomright.bmp"/>
	<left bitmap="~~brd_left~~.bmp"/>		<left bitmap="left.bmp"/>
	<top bitmap="~~brd_top~~.bmp"/>		<top bitmap="top.bmp"/>
	<right bitmap="~~brd_right~~.bmp"/>		<right bitmap="right.bmp"/>
	<bottom bitmap="~~brd_bottom~~.bmp"/>		<bottom bitmap="bottom.bmp"/>
	</border>		</border>
	</resource>		</resource>
	</pre>		</pre>

Rob: /* Example */

2008-11-25T11:27:53Z

Example

← Older revision		Revision as of 11:27, 25 November 2008
Line 182:		Line 182:

	<pre>		<pre>
			<resource id="color">
			<color color="ff0080"/>
			</resource>

			<resource id="font">
			<font face="Arial" size="40" style="bold"/>
			</resource>

			<resource id="bitmap">
			<bitmap bitmap="image.bmp"/>
			</resource>

			<resource id="solid">
			<solid color="00ff00" thickness="2"/>
			</resource>

			<resource id="border">
			<border>
			<topleft bitmap="brd_topleft.bmp"/>
			<topright bitmap="brd_topright.bmp"/>
			<bottomleft bitmap="brd_bottomleft.bmp"/>
			<bottomright bitmap="brd_bottomright.bmp"/>
			<left bitmap="brd_left.bmp"/>
			<top bitmap="brd_top.bmp"/>
			<right bitmap="brd_right.bmp"/>
			<bottom bitmap="brd_bottom.bmp"/>
			</border>
			</resource>
	</pre>		</pre>

Rob: /* The "border" Element{{anchor|border}} */

2008-11-25T11:20:45Z

The "border" Element{{anchor|border}}

← Older revision		Revision as of 11:20, 25 November 2008
Line 112:		Line 112:
	==The "border" Element{{anchor\|border}}==		==The "border" Element{{anchor\|border}}==

	The "border" element defines the facets of a bitmap-based border resource. Unlike most elements, this element possesses no attributes. However, it does have eight child elements that specify the different pieces of the border. The complete list of child elements is below.		The "border" element defines the facets of a bitmap-based border resource. Bitmap-based borders are comprised of eight bitmaps. There is one bitmap in each of the four corners around the visual element, plus four additional bitmaps that are used as a repeating pattern along each edge. Each bitmap may also be specified with a mask that is used to draw non-rectangular portions of the bitmap appropriately. Masks must always be monochrome bitmaps, since they identify which pixels of the primary bitmap are and are not drawn.

			Unlike most elements, this element possesses no attributes. However, it does have eight child elements that specify the different pieces of the border. The complete list of child elements is below.

	:{\| class="infotable"		:{\| class="infotable"
Line 140:		Line 142:
	\|-		\|-
	\|}		\|}

			{{important}}The bitmaps comprising a border must be symmetric. This means that six of the bitmaps must possess the same height and another six must possess the same width. Specifically, all bitmaps used across the top and bottom edges must have the same height, which includes: topleft, top, topright, bottomleft, bottom, and bottomright. In addition, all bitmaps used across the left and right edges must have the same width, which includes: topleft, left, bottomleft, topright, right, and bottomright.

	===Corner Elements{{anchor\|corner}}===		===Corner Elements{{anchor\|corner}}===
Line 150:		Line 154:
	\|-		\|-
	\|mask		\|mask
	\|(Optional) Text – Name of the file containing the monochromatic mask image to be used. This file must be placed in the same folder where all of the data files for the game system reside. If empty, the bitmap is assumed to be a solid rectangular region with no transparency. Default: Empty.		\|(Optional) Text – Name of the file containing the monochromatic mask image to be used. This file must have the same dimensions as the bitmap above and must be placed in the same folder where all of the data files for the game system reside. If empty, the bitmap is assumed to be a solid rectangular region with no transparency. Default: Empty.
	\|-		\|-
	\|xoffset		\|xoffset
Line 169:		Line 173:
	\|-		\|-
	\|mask		\|mask
	\|(Optional) Text – Name of the file containing the monochromatic mask image to be used. This file must be placed in the same folder where all of the data files for the game system reside. If empty, the bitmap is assumed to be a solid rectangular region with no transparency. Default: Empty.		\|(Optional) Text – Name of the file containing the monochromatic mask image to be used. This file must have the same dimensions as the bitmap above and must be placed in the same folder where all of the data files for the game system reside. If empty, the bitmap is assumed to be a solid rectangular region with no transparency. Default: Empty.
	\|-		\|-
	\|}		\|}

Rob: /* The "border" Element{{anchor|border}} */

2008-11-25T11:14:14Z

The "border" Element{{anchor|border}}

← Older revision		Revision as of 11:14, 25 November 2008
Line 147:		Line 147:
	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|bitmap		\|class="leftnormal"\|bitmap
	\|x –		\|Text – Name of the file containing the bitmap image to be used. This file must be placed in the same folder where all of the data files for the game system reside.
	\|-		\|-
	\|mask		\|mask
	\|x –		\|(Optional) Text – Name of the file containing the monochromatic mask image to be used. This file must be placed in the same folder where all of the data files for the game system reside. If empty, the bitmap is assumed to be a solid rectangular region with no transparency. Default: Empty.
	\|-		\|-
	\|~~x_offset~~		\|xoffset
	\|~~x –~~		\|Reserved for future use. Do not specify.
	\|-		\|-
	\|~~y_offset~~		\|yoffset
	\|~~x –~~		\|Reserved for future use. Do not specify.
	\|-		\|-
	\|}		\|}
Line 166:		Line 166:
	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|bitmap		\|class="leftnormal"\|bitmap
	\|x –		\|Text – Name of the file containing the bitmap image to be used. This file must be placed in the same folder where all of the data files for the game system reside.
	\|-		\|-
	\|mask		\|mask
	\|x –		\|(Optional) Text – Name of the file containing the monochromatic mask image to be used. This file must be placed in the same folder where all of the data files for the game system reside. If empty, the bitmap is assumed to be a solid rectangular region with no transparency. Default: Empty.
	\|-		\|-
	\|}		\|}

Rob at 11:01, 25 November 2008

2008-11-25T11:01:00Z

← Older revision		Revision as of 11:01, 25 November 2008
Line 116:		Line 116:
	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|[[#corner\|topleft]]		\|class="leftnormal"\|[[#corner\|topleft]]
	\|~~x –~~		\|Exactly one "topleft" child element must appear, specifying the upper left corner.
			\|-
			\|[[#corner\|topright]]
			\|Exactly one "topright" child element must appear, specifying the upper right corner.
			\|-
			\|[[#corner\|bottomleft]]
			\|Exactly one "bottomleft" child element must appear, specifying the lower left corner.
			\|-
			\|[[#corner\|bottomright]]
			\|Exactly one "bottomright" child element must appear, specifying the lower right corner.
			\|-
			\|[[#edge\|left]]
			\|Exactly one "left" child element must appear, specifying the left edge.
			\|-
			\|[[#edge\|top]]
			\|Exactly one "top" child element must appear, specifying the top edge.
	\|-		\|-
	\|x		\|[[#edge\|right]]
	\|~~x –~~		\|Exactly one "right" child element must appear, specifying the right edge.
	\|-		\|-
	\|x		\|[[#edge\|bottom]]
	\|~~x –~~		\|Exactly one "bottom" child element must appear, specifying the bottom edge.
	\|-		\|-
	\|}		\|}

	==Corner Elements{{anchor\|corner}}==		===Corner Elements{{anchor\|corner}}===

	There are four different corners within a border, resulting in four different child elements: "topleft", "topright", "bottomleft", and "bottomright". Each of these elements has the identical set of attributes, so they are all defined here in one place. The complete list of attributes for these elements is below.		There are four different corners within a border, resulting in four different child elements: "topleft", "topright", "bottomleft", and "bottomright". Each of these elements has the identical set of attributes, so they are all defined here in one place. The complete list of attributes for these elements is below.

	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|x		\|class="leftnormal"\|bitmap
			\|x –
			\|-
			\|mask
	\|x –		\|x –
	\|-		\|-
	\|x		\|x_offset
	\|x –		\|x –
	\|-		\|-
	\|x		\|y_offset
	\|x –		\|x –
	\|-		\|-
	\|}		\|}

	==Edge Elements{{anchor\|edge}}==		===Edge Elements{{anchor\|edge}}===

	There are four different edges within a border, resulting in four different child elements: "left", "top", "bottom", and "right". Each of these elements has the identical set of attributes, so they are all defined here in one place. The complete list of attributes for these elements is below.		There are four different edges within a border, resulting in four different child elements: "left", "top", "bottom", and "right". Each of these elements has the identical set of attributes, so they are all defined here in one place. The complete list of attributes for these elements is below.

	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|x		\|class="leftnormal"\|bitmap
	~~\|x –~~
	\|-
	\|x
	\|x –		\|x –
	\|-		\|-
	\|x		\|mask
	\|x –		\|x –
	\|-		\|-

Rob: /* The "border" Element{{anchor|border}} */

2008-11-25T10:55:47Z

The "border" Element{{anchor|border}}

@@ Line 112: / Line 112: @@
 ==The "border" Element{{anchor|border}}==
-The "border" element defines the facets of a bitmap-based border resource. The complete list of attributes for this element is below.
+The "border" element defines the facets of a bitmap-based border resource. Unlike most elements, this element possesses no attributes. However, it does have eight child elements that specify the different pieces of the border. The complete list of child elements is below.
 :{| class="infotable"

Rob: /* The "solid" Element{{anchor|solid}} */

2008-11-25T10:46:45Z

The "solid" Element{{anchor|solid}}

← Older revision		Revision as of 10:46, 25 November 2008
Line 101:		Line 101:
	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|color		\|class="leftnormal"\|color
	\|Text – Color value to be used in the format "~~xxxxx~~". The format for the color uses standard HTML color syntax, with each character representing a hexadecimal digit. The first two characters define the Red color value, the next two Green, and the last two Blue. For example, the color "ff0080" specifies a Red value of "ff", a Green value of "00", and a Blue value of "80".		\|Text – Color value to be used in the format "xxxxxx". The format for the color uses standard HTML color syntax, with each character representing a hexadecimal digit. The first two characters define the Red color value, the next two Green, and the last two Blue. For example, the color "ff0080" specifies a Red value of "ff", a Green value of "00", and a Blue value of "80".
	{{note}}For additional details on specifying colors via the HTML syntax, please refer to one of the many websites that provide this information, such as		{{note}}For additional details on specifying colors via the HTML syntax, please refer to one of the many websites that provide this information, such as
	[http://www.w3schools.com/Html/html_colors.asp http://www.w3schools.com/Html/html_colors.asp].		[http://www.w3schools.com/Html/html_colors.asp http://www.w3schools.com/Html/html_colors.asp].