Difference between revisions of "ISInterface:AddElement"

From Lavish Software Wiki
Jump to navigation Jump to search
 
 
Line 1: Line 1:
 
===Syntax===
 
===Syntax===
 
+
*bool AddElement(char *Name, char *Data, int X, int Y, unsigned long Color, char *Group="Default")
 
== Purpose ==
 
== Purpose ==
 
+
To add a HUD element
 
== Usage ==
 
== Usage ==
 
=== Parameters ===
 
=== Parameters ===
 
+
*char *Name
 +
:'''[in]''' Name of the HUD element to add
 +
*char *Data
 +
:'''[in]''' Data for the HUD element to display
 +
*int X
 +
:'''[in]''' X coordinate for the HUD element
 +
*int Y
 +
:'''[in]''' Y coordinate for the HUD element
 +
*unsigned long Color
 +
:'''[in]''' Color for the HUD element (hexadecimal)
 +
*char *Group
 +
:'''[in]''' ''Optional'' Group to put the HUD element in
 
=== Return Value ===
 
=== Return Value ===
 
+
*bool
 +
:Returns true on success, false on failure
 
== Examples ==
 
== Examples ==
 
+
===Add a HUD element===
 +
*pISInterface->AddElement("Height","${Display.Height}",250,300,FF0000FF);
  
 
== See Also ==
 
== See Also ==
 
* [[ISXDK:ISInterface|ISInterface]]
 
* [[ISXDK:ISInterface|ISInterface]]
 
+
* [[ISInterface:RemoveElement|RemoveElement]]
 
[[Category:ISXDK]]
 
[[Category:ISXDK]]
 
[[Category:ISInterface]]
 
[[Category:ISInterface]]

Latest revision as of 00:02, 3 September 2005

Syntax

  • bool AddElement(char *Name, char *Data, int X, int Y, unsigned long Color, char *Group="Default")

Purpose

To add a HUD element

Usage

Parameters

  • char *Name
[in] Name of the HUD element to add
  • char *Data
[in] Data for the HUD element to display
  • int X
[in] X coordinate for the HUD element
  • int Y
[in] Y coordinate for the HUD element
  • unsigned long Color
[in] Color for the HUD element (hexadecimal)
  • char *Group
[in] Optional Group to put the HUD element in

Return Value

  • bool
Returns true on success, false on failure

Examples

Add a HUD element

  • pISInterface->AddElement("Height","${Display.Height}",250,300,FF0000FF);

See Also