Cockpit Reference - Revision history

Cadillac at 02:11, 23 August 2021

2021-08-23T02:11:39Z

← Older revision		Revision as of 22:11, 22 August 2021
Line 191:		Line 191:

	The widget will always be aligned from the bottom-left corner.		The widget will always be aligned from the bottom-left corner.

			[[Category:Customization]]

Epsy: /* Common Attributes */ added blurb and camera attr info

2013-03-13T00:03:09Z

Common Attributes: added blurb and camera attr info

@@ Line 29: / Line 29: @@
 ==Common Attributes==
 ===camera===
 ===viewport===

Epsy: /* Compatibility mode */ Added widget specificities

2013-03-12T22:40:11Z

Compatibility mode: Added widget specificities

← Older revision		Revision as of 18:40, 12 March 2013
Line 143:		Line 143:
	===Old coordinate system===		===Old coordinate system===

	In the old coordinate system, <code><Position></code>'s coordinate system resizes to fit the output size so that <code>y=-1</code> is at the bottom of the output, <code>y=0.5</code> is at the top of the output, <code>x=-1</code> is at the left edge of the output, and <code>x=1</code> is at the right edge of the output. <code><Size></code> operates on the same scale, but measures '''half''' the width and height of the object, as if from center to edge.		In the old coordinate system, <code><Position></code>'s coordinate system resizes to fit the output size so that <code>y=-1</code> is at the bottom of the output, <code>y=0.5</code> is at the top of the output, <code>x=-1</code> is at the left edge of the output, and <code>x=1</code> is at the right edge of the output. This coordinate system is shifted if using an <code><Anchor></code> different than <code>0,0.33</code>. <code><Size></code> operates on the same scale, but measures '''half''' the width and height of the object, as if from center to edge. <code><Anchor></code>'s <code>minadjust</code> and <code>maxadjust</code> are ignored.
	This is an illustration of the coordinate system:
			This is an illustration of the old coordinate system. Note that 0.5 on the y axis is always the top of the screen.

	[[Image:Cockpit Coordinate System.png\|center\|illustration of the coordinate system]]		[[Image:Cockpit Coordinate System.png\|center\|illustration of the coordinate system]]

			===Label===

			The widget will always be aligned from the top left corner, the width will be halved and used to horizontally space cells, the height will be used as text size. Setting cell dimensions is unsupported and the table is locked in auto-sizing mode.

			===BarGauge===

			The gauge body will only occupy the top half of the allocated room, the other half being reserved for captions.

			===Camview===

			The widget will always be aligned from the bottom-left corner.

Epsy: /* Common Tags */ Fixed incorrect heading

2013-03-12T18:46:26Z

Common Tags: Fixed incorrect heading

← Older revision		Revision as of 14:46, 12 March 2013
Line 73:		Line 73:
	You would be telling Armagetron to position your widget close to the bottom left-hand corner, a fraction away from the edge of the output. It would be at an equal distance from the left and bottom edge of the screen, regardless of the output's aspect ratio.		You would be telling Armagetron to position your widget close to the bottom left-hand corner, a fraction away from the edge of the output. It would be at an equal distance from the left and bottom edge of the screen, regardless of the output's aspect ratio.

	===Size and Align===		====Size and Align====

	The <code><Anchor></code> and <code><Position></code> tags have so far positioned a point on the screen.		The <code><Anchor></code> and <code><Position></code> tags have so far positioned a point on the screen.
Line 85:		Line 85:
	<code><Align></code> is a convenience tag that lets you redefine how the widget aligns with its set position. It positions a point relative to the widget body, like <code><Anchor></code> sets a point relative to the output area.		<code><Align></code> is a convenience tag that lets you redefine how the widget aligns with its set position. It positions a point relative to the widget body, like <code><Anchor></code> sets a point relative to the output area.

	===Adjusting position and size depending on aspect ratio===		====Adjusting position and size depending on aspect ratio====

	The <code><Anchor></code> tag also accepts <code>minadjust</code> and <code>maxadjust</code> attributes. When the widget is processed, its <code><Position></code> and <code><Size></code> are multiplied by a factor. This factor is determined by dividing the output height by its width, then clamping that value so that it is at least <code>minadjust</code>'s value and at most <code>maxadjust</code>'s value. Those attributes both default to 1, so that no change is made by default.		The <code><Anchor></code> tag also accepts <code>minadjust</code> and <code>maxadjust</code> attributes. When the widget is processed, its <code><Position></code> and <code><Size></code> are multiplied by a factor. This factor is determined by dividing the output height by its width, then clamping that value so that it is at least <code>minadjust</code>'s value and at most <code>maxadjust</code>'s value. Those attributes both default to 1, so that no change is made by default.

Epsy: Started a section about the infamous oldcoord mode.

2013-03-12T15:29:04Z

Started a section about the infamous oldcoord mode.

← Older revision		Revision as of 11:29, 12 March 2013
Line 131:		Line 131:

	==Related settings==		==Related settings==

			==Compatibility mode==

			Compatibility mode is activated on a widget when it either:

			* has no <code><Anchor></code> tag,
			* has an <code><Anchor></code> tag with its <code>oldcoord</code> attribute set to <code>true</code>.

			When it is activated, the game will emulate the old coordinate system used for positioning widgets, and emulate quirks within the widgets themselves.

			===Old coordinate system===

			In the old coordinate system, <code><Position></code>'s coordinate system resizes to fit the output size so that <code>y=-1</code> is at the bottom of the output, <code>y=0.5</code> is at the top of the output, <code>x=-1</code> is at the left edge of the output, and <code>x=1</code> is at the right edge of the output. <code><Size></code> operates on the same scale, but measures '''half''' the width and height of the object, as if from center to edge.
			This is an illustration of the coordinate system:

			[[Image:Cockpit Coordinate System.png\|center\|illustration of the coordinate system]]

Epsy: /* Position and Size */ Added section content for and tags, and for the min-/maxadjust parameters

2013-03-12T15:05:56Z

Position and Size: Added section content for <Align> and <Size> tags, and for the min-/maxadjust <Anchor> parameters

@@ Line 45: / Line 45: @@
 # <code><Anchor></code> designates an anchor relative to the total output area. -1,-1 is the lower-left corner of the output, 1,1 is the higher-left corner.
 # <code><Position></code> positions the widget, relative to the anchor you defined. One unit in a direction is the same amount of pixels than one unit in any other direction.
 # <code><Size></code> gives the size of the widget. The units are also squares of pixels.
 ====Anchor and Position====
@@ Line 60: / Line 60: @@
 <div style="text-align: center">[[File:CockpitAnchor43.png|On a 4:3 output]] [[File:CockpitAnchor169.png|On a 16:9 output]]</div>
-It will always scale to have x=-1 at the left, x=1 at the right, y=-1 at the bottom and y=1 at the top of the output.
+It will always scale to have x=-1 at the left, x=1 at the right, y=-1 at the bottom and y=1 at the top of the output. If you do not set an anchor, [[#Compatibility mode|compatibility mode]] will be implicitly triggered on the widget.
 Once you have an anchor set, you can position your widget relative to it. The difference is that <code><Position></code>'s coordinate space always has a 1:1 ratio between width and height units.
@@ Line 72: / Line 72: @@
 You would be telling Armagetron to position your widget close to the bottom left-hand corner, a fraction away from the edge of the output. It would be at an equal distance from the left and bottom edge of the screen, regardless of the output's aspect ratio.
 ===Background, Foreground and LineColor===

Epsy: /* Position and Size */ Added graphics and text.

2013-01-17T18:05:47Z

Position and Size: Added <Position> graphics and text.

← Older revision		Revision as of 14:05, 17 January 2013
Line 58:		Line 58:
	Setting the anchor at -1,-1 tells Armagetron that you are about to put your widget near the bottom left-hand side of the output. If you put it at 1,1, then you'd be in the upper right-hand side. Here is the coordinate space used for the anchor tag, on 4:3 and 16:9 outputs, respectively:		Setting the anchor at -1,-1 tells Armagetron that you are about to put your widget near the bottom left-hand side of the output. If you put it at 1,1, then you'd be in the upper right-hand side. Here is the coordinate space used for the anchor tag, on 4:3 and 16:9 outputs, respectively:

	[[File:CockpitAnchor43.png\|On a 4:3 output]] [[File:CockpitAnchor169.png\|On a 16:9 output]]		<div style="text-align: center">[[File:CockpitAnchor43.png\|On a 4:3 output]] [[File:CockpitAnchor169.png\|On a 16:9 output]]</div>

	It will always scale to have x=-1 at the left, x=1 at the right, y=-1 at the bottom and y=1 at the top of the output.		It will always scale to have x=-1 at the left, x=1 at the right, y=-1 at the bottom and y=1 at the top of the output.

	Once you have an anchor set, you can position your widget relative to it. The difference is that <code><Position></code> ~~uses a different~~ coordinate space~~. 0,0 is at the anchor you defined, the output is 2 units wide,~~ and ~~the~~ units ~~vertically are the same size as they are horizontally~~.		Once you have an anchor set, you can position your widget relative to it. The difference is that <code><Position></code>'s coordinate space always has a 1:1 ratio between width and height units.

	[[File:CockpitPosition.png\|How Position's coordinate space works for the previous Anchor example.]]		<div style="text-align: center">[[File:CockpitPosition.png\|How Position's coordinate space works for the previous Anchor example.]][[File:CockpitPosition169.png\|The scale does not change with a different aspect ratio.]]</div>

			0,0 is at the anchor you defined and the output is 2 units wide. Here, the blue elements symbolize the total output area and the anchor coordinates. The red elements show the coordinate space for the position. As you can see from the dashed square, it does not get resized vertically. If you were to write:

			<Anchor x="-1" y="-1" />
			<Position x=".1" y=".1" />

			You would be telling Armagetron to position your widget close to the bottom left-hand corner, a fraction away from the edge of the output. It would be at an equal distance from the left and bottom edge of the screen, regardless of the output's aspect ratio.

	===Background, Foreground and LineColor===		===Background, Foreground and LineColor===

Epsy: /* Position and Size */ Completed part of the Anchor/Position ref

2013-01-17T05:00:13Z

Position and Size: Completed part of the Anchor/Position ref

← Older revision		Revision as of 01:00, 17 January 2013
Line 41:		Line 41:

	===Position and Size===		===Position and Size===

			Cockpit widgets are positioned with up to 4 tags:
			# <code><Anchor></code> designates an anchor relative to the total output area. -1,-1 is the lower-left corner of the output, 1,1 is the higher-left corner.
			# <code><Position></code> positions the widget, relative to the anchor you defined. One unit in a direction is the same amount of pixels than one unit in any other direction.
			# <code><Align></code> defines what point in the widget is being positioned. If unspecified, it defaults to the center.
			# <code><Size></code> gives the size of the widget. The units are also squares of pixels.

			====Anchor and Position====

			Not all players play Armagetron on the same kind of display. Some play it on a 4:3 resolution, while others use 16:9 or 16:10. Or they could be playing splitscreen, causing each player's cockpit to be 2:3 or 32:9. While those last two cases are a bit extreme, your cockpit has to be able to adapt to 4:3 or 16:9 without trouble. Armagetron used to have one coordinate system that went from -1 to 1 horizontally and from -1 to 0.5 vertically. It was tailored for 4:3 outputs so to adapt cockpits for 16:9 it would just squish the cockpit vertically to fit.

			This is no longer the case. Usually cockpit widgets are put near corners or edges of the output area. To help you do that, the <code><Anchor></code> tag lets you tell Armagetron just that. For instance:

			<Anchor x="-1" y="-1" />

			Setting the anchor at -1,-1 tells Armagetron that you are about to put your widget near the bottom left-hand side of the output. If you put it at 1,1, then you'd be in the upper right-hand side. Here is the coordinate space used for the anchor tag, on 4:3 and 16:9 outputs, respectively:

			[[File:CockpitAnchor43.png\|On a 4:3 output]] [[File:CockpitAnchor169.png\|On a 16:9 output]]

			It will always scale to have x=-1 at the left, x=1 at the right, y=-1 at the bottom and y=1 at the top of the output.

			Once you have an anchor set, you can position your widget relative to it. The difference is that <code><Position></code> uses a different coordinate space. 0,0 is at the anchor you defined, the output is 2 units wide, and the units vertically are the same size as they are horizontally.

			[[File:CockpitPosition.png\|How Position's coordinate space works for the previous Anchor example.]]

	===Background, Foreground and LineColor===		===Background, Foreground and LineColor===

Epsy: Added subsection skeleton for common attributes.

2013-01-17T03:02:59Z

Added subsection skeleton for common attributes.

← Older revision		Revision as of 23:02, 16 January 2013
Line 29:		Line 29:

	==Common Attributes==		==Common Attributes==

			===camera===

			===viewport===

			===toggleSticky, toggleDefault===

			===usetemplate===

	==Common Tags==		==Common Tags==
Line 53:		Line 61:

	===Camview===		===Camview===

	~~==Templates==~~

	==Related settings==		==Related settings==

Epsy: Created with a skeleton and the first section

2013-01-17T01:33:52Z

Created with a skeleton and the first section

New page

{{Cockpits Blurb}}

This page describes all the cockpit-related features available in the 0.4-cockpit branch. It has not been merged into 0.4 yet. The current features are explained on the [[Cockpit Tutorial]] page.

==The boilerplate==

<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<!DOCTYPE Resource SYSTEM "cockpit.dtd">

<Resource type="aacockpit" name="cockpit name" version="a version" author="your name" category="a category">
<Cockpit version="0.0.1">
Widgets go here
</Cockpit>
</Resource>

The attributes of the <code><Resource></code> tag form the path your cockpit will have to be placed at:

author/category/name-version.aacockpit.xml

If category is omitted or empty, the resource will be straight under the author directory. It can contain forward slashes, in which case the file will be several directories deep. See also [[Testing Resources]].

A few rules and recommendations:
* Don't use spaces/
* Don't use dashes(<code>-</code>) in the name.
* Use numbers or dotted numbers for your version. For example, you could use <code>1</code>, <code>1.5</code> or <code>0.4.3</code>. Make the version number increase as you publish updates and be consistent with the number of dots in it.
* Be consistent with your author name.

Inside the <code><Cockpit></code> tag is where the widgets go. A widget is an element on the HUD. Do '''not''' change the version on that tag. It may be used to introduce backward-compatibility changes in the future.

==Common Attributes==

==Common Tags==

===Position and Size===

===Background, Foreground and LineColor===

===Caption===

===DataSet===

==Widgets==

===Rectangle===

===BarGauge and VerticalBarGauge===

===NeedleGauge===

===Label===

===Map===

===Camview===

==Templates==

==Related settings==