Beginner Guide to Styling Syntax

[grohn]

Beginner Guide to Styling Syntax

Starting your mod:
The first step to creating a UI mod is to extract the necessary text files from the game data.
For details on how to do this, see this tutorial. (http://forums.heroesofnewerth.com/showthread.php?t=12217)
When you are done making your mod, you will need to compress it back into an s2z format for distribution.
Alternately (and preferably), you can make a .honmod, instead of a .s2z, for you with HoN Modification Manager. (http://forums.heroesofnewerth.com/showthread.php?t=25883)

Ok, so now that you have extracted your files to /Heroes of Newerth/game/ui, open the file you want to modify with a text editor (I recommend notepad++ (http://notepad-plus.sourceforge.net/uk/site.htm))

XML Syntax:
All the UI code is programmed in an XML syntax.

Elements:
The code consists of a series of elements. An example of an element would be:

<panel />
This creates a panel element.

All elements must be closed. There are two ways of doing this:

<panel />

<panel></panel>
Both examples are the same. The first is simpler, however the second allows you to use "nesting" (discussed later)


There are many different types of elements. For a full list, see: HoNWiki (http://honwiki.net/wiki/XAML_reference)
In this tutorial, I will cover the following simple elements:
-panel
-frame
-label

Attributes:
Within your element is a series of attributes.
Attributes define the specific properties of the element.
Attributes are defined in the following manner.

<element attribute1="value" attribute2="value" attribute3="value" />
So, for example:

<panel name="demo" x="100" y="100" color="red" />
This would create a panel element. In this case, there are four attributes: name, x, y, color. Each of these attributes has their own value. (The purpose of each attribute is discussed later.)

The order of the attributes does not matter.

Likewise, whitespace (the number of spaces or line breaks between words) does not matter.

So,

<panel name="demo" x="100" y="100" color="red" />
is the same as

<panel
name="demopanel"
x="100"
y="100"
color="red"
/>

Furthermore, when dealing with attributes that take a boolean (that is, "true" or "false"), you can use 1 and 0 instead.
That is, a value of "1" is the same as "true"
A value of "0" is the same as "false"

Nesting:
Nesting refers to "stacking" elements inside eachother. Doing this allows you to easily position and manipulate many different, related elements, at the same time.

The following is an example of nesting:

<panel name="parentpanel">
<panel name="childpanel" />
</panel>
The outside panel is called the parent.
The inside panel is called the child.

You can nest elements as many times as you want, such as:

<panel name="A">
<frame name="B">
<panel name="C">
<label />
<label />
</panel>
</frame>
</panel>
This example has four levels of nesting.
A is the parent of B. B is a parent of C. C is the parent of the two labels.

Note: Keep in mind, an element's parent may be the interface itself.

Remember: all elements must be closed. The order which you close them must match the order which you created them.

Visibility:
The visible attribute is used by all the simple element types.
Quite simply, it determines whether or not a panel is able to be seen or interacted with.

<panel visible="true"/>
will be visible. However,

<panel visible="false"/>
will not be visible.

Note: The default value is true. In other words, if you do not type out a visibility attribute, the element will still be visible.

Another important thing to remember about the visible attribute is that it affects all children when nesting. In other words, if the parent element is not visible, none of its children will be visible. This can be useful for hiding or showing many different elements at the same time.

Order of Display:
Elements which are placed at the top of the code are rendered first: They will be behind other interface elements.
On the other hand, elements that are at the bottom of the code are rendered last. They will appear in front of all other elements, and will never be covered by other elements.

<panel color="blue" width="200" height="200">
<panel color="lime" x="25" y="25" width="100" height="100"/>
<panel color="yellow" x="50" y="50" width="100" height="100"/>
<panel color="orange" x="75" y="75" width="100" height="100"/>
</panel>
http://img191.imageshack.us/img191/5453/tempimgn.png
Notice how the lime panel appears first in the code. It is covered by the two subsequent panels.

However, you can reverse this order with the reverse attribute. This will cause the children of the element to be rendered in the opposite order.

<panel color="blue" width="200" height="200" reverse="true">
<panel color="lime" x="25" y="25" width="100" height="100"/>
<panel color="yellow" x="50" y="50" width="100" height="100"/>
<panel color="orange" x="75" y="75" width="100" height="100"/>
</panel>
http://img402.imageshack.us/img402/2221/tempimg.png
Note how the panels appear in the opposite order.


Position and Sizing:
For this part of the tutorial, I will be using the panel element. A panel is simply a rectangle. It can be colored, or have an image in it.

Let's take a basic panel:

<panel x="100" y="100" width="200" height="200" color="blue" />
This is what it looks like ingame:
http://img69.imageshack.us/img69/2221/tempimg.png
The purpose of the attributes are self explanatory, but I will clarify anyway:
x:The x offset of the panel. A positive value will shift the panel to the right, a negative will shift it to the left. "100" means 100 pixels.
y:The y offset of the panel. A positive value will shift the panel to down, a negative will shift it up. "100" means 100 pixels.
width: The width of the panel. "200" means 200 pixels.
height: The height of the panel. "200" means 200 pixels.
color: The color of the panel. There are several ways to define a color (explained later).

Let's take a closer look with the following diagram:
http://img686.imageshack.us/img686/2221/tempimg.png




The x and y attributes always refer to the parent of the element. In the previous example, the parent was the interface itself, which covers the entire screen.
Let's look at another example, this time with nested elements.

<panel color="blue" x="100" y="100" width="200" height="200">
<panel color="lime" x="75" y="50" width="100" height="100" />
</panel>
http://img191.imageshack.us/img191/2221/tempimg.png

You can also use a negative value:

<panel color="blue" x="100" y="100" width="200" height="200">
<panel color="lime" x="-75" y="50" width="100" height="100" />
</panel>
http://img85.imageshack.us/img85/2221/tempimg.png

Using dimensions other than pixels:
Up to this point, I have only specified x, y, width, and height in the number of pixels.
However, this method is rarely, if ever, used in practice. The reason for this is to ensure that the interface doesn't look different on an 800x600 than a 1920x1200 monitor
Instead, there are several more practical dimensions that can be used instead.

h:
This is the most common method, and you will find this throughout S2's code.
One h refers to 1% of the screen height.
For example, if you are using a 1024x768 resolution monitor, one h would be 7.68 pixels.
However, if you are using a 1680x1050 resolution monitor, one h would be 10.5 pixels.

Note: you can also use w, instead of h. While h refers to 1% of the screen height, w refers to 1% of the screen width.

For example:

<panel width="10.4h" height="10.8h" x="15h" y="10h"/>
When using a 1024x768 resolution, this panel is 80 pixels wide, and 83 pixels high.
However, with a 1680x1050 resolution, this panel is 109 pixels wide, and 113 pixels high.


%:
The % refers to the percent of the parent element's width or height.

For example:

<panel color="blue" width="200" height="200">
<panel color="lime" width="50%" height="100%" />
</panel>
http://img94.imageshack.us/img94/2221/tempimg.png
Notice how the green child element is exactly 50% of the width of it's parent, the blue panel.

% also works with x and y.

<panel color="blue" width="200" height="100">
<panel color="lime" x="5%" y="20%" width="50%" height="50%" />
</panel>
http://img42.imageshack.us/img42/2221/tempimg.png
The x of the child is 5% of 200.
The y of the child is 20% of 100.
The width of the child is 50% of 200.
The height of the child is 50% of 100.

Remember: The parent of an element may be the interface itself. If this is the case, % will refer to the entire size of the screen.

Note: The default width and height is 100%. This means that if you do not specify a width or a height, the element will completely fill its parent.

@:
@ is similar to %, but with one big difference.
If you set an element's width to be, let's say, 50%, it will have a width of 50% of the width of its parent.
However, if you set an element's width to be 50@, it will have a width of 50% of the height of its parent.

Likewise, if you set an element's height to be 50%, it will have a height of 50% of the height of its parent.
If you set an element's height to be 50@, it will have a height of 50% of the width of its parent.

For example:

<panel color="blue" width="200" height="50">
<panel color="lime" width="100@" height="100%" />
</panel>
http://img109.imageshack.us/img109/2221/tempimg.png
Notice how the height of the parent element is 50 pixels.
The child, has a width of 100@. That means that it's width will be equal to 100% of the parent's height. This means that the child will have a width of 50 pixels.

+ and -:
The plus sign and the minus sign set the width in relation to the parent.

For example, if you have a parent width 200. And a child with width of "-75", the child's width will be 200-75 = 125.

<panel color="blue" width="200" height="200">
<panel color="lime" width="-75"/>
</panel>
http://img258.imageshack.us/img258/2221/tempimg.png

Or using a plus sign,

<panel color="blue" width="200" height="200">
<panel color="lime" width="+75" height="50"/>
</panel>
The lime panel is the child. Its width is 275.
http://img191.imageshack.us/img191/9923/tempimgm.png


Using align and valign:
Align and valign allow you to align an element with respect to a position other than the top left.


<panel color="blue" width="500" height="500">
<panel color="lime" align="see picture" valign="see picture" width="25%" height="25%" />
</panel>
http://img109.imageshack.us/img109/7586/tempimgx.png
Note: You can then use the x and y attributes to shift an element left, right, up, or down, after it has been properly aligned.

Coloring:
There are several ways to set the color of a panel or a frame element.
Using predefined colors:
Simply use a string that corresponds to a color. All the previous examples in this tutorial use this method.
For example,

color="blue"
color="red"
color="lime"
color="orange"
etc....

Using R G B A:
Another method is the use of red, green, blue, and alpha to define a color.
Alpha is the transparency of the element.
This takes the format:

color="R G B A"
Where each of these is a value from 0 to 1.
0 means not used, while 1 means fully saturated.
For alpha, 0 means completely transparent, 1 means fully opaque.
When using decimals, omit the preceding 0. (ie use .5 instead of 0.5)

So for example, a red panel would be

<panel color="1 0 0 1" x="50" y="50" width="100" height="100"/>
http://img12.imageshack.us/img12/2221/tempimg.png
Or a blue

<panel color="0 0 1 1" x="50" y="50" width="100" height="100"/>
http://img12.imageshack.us/img12/5880/tempimgj.png
Or an orange

<panel color="1 .5 0 1" x="50" y="50" width="100" height="100"/>
http://img260.imageshack.us/img260/2221/tempimg.png
Or a semi-transparent orange

<panel color="1 .5 0 .5" x="50" y="50" width="100" height="100"/>
http://img168.imageshack.us/img168/2221/tempimg.png

Using hexadecimal:
This is similar to R G B A, but it uses hexadecimal numbers from 0 to 255 instead of 0 to 1
This takes the format:

color="#RRGGBBAA"
Where each of these is a value from 0 to 255, using hexadecimal numbers.
Here's a hexadecimal guide (http://www.blythe.org/webwork/numbercolor.html).

For example, the semi transparent orange I made in the last section would be:

<panel color="#FF800080" x="50" y="50" width="100" height="100"/>

Styles:
The style element allows you to apply a predefined set of attributes to many different elements.

For example, let's say I specify the following style:

<style name="demo_style" color="red" width="100" height="200"/>
And then make the following panel:

<panel name="demo_panel" style="demo_style"/>
The "demo_panel" will have a red color, a width of 100, and a height of 200.


You can use any attribute with <style>, you are NOT limited to cosmetic attributes.

If you specify an attribute in style, and you specify the same attribute in the element it is used in, the attribute in the latter will be used. For example:

<style name="demo_style" color="red"/>
<panel name="demo_panel" style="demo_style" color="lime"/>
demo_panel will be lime colored, not red.

Clicking:
By default, all elements are clickable. This means that they will obstruct mouse clicks, and you will not be able to click buttons or terrain that they cover.
You can make it so an element does not obstruct mouse clicks by using the noclick attribute.

noclick="true"
noclick="false"

Furthermore, you can make it so that all the children of an element are unclickable by using the passivechildren attribute.

<panel name="A" passivechildren="true">
<panel name="B"/>
<panel name="C">
<panel name="D"/>
</panel>
</panel>
Panel A is still clickable. However, panels B, C, and D are not clickable.

Clicking events:
In order to make something happen when you click a panel, use the onclick attribute. Or, for right clicking, use the onrightclick attribute.
These will execute code when the element is clicked. I am not going to cover the syntax of this event code in this tutorial.

Furthermore, you can also use onmouseldown and onmouserdown to execute code when a player presses down the mouse button.
Then, you can use onmouselup and onmouserup to execute code when the player releases the mouse button.

Cangrab: The cangrab attribute allows the user to click and drag a panel. Think of the test menu in a practice game.

Elements other than panels:
Up to this point, I have only used the panel element for examples. There are many types of elements other than panels, each with a different purpose.

Frames:
frames are very similar to panels, however they have several differences.

Frames do not respond to any click events. They cannot use cangrab either.

Frames have a default color of grey. Panels, on the other hand, have a default color of invisible.

Frame Borders:
Frames can have a border, unlike panels.
To define the color of the border, use the bordercolor attribute.
To define the width of the border, use the borderthickness attribute.

For example:

<frame color="blue" bordercolor="lime" borderthickness="10" width="100" height="100" x="50" y="50"/>
http://img46.imageshack.us/img46/9923/tempimgm.png

Labels:
Labels are used to display text.
Text content:
There are two ways of setting the content of a label.

<label content="Your text here"/>
or

<label>Your text here</label>
If your text is longer than the label can fit, it will get cut off, unless you use the wrap attribute.

Font:
The fonts are called "dyn_#" where # corresponds to the size of the font.

<label font="dyn_12" content="Hello world!"/>

The font sizes are all dynamic. They will change based upon the screen height (similar to how h works)
For example, text with a font of dyn_10 will have a height of 1% of the screen height.
Text with a font of dyn_12 will have a height of 1.2% of the screen height.
Text with a font of dyn_14 will have a height of 1.4% of the screen height.

Aligning your text:
Use textalign and textvalign to align your text, similar to how you align elements.

Coloring the text:
The color attribute will set the color of the text. Labels cannot have a background.

For example:

<panel width="200" height="200" color="0 0 .2 1">
<label content="Hello World" font="dyn_14" color=".5 1 .5 1" textalign="center" textvalign="center"/>
</panel>
http://img121.imageshack.us/img121/2221/tempimg.png

________________________
Comments and criticism are welcome.

[grohn]

Reserved.

[Sephinator]

Nice guide, really helped me with some things. :)

[Paranoiac]

nice beginner guide, we are going to need a guide section soon haha.

[Tisser]

I love this guide! Really cleared a lot of things up for me.

However you're missing negative numbers on width and height.
I'm not sure about this, but I think that if you do like width="-2h" it means parent_width - 2h. Ergo it'll have 2h less width then it's parent.

[grohn]

I love this guide! Really cleared a lot of things up for me.

However you're missing negative numbers on width and height.
I'm not sure about this, but I think that if you do like width="-2h" it means parent_width - 2h. Ergo it'll have 2h less width then it's parent.

You are correct. I forgot about those, I'll add now.
You can also use a plus sign, like "+2h" and it will be 2h larger than it's parent.

[Welps]

Very cool guide! Helped me out quite a bit. :)

Was there a way to make an image appear instead of a color?

[MaxGhost]

texture="<path>" as an attribute.

[Welps]

Awesome thanks! That totally works. :D

[Whitesock]

This is so cool. I am terrible at coding, but I love making graphics, so I might try this someday to make a UI (if this is how it is done). :)

[Barter]

Order of Display:
Elements which are placed at the top of the code are rendered first: They will be behind other interface elements.
On the other hand, elements that are at the bottom of the code are rendered last. They will appear in front of all other elements, and will never be covered by other elements.
You can also reverse that order by using the attribute reverse in a panel to reverse the order of the elements inside it.
<panel reverse="1">
elements
</panel>

[Kyll3R]

Wow! Awesome!

[Sephinator]

Helped me too find those "hiding interface" code bugs. :)
Forgot some </panel>'s ^^

[grohn]

You can also reverse that order by using the attribute reverse in a panel to reverse the order of the elements inside it.
<panel reverse="1">
elements
</panel>
Thanks. Added.

[ElementUser]

Nice programming guide for HoN Mods :D

[kevs926]

the float means the child panels will be placed to the specified direction(bottom or right only) after the first one, the padding specifies the distance(2 pixels in this case) for the next panel. if you specify a point for child panels, then it will ignore float. if you specify only x for float="bottom" im not sure if it will affect float but im sure setting y affects the vertical floats

<panel y="100" x="100" height="100" width="100" padding="2" float="bottom" color="blue">
<panel height="25" color="orange"/>
<panel height="30" color="white"/>
<panel height="35" color="red"/>

</panel>
http://img690.imageshack.us/img690/4279/code1.png
ignore the leftmost pixels, those are cropping mistakes

right float


1 <panel y="400" x="400" height="100" width="100" float="right" color="blue">
2 <panel width="25" color="orange"/>
3 <panel width="30" color="white"/>
4 <panel width="35" color="red"/>
5 <panel width="10" color="0 0 0 .5"/>
6 </panel>

http://img36.imageshack.us/img36/3919/code2j.png

havent tried if right + bottom float will work

edit: This has a weird effect on reverse="true". The child panel at line5 is not the first one put to the leftmost and line4 should be placed to the right of line5 panel

someone pls kindly tell me how do i make something that is like float="left" or float="top"

[Zka_]

Amazing guide... seriously.. Im thinking about start making mods, and this guide helps A LOT!!

Simple Awesome. I was planning to make a new UI with CERO XML/XAML knowledge but now that I read this... I realized that it won't be any easy and now I know my way through those files.

My contribution for those that plan to make UI's:

As someone said above, you need to add "texture='texture path' />" so your panel has a cool look instead of a simple color. I've done some research with the texture files and found out a few things:

After unpacking the textures.s2z file, you will need a few things to actually edit/see them. Every texture comes as a *.DDS File and for some reason, which i haven't discovered yet, they come upside down.

Now, to view them you will need two things. Nvidia made 2 add-ons(pc addons) so you can view/edit these files. Links below.

http://developer.nvidia.com/object/dds_thumbnail_viewer.html -> Allows you to see the preview in desktop.

http://developer.nvidia.com/object/photoshop_dds_plugins.html -> Allows you to open/edit/view DDS files in photoshop.

I'll post again with new findings :)

[MaxGhost]

ZonPan that's known already. To use custom textures, make them .tga and keep them right-side up and store them in your resources file along with your .interface and .package files. textures.s2z should never be modified by users.

Well, guess what, I didn't know any of that, just wanted to "contribute" but apparently I didn't contribute at all.
Thanks for making me notice and yea I should probably read the forums before trying to help.

[BASH]

.tga - just use your picture like you would use it anywhere else, but be sure to add a channel for transparency if you need it
.png - you have to flip the picture horizontally in order to use it right

Thank you very much for this guide! It helped a lot.

[MaxGhost]

Well, guess what, I didn't know any of that, just wanted to "contribute" but apparently I didn't contribute at all.
Thanks for making me notice and yea I should probably read the forums before trying to help.

It's fine. I'm happy to see users learn things on their own. It proves that they know what they're doing unlike a handful of other modders. Can't wait to see what you end up making :)

Also, .tga generally looks better in the game than .png from my experiences.

[BadAssKicker]

This is the progress of a mod so far and I need help. I am customizing The Minor Totem Mod (http://forums.heroesofnewerth.com/showthread.php?t=112909) for my Big Hero Guide Mod (http://forums.heroesofnewerth.com/showthread.php?t=80633). I took screenshots of the guide I want to show ingame (Newti's Big Hero Guide (http://forums.heroesofnewerth.com/showthread.php?t=64274)), cut out the important information and put it in the mod, but why are the pictures so pixelated? You can't read it ingame. I tried .png, .tga, .jpg, always the same.

http://i298.photobucket.com/albums/mm244/Nabahr/th_screen-1.jpg (http://i298.photobucket.com/albums/mm244/Nabahr/screen-1.jpg)
(click on pic to enlarge)

Here is the code of the right side:


<panel width="500" height="450" x="520" y="110" color="black" noclick="true" >

<image x="0" y="0" width="498" height="396" noclick="true" nocompress="true" watch="TMTUpdate" ontrigger="if(StringEquals(*('tmt_' # tmt_source_name # '_notes'), 'Accursed'), SetTexture('/ui/images/tmt_accursed_notes.png'));" />

</panel>


EDIT: You have to use images 500+ % bigger than the original one. That way it looks good ingame.

[Imbisill]

This helped a lot, thanks a bunch.

A sticky wouldn't be wrong.

[Fuga]

Is there an event that would do something when a hon_player says X in allchat?

[uc]

This helped a lot, thanks a bunch.

A sticky wouldn't be wrong.
Yeah for the longest time i didn't know the difference between % and @