ImageReference Element (Data)

From HLKitWiki
Jump to: navigation, search

Context: HL KitKit Reference … Data File Reference … Portal Element (Data) 

The "image_reference" Element

It is not possible to copy a field-based image (including user-added images) to another field. However, there are times when you'll want to do exactly that. Consequently, the Kit provides a mechanism for establishing a reference to an image field. The role of the "image_reference" element is to display the contents of one of these field references. The complete list of attributes for this element is below.

field Id – Specifies the unique id of the field whose contents dictate the image to to be displayed within the portal. The field must be a value-based field and it must contain a reference to another field that identifies an image. The field must exist within the pick/thing associated with the containing template. If this portal is not defined within a template, a reference-based image is not allowed.


The following example demonstrates what a referenace-based image portal might look like. All default values are assumed for optional attributes.

<portal id="image" style="imgNormal">
  <image_reference field="imageref"/>