DOM Editor

From HEWIKI
Jump to: navigation, search

Contents

The DOM Editor is a tool for viewing and editing DOM definitions visually as an alternative to using the CLI directly. The information on this page relates to the DOM Editor 2.0, which improves functionality and usability, and separates viewing and editing of the client and server DOMs into independent windows.

NOTE: For information on the previous version of the DOM Editor, please refer to DOM Editor 1.0


Introduction

In HSL, the data object model (classes, fields, enums, etc.) are defined independently of the scripting language (HSL). This is different than most computer languages, but gives HeroEngine it's distinctive power and real-time collaborative flexibility. The DOM can be manipulated with the CLI, but it is much easier to use the DOM Editor.



Overview

Using the DOM Editor, you may create, view, modify and delete fields, classes, enums, associations, association groups, and named package groups for both the client and the server. Changes made by the DOM editor or CLI are immediately available for use in script.

The Client DOM Editor and the Server DOM Editor are displayed independently, and available as separate HeroBlade options under the HeroScript menu. This allows maximum flexibility when you need to reference or compare data in each. Each DOM datatype is displayed on a separately tabbed page. This layout allows users to browse and modify both the client and server datatypes independently.

By default, both the client and server DOMs are set to read-only mode. This can be independently enabled or disabled using the check box in the upper right of each DOM.

When a datatype entry is selected, its detail information is displayed below it in the lower portion of the UI.



ClientDOM.png ServerDOM.png

Read Only Mode

By default, the DOM Editor opens in read-only mode to prevent accidental modifications of DOM definitions. In order to make any change to the DOM definitions, you must first clear the read-only flag located in the top right section of the DOM editor.

Confirm Changes

If the DOM editor is not in read-only mode, it defaults to prompt the user before it sends a change that can cause DOM modifications. When confirmation is active, a dialog box will pop up displaying the commands which it is about to send to the server, so they can be inspected for errors or unwanted changes. Clearing this checkbox causes the editor to pass all commands directly to the server without prompting for verification.

Datatype Definition Options

The text box, left center, below the list of datatype definitions, allows you to search the list of definitions for specific entries. The left and right arrow buttons enable you to move to the previous and next definitions, respectively. The Name, Description, and, optionally Type and Archetype checkboxes, depending on the datatype context, allow you to restrict the search to a specific definition column.

Definition Detail Display and Editing

The lower portion of the UI displays detail information for the currently selected datatype definition. When not in read-only mode, changes may be made and saved to the definition of the datatype. Please refer to each datatype for more information on the specific type of information that can be modified.

Options

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox