User Tools
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
guisys:guifiles [2011-06-27 11:56] Carsten Removed more obsolete passages of text |
guisys:guifiles [2017-02-21 11:42] (current) Carsten remove obsolete reference to Trac |
||
|---|---|---|---|
| Line 24: | Line 24: | ||
| * makes packaging a complete GUI in a ''my_GUI.zip'' archive possible, so that the GUI can easily and safely be distributed, shipped and handled. | * makes packaging a complete GUI in a ''my_GUI.zip'' archive possible, so that the GUI can easily and safely be distributed, shipped and handled. | ||
| - | The name of the directory should match the file name of the GUI. That is, if your GUI's name is ''CallLift_init.cgui'' and ''CallLift_main.cgui'', it should be stored in a directory with the same name ''CallLift/'' (or in a zip archive with the same base name ''CallLift.zip''). | + | The name of the directory should match the file name of the GUI. That is, if your GUI's file names are ''CallLift_init.cgui'' and ''CallLift_main.cgui'', it should be stored in a directory with the same name ''CallLift/'' (or in a zip archive with the same base name ''CallLift.zip''). |
| Note that when you are saving a new GUI that does not yet have a separate directory, you can use the "New Folder" button (or right-click context menu) of the "Save" dialog to create such new directories as required. | Note that when you are saving a new GUI that does not yet have a separate directory, you can use the "New Folder" button (or right-click context menu) of the "Save" dialog to create such new directories as required. | ||
| Line 53: | Line 53: | ||
| The GUI Editor is usually used to create and edit the static aspects of GUI windows, automatically generating the related script code when saving the file. | The GUI Editor is usually used to create and edit the static aspects of GUI windows, automatically generating the related script code when saving the file. | ||
| - | Dynamic aspects like animations or other kinds of effects typically require adding custom script code, so editing ''cgui'' files (usually the ''_main.cgui'' file) is something that you'll likely want to do often. | + | Dynamic aspects like animations or other kinds of effects typically require adding custom script code, so editing ''cgui'' files (usually the ''_main.cgui'' file) is something that you'll likely want to do often. |
| - | See the [[http://api.cafu.de/scripting/group__GUI.html|GUI Scripting Reference Documentation]] for more details. | + | See the [[http://api.cafu.de/lua/|Lua Scripting Overview]] and the [[http://api.cafu.de/lua/group__GUI.html|GUI Scripting Reference Documentation]] for more details. |
| Line 89: | Line 89: | ||
| * All hand-written code enters file ''Teleporter_main.cgui'' instead. | * All hand-written code enters file ''Teleporter_main.cgui'' instead. | ||
| * The connection between the two files is made by the ''dofile()'' statement. | * The connection between the two files is made by the ''dofile()'' statement. | ||
| - | |||
| - | \\ | ||
| - | ^ Tip by the Cafu development team: ^ | ||
| - | | The ''Games/DeathMatch/GUIs/MainMenu/MainMenu(_init).cgui'' files that are natively included with Cafu are prime examples of this technique. | | ||
| - | |||
| - | Future versions of the GUI Editor may even mildly enforce the two-files approach, where one file has the normal file name and its "twin" gets the ''_init'' suffix automatically appended. This helps e.g. to prevent accidental overwrites when you happen to load ''CallLift.cgui'' into the GUI Editor instead of ''CallLift_init.cgui''. | ||
| Line 101: | Line 95: | ||
| The ''cmat'' files contain the material definitions for the graphical elements of this GUI. | The ''cmat'' files contain the material definitions for the graphical elements of this GUI. | ||
| - | At the time of this writing, the materials for GUIs are still defined in the "global" material scripts for the MOD, but for the future we intend to have separate material scripts for each GUI that work analogous to [[http://www.cafu.de/wiki/modeleditor:modelfiles#cmat_material_definition_files|cmat material definition files]] for models. | + | At the time of this writing, the materials for GUIs are still defined in the "global" material scripts for the MOD, but for the future we intend to have separate material scripts for each GUI that work analogous to [[http://docs.cafu.de/modeleditor:modelfiles#cmat_material_definition_files|cmat material definition files]] for models. |
| Line 107: | Line 101: | ||
| The texture images are referenced from the material definition scripts. | The texture images are referenced from the material definition scripts. | ||
| - | See the documentation about [[http://www.cafu.de/wiki/#the_cafu_material_system|the Cafu Material System]] for more details. | + | See the documentation about [[http://docs.cafu.de/#the_cafu_material_system|the Cafu Material System]] for more details. |
| /* Example: | /* Example: | ||
guisys/guifiles.1309168609.txt.gz ยท Last modified: 2013-01-07 12:07 (external edit)