Chapter 3.2: Layout File Format (.layout)

Home | << Previous: Widget Types | Layout File Format | Next: Sizing & Positioning >>

Basic Structure

A .layout file defines a tree of widgets. Every file has exactly one root widget, which contains nested children.

WidgetTypeClass WidgetName {
 attribute value
 attribute "quoted value"
 {
  ChildWidgetTypeClass ChildName {
   attribute value
  }
 }
}

Key rules:

The root element is always a single widget (typically FrameWidgetClass).
Widget type names use the layout class name, which always ends with Class (e.g., FrameWidgetClass, TextWidgetClass, ButtonWidgetClass).
Each widget has a unique name following its type class.
Attributes are key value pairs, one per line.
Attribute names containing spaces must be quoted: "text halign" center.
String values are quoted: text "Hello World".
Numeric values are unquoted: size 0.5 0.3.
Children are nested inside { } blocks after the parent's attributes.

Attribute Reference

Positioning & Sizing

Attributum	Ertekek	Leiras
`position`	`x y`	Widget position (proportional 0-1 or pixel values)
`size`	`w h`	Widget dimensions (proportional 0-1 or pixel values)
`halign`	`left_ref`, `center_ref`, `right_ref`	Horizontal alignment reference point
`valign`	`top_ref`, `center_ref`, `bottom_ref`	Vertical alignment reference point
`hexactpos`	`0` or `1`	0 = proportional X position, 1 = pixel X position
`vexactpos`	`0` or `1`	0 = proportional Y position, 1 = pixel Y position
`hexactsize`	`0` or `1`	0 = proportional width, 1 = pixel width
`vexactsize`	`0` or `1`	0 = proportional height, 1 = pixel height
`fixaspect`	`fixwidth`, `fixheight`	Maintain aspect ratio by constraining one dimension
`scaled`	`0` or `1`	Scale with DayZ UI scaling setting
`priority`	integer	Z-order (higher values render on top)

The hexactpos, vexactpos, hexactsize, and vexactsize flags are the most important attributes in the entire layout system. They control whether each dimension uses proportional (0.0 - 1.0 relative to parent) or pixel (absolute screen pixels) units. See 3.3 Meretezees es pozicionalas for a thorough explanation.

Visual Attributes

Attributum	Ertekek	Leiras
`visible`	`0` or `1`	Initial visibility (0 = hidden)
`color`	`r g b a`	Color as four floats, each 0.0 to 1.0
`style`	style name	Predefined visual style (e.g., `Default`, `Colorable`)
`draggable`	`0` or `1`	Widget can be dragged by the user
`clipchildren`	`0` or `1`	Clip child widgets to this widget's bounds
`inheritalpha`	`0` or `1`	Children inherit this widget's alpha value
`keepsafezone`	`0` or `1`	Keep widget within screen safe zone

Behavioral Attributes

Attributum	Ertekek	Leiras
`ignorepointer`	`0` or `1`	Widget ignores mouse input (clicks pass through)
`disabled`	`0` or `1`	Widget is disabled
`"no focus"`	`0` or `1`	Widget cannot receive keyboard focus

Text Attributes

These apply to TextWidgetClass, RichTextWidgetClass, MultilineTextWidgetClass, ButtonWidgetClass, and other text-bearing widgets.

Attributum	Ertekek	Leiras
`text`	`"string"`	Default text content
`font`	`"path/to/font"`	Font file path
`"text halign"`	`left`, `center`, `right`	Horizontal text alignment within the widget
`"text valign"`	`top`, `center`, `bottom`	Vertical text alignment within the widget
`"bold text"`	`0` or `1`	Bold rendering
`"italic text"`	`0` or `1`	Italic rendering
`"exact text"`	`0` or `1`	Use exact pixel font size instead of proportional
`"exact text size"`	integer	Font size in pixels (requires `"exact text" 1`)
`"size to text h"`	`0` or `1`	Resize widget width to fit text
`"size to text v"`	`0` or `1`	Resize widget height to fit text
`"text sharpness"`	float	Text rendering sharpness
`wrap`	`0` or `1`	Enable word wrapping

Image Attributes

These apply to ImageWidgetClass.

Attributum	Ertekek	Leiras
`image0`	`"set:name image:name"`	Primary image from an imageset
`mode`	`blend`, `additive`, `stretch`	Image blend mode
`"src alpha"`	`0` or `1`	Use the source alpha channel
`stretch`	`0` or `1`	Stretch image to fill widget
`filter`	`0` or `1`	Enable texture filtering
`"flip u"`	`0` or `1`	Flip image horizontally
`"flip v"`	`0` or `1`	Flip image vertically
`"clamp mode"`	`clamp`, `wrap`	Texture edge behavior
`"stretch mode"`	`stretch_w_h`, etc.	Stretch mode

Spacer Attributes

These apply to WrapSpacerWidgetClass and GridSpacerWidgetClass.

Attributum	Ertekek	Leiras
`Padding`	integer	Inner padding in pixels
`Margin`	integer	Space between child items in pixels
`"Size To Content H"`	`0` or `1`	Resize width to match children
`"Size To Content V"`	`0` or `1`	Resize height to match children
`content_halign`	`left`, `center`, `right`	Child content horizontal alignment
`content_valign`	`top`, `center`, `bottom`	Child content vertical alignment
`Columns`	integer	Grid columns (GridSpacer only)
`Rows`	integer	Grid rows (GridSpacer only)

Button Attributes

Attributum	Ertekek	Leiras
`switch`	`toggle`	Makes the button a toggle (stays pressed)
`style`	style name	Visual style for the button

Slider Attributes

Attributum	Ertekek	Leiras
`"fill in"`	`0` or `1`	Show a filled track behind the slider handle
`"listen to input"`	`0` or `1`	Respond to mouse input

Scroll Attributes

Attributum	Ertekek	Leiras
`"Scrollbar V"`	`0` or `1`	Show vertical scrollbar
`"Scrollbar H"`	`0` or `1`	Show horizontal scrollbar

Script Integration

The `scriptclass` Attribute

The scriptclass attribute binds a widget to an Enforce Script class. When the layout is loaded, the engine creates an instance of that class and calls its OnWidgetScriptInit(Widget w) method.

FrameWidgetClass MyPanel {
 size 1 1
 scriptclass "MyPanelHandler"
}

The script class must inherit from Managed and implement OnWidgetScriptInit:

class MyPanelHandler : Managed
{
    Widget m_Root;

    void OnWidgetScriptInit(Widget w)
    {
        m_Root = w;
    }
}

The ScriptParamsClass Block

Parameters can be passed from the layout to the scriptclass via a ScriptParamsClass block. This block appears as a second { } child block after the widget's children.

ImageWidgetClass Logo {
 image0 "set:dayz_gui image:DayZLogo"
 scriptclass "Bouncer"
 {
  ScriptParamsClass {
   amount 0.1
   speed 1
  }
 }
}

The script class reads these parameters in OnWidgetScriptInit by using the widget's script param system.

DabsFramework ViewBinding

In mods that use DabsFramework MVC, the scriptclass "ViewBinding" pattern connects widgets to a ViewController's data properties:

TextWidgetClass StatusLabel {
 scriptclass "ViewBinding"
 "text halign" center
 {
  ScriptParamsClass {
   Binding_Name "StatusText"
   Two_Way_Binding 0
  }
 }
}

Param	Leiras
`Binding_Name`	Name of the ViewController property to bind to
`Two_Way_Binding`	`1` = UI changes push back to the controller
`Relay_Command`	Function name on the controller to call when the widget is clicked/changed
`Selected_Item`	Property to bind the selected item to (for lists)
`Debug_Logging`	`1` = enable verbose logging for this binding

Children Nesting

Children are placed inside a { } block after the parent's attributes. Multiple children can exist in the same block.

FrameWidgetClass Parent {
 size 1 1
 {
  TextWidgetClass Child1 {
   position 0 0
   size 1 0.1
   text "First"
  }
  TextWidgetClass Child2 {
   position 0 0.1
   size 1 0.1
   text "Second"
  }
 }
}

Children are always positioned relative to their parent. A child with position 0 0 and size 1 1 (proportional) fills its parent completely.

Teljes kommentezett pelda

Here is a fully annotated layout file for a notification panel -- the kind of UI you might build for a mod:

// Root container -- invisible frame that covers 30% of screen width
// Centered horizontally, positioned at top of screen
FrameWidgetClass NotificationPanel {

 // Start hidden (script will show it)
 visible 0

 // Don't block mouse clicks on things behind this panel
 ignorepointer 1

 // Blue tint color (R=0.2, G=0.6, B=1.0, A=0.9)
 color 0.2 0.6 1.0 0.9

 // Position: 0 pixels from left, 0 pixels from top
 position 0 0
 hexactpos 1
 vexactpos 1

 // Size: 30% of parent width, 30 pixels tall
 size 0.3 30
 hexactsize 0
 vexactsize 1

 // Center horizontally within parent
 halign center_ref

 // Children block
 {
  // Text label fills the entire notification panel
  TextWidgetClass NotificationText {

   // Also ignore mouse input
   ignorepointer 1

   // Position at origin relative to parent
   position 0 0
   hexactpos 1
   vexactpos 1

   // Fill parent completely (proportional)
   size 1 1
   hexactsize 0
   vexactsize 0

   // Center the text both ways
   "text halign" center
   "text valign" center

   // Use a bold font
   font "gui/fonts/Metron-Bold"

   // Default text (will be overridden by script)
   text "Notification"
  }
 }
}

And here is a more complex example -- a dialog with a title bar, scrollable content, and a close button:

WrapSpacerWidgetClass MyDialog {
 clipchildren 1
 color 0.7059 0.7059 0.7059 0.7843
 size 0.35 0
 halign center_ref
 valign center_ref
 priority 998
 style Outline_1px_BlackBackground
 Padding 5
 "Size To Content H" 1
 "Size To Content V" 1
 content_halign center
 {
  // Title bar row
  FrameWidgetClass TitleBarRow {
   size 1 26
   hexactsize 0
   vexactsize 1
   draggable 1
   {
    PanelWidgetClass TitleBar {
     color 0.4196 0.6471 1 0.9412
     size 1 25
     style rover_sim_colorable
     {
      TextWidgetClass TitleText {
       size 0.85 0.9
       text "My Dialog"
       font "gui/fonts/Metron"
       "text halign" center
       "text valign" center
      }
      ButtonWidgetClass CloseBtn {
       size 0.15 0.9
       halign right_ref
       text "X"
      }
     }
    }
   }
  }

  // Scrollable content area
  ScrollWidgetClass ContentScroll {
   size 0.97 235
   hexactsize 0
   vexactsize 1
   "Scrollbar V" 1
   {
    WrapSpacerWidgetClass ContentItems {
     size 1 0
     hexactsize 0
     "Size To Content V" 1
    }
   }
  }
 }
}

Gyakori hibak

A Class utotagrol valo megfeledkezes -- A layoutokban ird: TextWidgetClass, ne TextWidget.
Aranyos es pixeles ertekek keverese -- Ha hexactsize 0, a meretertek 0.0-1.0 aranyos. Ha hexactsize 1, pixeles ertekek. 300 hasznalata aranyos modban a szulo szelessegenek 300-szorosat jelenti.
Tobbszovas atributumok idezojel nelkul -- Ird: "text halign" center, ne text halign center.
ScriptParamsClass rossz blokkba helyezese -- Kulon { } blokkban kell lennie a gyermekblokk utan, nem belul.

Legjobb gyakorlatok

Mindig allitsd be mind a negy exact flaget (hexactpos, vexactpos, hexactsize, vexactsize) kifejezetten minden widgeten. Az alapertelmezett ertekekre valo tamaszkodas ketseges layoutokhoz vezet, amelyek eltorodnek a szulo struktura valtozasakor.
Hasznald a scriptclass-t takarekosan -- csak azokon a widgeteken, amelyeknek tenyleg szukseguk van script-vezerelt viselkedesre. A tulzott kottes inicializacios terhelest jelent.
Nevezd el a widgeteket leirojon (PlayerListScroll, TitleBarClose) ahelyett, hogy generikusan (Frame1, btn). A script kod a FindAnyWidget()-et nev alapjan hasznalja, es az utkozesek csendes hibahoz vezetnek.
Tartsd a layout fajlokat 200 sor alatt. Oszd fel az osszetett UI-kat tobb .layout fajlra, amelyeket CreateWidgets()-szel toltesz be es programozan kapcsolsz a szulohoz.
Mindig tedd idezowjelbe a tobbszovas attributum neveket ("text halign", "Size To Content V"). Az idezet nelkuli tobbszovas attributumok csendben, hiba nelkul kudarcot vallanak.

Elmelet vs gyakorlat

Mit mond a dokumentacio az okhoz kepest, hogyan mukodnek a dolgok tenylegesen futasi idoben.

Koncept	Elmelet	Valosag
`scriptclass` inicializalas	`OnWidgetScriptInit` meghivasra kerul a layout betoltesekor	Ha az osztaly nem orokol a `Managed`-bol vagy konstruktor hibaja van, a widget betoltodik, de a kezelo csendben null
`ScriptParamsClass`	A parameterek tetszoleges adatokat adnak at a script osztalyoknak	Csak szoveges es szamertekek mukodnek megbizhatoan; beagyazott objektumok vagy tombok nem tamogatottak
`color` attributum	Negy float 0.0-1.0 (RGBA)	Egyes widget tipusok figyelmen kivul hagyjan az alfa csatornat vagy `inheritalpha 1`-et igenyelnek a szulon az atlatszoság tovabbitasahoz
Attributum alapertelmezesek	A nem dokumentalt attributumok a motor alapertelmezeit hasznaljak	Az alapertelmezesek widget tipusonkent elternek
`"no focus"`	Megakadalyozza a billentyuzet fokuszt	Megakadalyozza a gamepad kivalasztasat is, ami eltomheti a kontroller navigaciot, ha interaktiv widgeteken van beallitva

Kompatibilitas es hatas

Multi-Mod: A layout fajlok modonkent izoaltak -- nincs kozvetlen utkozos. Azonban a scriptclass neveknek globaliasan egyedinek kell lenniuk. Ket mod, amely scriptclass "PanelHandler"-t hasznal, az egyiket csendben meghibasitja.
Teljesitmeny: Minden widget egy layoutban valodi motor objektum. Az 500+ widgetes layoutok merheto FPS csokkenest okoznak. Nagy listakhoz reszesitsd elonyben a programozott poolingot.
Verzio: A layout formatum stabil a DayZ 1.0 ota. A ScriptParamsClass blokkot es a ViewBinding scriptclass-t a DabsFramework adta hozza, es nem vanilla funkciok.

Valos modokban megfigyelt mintak

Minta	Mod	Reszlet
`scriptclass "ViewBinding"` `ScriptParamsClass`-szal	DabsFramework / DayZ Editor	Ketiranyu adat kottes layoutok es ViewControllerek kozott a `Binding_Name` parameteren keresztul
`WrapSpacerWidgetClass` dialogus gyokerkent	COT, Expansion	Lehetove teszi a `Size To Content V/H`-t a dialogusok automatikus meretezesere a dinamikus tartalom korul
Kulon `.layout` lista soronkent	VPP Admin Tools	Minden jatekos sor onallo layout, WrapSpacerbe toltve, lehetove teve az ujrafelhasznalast es poolingot
`priority 998-999` modalis fedvenyekhez	DabsFramework, COT	Biztositja, hogy a dialogusok az osszes tobbi UI elem fole keruljenek

Kovetkezo lepesek

3.3 Meretezees es pozicionalas -- Sajatitsd el az aranyos vs. pixeles koordinata rendszert
3.4 Kontener widgetek -- Melysegu elmerules a spacer es scroll widgetekben

Chapter 3.2: Layout File Format (.layout) ​

Basic Structure ​

Attribute Reference ​

Positioning & Sizing ​

Visual Attributes ​

Behavioral Attributes ​

Text Attributes ​

Image Attributes ​

Spacer Attributes ​

Button Attributes ​

Slider Attributes ​

Scroll Attributes ​

Script Integration ​

The scriptclass Attribute ​

The ScriptParamsClass Block ​

DabsFramework ViewBinding ​

Children Nesting ​

Teljes kommentezett pelda ​

Gyakori hibak ​

Legjobb gyakorlatok ​

Elmelet vs gyakorlat ​

Kompatibilitas es hatas ​

Valos modokban megfigyelt mintak ​

Kovetkezo lepesek ​