Lua:AddHudIcon - Revision history

Crazycarl at 06:34, 2 May 2010

2010-05-02T06:34:14Z

Crazycarl at 06:32, 2 May 2010

2010-05-02T06:32:32Z

Crazycarl: New page: {{Infobox manual/Header}} ==AddHudIcon== Adds an icon to a player's screen ===Usage===

AddHudIcon(player, material, icon_id, x, y, w, h, align)

===Output=== Returns: nothing ...

2009-05-11T19:00:45Z

New page: {{Infobox manual/Header}} ==AddHudIcon== Adds an icon to a player's screen ===Usage=== <pre>AddHudIcon(player, material, icon_id, x, y, w, h, align)</pre> ===Output=== Returns: nothing ...

New page

{{Infobox manual/Header}}
==AddHudIcon==

Adds an icon to a player's screen

===Usage===
<pre>AddHudIcon(player, material, icon_id, x, y, w, h, align)</pre>

===Output===
Returns: nothing

===Input===
* player(CFFPlayer) A reference to the player receiving the icon
* material(string) the name of a vmt file to serve as the icon <ref name="material">the file name must end in .vtf; however it is actually looking up a vmt file. This .vmt must be located in located in FortressForever\materials\vgui\.</ref>
* icon_id(string) a name for this icon (so we can remove it later)
* x(integer) horizontal position
* y(integer) vertical position
* w(integer) width of the icon
* h(integer) height of the icon
* align(integer) x alignment options <ref name="units">Verify: what units are used for icon size and position?</ref>
** 0: align to left
** 1: align to right
** 2: align to left of center
** 3: align to right of center

===Example===
<pre>local player = CastToPlayer( player_entity )
AddHudIcon(player, "minimap.vtf", "mapoverlay", 0, 40, 128, 128, 1 )</pre>

{{Reflist}}
[[Category:HUD_Items]]
{{Infobox manual/Footer}}

@@ Line 1: / Line 1: @@
 {{Infobox manual/Header}}
 ==AddHudIcon==
@@ Line 12: / Line 13: @@
 ===Input===
 * player(CFFPlayer) A reference to the player receiving the icon
-* material(string) the name of a vmt file to serve as the icon the file name must end in .vtf; however it is actually looking up a vmt file. This .vmt must be located in located in FortressForever\materials\vgui\.
+* material(string) the name of a vmt file to serve as the icon. This string must end in .vtf--however it is actually looking up a vmt file. This .vmt must be located in FortressForever\materials\vgui\.
 * icon_id(string) a name for this icon (so we can remove it later)
 * x(integer) horizontal position
@@ Line 18: / Line 19: @@
 * w(integer) width of the icon
 * h(integer) height of the icon
-* align(integer) x alignment options Verify: what units are used for icon size and position?
+* align(integer) x alignment options.
 ** 0: align to left
 ** 1: align to right