Lua:AddHudIcon

From Fortress Forever Wiki
Revision as of 12:00, 11 May 2009 by Crazycarl (Talk | contribs) (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 ...)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


AddHudIcon

Adds an icon to a player's screen

Usage

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

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

local player = CastToPlayer( player_entity )
AddHudIcon(player, "minimap.vtf", "mapoverlay", 0, 40, 128, 128, 1 )

Template:Reflist