Difference between revisions of "Lua:AddHudIcon"

From Fortress Forever Wiki
Jump to: navigation, search
m
m
 
Line 1: Line 1:
 
{{Infobox manual/Header}}
 
{{Infobox manual/Header}}
 +
{{Infobox mapping}}
 
==AddHudIcon==
 
==AddHudIcon==
  
Line 12: Line 13:
 
===Input===
 
===Input===
 
* player(CFFPlayer) A reference to the player receiving the icon
 
* 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)
 
* icon_id(string) a name for this icon (so we can remove it later)
 
* x(integer) horizontal position
 
* x(integer) horizontal position
Line 18: Line 19:
 
* w(integer) width of the icon
 
* w(integer) width of the icon
 
* h(integer) height 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
 
** 0: align to left
 
** 1: align to right
 
** 1: align to right

Latest revision as of 23:34, 1 May 2010


Mapping for FF
The Basics

Setting up Hammer
Getting Started With Lua
Releasing a map

FF-specific Entities

Lua location system

Map Templates
FF Lua Documentation

Entity Typing
Entity Collections

Commands
Callbacks

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. 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
  • y(integer) vertical position
  • w(integer) width of the icon
  • h(integer) height of the icon
  • align(integer) x alignment options.
    • 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 )