-
Notifications
You must be signed in to change notification settings - Fork 291
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4971 from SJuliez/entity-debug-output
Entity debug helper
- Loading branch information
Showing
3 changed files
with
181 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| /* | ||
| * Copyright (c) 2023 - The MegaMek Team. All Rights Reserved. | ||
| * | ||
| * This file is part of MegaMek. | ||
| * | ||
| * MegaMek is free software: you can redistribute it and/or modify | ||
| * it 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. | ||
| * | ||
| * MegaMek is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with MegaMek. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
| package megamek.utilities; | ||
|
|
||
| import megamek.common.CriticalSlot; | ||
| import megamek.common.Entity; | ||
| import megamek.common.Mech; | ||
| import megamek.common.Protomech; | ||
|
|
||
| import java.awt.*; | ||
| import java.awt.datatransfer.Clipboard; | ||
| import java.awt.datatransfer.StringSelection; | ||
|
|
||
| /** | ||
| * This class is for debugging Entity with respect to the internal state of equipment. | ||
| */ | ||
| @SuppressWarnings("unused") | ||
| public class DebugEntity { | ||
|
|
||
| /** | ||
| * Gets a full listing of the internal representation of the unit's equipment and crit slots with most | ||
| * of the internal state of each ({@link #getEquipmentState(Entity)}) and copies it to the clipboard. | ||
| * | ||
| * @param entity The entity to debug | ||
| */ | ||
| public static void copyEquipmentState(Entity entity) { | ||
| copyToClipboard(getEquipmentState(entity)); | ||
| } | ||
|
|
||
| /** Copies the given text to the Clipboard. */ | ||
| public static void copyToClipboard(String text) { | ||
| StringSelection stringSelection = new StringSelection(text); | ||
| Clipboard clipboard = Toolkit.getDefaultToolkit().getSystemClipboard(); | ||
| clipboard.setContents(stringSelection, null); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a full listing of the internal representation of the unit's equipment and crit slots with most | ||
| * of the internal state of each. | ||
| * | ||
| * @param entity The entity to debug | ||
| * @return A String describing the internal state of the Entity's equipment | ||
| */ | ||
| public static String getEquipmentState(Entity entity) { | ||
| StringBuilder result = new StringBuilder(); | ||
| try { | ||
| result.append("Chassis: >").append(entity.getChassis()).append("<\n"); | ||
| result.append("Model: >").append(entity.getModel()).append("<\n"); | ||
|
|
||
| result.append("Equipment:\n"); | ||
| for (int i = 0; i < entity.getEquipment().size(); i++) { | ||
| result.append("[" + i + "] ").append(entity.getEquipment(i)).append("\n"); | ||
| if (entity != entity.getEquipment(i).getEntity()) { | ||
| result.append("Different Entity!"); | ||
| } | ||
| } | ||
| result.append("\n"); | ||
|
|
||
| result.append("Locations:\n"); | ||
| for (int location = 0; location < entity.locations(); location++) { | ||
| result.append(entity.getLocationAbbr(location)).append(":\n"); | ||
| for (int slot = 0; slot < entity.getNumberOfCriticals(location); slot++) { | ||
| CriticalSlot criticalSlot = entity.getCritical(location, slot); | ||
| if (criticalSlot != null) { | ||
| result.append("[" + slot + "] ").append(criticalSlot); | ||
| if (criticalSlot.getType() == 0) { | ||
| result.append(" ("); | ||
| if (entity instanceof Mech) { | ||
| result.append(((Mech) entity).getSystemName(criticalSlot.getIndex())); | ||
| } else if (entity instanceof Protomech) { | ||
| result.append(Protomech.systemNames[criticalSlot.getIndex()]); | ||
| } | ||
| result.append(")"); | ||
| } | ||
| result.append("\n"); | ||
| } | ||
| } | ||
| } | ||
| } catch (Exception e) { | ||
| result.append("\nAn exception was encountered here. " + e.getMessage()); | ||
| } | ||
|
|
||
| return result.toString(); | ||
| } | ||
|
|
||
| private DebugEntity() { } | ||
| } |