Difference between revisions of "ISKernel:HUD (Command)"

From Lavish Software Wiki
Jump to navigation Jump to search
 
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
== Syntax ==
 
== Syntax ==
 
{{CMD-DR|HUD|Intermediate|Intermediate|Intermediate|Intermediate}}
 
{{CMD-DR|HUD|Intermediate|Intermediate|Intermediate|Intermediate}}
HUD -list|-fontsize <#>|-remove <name>|-add <name> <#,#> <text>
+
HUD -list|-remove <name>|-add <name> <#,#> <text>
  
== Description ==
+
== Forms ==
Manipulates elements on the Heads-up Display.
+
*HUD -list - lists Inner Space HUD Elements
 +
*HUD -add <name> <#,#> <text> - Creates a HUD Element with <text> at <#,#> position
 +
*HUD -remove <name> - removes a HUD element
  
 
== Examples ==
 
== Examples ==
 +
===List all HUD Elements===
 
*HUD -list
 
*HUD -list
:Lists all HUD elements
+
;Output
*HUD -fontsize
+
Inner Space HUD Elements
:Sets the font size for all newly created HUD elementsDefault is 12.
+
-------------------
 +
'fps' [20,5] [Color:FFFFFFFF] [Group:FPS Indicator] [Size:12] 'FPS: ${Display.FPS}'
 +
  'system memory indicator' [20,20] [Color:FFFFFFFF] [Group:Memory Indicator] [Size:12] 'System RAM Available: ${
 +
'texture memory indicator' [20,35] [Color:FFFFFFFF] [Group:Memory Indicator] [Size:12] 'Texture Memory Availabl
 +
===Add a HUD Element===
 
*HUD -add FPS 0,0 ${FPS}
 
*HUD -add FPS 0,0 ${FPS}
 
:Adds a HUD element named "FPS" at location 0,0 on the screen, with the value of ${FPS}.  The value is parsed when the HUD is updated, not right away, so this value automatically updates.
 
:Adds a HUD element named "FPS" at location 0,0 on the screen, with the value of ${FPS}.  The value is parsed when the HUD is updated, not right away, so this value automatically updates.
 +
===Remove a HUD Element===
 
*HUD -remove FPS
 
*HUD -remove FPS
 
:Removes the "FPS" element
 
:Removes the "FPS" element
  
 
== See Also ==
 
== See Also ==
 +
*[[ISSession:HUDSet (Command)|HUDSet (Command)]]
 +
*[[ISSession:HUDGroup (Command)|HUDGroup (Command)]]
 +
*[[LavishGUI#Commands|LavishGUI Commands]]
 
*[[LavishScript:Commands|LavishScript Commands]]
 
*[[LavishScript:Commands|LavishScript Commands]]
 +
*[[IS:Kernel#Commands|Kernel Commands]]
 
*[[IS:Session#Commands|Inner Space Session Commands]]
 
*[[IS:Session#Commands|Inner Space Session Commands]]
 +
 +
  
 
{{Command-Stub}}
 
{{Command-Stub}}
 
[[Category:Inner Space]]
 
[[Category:Inner Space]]
[[Category:Inner Space Session]]
+
[[Category:Inner Space Kernel]]
[[Category:Inner Space Session Commands]]
+
[[Category:Inner Space Kernel Commands]]

Latest revision as of 23:20, 9 October 2008

Syntax

Command Difficulty Rating
HUD
Usage Intermediate
Level of Understanding Intermediate
Computer Savvy Intermediate
Logic Intermediate

HUD -list|-remove <name>|-add <name> <#,#> <text>

Forms

  • HUD -list - lists Inner Space HUD Elements
  • HUD -add <name> <#,#> <text> - Creates a HUD Element with <text> at <#,#> position
  • HUD -remove <name> - removes a HUD element

Examples

List all HUD Elements

  • HUD -list
Output
Inner Space HUD Elements
-------------------
'fps' [20,5] [Color:FFFFFFFF] [Group:FPS Indicator] [Size:12] 'FPS: ${Display.FPS}'
'system memory indicator' [20,20] [Color:FFFFFFFF] [Group:Memory Indicator] [Size:12] 'System RAM Available: ${
'texture memory indicator' [20,35] [Color:FFFFFFFF] [Group:Memory Indicator] [Size:12] 'Texture Memory Availabl

Add a HUD Element

  • HUD -add FPS 0,0 ${FPS}
Adds a HUD element named "FPS" at location 0,0 on the screen, with the value of ${FPS}. The value is parsed when the HUD is updated, not right away, so this value automatically updates.

Remove a HUD Element

  • HUD -remove FPS
Removes the "FPS" element

See Also