home *** CD-ROM | disk | FTP | other *** search
/ Game Level Design / GLDesign.bin / Software / UnrealEngine2Runtime / UE2Runtime-22262001_Demo.exe / Core / Classes / Commandlet.uc next >
Encoding:
Text File  |  2003-08-27  |  2.6 KB  |  88 lines
  1. //=============================================================================
  2. /// UnrealScript Commandlet (command-line applet) class.
  3. ///
  4. /// Commandlets are executed from the ucc.exe command line utility, using the
  5. /// following syntax:
  6. ///
  7. ///     UCC.exe package_name.commandlet_class_name [parm=value]...
  8. ///
  9. /// for example:
  10. ///
  11. ///     UCC.exe Core.HelloWorldCommandlet
  12. ///     UCC.exe Editor.MakeCommandlet
  13. ///
  14. /// In addition, if you list your commandlet in the public section of your
  15. /// package's .int file (see Engine.int for example), then your commandlet
  16. /// can be executed without requiring a fully qualified name, for example:
  17. ///
  18. ///     UCC.exe MakeCommandlet
  19. ///
  20. /// As a convenience, if a user tries to run a commandlet and the exact
  21. /// name he types isn't found, then ucc.exe appends the text "commandlet"
  22. /// onto the name and tries again.  Therefore, the following shortcuts
  23. /// perform identically to the above:
  24. ///
  25. ///     UCC.exe Core.HelloWorld
  26. ///     UCC.exe Editor.Make
  27. ///     UCC.exe Make
  28. ///
  29. /// It is also perfectly valid to call the Main method of a
  30. /// commandlet class directly, for example from within the body
  31. /// of another commandlet.
  32. ///
  33. /// Commandlets are executed in a "raw" UnrealScript environment, in which
  34. /// the game isn't loaded, the client code isn't loaded, no levels are
  35. /// loaded, and no actors exist.
  36. //=============================================================================
  37. class Commandlet
  38.     extends Object
  39.     abstract
  40.     transient
  41.     noexport
  42.     native;
  43.  
  44. /// Command name to show for "ucc help".
  45. var localized string HelpCmd;
  46.  
  47. /// Command description to show for "ucc help".
  48. var localized string HelpOneLiner;
  49.  
  50. /// Usage template to show for "ucc help".
  51. var localized string HelpUsage;
  52.  
  53. /// Hyperlink for more info.
  54. var localized string HelpWebLink;
  55.  
  56. /// Parameters and descriptions for "ucc help <this command>".
  57. var localized string HelpParm[16];
  58. var localized string HelpDesc[16];
  59.  
  60. /// Whether to redirect log output to console stdout.
  61. var bool LogToStdout;
  62.  
  63. /// Whether to load objects required in server, client, and editor context.
  64. var bool IsServer, IsClient, IsEditor;
  65.  
  66. /// Whether to load objects immediately, or only on demand.
  67. var bool LazyLoad;
  68.  
  69. /// Whether to show standard error and warning count on exit.
  70. var bool ShowErrorCount;
  71.  
  72. /// Whether to show Unreal banner on startup.
  73. var bool ShowBanner;
  74.  
  75. /// Entry point.
  76. native event int Main( string Parms );
  77.  
  78. defaultproperties
  79. {
  80.     LogToStdout=true
  81.     IsServer=true
  82.     IsClient=true
  83.     IsEditor=true
  84.     LazyLoad=true
  85.     ShowErrorCount=false
  86.     ShowBanner=true
  87. }
  88.