Skip to content

Commit

Permalink
Add hotkeys for editor map overlays
Browse files Browse the repository at this point in the history
  • Loading branch information
dragunoff committed May 9, 2022
1 parent ed24902 commit b661599
Show file tree
Hide file tree
Showing 4 changed files with 143 additions and 82 deletions.
61 changes: 0 additions & 61 deletions OpenRA.Mods.Common/Widgets/Logic/Editor/MapEditorLogic.cs
Expand Up @@ -11,26 +11,15 @@

using System.Linq;
using OpenRA.Graphics;
using OpenRA.Mods.Common.Lint;
using OpenRA.Mods.Common.Traits;
using OpenRA.Widgets;

namespace OpenRA.Mods.Common.Widgets.Logic
{
[ChromeLogicArgsHotkeys("ChangeZoomKey")]
public class MapEditorLogic : ChromeLogic
{
MapCopyFilters copyFilters = MapCopyFilters.All;

enum MapOverlays
{
None = 0,
Grid = 1,
Buildable = 2,
}

MapOverlays overlays = MapOverlays.None;

[ObjectCreator.UseCtor]
public MapEditorLogic(Widget widget, World world, WorldRenderer worldRenderer)
{
Expand Down Expand Up @@ -63,16 +52,6 @@ public MapEditorLogic(Widget widget, World world, WorldRenderer worldRenderer)
};
}

var overlayDropdown = widget.GetOrNull<DropDownButtonWidget>("OVERLAY_BUTTON");
if (overlayDropdown != null)
{
overlayDropdown.OnMouseDown = _ =>
{
overlayDropdown.RemovePanel();
overlayDropdown.AttachPanel(CreateOverlaysPanel(world));
};
}

var cashLabel = widget.GetOrNull<LabelWidget>("CASH_LABEL");
if (cashLabel != null)
{
Expand Down Expand Up @@ -112,45 +91,5 @@ Widget CreateCategoriesPanel()

return categoriesPanel;
}

Widget CreateOverlaysPanel(World world)
{
var categoriesPanel = Ui.LoadWidget("OVERLAY_PANEL", null, new WidgetArgs());
var categoryTemplate = categoriesPanel.Get<CheckboxWidget>("CATEGORY_TEMPLATE");

MapOverlays[] allCategories = { MapOverlays.Grid, MapOverlays.Buildable };
foreach (var cat in allCategories)
{
var category = (CheckboxWidget)categoryTemplate.Clone();
category.GetText = () => cat.ToString();
category.IsChecked = () => overlays.HasFlag(cat);
category.IsVisible = () => true;
category.OnClick = () => overlays ^= cat;

if (cat.HasFlag(MapOverlays.Grid))
{
var terrainGeometryTrait = world.WorldActor.Trait<TerrainGeometryOverlay>();
category.OnClick = () =>
{
overlays ^= cat;
terrainGeometryTrait.Enabled = overlays.HasFlag(MapOverlays.Grid);
};
}

if (cat.HasFlag(MapOverlays.Buildable))
{
var buildableTerrainTrait = world.WorldActor.Trait<BuildableTerrainOverlay>();
category.OnClick = () =>
{
overlays ^= cat;
buildableTerrainTrait.Enabled = overlays.HasFlag(MapOverlays.Buildable);
};
}

categoriesPanel.AddChild(category);
}

return categoriesPanel;
}
}
}
109 changes: 109 additions & 0 deletions OpenRA.Mods.Common/Widgets/Logic/Editor/MapOverlaysLogic.cs
@@ -0,0 +1,109 @@
#region Copyright & License Information
/*
* Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
* This file is part of OpenRA, which is free software. It is made
* available to you under the terms of the GNU General Public License
* as published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version. For more
* information, see COPYING.
*/
#endregion

using System.Collections.Generic;
using OpenRA.Mods.Common.Lint;
using OpenRA.Mods.Common.Traits;
using OpenRA.Widgets;

namespace OpenRA.Mods.Common.Widgets.Logic
{
[ChromeLogicArgsHotkeys("ToggleGridOverlayKey", "ToggleBuildableOverlayKey")]
public class MapOverlaysLogic : ChromeLogic
{
enum MapOverlays
{
None = 0,
Grid = 1,
Buildable = 2,
}

readonly TerrainGeometryOverlay terrainGeometryTrait;
readonly BuildableTerrainOverlay buildableTerrainTrait;

[ObjectCreator.UseCtor]
public MapOverlaysLogic(Widget widget, World world, ModData modData, Dictionary<string, MiniYaml> logicArgs)
{
terrainGeometryTrait = world.WorldActor.Trait<TerrainGeometryOverlay>();
buildableTerrainTrait = world.WorldActor.Trait<BuildableTerrainOverlay>();

var toggleGridKey = new HotkeyReference();
if (logicArgs.TryGetValue("ToggleGridOverlayKey", out var yaml))
toggleGridKey = modData.Hotkeys[yaml.Value];

var toggleBuildableKey = new HotkeyReference();
if (logicArgs.TryGetValue("ToggleBuildableOverlayKey", out yaml))
toggleBuildableKey = modData.Hotkeys[yaml.Value];

var keyhandler = widget.Get<LogicKeyListenerWidget>("OVERLAY_KEYHANDLER");
keyhandler.AddHandler(e =>
{
if (e.Event != KeyInputEvent.Down)
return false;
if (toggleGridKey.IsActivatedBy(e))
{
terrainGeometryTrait.Enabled ^= true;
return true;
}
if (toggleBuildableKey.IsActivatedBy(e))
{
buildableTerrainTrait.Enabled ^= true;
return true;
}
return false;
});

var overlayPanel = CreateOverlaysPanel();

var overlayDropdown = widget.GetOrNull<DropDownButtonWidget>("OVERLAY_BUTTON");
if (overlayDropdown != null)
{
overlayDropdown.OnMouseDown = _ =>
{
overlayDropdown.RemovePanel();
overlayDropdown.AttachPanel(overlayPanel);
};
}
}

Widget CreateOverlaysPanel()
{
var categoriesPanel = Ui.LoadWidget("OVERLAY_PANEL", null, new WidgetArgs());
var categoryTemplate = categoriesPanel.Get<CheckboxWidget>("CATEGORY_TEMPLATE");

MapOverlays[] allCategories = { MapOverlays.Grid, MapOverlays.Buildable };
foreach (var cat in allCategories)
{
var category = (CheckboxWidget)categoryTemplate.Clone();
category.GetText = () => cat.ToString();
category.IsVisible = () => true;

if (cat.HasFlag(MapOverlays.Grid))
{
category.IsChecked = () => terrainGeometryTrait.Enabled;
category.OnClick = () => terrainGeometryTrait.Enabled ^= true;
}
else if (cat.HasFlag(MapOverlays.Buildable))
{
category.IsChecked = () => buildableTerrainTrait.Enabled;
category.OnClick = () => buildableTerrainTrait.Enabled ^= true;
}

categoriesPanel.AddChild(category);
}

return categoriesPanel;
}
}
}
5 changes: 4 additions & 1 deletion mods/cnc/chrome/editor.yaml
Expand Up @@ -212,8 +212,11 @@ Container@EDITOR_ROOT:
TooltipContainer@TOOLTIP_CONTAINER:

Container@EDITOR_WORLD_ROOT:
Logic: LoadIngamePerfLogic, MapEditorLogic, ActorEditLogic
Logic: LoadIngamePerfLogic, MapEditorLogic, ActorEditLogic, MapOverlaysLogic
ToggleGridOverlayKey: EditorToggleGridOverlay
ToggleBuildableOverlayKey: EditorToggleBuildableOverlay
Children:
LogicKeyListener@OVERLAY_KEYHANDLER:
Container@PERF_ROOT:
EditorViewportController@MAP_EDITOR:
Width: WINDOW_RIGHT
Expand Down
50 changes: 30 additions & 20 deletions mods/common/hotkeys/editor.yaml
@@ -1,3 +1,33 @@
EditorTilesTab: E
Description: Tiles Tab
Types: Editor
Contexts: Editor

EditorOverlaysTab: R
Description: Overlays Tab
Types: Editor
Contexts: Editor

EditorActorsTab: T
Description: Actors Tab
Types: Editor
Contexts: Editor

EditorHistoryTab: Y
Description: History Tab
Types: Editor
Contexts: Editor

EditorToggleGridOverlay: F1
Description: Grid Overlay
Types: Editor
Contexts: Editor

EditorToggleBuildableOverlay: F2
Description: Buildable Terrain Overlay
Types: Editor
Contexts: Editor

EditorUndo: Z Ctrl
Description: Undo
Types: Editor
Expand All @@ -19,23 +49,3 @@ EditorCopy: C Ctrl
Contexts: Editor
Platform:
OSX: C Meta

EditorTilesTab: E
Description: Tiles Tab
Types: Editor
Contexts: Editor

EditorOverlaysTab: R
Description: Overlays Tab
Types: Editor
Contexts: Editor

EditorActorsTab: T
Description: Actors Tab
Types: Editor
Contexts: Editor

EditorHistoryTab: Y
Description: History Tab
Types: Editor
Contexts: Editor

0 comments on commit b661599

Please sign in to comment.