HeroEngine Controls

From HeroWiki
Jump to: navigation, search

File:HeroBladeCollection1.png

This is an easy-level tutorial outlining HeroEngine's workhorse of development, the HeroBlade client, and specifically how to use it to move around within a game world.
  • Be sure to check out the Script Editor shortcuts at the bottom of the page

Overview

HeroBlade is the world- and game-building component of HeroEngine. Your world builders, game mechanics team, artists and so on will all use HeroBlade.

With HeroBlade you can:

Make sure you've already followed the setup instructions located on your account page at [1].


If problems are experienced with the client, first check here for a list of Common Problems.

Learn how to look around

Template:See also At this point, clicking and dragging with the mouse will do different things, depending on which of two modes you are in, Character Mode (also called Game Mode) or Fly Mode (also called Camera Mode). These modes are entered into either by clicking on the appropriate button in the Transform Toolbar at the top of HeroBlade, or via a Keyboard shortcut.

File:Character tool.png This is the default mode when HeroBlade first starts up. To return to this mode in the future, simply click on the Character Button in the Transform Toolbar, or press the ` (reverse apostrophe) key.

While in this mode, the mouse buttons and keyboard keys work as follows. It is highly recommended to practice with all of them, since you will be using them frequently.

Character (Game) Mode Fly (Edit) Mode
Left-Click (Button 1) Activates the selected item in the viewport (for example: choosing a spell, pulling a lever, or clicking on an action mark if there is one nearby). R-key Move the View directly up
Right-Click (Button 2) Hold and Drag to turn the character to face a direction F-key Move the View directly down
Both Button 1 and Button 2 simultaneously Walk the character forward W-key Move View forward
Button 3 (the "back" button on the mouse) While holding this button, click and drag with the mouse, to move the camera view without rotating the character S-key Move View backward
Button 4 Snaps the camera back to the view of your character A-key Move View left (strafe)
Mouse-Wheel Zoom view in and out from character D-key Move View right (strafe)
W-key Move character forward Q-key Rotate View left
S-key Move character backward E-key Rotate View right
A-key Move character left X-key Decrease camera movement speed
D-key Move character right C-key Increase camera movement speed
Q-key Rotate character left Z-key Set camera movement speed to minimum rate
Q-key Rotate character right E-key Set camera movement speed to maximum rate


The speed of the camera can be adjusted faster or slower, with the following keys. Note how the camera speed display changes when you tap or press and hold one of the keys.

After you have adjusted the speed faster, try using the above keys to move the view around, to see how the speed has changed. Adjust the speed until you find something that you are comfortable with.

Changing the camera speed will briefly highlight the speed slider at the bottom of the HeroBlade window. This slider can also be used to control the speed.

Camera collision

When in camera mode, the viewpoint will not pass through objects, but will instead be stopped by them.

  • Try to move your viewpoint into a large object, such as a tree, wall, or even the floor. The movement should stop.
  • Toggle collision off, by pressing F2
  • You should now be able to move the camera without hindrance through any object.
  • Toggle collision back on, by clicking on the Collision indicator in the HeroBlade Status Bar. This does the same thing as toggling collision on and off with F2.

300px300px

Mouse buttons

The mouse buttons in Camera mode work as follows:

Left-Click (Button 1)
Hold and Drag to move the view in the viewport
Right-Click (Button 2)
Same as left-click
Both Button 1 and Button 2 simultaneously
Hold and drag to move the view in the viewport in a different way. Moving the mouse left and right "strafes" left and right, and moving the mouse forward and back zooms in and out. The sensitivity of this movement is controlled by the speed keys above (X, C, Z, V).
Button 3
If an instance of an asset is selected, Template:Select pressing Button 3 on the mouse will focus on that selection. If no asset is selected, the closest asset will be selected and focused. This is the same as pressing CTRL-G.
Button 4
Currently has no function
Mouse-Wheel
Scroll through the various manipulation controls in the Transform Toolbar. For use with Area Creation
  • Choose the selection tool in the Transform Toolbar Template:Select and then click on an object in the viewport. A bounding box should appear around it.
    • Note: If you cannot seem to select something, it may be because it was set as unselectable in its properties, or the Filters menu may have that type of object set as unselectable. Try selecting something else instead, until you find something with a bounding box around it.
  • While hovering the mouse anywhere over the viewport, press Button 3. This will move your viewpoint and focus on the selected object. Repeat this with several other objects (select and then press Button 3), to get used to the process of focusing on a particular object.


Tips:

  • It is highly advisable to become familiar with moving the fly camera with the mouse and keyboard, along with adjusting the camera speed. Spend a few minutes practicing with these movement controls until you are comfortable with them (like touch-typing instead of hunt-and-peck).
  • If the camera moves too quickly, use X or Z to decrease the rate, or hold down the SHIFT key to slow it down temporarily.
  • If your game has a Chat Panel which is visible in the main viewport, and the chat panel is selected, you may need to click back into the main game screen for the above keys to work.
  • If it is more comfortable to invert the X- or Y-axis for mouse movement, this can be toggled in the Renderer Panel


Overhead Mode

While in Fly Mode, you can also toggle in and out of an "Overhead Mode", by tapping CTRL-O.

  • Tap CTRL-O
  • Tap Z to slow down the camera speed.
  • Move the viewpoint with the W,A,S,D buttons.
  • Zoom in and out with the mouse wheel.
  • Tap CTRL-O to toggle back to camera mode.

Walk around

Going back into character mode will move your character to the current location of the camera viewpoint, and "drop" your character to the nearest floor surface. However, if your viewpoint is too high up in the sky, your character will simply float there.

  • In Camera Mode, move your viewpoint high above the ground.
  • Go into Game (Character) Mode by pressing the "~" key. This does the same thing as clicking on the picture of the character in the top toolbar.File:Character tool.png
  • Your character will stay floating in mid-air.
  • Go back into Camera Mode Template:Camera
  • Move your viewpoint close to a floor somewhere
  • Go back into character mode, until your character drops to a natural standing position.

Now spend some time walking and flying around the game world to get familiar with the keyboard movement.

  • Use the method of keyboard and mouse combinations with which you are most comfortable. One commonly used method is to use your left hand to hold down the W or S keys to move forward and back, while steering with your right hand by right-clicking and holding with the mouse.

While exploring, if you get stuck or into an odd place where you can't see anything, check the troubleshooting steps below: If you get stuck.

If you get stuck

While in development, or learning how to move around in a game world, it is possible that some areas might cause your character to get "stuck" in a corner or next to a wall somewhere. If you get stuck, try to use one of the following methods to get unstuck.

  • Fly to a safer spot.
    • Go into Fly Mode by clicking on the picture of the camera Template:Camera in the top toolbar
    • Press and hold the "W" key to see if you can move that way.
    • Fly to a different point (such as up into the sky) by aiming that direction with the mouse, and then pressing and holding the "W" key. Or, look down at the ground and press "S" and see if you can "back up" into the sky.
    • If you still cannot move, press F2. This turns off Collision and changes to a "walk/fly through walls" mode. Repeat the above two steps.
    • When you are a safe distance from the spot where your character was stuck, press the "~" key to return to Character Mode. This will teleport your character to the current location of the Fly Mode camera. If you are close to a floor, your character should automatically drop from the camera location to the ground. If you are high enough, however, your character may "hover" in space. To get your character back down to the ground, go back into Fly Mode and move the camera view closer to an appropriate piece of scenery.
    • If you are still stuck, try one of the following methods.

  • Teleport out by going to a waypoint.
    • From the Panels menu, choose "Paths".
    • Select a path (if one has been created)
    • In the lower panel you will see a list of waypoints. Select one and click on "goto".
    • Deselect the waypoint by clicking "Unselect" in the Paths Panel.
  • If you are still stuck, try to go to a different area and then return.

    • From the "Panels" menu, choose "Organizer".
    • Choose a different area (if one is available)
    • Right-click on it, and choose "Go to instance > New Instance"
    • After you load into the other area, come back to the area where you started

  • If you are still stuck, close HeroBlade and re-open it.

Running HeroBlade for the second time

Please note: You must launch the HeroBlade via the shortcuts provided.

Each time you start the HeroBlade application, it will automatically do a version check for any necessary updates, and then start itself up. As before, you'll see a lot of "loading" messages. Simply wait until it brings up the game or character manager, and then you can proceed.



HeroBlade Mouse and Keyboard Shortcuts

World Builder Keyboard Shortcuts

Note: Many of these will only work in Fly mode.
Key Use Key Use
W Move forward ` Game Mode
A Pan Left 1 Camera Mode
S Move Backward 2 Select Tool
D Pan Right 3 MoveTool
R Pan up 4 Rotate Tool
F Pan Down 5 Scale Tool
Q Rotate Left 6 Dynamic Place Tool
E Rotate Right 7 Width/Depth/Height Tool
Z Camera Speed Slowest 8 Terrain Brush Mode
X Camera Speed Decrease CTRL+SHift+C Copy ID's of selected Instances
C Camera Speed Increae Ctrl+D Clone/Duplicate Instance
V Camera Speed Fastest Ctrl+Shift+D Deep Clone
G Toggle Render All Rooms Ctrl+F Toggle FPS Graph
B Tggle Bright Directional Light Ctrl+G Go to Selection
N Toggle Snap Ctrl+G (Game Mode) Toggle Active
F1 Onlne Help Ctrl+L Open Library
F2 Toggle Camera Collision Ctrl+N Toggle Textures
F3 Toggle Debug Light Ctrl+O Toggle Top Down Camera
F4 Toggle Sound Ctrl+Q Repeat Last Add Instance
F5 Utilities Interface Menu Ctrl+R Apply Active Random Toggles
F7 Toggle Dim Other Rooms Ctrl+Shift+R On/Off Random Toggles
F9 Move to center of Room Bounding Box Ctrl+S Snap Selection to Grid
F10 Toggle UI On/Off Ctrl+T Toggle Tooltip Info
- - Ctrl+Shift+T GUI Analysis Menu
DEL Delete Selected Instance Ctrl+W Toggle Wireframe
ESC Unselect All Ctrl+Y Redo
SPACE Toggle Selection Lock Ctrl+Z Undo
Pg UP Select Parents Ctrl+Shift+Z Redo
Pg DOWN Select Children / Bipass Selectable Property



Mouse

Key Use
Right-Click & Drag Rotate Fly Camera Viewpoint
Click Select Target
SHIFT-click in Selection Mode will select alternate objects if cursor is over multiple overlapping objects.
CTRL-click in Selection Mode Allows to Select/Deselect Multiple Selections
Mouse Wheel Zooms View In / Out



Movement

Key Use
W Forward (or North in Overhead View)
S Backward (or South in Overhead View)
A Strafe Left (or West in Overhead View)
D Strafe Right (or East in Overhead View)
R Strafe Up (disable in Overhead View)
F Strafe Down (disable in Overhead View)
Q Rotate Left
E Rotate Right
V Sets Camera Movement Speed to Fastest
C Increases Camera Movement Speed
Z Sets Camera Movement Speed to Slowest
X Decreases Camera Movement Speed



Camera

Notes:

  • These numbers can only be used on the regular "alpha" keyboard, and not the numeric keypad.
  • These will only work in Fly Mode. Note that pressing ~ will toggle into Game Mode, at which point the other numbers won't work. In Hero's Journey and Clean Engine, there is a special keybinding to get back into Fly Mode, by pressing CTRL ~ but this may not work in all games, since it is game-specific.
  • To invert the mouse X and or Y axis see the Renderer_panel.
Key Use
~ Toggle to Game (character) Mode
1 Camera Mode: Fly, No Select
Ctrl-~ will also return to Fly mode, see notes above
2 Camera Mode: Select
3 Camera Mode: Select and Translate
4 Camera Mode: Select and Rotate
5 Camera Mode: Select and Scale
6 Camera Mode: Select and Dynamic Placement
7 Camera Mode: Select and Adjust Width/Depth/Height
8 Camera Mode: Terrain Tool
CTRL-O Camera Mode: Overhead View (note that in earlier versions of HeroBlade, this was called Top-Down View, and was accessed by tapping "T")
Z Minimum Camera Speed
X Reduce Camera Speed
C Increase Camera Speed
V Maximize Camera Speed
SHIFT Hold to Cut Camera Speed in Half

Miscellaneous

Note: Many of these will only work in Fly mode.
Key Use
ESC Deselects All Selected Objects
SPACEBAR Temporarily Locks Selected Object/s in Selected Mode. Further mouse clicks will not select or deselect objects. Esc or hitting the SPACEBAR again will remove the lock. This allows GMs to isolate object/s to work on without fear of accidentally deselecting or selecting other objects.
CTRL While held down, hovering over the move axes will toggle a view of the snap grid
\ While held, objects whose Selectable property is FALSE can be selected.
B Toggle Bright Light
G Toggle All Rooms Rendering
H Randomly generate a different face for your character
M Toggles Rendering Mirrors ON / OFF
N Toggles Snap (to grid) ON / OFF
P Toggles Paths Visible / Invisible
CTRL-G In Fly mode: Moves Fly Camera to the selected objects (or random nearest object) and activates room if auto-select room is on.
In Character mode: Toggles gameplay mode on and off (implementation may be game-specific)
CTRL-L Toggles the library open or closed while in fly camera mode
CTRL-R Activates Room of First Selected Object, without Moving fly Camera
CTRL-D Clones Selected Items
CTRL-Q Repeat Last Add Instance
CTRL-N Toggles No Textures
CTRL-F Toggles FPS Graph
CTRL-S Snaps the current selection to the grid
CTRL-W Toggles Wireframe Mode
CTRL-Space Memorizes current node selections
Shift-Space Reselects nodes memorized by CTRL-Space
DELETE Deletes Selected Items with confirmation dialog
F2 Toggle Collide
F3 Toggle Debug Light
F5 Invoke Utilities Interface
F6 Toggle AutoSelect
F7 Toggle Dim Other Rooms
F9 Move Camera to Currently Selected Room
F12 Toggle Full Screen Mode
F11 Toggle Debug Switch
Ctrl+Shift+C Copy selected node GUID to the clipboard
PageUp Change selection to the parent(s) of the currently-selected nodes. Works the same as the "Select Parent" button on the parenting toolbar
Ctrl+PageUp Change selection to the parent(s) of the currently-selected nodes, and nodes without parents selected
Page Down Select the children of the selected nodes
Ctrl+PageDown Select the children of the selected nodes, and nodes without children
Ctrl+Shift+G Toggle construction grid on and off, at the altitude of the selected node (if any)
Ctrl-T Toggle for tool tips, to get information about art assets in the viewport)

Asset Library Shortcuts

Key Use
Ctrl-L Toggles the library open and closed (if you are in Fly Mode


Script Editor Keyboard Shortcuts

Key Use
F3 Find Next
Shift+F3 Find Previous
F2 Next Bookmark
Shift+F2 Previous Bookmark
Ctrl+F2 Toggle Bookmark
Ctrl+Shift+F2 Clear Bookmark
Ctrl+Shift+A Search in all scripts