Drag[en]gine Script Module DragonScript
1.21
|
Window running a GameWorld. More...
Classes | |
class | Loader |
Game loader for use with WindowGameWorld. More... | |
Public Member Functions | |
Vector | backProject (MouseEvent event) |
Back project position into 3d world. More... | |
Vector | backProject (Point position) |
Back project position into 3d world. More... | |
void | dispose () |
Dispose of Widget. More... | |
bool | getActivateMicrophone () |
Activate microphone if game world is set. More... | |
Camera | getCamera () |
Game camera. More... | |
CameraDirector | getCameraDirector () |
Camera directory or null. More... | |
Console | getConsole () |
Console object. More... | |
GameWorld | getGameWorld () |
Game world. More... | |
Microphone | getMicrophone () |
Microphone to hear sound. More... | |
Panel | getPanelBorder () |
Panel with BorderLayout containing world render content. More... | |
Panel | getPanelStack () |
Panel with StackLayout containing world render. More... | |
bool | getUpdateCameraDirector () |
Update camera director on frame updates. More... | |
bool | getUpdateGameWorld () |
Update game world on frame updates. More... | |
WorldRenderer | getWorldRenderer () |
World renderer. More... | |
WindowGameWorld | new () |
Create screen sized window using BaseGameApp console. More... | |
WindowGameWorld | new (Console console) |
Create screen sized window. More... | |
void | onDesignerSelectorChanged () |
Designer selector changed. More... | |
void | onFrameUpdate (float elapsed) |
Update game world every frame update if present. More... | |
void | onGameWorldChanged () |
Game world changed. More... | |
Point | project (DVector position) |
Project point from 3d world. More... | |
void | setActivateMicrophone (bool activateMicrophone) |
Set if microphone is activated if game world is set. More... | |
void | setCameraDirector (CameraDirector director) |
Set camera directory or null. More... | |
void | setGameWorld (GameWorld gameWorld) |
Set game world or null to remove. More... | |
void | setGameWorld (GameWorld gameWorld, bool dispose) |
Set game world or null to remove. More... | |
void | setUpdateCameraDirector (bool update) |
Set update camera director on frame updates. More... | |
void | setUpdateGameWorld (bool update) |
Set update game world on frame updates. More... | |
Public Member Functions inherited from Dragengine.Gui.Window | |
void | activeWidgetGrabFocus () |
void | addWindowListener (WindowListener listener) |
Add window listener. More... | |
void | becomeBackgroundWindow () |
Set window to act as a non-interactive background window. More... | |
void | centerWindow () |
Move window to the center of the parent desktop. More... | |
void | close () |
Close window. More... | |
void | fitToContent () |
Fit window size to content size. More... | |
bool | getActivated () |
Window is activated. More... | |
Widget | getActiveWidget () |
Active widget or null if there is none. More... | |
bool | getAlwaysOnTop () |
Window is always on top of all others. More... | |
WindowModal | getBlockingWindow () |
Modal window blocking this window or null. More... | |
bool | getCanActivate () |
Window can be activated. More... | |
bool | getCanClose () |
Window can be closed. More... | |
bool | getCanMaximize () |
Window can be maximized. More... | |
bool | getCanMinimize () |
Window can be minimized. More... | |
bool | getCanMove () |
Window can be moved. More... | |
bool | getCanReorder () |
Window can be reordered. More... | |
bool | getCanResize () |
Window can be resized. More... | |
Decoration | getDecoration () |
Decoration of window. More... | |
BorderSize | getDecorationSize () |
Get decoration size. More... | |
Color | getModalDarkenColor () |
Darkening color while modal window is in use. More... | |
bool | getProtectDecoration () |
Protect custom set decoration. More... | |
bool | getProtectModalDarkenColor () |
Protect custom set modal window darkening color. More... | |
Window | getTopBlockingWindow () |
Get top most blocking window or null. More... | |
Window | getWindow () |
Window or null if this widget is not part of a window. More... | |
Point | getWindowPosition () |
Widget position in window coordinates. More... | |
WindowState | getWindowState () |
Window state. More... | |
void | grabFocus () |
Grab the focus if possible. More... | |
void | moveAbove (Window window) |
Move window right above the given window. More... | |
void | moveBelow (Window window) |
Move window right below the given window. More... | |
void | moveToBottom () |
Move window to the bottom. More... | |
void | moveToTop () |
Move window to the top. More... | |
Window | new (int x, int y, int width, int height) |
Create window with the given geometry. More... | |
Window | new (Point position, Point size) |
Create window with the given geometry. More... | |
Widget | nextFocusWidgetAfter (Widget widget) |
Find next widget in the focus cycle that can grab the focus. More... | |
void | onDesignerChanged () |
Designer changed. More... | |
void | onDesktopResized () |
Desktop size changed. More... | |
void | onGuiThemeChanged () |
Gui theme changed. More... | |
void | onMaximized (WindowEvent event) |
Window has been maximized. More... | |
void | onMinimized (WindowEvent event) |
Window has been minimized. More... | |
void | onTranslationChanged () |
Translation manager or active language pack changed. More... | |
Widget | prevFocusWidgetAfter (Widget widget) |
Find previous widget in the focus cycle that can grab the focus. More... | |
void | removeWindowListener (WindowListener listener) |
Remove window listener. More... | |
void | requestGrabFocus (Widget widget) |
Request to focus the specified widget. More... | |
void | sendEventToListeners (Event event, bool sendToParent) |
Send event to all appropriate listeners for events of its kind. More... | |
void | setActivated (bool activated) |
Set if window is activated. More... | |
void | setActiveWidget (Widget widget) |
Set active widget. More... | |
void | setAlwaysOnTop (bool alwaysOnTop) |
Set if window is always on top of all others. More... | |
void | setBlockingWindow (WindowModal window) |
Set modal window blocking this window or null. More... | |
void | setCanActivate (bool canActivate) |
Set if window can be activated. More... | |
void | setCanClose (bool canClose) |
Set if window can be closed. More... | |
void | setCanMaximize (bool canMaximize) |
Set if window can be maximized. More... | |
void | setCanMinimize (bool canMinimize) |
Set if window can be minimized. More... | |
void | setCanMove (bool canMove) |
Set if window can be moved. More... | |
void | setCanReorder (bool canReorder) |
Set if window can be reordered. More... | |
void | setCanResize (bool canResize) |
Set window can be resized. More... | |
void | setDecoration (Decoration decoration) |
Set decoration of window. More... | |
void | setModalDarkenColor (Color color) |
Set darkening color while modal window is in use. More... | |
void | setProtectDecoration (bool protect) |
Set protect custom set decoration. More... | |
void | setProtectModalDarkenColor (bool protect) |
Set protect custom set modal window darkening color. More... | |
void | setTitle (String title) |
Set window title. More... | |
void | setWindowState (WindowState state) |
Set window state. More... | |
Public Member Functions inherited from Dragengine.Gui.Container | |
void | addWidget (Widget widget) |
void | addWidget (Widget widget, Object settings) |
bool | allowsChildGrabFocus () |
void | doLayout () |
Widget | findFocusableWidget () |
Widget | findLastFocusableWidget () |
Widget | findWidget (Block ablock) |
Find widget using block or null if not found. More... | |
int | getContainerHeight () |
Point | getContainerSize () |
int | getContainerWidth () |
bool | getHasBlockedDoLayout () |
doLayout calls happened during runWhileBlockingLayout. More... | |
Layout | getLayout () |
Point | getMinimumSize () |
Point | getMinimumSizeForHeight (int height) |
Minimum size of widget using reference widget height and variable width. More... | |
Point | getMinimumSizeForWidth (int width) |
Minimum size of widget using reference widget width and variable height. More... | |
bool | getStateChangeNotifyChildren () |
Notify children if state changed. More... | |
Widget | getWidget (int index) |
Widget | getWidgetAt (Point position) |
Widget at coordinates or null if not found. More... | |
int | getWidgetCount () |
void | giveUpFocus () |
bool | hasFocusWidget () |
Focus widget is inside container somewhere. More... | |
bool | hasWidget (Widget widget) |
int | indexOfWidget (Widget widget) |
Object | injectWidget (Object injectValue, Block ablock) |
Process value visiting widgets using block. More... | |
bool | isChildVisible (Widget child) |
bool | isMouseInside () |
Mouse is hovering over this widget. More... | |
void | layoutParent () |
void | moveWidget (Widget widget, int newPosition) |
Container | new (Layout layout) |
Create container with layout. More... | |
Container | new (Layout layout, Block blockAddContent) |
Create container with layout calling block to add content. More... | |
void | onPaddingChanged () |
Padding changed. More... | |
void | onStateChanged (StateChangeEvent event) |
State changed. More... | |
void | removeAllWidgets () |
Remove and dispose all widgets. More... | |
void | removeWidget (Widget widget) |
Remove widget without disposing. More... | |
bool | requestCaptureMouse (Widget widget) |
bool | requestReleaseMouse (Widget widget) |
void | runWhileBlockingLayout (Block ablock) |
Run block while layouting is blocked. More... | |
void | setEnabled (bool enabled) |
void | setHasBlockedDoLayout (bool hasBlockedDoLayout) |
Set if doLayout calls happened during runWhileBlockingLayout. More... | |
void | setLayout (Layout layout) |
void | setMousePointer (MousePointerFactory mousePointer) |
Set mouse pointer to use. More... | |
void | setStateChangeNotifyChildren (bool notify) |
Set to notify children if state changed. More... | |
Public Member Functions inherited from Dragengine.Gui.Widget | |
void | addDragListener (DragListener listener) |
void | addFocusListener (FocusListener listener) |
Add focus listener. More... | |
void | addGamepadListener (GamepadListener listener) |
Add gamepad listener. More... | |
void | addKeyListener (KeyListener listener) |
void | addMouseListener (MouseListener listener) |
void | addStateChangeListener (StateChangeListener listener) |
Add state change listener. More... | |
void | addWidgetListener (WidgetListener listener) |
Add widget listener. More... | |
bool | canGrabFullFocus () |
void | captureMouse () |
void | design () |
Design widget using WidgetDesigner. More... | |
CanvasCreator | getBackgroundCanvasCreator () |
Background canvas creator or null to use background color. More... | |
Border | getBorder () |
BorderSize | getBorderSize () |
RectArea | getBoundary () |
Rectangulare boundary of the widget. More... | |
RectArea | getBoundaryWithBorder () |
Rectangulare boundary of the widget including border. More... | |
bool | getCanFocus () |
CanvasView | getCanvasBackground () |
CanvasView | getCanvasContent () |
CanvasView | getCanvasWidget () |
Clipboard | getClipboard () |
Clipboard or null to use parent clipboard. More... | |
ColorMatrix | getColorTransformation () |
Color transformation. More... | |
WidgetDesigner | getDesigner () |
Designer. More... | |
String | getDesignerSelector () |
Designer selector. More... | |
Desktop | getDesktop () |
Point | getDesktopPosition () |
Widget position in desktop coordinates. More... | |
bool | getEnabled () |
MousePointerFactory | getFirstMousePointer () |
First assigned mouse pointer. More... | |
Font | getFont () |
bool | getHasFocus () |
int | getHeight () |
Height of widget. More... | |
RangeModel | getHorizontalRangeModel () |
Horizontal range model for viewports to synchronize the horizontal scrollbar. More... | |
Widget | getHoverWidget () |
Widget the mouse hovers above or null. More... | |
Point | getMinimumSizeWithBorder () |
Point | getMinimumSizeWithBorderForHeight (int height) |
Minimum size of widget with border using reference height. More... | |
Point | getMinimumSizeWithBorderForWidth (int width) |
Minimum size of widget with border for reference width. More... | |
MousePointerFactory | getMousePointer () |
Mouse pointer to use. More... | |
BorderSize | getPadding () |
Padding. More... | |
Container | getParent () |
Point | getPosition () |
Position of the widget. More... | |
bool | getProtectBackgroundCanvasCreator () |
Protect custom set background canvas creator. More... | |
bool | getProtectBorder () |
Protect custom set border. More... | |
bool | getProtectFont () |
Protect custom set font. More... | |
bool | getProtectMinimumSize () |
Protect custom set minimumsize. More... | |
bool | getProtectMousePointer () |
Protect custom set mouse pointer. More... | |
bool | getProtectPadding () |
Protect custom set padding. More... | |
bool | getProtectTextColor () |
Protect custom set text color. More... | |
Point | getRelativePosition (Container parent) |
Widget position in parent widget coordinates. More... | |
Point | getScreenPosition () |
Widget position in screen coordinates. More... | |
RectArea | getScreenRectArea () |
Point | getSetMinimumSize () |
Point | getSize () |
Size of the widget. More... | |
Color | getTextColor () |
Text color. More... | |
String | getTitle () |
Widget title. More... | |
Object | getToolTip () |
Tooltip or null. More... | |
float | getTotalTransparency () |
TexMatrix2 | getTransformation () |
float | getTransparency () |
RangeModel | getVerticalRangeModel () |
Vertical range model for viewports to synchronize the vertical scrollbar. More... | |
bool | getVisible () |
int | getWidth () |
Width of widget. More... | |
int | getX () |
X position of widget. More... | |
int | getY () |
Y position of widget. More... | |
bool | hasParent (Container container) |
bool | isDesignerSet () |
Custom designer is set. More... | |
bool | isFullEnabled () |
Widget and all parent widgets are enabled. More... | |
bool | isMinimumSizeSet () |
bool | isPointInside (Point position) |
bool | isTransformationSet () |
Widget | nextFocusWidget () |
Find next widget in the focus cycle that can grab the focus. More... | |
void | notifyBorderParametersChanged () |
void | onDispose (WidgetEvent event) |
Window is disposing. More... | |
void | onFocusLost (FocusEvent event) |
Widget lost focus. More... | |
void | onFocusReceived (FocusEvent event) |
Widget received focus. More... | |
void | onGamepadButtonPressed (GamepadEvent event) |
Gamepad button has been pressed. More... | |
void | onGamepadButtonReleased (GamepadEvent event) |
Gamepad button has been released. More... | |
void | onHidden (WidgetEvent event) |
Widget has been hidden. More... | |
void | onParentStateChanged () |
Parent state changed. More... | |
void | onParentStateChanged (bool force) |
Parent state changed. More... | |
void | onReposition (WidgetEvent event) |
Position changed. More... | |
void | onResize (WidgetEvent event) |
Size changed. More... | |
void | onSetFont () |
void | onSetTextColor () |
Text color changed. More... | |
void | onShown (WidgetEvent event) |
Widget has been shown. More... | |
void | popdownVirtualKeyboard () |
Popdown virtual keyboard if Desktop has one assigned. More... | |
void | popupVirtualKeyboard () |
Popup virtual keyboard if Desktop has one assigned. More... | |
Widget | prevFocusWidget () |
Find previous widget in the focus cycle that can grab the focus. More... | |
void | processEvent (Event event) |
void | releaseMouse () |
void | removeDragListener (DragListener listener) |
void | removeFocusListener (FocusListener listener) |
Remove focus listener. More... | |
void | removeGamepadListener (GamepadListener listener) |
Remove gamepad listener. More... | |
void | removeKeyListener (KeyListener listener) |
void | removeMouseListener (MouseListener listener) |
void | removeStateChangeListener (StateChangeListener listener) |
Remove state change listener. More... | |
void | removeWidgetListener (WidgetListener listener) |
Remove widget listener. More... | |
void | safeDispose () |
Safely dispose of widget. More... | |
void | sendEvent (Event event) |
void | setBackgroundCanvasCreator (CanvasCreator creator) |
Set background canvas creator or null to use background color. More... | |
void | setBorder (Border border) |
void | setCanFocus (bool canFocus) |
void | setClipboard (Clipboard clipboard) |
Set clipboard or null to use parent clipboard. More... | |
void | setColorTransformation (ColorMatrix transformation) |
Set color transformation. More... | |
void | setDesigner (WidgetDesigner designer) |
Set designer. More... | |
void | setDesignerSelector (String selector) |
Set designer selector. More... | |
void | setFont (Font font) |
void | setHasFocus (bool hasFocus) |
void | setHeight (int height) |
Set height of widget. More... | |
void | setMinimumSize (Point size) |
void | setPadding (BorderSize padding) |
Set padding. More... | |
void | setParent (Container parent) |
void | setPosition (Point position) |
Set position of widget. More... | |
void | setProtectBackgroundCanvasCreator (bool protect) |
Set protect custom set background canvas creator. More... | |
void | setProtectBorder (bool protect) |
Set protect custom set border. More... | |
void | setProtectFont (bool protect) |
Set protect custom set font. More... | |
void | setProtectMinimumSize (bool protect) |
Set protect custom set minimumsize. More... | |
void | setProtectMousePointer (bool protect) |
Set protect custom set mouse pointer. More... | |
void | setProtectPadding (bool protect) |
Set protect custom set padding. More... | |
void | setProtectTextColor (bool protect) |
Set protect custom set text color. More... | |
void | setSize (Point size) |
Set size of widget. More... | |
void | setTextColor (Color color) |
Set text color. More... | |
void | setToolTip (Object toolTip) |
Set tooltip or null. More... | |
void | setTransformation (TexMatrix2 transformation) |
void | setTransparency (float transparency) |
void | setVisible (bool visible) |
void | setWidth (int width) |
Set width of widget. More... | |
void | setX (int x) |
Set X position of widget. More... | |
void | setY (int y) |
Set Y Position of widget. More... | |
void | startFrameUpdater () |
Start frame updater if not running. More... | |
void | stopFrameUpdater () |
Stop frame updater if running. More... | |
void | stopRepeatEventTimer () |
Protected Member Functions | |
void | createContent () |
Create window content. More... | |
Protected Member Functions inherited from Dragengine.Gui.Window | |
void | setDecorationFromDesigner () |
Set decoration from designer if not protected. More... | |
void | updateCanvasGeometry () |
Update canvas position and size. More... | |
Protected Member Functions inherited from Dragengine.Gui.Widget | |
WidgetDesigner | getDesignerFromTheme () |
Get designer from gui theme. More... | |
void | updateCanvasBackground () |
Update background canvas content. More... | |
Window running a GameWorld.
Simple way to run a game world. All you need to do is subclassing WindowGameWorld.Loader load and assign a game world to the widget. If a game world is present it is updated every frame update. Optionally the updating of the game world and camera director can be individually disabled. This can be used for example to pause the game world processing or to show a main menu without consuming processing time.
The panel contains a WorldRenderer widget showing the content of a GameWorld object if present. The game world is loaded using a subclass of GameWorldLoader. For convenience the class WindowGameWorld.Loader provides support of updating the WindowGameWorld once finished. The most simple solution is to subclass WindowGameWorld.Loader instead of GameWorldLoader.
A CameraDirector can be set to operate the camera and microphone resource. This is the preferred way since it allows to easily change the directory taking control of these resources without having to worry about all Typically you use ElementCameraDirector to handle camera and microphone relative to a player actor and ConversationCameraDirector to play back conversations.
Window can be styled using designer named "WindowGameWorld". The default style makes the window borderless with no mouse pointer suitable for full screen use.
The layout is enhanced like this to allow for more possibilities:
The window stack layout allows to stack widgets over the world render panels which should cover the entire window. Typically these are UI widgets not directly interacting with the world renderer panel content.
The getPanelBorder() allows to add UI widgets at the borders of the window to create the UI layouts typically used for games where the world renderer is part of a UI interface the player interacts with (hence not first person shooter type games). Using this panel makes the world renderer and widgets stacked over it to occupy the empty space.
The getPanelStack() allows to add stack widgets over the world renderer itself. These widgets have the same size as the world renderer in contrary to being added to the window itself. This is useful for adding widgets that should only cover the world renderer like targeting reticules or damage indicators.
Vector Dragengine.Gui.WindowGameWorld.backProject | ( | MouseEvent | event | ) |
Back project position into 3d world.
Event can originate from any widget inside the window. The event position is converted to world renderer coordinate system before calling backProject on world renderer.
Back project position into 3d world.
|
protected |
Create window content.
Called during constructor. Sets StackLayout as window layout and adds getWorldRenderer() as only widget.
void Dragengine.Gui.WindowGameWorld.dispose | ( | ) |
Dispose of Widget.
Reimplemented from Dragengine.Gui.Window.
bool Dragengine.Gui.WindowGameWorld.getActivateMicrophone | ( | ) |
Activate microphone if game world is set.
CameraDirector Dragengine.Gui.WindowGameWorld.getCameraDirector | ( | ) |
Camera directory or null.
Console Dragengine.Gui.WindowGameWorld.getConsole | ( | ) |
Console object.
Microphone Dragengine.Gui.WindowGameWorld.getMicrophone | ( | ) |
Microphone to hear sound.
Panel Dragengine.Gui.WindowGameWorld.getPanelBorder | ( | ) |
Panel with BorderLayout containing world render content.
Allows to add UI widgets at the borders of the window to create the UI layouts typically used for games where the world renderer is part of a UI interface the player interacts with (hence not first person shooter type games). Using this panel makes the world renderer and widgets stacked over it to occupy the empty space.
Panel Dragengine.Gui.WindowGameWorld.getPanelStack | ( | ) |
Panel with StackLayout containing world render.
Allows to add stack widgets over the world renderer itself. These widgets have the same size as the world renderer in contrary to being added to the window itself. This is useful for adding widgets that should only cover the world renderer like targeting reticules or damage indicators.
bool Dragengine.Gui.WindowGameWorld.getUpdateCameraDirector | ( | ) |
Update camera director on frame updates.
bool Dragengine.Gui.WindowGameWorld.getUpdateGameWorld | ( | ) |
Update game world on frame updates.
WorldRenderer Dragengine.Gui.WindowGameWorld.getWorldRenderer | ( | ) |
World renderer.
WindowGameWorld Dragengine.Gui.WindowGameWorld.new | ( | ) |
Create screen sized window using BaseGameApp console.
Reimplemented from Dragengine.Gui.Window.
WindowGameWorld Dragengine.Gui.WindowGameWorld.new | ( | Console | console | ) |
Create screen sized window.
void Dragengine.Gui.WindowGameWorld.onDesignerSelectorChanged | ( | ) |
Designer selector changed.
Updates world renderer widget designer selector to "WorldRenderer.{selector}".
Reimplemented from Dragengine.Gui.Window.
void Dragengine.Gui.WindowGameWorld.onFrameUpdate | ( | float | elapsed | ) |
Update game world every frame update if present.
elapsed | Elapsed time as reported by Engine.getElapsedTime(). |
Reimplemented from Dragengine.Gui.Widget.
void Dragengine.Gui.WindowGameWorld.onGameWorldChanged | ( | ) |
Game world changed.
Project point from 3d world.
void Dragengine.Gui.WindowGameWorld.setActivateMicrophone | ( | bool | activateMicrophone | ) |
Set if microphone is activated if game world is set.
void Dragengine.Gui.WindowGameWorld.setCameraDirector | ( | CameraDirector | director | ) |
Set camera directory or null.
Deactivates the old camera director if present and unsets camera and microphone. Activates the new camera if present and sets camera and microphone.
Updates the camera director once if updating camera director is enabled
void Dragengine.Gui.WindowGameWorld.setGameWorld | ( | GameWorld | gameWorld | ) |
Set game world or null to remove.
The old game world is disposed of if present. If disposing causes exceptions the error is logged and the game world discarded.
This is the same as calling setGameWorld(gameWorld, true).
Calls onGameWorldChanged() hoock method if the game world changed.
void Dragengine.Gui.WindowGameWorld.setGameWorld | ( | GameWorld | gameWorld, |
bool | dispose | ||
) |
Set game world or null to remove.
If dispose is true the old game world is disposed of if present. If disposing causes exceptions the error is logged and the game world discarded.
If dispose is false the caller is responsible to dispose of the game world at the appropriate time. This can be used for games using multiple game worlds they switch between disposing them at game exit time.
Calls onGameWorldChanged() hoock method if the game world changed.
void Dragengine.Gui.WindowGameWorld.setUpdateCameraDirector | ( | bool | update | ) |
Set update camera director on frame updates.
void Dragengine.Gui.WindowGameWorld.setUpdateGameWorld | ( | bool | update | ) |
Set update game world on frame updates.