Eagle517/tge
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added everything

Browse Source
This commit is contained in:
Metario
2017-04-17 06:17:10 -06:00
commit 9c6ff74f19
6121 changed files with 1625704 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
example/common/help/10. Terrain Texture Painter.hfl Executable file
View File

@ -0,0 +1,6 @@
<lmargin%:5><rmargin%:95><font:Arial Bold:20>Terrain Texture Painter...<font:Arial:16>
The Terrain Texture Painter tool is used to manually paint terrain textures on the terrain. Users can select up to six different textures in the boxes in the upper right corner of the screen. Selecting a texture will place a black box around it. The terrain brush can then be used to paint the texture on the terrain.
Terrains with more than four textures may exhibit rendering irregularities if all those textures are used in the same area of a map. In general it is wise to use four or fewer textures on any individual terrain map.

8
example/common/help/2. License.hfl Executable file
View File

@ -0,0 +1,8 @@
<lmargin%:5><rmargin%:95><font:Arial Bold:20>Torque Game Engine Licenses<font:Arial:16>
For information about Torque Game Engine Licenses please visit our website.
<a:www.garagegames.com/products/111/>Torque Game Engine - Indie License</a>
<a:www.garagegames.com/products/112/>Torque Game Engine - Commercial Use License</a>

42
example/common/help/3. Gui Editor.hfl Executable file
View File

@ -0,0 +1,42 @@
<lmargin%:5><rmargin%:95><font:Arial Bold:20>Gui Editor...
GUI Editor Basics<font:Arial:16>
This description covers the basics of using the GUI Editor. For detailed documentation and tutorials see the <a:www.garagegames.com/developer/torque/tge/>Torque Home Page</a>
Press the F10 key on the keyboard to toggle the GUI Editor on and off. The GUI Editor will start editing the current main content control, minus any dialogs that may be visible.
The GUI Editor is broken up into four main visual components. In the upper left portion of the screen is the content editor, where controls can be placed, moved and resized. In the upper right is the tree, that shows the current content control hierarchy. The lower left panel is the tool bar, which contains functions for aligning, and spacing controls as well as creating new controls and screens. The lower right pane is the inspector, where the currently selected control's attributes are displayed.
<font:Arial Bold:20>Mouse Editing<font:Arial:16>
Left clicking the mouse on a control in the content editor selects that control. Once selected, a control can be moved by clicking and dragging its content area, or resized using one of the 8 black sizing knobs. Shift-clicking on several controls allows the user to select more than one control at once. In this case, the sizing knobs turn white, and can no longer be used to size the control, but the controls can still be moved by dragging. Only controls that share the same parent can be selected at the same time.
The parent control of the currently selected control is outlined with a yellow and blue band. This control is known as the <spush><font:Arial Bold:16>Current Add Parent<spop>. Any new control created from the toolbar or pasted from the clipboard will be added to this control. The Current Add Parent control can be set manually by either left-clicking one of its children, or right-clicking the control itself.
<font:Arial Bold:20>Keyboard Commands<font:Arial:16>
The editor supports several keyboard commands and shortcuts:
<spush><font:Arial Bold:16>Control-A<spop> - Select All. Selects all the controls in the Current Add Parent.
<spush><font:Arial Bold:16>Control-C<spop> - Copy. Copies the currently selected control(s) to the clipboard.
<spush><font:Arial Bold:16>Control-X<spop> - Cut. Cuts the currently selected control(s) to the clipboard.
<spush><font:Arial Bold:16>Control-V<spop> - Paste. Pastes any control(s) on the clipboard into the Current Add Parent.
<spush><font:Arial Bold:16>Arrow Keys<spop> - Movement. Moves the current control selection one pixel in the direction of the arrow.
<spush><font:Arial Bold:16>Shift-Arrow Keys<spop> - Movement. Moves the current control selection ten pixels in the direction of the arrow.
<spush><font:Arial Bold:16>Delete/Backspace<spop> - Delete. Deletes the current control selection.
<font:Arial Bold:20>Toolbar Commands<font:Arial:16>
The toolbar has several command buttons that operate on the current selection set and creating and saving guis, as well as pop-up menus for creating new controls and changing the currently edited gui. The functions of the buttons are described below:
<spush><font:Arial Bold:16>Align Left<spop> - Aligns the left edge of all controls in the current selection set to the leftmost point of any of the selected controls.
<spush><font:Arial Bold:16>Align Right<spop> - Aligns the right edge of all controls in the current selection set to the rightmost point of any of the selected controls.
<spush><font:Arial Bold:16>Center Horiz<spop> - Centers horizontally all selected controls in the rectangle bounded by the current selection set.
<spush><font:Arial Bold:16>Align Top<spop> - Aligns the top edge of all controls in the current selection set to the topmost point of any of the selected controls.
<spush><font:Arial Bold:16>Align Bottom<spop> - Aligns the bottom edge of all controls in the current selection set to the bottommost point of any of the selected controls.
<spush><font:Arial Bold:16>Help<spop> - Displays this help dialog.
<spush><font:Arial Bold:16>Space Vert<spop> - Evenly spaces vertically all selected controls.
<spush><font:Arial Bold:16>Space Horiz<spop> - Evenly spaces horizontally all selected controls.
<spush><font:Arial Bold:16>Bring Front<spop> - Moves the selected control in front of its sibling controls.
<spush><font:Arial Bold:16>Send Back<spop> - Moves the selected control behind its sibling controls.
<spush><font:Arial Bold:16>New...<spop> - Brings up a dialog that allows the user to create and name a new control for editing.
<spush><font:Arial Bold:16>Save<spop> - Brings up a dialog that allows the user to save the current content control to a file.
<spush><font:Arial Bold:16>New Control (popup)<spop> - Displays a list of all controls that the user can create to add to the current content control.
<spush><font:Arial Bold:16>Show GUI (popup)<spop> - Displays the name of the gui currently being edited. Selecting this popup allows the user to choose a screen to edit from all loaded guis.

50
example/common/help/4. Mission Editor Overview.hfl Executable file
View File

@ -0,0 +1,50 @@
<lmargin%:5><rmargin%:95><font:Arial Bold:20>Mission Editor...
Mission Editor Overview<font:Arial:16>
This description covers the basics of using the World Editor. For detailed documentation and tutorials see the <a:www.garagegames.com/developer/torque/tge/>Torque Home Page</a>
The Mission Editor is the in-game tool for creating and editing landscapes and placing objects in the 3D world.
Press the F11 key while in the game to toggle the Mission Editor on and off. The mission editor will start editing the currently loaded mission.
The Mission Editor is composed of the following tools, selectable from the Window menu:
<font:Arial Bold:16>World Editor<font:Arial:16> - Full screen object movement and selection.
<font:Arial Bold:16>World Editor Inspector<font:Arial:16> - Used to inspect the properties of mission objects
<font:Arial Bold:16>World Editor Creator<font:Arial:16> - Used to create new mission objects
<font:Arial Bold:16>Mission Area Editor<font:Arial:16> - Used to adjust the bounds of the mission area, as well as mirror terrain data
<font:Arial Bold:16>Terrain Editor<font:Arial:16> - Tool for manually adjusting the terrain heightfield and square properties
<font:Arial Bold:16>Terrain Terraform Editor<font:Arial:16> - Tool for procedurally generating the terrain heightfield from fractal operations
<font:Arial Bold:16>Terrain Texture Editor<font:Arial:16> - Tool for procedurally generating the terrain textures based on rules
<font:Arial Bold:16>Terrain Texture Painter<font:Arial:16> - Tool for manually painting terrain textures on the terrain
There are several editor functions and menus that are available in all mission editor modes:
<font:Arial Bold:20>Basic Movement<font:Arial:16>
The normal movement keys can be used to control both the player and the camera. The right mouse button is used to rotate the camera or adjust the player's view.
<font:Arial Bold:20>File Menu<font:Arial:16>
<font:Arial Bold:16>New Mission...<font:Arial:16> - Creates a new empty mission with a default terrain and sky
<font:Arial Bold:16>Open Mission...<font:Arial:16> - Opens an existing mission for editing
<font:Arial Bold:16>Save Mission<font:Arial:16> - Saves changes to the current mission to disk
<font:Arial Bold:16>Save Mission As...<font:Arial:16> - Saves the current mission under a new name
<font:Arial Bold:16>Import Terraform Data...<font:Arial:16> - Imports terraform rules from an existing terrain file
<font:Arial Bold:16>Import Texture Data...<font:Arial:16> - Imports terrain texture rules from an existing terrain file
<font:Arial Bold:16>Export Terraform Bitmap...<font:Arial:16> - Only active from the Terrain Terraform Editor - exports the current terraform map to a bitmap
<font:Arial Bold:20>Edit Menu<font:Arial:16>
<font:Arial Bold:16>Undo<font:Arial:16> - Undoes the last action in terrain or world editing. Not all actions can be undone
<font:Arial Bold:16>Redo<font:Arial:16> - Redoes the last undone action
<font:Arial Bold:16>Cut<font:Arial:16> - Cuts the selected objects in the world editor from the mission to the clipboard
<font:Arial Bold:16>Copy<font:Arial:16> - Copies the selected objects in the world editor to the clipboard
<font:Arial Bold:16>Paste<font:Arial:16> - Pastes the current clipboard contents into the mission
<font:Arial Bold:16>Select All<font:Arial:16> - Selects all mission objects in the world editor
<font:Arial Bold:16>Select None<font:Arial:16> - Clears the current selection in the world and terrain editors
<font:Arial Bold:16>Relight Scene<font:Arial:16> - Recomputes mission static lighting
<font:Arial Bold:16>World Editor Settings...<font:Arial:16> - Accesses the settings dialog for the World Editor
<font:Arial Bold:16>Terrain Editor Settings...<font:Arial:16> - Accesses the settings dialog for the Terrain Editor
<font:Arial Bold:20>Camera Menu<font:Arial:16>
<font:Arial Bold:16>Drop Camera At Player<font:Arial:16> - Moves the camera object to the location of the player, and sets the mode to camera movement mode
<font:Arial Bold:16>Drop Player At Camera<font:Arial:16> - Moves the player object to the location of the movable camera, and sets the mode to player movement mode
<font:Arial Bold:16>Toggle Camera<font:Arial:16> - Toggles between player and camera movement mode
<font:Arial Bold:16>Slowest...Fastest<font:Arial:16> - Adjusts the speed of the camera

53
example/common/help/5. World Editor.hfl Executable file
View File

@ -0,0 +1,53 @@
<lmargin%:5><rmargin%:95><font:Arial Bold:20>World Editor...
World Editor Basics<font:Arial:16>
The World Editor has three seperate "windows" in the Mission Editor:
World Editor - a full screen object manipulator
World Editor Inspector - used for inspecting and editing the properties of objects
World Editor Creator - used for creating new mission objects
The World Editor main view is a view of the 3D world. Objects in this view (interiors, shapes, markers, etc) can be manipulated with the mouse and keyboard.
The following mouse and keyboard functions exist:
<font:Arial Bold Italic:16>Clicking on an unselected object<font:Arial:16> - deselects all currently selected objects and selects the clicked object
<font:Arial Bold Italic:16>Clicking in empty space<font:Arial:16> - click-drags a box around objects, and selects all objects in the box
<font:Arial Bold Italic:16>Shift-clicking on an object<font:Arial:16> - toggles selection of the clicked object
<font:Arial Bold Italic:16>Mouse dragging a selected object<font:Arial:16> - moves the selected objects, either on a horizontal plane, or sticking to the terrain, depending on the setting of the "Planar Movement" checkbox in the World Editor Settings dialog
<font:Arial Bold Italic:16>Control-clicking and drag<font:Arial:16> - moves the selected objects vertically
<font:Arial Bold Italic:16>Alt-clicking and drag<font:Arial:16> - rotates the selected objects about the selected axis
<font:Arial Bold Italic:16>Alt-control-clicking and drag<font:Arial:16> - scales the selected object by a face on the bounding box
If gizmos are enabled in the World Editor Settings dialog, they can also be clicked and dragged:
<font:Arial Bold Italic:16>click-drag gizmo axis<font:Arial:16> - move selection along that axis
<font:Arial Bold Italic:16>alt-click-drag gizmo axis<font:Arial:16> - rotate selection on that axis
<font:Arial Bold Italic:16>alt-control-click-drag gizmo axis<font:Arial:16> - scale along that axis
<font:Arial Bold:20>World Menu<font:Arial:16>
The World Menu contains world editor specific options for controlling properties of the current selection, as well as choosing where new objects are dropped. The following list describes the world menu options:
<font:Arial Bold:16>Lock Selection<font:Arial:16> - Locks the current selection so that it cannot be manipulated from the world editor view
<font:Arial Bold:16>Unlock Selection<font:Arial:16> - Unlocks a locked selection
<font:Arial Bold:16>Hide Selection<font:Arial:16> - Hides the current selection to reduce clutter while editing
<font:Arial Bold:16>Show Selection<font:Arial:16> - Shows hidden objects in the selection
<font:Arial Bold:16>Delete Selection<font:Arial:16> - Deletes the currently selected objects
<font:Arial Bold:16>Camera To Selection<font:Arial:16> - Moves the camera to the selected objects
<font:Arial Bold:16>Reset Transforms<font:Arial:16> - Resets the rotation and scale on the selected objects
<font:Arial Bold:16>Drop Selection<font:Arial:16> - Re-drops the selected objects into the mission according to the drop rule (see below)
<font:Arial Bold:16>Add Selection to Instant Group<font:Arial:16> - Moves the currently selected objects into the current Instant Group.
<font:Arial Bold:16>Drop at Origin<font:Arial:16> - New objects will be created at the origin
<font:Arial Bold:16>Drop at Camera<font:Arial:16> - New objects will be created at the camera's location
<font:Arial Bold:16>Drop at Camera w/Rot<font:Arial:16> - New objects will be created at the camera's location with the camera's current orientation
<font:Arial Bold:16>Drop below Camera<font:Arial:16> - New objects will be created below the camera's location
<font:Arial Bold:16>Drop at Screen Center<font:Arial:16> - New objects will be created in the world where the view direction hits an object
<font:Arial Bold:16>Drop at Centroid<font:Arial:16> - New objects will be created in the world at the center of the selection
<font:Arial Bold:16>Drop to Ground<font:Arial:16> - New objects will be dropped at the terrain ground level
<font:Arial Bold:20>World Editor Tree<font:Arial:16>
The World Editor tree view is displayed in the upper right screen quadrant in both the World Editor Inspector and the World Editor Creator. This tree displays the hierarchy of the mission data file. Objects selected in the tree will also be selected in the main view. There is a special group selection called the <font:Arial Bold:16>Instant Group<font:Arial:16>. This group is where objects that are pasted are placed, as well as where objects created from the World Editor Creator are placed. In the World Editor tree view the instant group is displayed with a grey hilight. To change the current instant group, Alt-click on a group in the tree view.
<font:Arial Bold:20>World Editor Inspector<font:Arial:16>
The World Editor Inspector allows the user to specify properties of mission objects. When an object is selected in Inspector mode, that object's properties will be displayed in the lower right quadrant of the screen. Once properties are edited, clicking the apply button will set those properties into the object. Dynamic properties can be assigned to objects with the Dynamic Fields Add button. Dynamic fields are accessable through the scripting language and are used to add game-specific properties to mission objects.
<font:Arial Bold:20>World Editor Creator<font:Arial:16>
The World Editor Creator displays a tree view in the lower left corner of the screen. This tree contains all objects that can be created in a mission.

9
example/common/help/6. Mission Area Editor.hfl Executable file
View File

@ -0,0 +1,9 @@
<lmargin%:5><rmargin%:95><font:Arial Bold:20>Mission Area Editor...<font:Arial:16>
The Mission Area Editor displays an overhead height map in the upper right corner of the screen, with markers for mission objects, a box for the mission area and a pair of lines denoting the current field of view. Clicking anywhere on the display will move the current view object (either camera or player) to that location in the mission.
To edit the mission area, click on the "Edit Area" checkbox. This will display 8 resizing knobs on the mission area box, that can be dragged with the mouse.
The "Center" button will cause the terrain file data to be repositioned and centered at 0,0 in the center of the mission area box.
To mirror the terrain, click on the Mirror button. This will put the mission area editor in mirror mode. The left and right arrow buttons adjust the mirror plane angle to one of 8 different angles (2 axis aligned, 2 45-degree splits), and the Apply button will mirror the terrain across the mirror plane.

17
example/common/help/7. Terrain Editor.hfl Executable file
View File

@ -0,0 +1,17 @@
<lmargin%:5><rmargin%:95><font:Arial Bold:20>Terrain Editor...<font:Arial:16>
The terrain editor is used to manually modify the terrain height map and square properties. Terrain editing is accomplished using the brush. The brush is a selection of terrain points or squares centered around the mouse cursor. The brush is either a circle or square area, and can be one of several size selected from the brush menu. The brush can also be either a hard brush - where the affect on the terrain is the same across the surface of the brush - or a soft brush - where the brush's influence on terrain diminishes towards the edges of the brush. The Terrain Editor Settings dialog filter view controls the falloff of the soft brush.
The following terrain editing action modes can be selected from the <font:Arial Bold:16>Action<font:Arial:16> menu.
<font:Arial Bold:16>Select<font:Arial:16> - Painting with the brush selects grid points
<font:Arial Bold:16>Adjust Selection<font:Arial:16> - The currently selected grid points can be raised or lowered as a group
<font:Arial Bold:16>Add Dirt<font:Arial:16> - "Dirt" is added at the center of the brush
<font:Arial Bold:16>Excavate<font:Arial:16> - "Dirt" is removed from the center of the brush
<font:Arial Bold:16>Ajust Height<font:Arial:16> - The brush selection can be dragged to raise or lower it
<font:Arial Bold:16>Flatten<font:Arial:16> - The brush surface is set to a flat plane height
<font:Arial Bold:16>Smooth<font:Arial:16> - Rough areas are made more smooth in the bounds of the brush
<font:Arial Bold:16>Set Height<font:Arial:16> - The terrain within the brush is set to a constant height (configurable in the Terrain Editor Settings)
<font:Arial Bold:16>Set Empty<font:Arial:16> - The squares covered by the brush are made into holes in the terrain
<font:Arial Bold:16>Clear Empty<font:Arial:16> - The squares covered by the brush are made solid
<font:Arial Bold:16>Paint Material<font:Arial:16> - The current terrain texture material will be painted with the brush

21
example/common/help/8. Terrain Terraform Editor.hfl Executable file
View File

@ -0,0 +1,21 @@
<lmargin%:5><rmargin%:95><font:Arial Bold:20>Terrain Terraform Editor...<font:Arial:16>
The Terrain Terraform Editor is used to algorithmically generate terrain heightfields. Heightfield operations are arranged in a stack, with some operations using the results of previous operations to produce new heightfields. The results of the last operation on the stack can be applied to the terrain using the Apply button.
The Terraform Editor has two panes - the top pane displays information about the currently selected operation, and the bottom pane shows the current operation stack. Between the two is a pull down menu for the creation of new operations. The first operation in the stack is always the General operation (which can't be deleted).
The following operations are supported in the editor:
<font:Arial Bold:16>fBm Fractal<font:Arial:16> - Fractal for creating bumpy hills
<font:Arial Bold:16>Rigid Multifractal<font:Arial:16> - Fractal for creating ridges and sweeping valleys
<font:Arial Bold:16>Canyon Fractal<font:Arial:16> - Fractal for creating vertical canyon ridges
<font:Arial Bold:16>Sinus<font:Arial:16> - Overlapping sine wave patterns with different frequencies useful for creating rolling hills
<font:Arial Bold:16>Bitmap<font:Arial:16> - Used to import an existing 256x256 bitmap as a heightfield
<font:Arial Bold:16>Turbulence<font:Arial:16> - perturbs another operation on the stack
<font:Arial Bold:16>Smoothing<font:Arial:16> - smooths another operation on the stack
<font:Arial Bold:16>Smooth Water<font:Arial:16> - smooths water
<font:Arial Bold:16>Smooth Ridges/valleys<font:Arial:16> - smooths an existing operation on edge boundaries
<font:Arial Bold:16>Filter<font:Arial:16> - filters an existing operation based on a curve
<font:Arial Bold:16>Thermal Erosion<font:Arial:16> - erodes an existing operation using a thermal erosion algorithm
<font:Arial Bold:16>Hydraulic Erosion<font:Arial:16> - erodes an existing operation using a hydraulic erosion algorithm
<font:Arial Bold:16>Blend<font:Arial:16> - blends two existing operations acording to a scale factor and mathmatical operator
<font:Arial Bold:16>Terrain File<font:Arial:16> - loads an existing terrain file onto the stack

12
example/common/help/9. Terrain Texture Editor.hfl Executable file
View File

@ -0,0 +1,12 @@
<lmargin%:5><rmargin%:95><font:Arial Bold:20>Terrain Texture Editor...<font:Arial:16>
The Terrain Texture Editor is used to algorithmically place terrain texures based on the heightfield at the bottom of the terraformer heightfield stack. The texture editor has three main interface elements on the right side of the screen - from top to bottom they are the operation inspector pane, the material list, and the placement operation list.
Essentially, terrain materials (textures) are added with the "Add Material" button. This will look for any texture (.png or .jpg) in a subdirectory of any directory named "terrains". Once a material is added to the terrain, the user can select one of several placement operations that govern where that material will be placed on the terrain - they are:
<font:Arial Bold:16>Place by Fractal<font:Arial:16> - Places the terrain texture randomly across the terrain based on a brownian motion fractal.
<font:Arial Bold:16>Place by Height<font:Arial:16> - Places the texture based on an elevation filter
<font:Arial Bold:16>Place by Slope<font:Arial:16> - Places the texture based on a slope filter
<font:Arial Bold:16>Place by Water Level<font:Arial:16> - Places the texture based on the water level parameter in the terraform editor
Pressing the "Apply" button applies the current texture operation list to the terrain file.