Organizer panel

From HEWIKI
(Difference between revisions)
Jump to: navigation, search
(Area renaming)
 
(24 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Image:Organizer_Areas.jpg|right|frame|The Organizer panel, with the Areas tab selected]]The '''Organizer Panel''' serves as a method to organize [[Area Server|areas]], [[prototypes]], [[HeroScript|scripts]], and [[GUIXML]] files. It provides a quick overview of what has been created and where it is stored. Note that removing an item from the Organizer Panel, will probably ''not'' delete it -- it simply removes it from the hierarchy.
+
[[Image:OrganizerArea.png|frame|right|200x400px|The Area Organizer]]The '''Organizer Panels''' serve as a methods to organize [[Area Server|areas]], [[Prototypes]], [[HeroScript|scripts]], and [[GUIXML]] files. It provides a quick overview of what has been created and where it is stored. Note that removing an item from the Organizer Panel, will ''not'' delete it -- it simply removes it from the hierarchy.  
  
 +
<br>
  
==Tabs==
+
== Panels ==
The Organizer Panel is navigated by tabs:
+
* [[#Areas tab|Areas]]
+
* [[#Prototype tabs|Server Prototypes]]
+
* [[#Script tabs|Server Scripts]]
+
* [[#Prototype tabs|Client Prototypes]]
+
* [[#Script tabs|Client Scripts]]
+
* [[#GUIXML tab|GUI XML]]
+
* [[Package groups]]
+
  
== Areas tab ==
+
The Organizer Panels are:
The '''Areas''' tab provides a listing of all areas which have been created.  They are organized into various folders and subfolders.
+
  
The filter '''input box''', located at the bottom of the panel, may be used to quickly locate an area provided you know the name
+
*[[Area Organizer panel|Area Organizer]]
 +
*[[#Prototype_Organizer|Server Prototypes]]
 +
*[[#Script_Organizer|Server Scripts]]
 +
*[[#Prototype_Organizer|Client Prototypes]]
 +
*[[#Script_Organizer|Client Scripts]]
 +
*[[#GUI_Editor|GUI XML]]
 +
*[[Package groups]]
  
[[Image:FilteredAreaOrganizer.jpg|center]]
+
== Script Organizer  ==
 +
[[Image:AssumeOwnershipMenu.png|thumb|right|AssumeOwnershipMenu.png|This is accessed by right-clicking on the desired script and choosing "Assume Ownership"]]
 +
The Server and Client Scripts Organizers allow for organization of HSL scripts in the Server [[GOM]] and Client GOM. By default when a script is created, it is added to the main folder of the organizer.
  
[[Image:Organizer_Popup.jpg|right]]Once you have located and highlighted the area to which you desire to travel, you can either double-click it or right-click it to bring up a pop-up menu. From here you may select to travel to either an [[Edit Instance]], [[Play Instance]] or create a new Instance.
+
Removing scripts from the organizer does not delete them, it simply takes them out of the organizer. To delete a script, use the [[Script Editor]].  
  
<br clear="all">
+
==== Right-click menu ====
===Right-click menu===
+
A unique option on the script's right-click menu is "Assume Ownership". When you select this option, it will set the owner of the script to your account. The only place this ownership shows up at this time (May 2008), is in the script picker itself.
[[Image:HeroBladeAreaOrganizerGoToInstance.png|right]]While under the Areas tab, from the '''right-click menu''', you can:
+
* Look at and modify an Area's '''Info''' properties
+
* '''Add''' an existing '''area''' to the Organizer hierarchy (this only works while you have a folder selected)
+
* '''Add a subfolder''' to the hierarchy (this only works while you have a folder selected)
+
* '''Remove''' an area from the hierarchy (this does not delete it -- see below)
+
* '''Cut / Copy / Paste''' normally
+
* '''Go To Instance''', either starting up a new [[edit instance|edit]] or [[play instance]], or going to one that's already running
+
* '''Startup''' an edit or play instance without actually going to it
+
* '''Shutdown''' or stop a running instance
+
* '''Create New Area''' an entirely new area
+
* '''Import''' brings all of the objects from another area, and duplicates them into the current area.  
+
  
{{br}}
+
== Prototype Organizer  ==
====Area options====
+
  
[[Image:RemoveArea.png|center]]
+
*Server Prototypes
 +
*Client Prototypes
  
=====Adding an area=====
+
The [[Prototype]] organizers for server and client allow you to organize the various prototypes. There are no special features for the prototype organizer, other than the usual options for Information, Remove, Cut, and Copy.  
To add a reference to an area back into the organizer, right-click on a folder and choose '''Add existing area'''.  
+
  
[[Image:Area2.jpg|center]]
+
Some prototypes will be associated with [[Spec Oracles]]. For example, you may see a folder labeled Fx Specs, with specs such as <tt>_FxSpec###</tt> The number of each item will be associated with the <tt>SpecKey</tt> numbers in the [[FxGUI]]. Other prototypes may be associated with other Spec Oracles, as can be viewed in the [[HotSpot Menu]] under "Tools".
  
Then select the desired area from a list of areas.
+
Some prototypes are associated with [[Asset Types]]. When artists create objects to be placed in the Repository, each such object is associated with a basic asset type. When a game designer seeks to instantiate one of those objects, HeroEngine uses the prototype associated with that specific asset type.
[[Image:AddAreaToOrganizer example.png|center]]
+
  
=====Area renaming=====
+
For more information see [[Prototypes]]
To free up a name so that a new area can be created with the old name, modify the area's properties, via the '''Info''' option on the right-click menu.
+
  
[[Image:Area4.jpg|center]]
+
== GUI Editor  ==
  
And then you can rename it:
+
[[Image:GUI tab-organizer panel.png|right|thumb|GUI_tab-organizer_panel.png|The GUIXML Organizer]] The [[GUIXML]] Organizer is used to organize [[GUI Control]] types (sometimes called "Prototypes")
[[Image:HeroBladeAreaInfoCwissTestFoo.png|center]]
+
  
=====Area deletion=====
+
Clicking on a control in the organizer is context-sensitive.  
An area can be '''Remove'''d via the right-click menu, but be aware that this does not actually "Delete" the area.  It merely removes the organizer's reference to it in a particular folder.  
+
  
If you wish to create another area with the same name, you can either:
+
*Double-clicking a control will open up that control in the [[GUI Editor]]
* Rename your old area (see above) to free up the name
+
*Double-clicking a control ''while in the editor'' will add that control to the currently-selected control in the editor, as a new child control.
* Completely delete the existing area.  This is done directly in the database, via the [[AREADEL]] CLI command
+
  
{{br}}
+
'''Notes:'''
  
===GoTo menu===
+
*Deleting a control in the Organizer may not actually delete the Control, as the Control might be in multiple folders.  
[[Image:GoToArea.jpg|right]]
+
*When adding a new GUI Control type, it is necessary to click "Refresh", otherwise it may not appear on the list.
To travel to an area, find it in the organizer panel.  If you know its name, you can type part of it into the Filter box at the bottom of the panel, to locate areas which start with that text.
+
*New types will appear at the Root level, and must be manually moved to the correct folder.
  
* If you select the '''Edit''' button, your character will travel to the [[edit instance]] of the area, spinning the area up automatically if needed. 
+
[[Category:HeroBlade_panels]]
* If you select the '''Play''' button, it does one of two things:
+
** If the dropdown box to the right of the button says NEW, a new (unoccupied) [[play instance]] of the area will be spun up and your character will travel there. 
+
** Otherwise, if you have selected an already spun-up play instance (by number) from the dropdown, that's where your character will go.
+
 
+
[[Image:GoToPlayArea.jpg|center]]
+
 
+
Note that the edit instance is always instance #0, and play instance numbers area always dynamically assigned, and therefore not predictable.
+
 
+
(is the above still applicable, or has it been done away with in favor of right-click menus?)
+
 
+
===Importing areas===
+
:See Main Article: [[How to Import an Area]]
+
 
+
== Script tabs ==
+
 
+
The Server Scripts and Client Scripts tabs allow for organization of HSL scripts in the Server [[GOM]] and Client GOM.  By default when a script is created, it is added to the main folder of the organizer. 
+
 
+
Removing scripts from the organizer does not delete them, it simply takes them out of the organizer.  To delete a script, use the [[Script Editor]].
+
 
+
===Right-click menu===
+
A unique option on the script's right-click menu is "Assume Ownership".  When you select this option, it will set the owner of the script to your account.  The only place this ownership shows up at this time (May 2008), is in the script picker itself.
+
 
+
(Need a few more pictures and a little bit of text on any option that is unique to the script organizers tab)
+
 
+
== Prototype tabs ==
+
 
+
* Server Prototypes
+
* Client Prototypes
+
 
+
The [[prototype]] organizers for server and client allow you to organize the various prototypes.  There are no special features for the prototype organizer, other than the usual options for Information, Remove, Cut, and Copy.
+
 
+
Some prototypes will be associated with [[Spec Oracles]].  For example, you may see a folder labeled Fx Specs, with specs such as <tt>_FxSpec###</tt>  The number of each item will be associated with the <tt>SpecKey</tt> numbers in the [[FxGUI]]. Other prototypes may be associated with other Spec Oracles, as can be viewed in the [[HotSpot Menu]] under "Tools".
+
 
+
Some prototypes are associated with [[Asset Types]].  When artists create objects to be placed in the Repository, each such object is associated with a basic asset type.  When a game designer seeks to instantiate one of those objects, HeroEngine uses the prototype associated with that specific asset type.
+
  (for non-obvious prototypes, how are they modified/deleted?)
+
 
+
== GUIXML tab ==
+
[[Image:GUI_tab-organizer_panel.png|right|GUI_tab-organizer_panel.png]]
+
The [[GUIXML]] tab of the Organizer panel is used to organize [[GUI Control]] types (sometimes called "Prototypes") 
+
 
+
Clicking on a control in the organizer is context-sensitive.
+
* Double-clicking a control will open up that control in the [[GUI Editor]]
+
* Double-clicking a control ''while in the editor'' will add that control to the currently-selected control in the editor, as a new child control.
+
 
+
'''Notes:'''
+
* Deleting a control in the Organizer may not actually delete the Control, as the Control might be in multiple folders.
+
* When adding a new GUI Control type, it is necessary to click "Refresh", otherwise it may not appear on the list.
+
* New types will appear at the Root level, and must be manually moved to the correct folder.
+
 
+
 
+
[[Category:HeroBlade panels]]
+

Latest revision as of 16:42, 14 March 2015

The Area Organizer
The Organizer Panels serve as a methods to organize areas, Prototypes, scripts, and GUIXML files. It provides a quick overview of what has been created and where it is stored. Note that removing an item from the Organizer Panel, will not delete it -- it simply removes it from the hierarchy.


Contents

Panels

The Organizer Panels are:

Script Organizer

This is accessed by right-clicking on the desired script and choosing "Assume Ownership"

The Server and Client Scripts Organizers allow for organization of HSL scripts in the Server GOM and Client GOM. By default when a script is created, it is added to the main folder of the organizer.

Removing scripts from the organizer does not delete them, it simply takes them out of the organizer. To delete a script, use the Script Editor.

Right-click menu

A unique option on the script's right-click menu is "Assume Ownership". When you select this option, it will set the owner of the script to your account. The only place this ownership shows up at this time (May 2008), is in the script picker itself.

Prototype Organizer

The Prototype organizers for server and client allow you to organize the various prototypes. There are no special features for the prototype organizer, other than the usual options for Information, Remove, Cut, and Copy.

Some prototypes will be associated with Spec Oracles. For example, you may see a folder labeled Fx Specs, with specs such as _FxSpec### The number of each item will be associated with the SpecKey numbers in the FxGUI. Other prototypes may be associated with other Spec Oracles, as can be viewed in the HotSpot Menu under "Tools".

Some prototypes are associated with Asset Types. When artists create objects to be placed in the Repository, each such object is associated with a basic asset type. When a game designer seeks to instantiate one of those objects, HeroEngine uses the prototype associated with that specific asset type.

For more information see Prototypes

GUI Editor

The GUIXML Organizer
The GUIXML Organizer is used to organize GUI Control types (sometimes called "Prototypes")

Clicking on a control in the organizer is context-sensitive.

Notes:

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox