Rob: /* The "image_field" Element */

2008-12-02T11:02:22Z

The "image_field" Element

← Older revision		Revision as of 11:02, 2 December 2008
Line 5:		Line 5:
	The role of the "output_image" element is an amalgam of the various "image" elements, except that it is designed for use exclusively within character sheet output. Any images that you want to display within a sheet will require the use of an "output_image" element. The complete list of attributes for this element is below.		The role of the "output_image" element is an amalgam of the various "image" elements, except that it is designed for use exclusively within character sheet output. Any images that you want to display within a sheet will require the use of an "output_image" element. The complete list of attributes for this element is below.

	~~IMPORTANT!~~ Only one mechanism for specifying the image contents may be employed within a given output image portal. That means you may use '''either''' the "image" attribute '''or''' the "field" attribute to define the contents. Use of multiple mechanisms will result in a compilation error.		{{important}}Only one mechanism for specifying the image contents may be employed within a given output image portal. That means you may use '''either''' the "image" attribute '''or''' the "field" attribute to define the contents. Use of multiple mechanisms will result in a compilation error.

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

Rob: New page: {{context|Kit Reference|Data File Reference|Portal Element (Data)}} ==The "image_field" Element== The role of the "output_image" element is an amalgam of the various "image" elements, ex...

2008-12-02T11:01:56Z

New page: {{context|Kit Reference|Data File Reference|Portal Element (Data)}} ==The "image_field" Element== The role of the "output_image" element is an amalgam of the various "image" elements, ex...

New page

{{context|Kit Reference|Data File Reference|Portal Element (Data)}}

==The "image_field" Element==

The role of the "output_image" element is an amalgam of the various "image" elements, except that it is designed for use exclusively within character sheet output. Any images that you want to display within a sheet will require the use of an "output_image" element. The complete list of attributes for this element is below.

IMPORTANT! Only one mechanism for specifying the image contents may be employed within a given output image portal. That means you may use '''either''' the "image" attribute '''or''' the "field" attribute to define the contents. Use of multiple mechanisms will result in a compilation error.

:{| class="infotable"
|class="leftnormal"|image
|(Optional) Text – Specifies the filename of a bitmap image within the data file folder for the game system. The given image is displayed within the portal.
|-
|field
|(Optional) Id – Specifies the unique id of the field whose contents dictate the image to to be displayed within the portal. The field may contain a user-defined image, a reference image, or a filename of a bitmap image within the data file folder for the game system. The field must exist within the pick/thing associated with the containing template. If this portal is not defined within a template, a field-based image is not allowed.
|-
|istransparent
|(Optional) Boolean – Indicates whether the image should be treated as transparent, wherein the pixel color at position 0,0 is considered transparent throughout the image. Default: "no".
|-
|}

==Example==

The following example demonstrates what an output image portal might look like. All default values are assumed for optional attributes.

<pre>
<portal id="oHLLogo" style="outNormal">
<output_image image="sheet_hllogo.bmp"/>
</portal>

<portal id="image" style="outNormal">
<output_image field="acTacImage"/>
</portal>
</pre>

OutputImage Element (Data) - Revision history

Rob: /* The "image_field" Element */

Rob: New page: {{context|Kit Reference|Data File Reference|Portal Element (Data)}} ==The "image_field" Element== The role of the "output_image" element is an amalgam of the various "image" elements, ex...