Difference between revisions of "LavishGUI:UI (Command)"

From Lavish Software Wiki
Jump to navigation Jump to search
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
== Syntax ==
 
== Syntax ==
 
{{CMD-DR|UI|Newbie|Newbie|Newbie|Newbie}}
 
{{CMD-DR|UI|Newbie|Newbie|Newbie|Newbie}}
UI -reset|-load <filename>|-reload <filename>|-unload <filename>
+
UI -reset|-[re]load [-skin <name>] <filename> [<element name> [new name]]|-unload <filename>
 
 
== Description ==
 
* -reset
 
: Clears all UI elements.  This includes the console, so have a plan for entering commands if necessary.
 
* -load <filename>
 
: Loads an XML interface file.  This is ''cumulative'' and will simply add the new elements to the current interface.  Any top-level elements in the file that already exist in the current UI will be skipped
 
* -reload <filename>
 
: Same as -load, but will not skip existing elements (it will replace them)
 
* -unload <filename>
 
: Unloads each of the elements described in the given XML file
 
  
 +
== Forms ==
 +
*UI -reset - clears all UI elements
 +
*UI -load [-skin <name>] <filename> - loads an XML interface file and adds the new elements to the current interface. Any top-level elements in the file that already exist in the current UI will be skipped
 +
*UI -reload [-skin <name>] <filename> - same as load except it will not skip existing elements and replace them instead
 +
*UI -unload <filename> - Unloads each of the elements described in the XML file
 
<small>Tip: The UIElement command can be used to remove specific UI elements</small>
 
<small>Tip: The UIElement command can be used to remove specific UI elements</small>
  
 
== Examples ==
 
== Examples ==
* ui -reset
+
===Removing all UI elements (including any console)===
* ui -load defaultui
+
*UI -reset
* ui -load myui
+
===Load a UI from an XML file===
* ui -reload myui
+
*UI -load defaultui
* ui -unload myui
+
*UI -load tradeskillui
 +
===Load a UI with a skin from an XML file ===
 +
*UI -load -skin myskin defaultui
 +
===Reload a UI from an XML file===
 +
*UI -reload myui
 +
===Unload a UI===
 +
*UI -unload myui
  
 
== See Also ==
 
== See Also ==
 
*[[ISSession:UIElement (Command)]]
 
*[[ISSession:UIElement (Command)]]
 +
*[[LavishGUI]]
 
*[[LavishScript:Commands|LavishScript Commands]]
 
*[[LavishScript:Commands|LavishScript Commands]]
 
*[[IS:Session#Commands|Inner Space Session Commands]]
 
*[[IS:Session#Commands|Inner Space Session Commands]]
  
{{Command-Stub}}
+
[[Category:LavishGUI]]
[[Category:Inner Space]]
 
[[Category:Inner Space Session]]
 
[[Category:Inner Space Session Commands]]
 

Latest revision as of 18:47, 14 October 2005

Syntax

Command Difficulty Rating
UI
Usage Newbie
Level of Understanding Newbie
Computer Savvy Newbie
Logic Newbie

UI -reset|-[re]load [-skin <name>] <filename> [<element name> [new name]]|-unload <filename>

Forms

  • UI -reset - clears all UI elements
  • UI -load [-skin <name>] <filename> - loads an XML interface file and adds the new elements to the current interface. Any top-level elements in the file that already exist in the current UI will be skipped
  • UI -reload [-skin <name>] <filename> - same as load except it will not skip existing elements and replace them instead
  • UI -unload <filename> - Unloads each of the elements described in the XML file

Tip: The UIElement command can be used to remove specific UI elements

Examples

Removing all UI elements (including any console)

  • UI -reset

Load a UI from an XML file

  • UI -load defaultui
  • UI -load tradeskillui

Load a UI with a skin from an XML file

  • UI -load -skin myskin defaultui

Reload a UI from an XML file

  • UI -reload myui

Unload a UI

  • UI -unload myui

See Also