Merge pull request #5824 from Baaaaaz/feature/5786-token-halos-in-campaign-properties

New Custom Halos

Author: kwvanderlinde

messages/src/main/proto/data_transfer_objects.proto

@@ -100,6 +100,58 @@ message LightDto {
   int32 lumens = 9;
 }
 
+message HaloDto {
+  string id = 1;
+  string name = 2;
+  bool gm_only = 3;
+  bool owner_only = 4;
+  bool inner = 5;
+  bool facing_with_token = 6;
+  bool flip_with_token = 7;
+  bool scale_with_token = 8;
+  repeated HaloPartDto halo_parts = 9;
+}
+
+message HaloPartDto {
+  enum HaloShapeTypeDto {
+    CIRCLE = 0;
+    ARC = 1;
+    CHORD = 2;
+    PIE = 3;
+    TRIANGLE = 4;
+    SQUARE = 5;
+    POLYGON = 6;
+    STAR = 7;
+    GRID = 8;
+    FOOTPRINT = 9;
+    TOKEN = 10;
+    OUTLINE = 11;
+    MBL = 12;
+    VBLCOVER = 13;
+    VBLHILL = 14;
+    VBLPIT = 15;
+    VBLWALL = 16;
+  }
+  DrawablePaintDto paint = 1;
+  HaloShapeTypeDto halo_shape_type = 2;
+  google.protobuf.Int32Value width = 3;
+  repeated float dashed_pattern = 4;
+  bool fill = 5;
+  bool flip_horizontal = 6;
+  bool flip_vertical = 7;
+  double angle = 8;
+  double offset = 9;
+  double rotate = 10;
+  double scale_x = 11;
+  double scale_y = 12;
+  int32 vertices = 13;
+  int32 mini = 14;
+  int32 mini_start = 15;
+  int32 mini_stop = 16;
+  double mini_rotate = 17;
+  double mini_spin = 18;
+}
+
 message LocationDto {
   oneof LocationTyp {
     LocalLocationDto local_location = 1;
@@ -134,6 +186,7 @@ message CampaignPropertiesDto {
   repeated SightTypeDto sight_types = 13;
   map<string, StatSheetPropertiesDto> token_type_stat_sheet = 14;
   google.protobuf.StringValue default_token_property_type = 15;
+  map<string, HaloListDto> halos = 16;
 }
 
 message SightTypeDto {
@@ -289,6 +342,10 @@ message LightSourceListDto {
   repeated LightSourceDto light_sources = 1;
 }
 
+message HaloListDto {
+  repeated HaloDto halos = 1;
+}
+
 enum WalkerMetricDto {
   NO_DIAGONALS = 0;
   MANHATTAN = 1;
@@ -403,6 +460,7 @@ message TokenDto {
   string notes_type = 68;
   string gm_notes_type = 69;
   StatSheetPropertiesDto stat_sheet_properties = 70;
+  repeated string halo_guids = 73;
 }
 
 message PathDto {
@@ -695,6 +753,9 @@ enum TokenUpdateDto {
     flipIso = 55;
     setSpeechName = 56;
     removeFacing = 57;
+    clearHalos = 58;
+    removeHalo = 59;
+    addHalo = 60;
 }
 
 message AssetTransferHeaderDto {
@@ -722,6 +783,8 @@ message TokenPropertyValueDto {
     GridDto grid = 10;
     TokenFootPrintDto token_foot_print = 11;
     string topology_type = 12;
+    string halo_id = 13;
+    HaloDto halo = 14;
   }
 }
 

src/main/java/net/rptools/maptool/client/AppActions.java

@@ -1623,13 +1623,39 @@ protected void executeAction(@Nonnull ZoneRenderer renderer) {
     }
   }
 
+  public static final Action TOGGLE_SHOW_TOKEN_HALOS =
+      new TranslatedClientAction(
+          "action.showTokenHalos", withMenuShortcut(KeyStroke.getKeyStroke("Q"))) {
+        {
+          putValue(Action.SMALL_ICON, RessourceManager.getSmallIcon(Icons.MENU_SHOW_TOKEN_HALOS));
+        }
+
+        @Override
+        public boolean isSelected() {
+          return AppState.isShowTokenHalos();
+        }
+
+        @Override
+        protected void executeAction() {
+          AppState.setShowTokenHalos(!AppState.isShowTokenHalos());
+          if (MapTool.getFrame().getCurrentZoneRenderer() != null) {
+            MapTool.getFrame().getCurrentZoneRenderer().repaint();
+          }
+        }
+      };
+
   public static final Action TOGGLE_SHOW_TOKEN_NAMES =
       new TranslatedClientAction(
           "action.showNames", withMenuShortcut(KeyStroke.getKeyStroke("T"))) {
         {
           putValue(Action.SMALL_ICON, RessourceManager.getSmallIcon(Icons.MENU_SHOW_TOKEN_NAMES));
         }
 
+        @Override
+        public boolean isSelected() {
+          return AppState.isShowTokenNames();
+        }
+
         @Override
         protected void executeAction() {
 

src/main/java/net/rptools/maptool/client/AppState.java

@@ -28,6 +28,7 @@ public class AppState {
 
   private static boolean showGrid = false;
   private static boolean showCoordinates = false;
+  private static boolean showTokenHalos = true;
   private static boolean showTokenNames = false;
   private static boolean linkPlayerViews = false;
   private static boolean useDoubleWideLine = true;
@@ -123,6 +124,14 @@ public static void setShowCoordinates(boolean flag) {
     showCoordinates = flag;
   }
 
+  public static void setShowTokenHalos(boolean flag) {
+    showTokenHalos = flag;
+  }
+
+  public static boolean isShowTokenHalos() {
+    return showTokenHalos;
+  }
+
   public static void setShowTokenNames(boolean flag) {
     showTokenNames = flag;
   }

src/main/java/net/rptools/maptool/client/MapToolExpressionParser.java

@@ -70,7 +70,7 @@ public class MapToolExpressionParser extends ExpressionParser {
               TokenBarFunction.getInstance(),
               TokenCopyDeleteFunctions.getInstance(),
               TokenGMNameFunction.getInstance(),
-              TokenHaloFunction.getInstance(),
+              TokenHaloFunctions.getInstance(),
               TokenImage.getInstance(),
               TokenInitFunction.getInstance(),
               TokenInitHoldFunction.getInstance(),

src/main/java/net/rptools/maptool/client/MapToolVariableResolver.java

@@ -215,7 +215,7 @@ public Object getVariable(String name, VariableModifiers mods) throws ParserExce
         // We don't want this evaluated as the # format is more useful to us then the
         // evaluated
         // format.
-        return TokenHaloFunction.getHalo(tokenInContext).toString();
+        return TokenHaloFunctions.getHalo(tokenInContext).toString();
       } else if (name.equals(TOKEN_NAME)) {
         // Don't evaluate return value.
         return TokenNameFunction.getName(tokenInContext);
@@ -370,7 +370,7 @@ public void setVariable(String varname, VariableModifiers modifiers, Object valu
       TokenBarFunction.setValue(tokenInContext, barName, value);
       return;
     } else if (varname.equals(TOKEN_HALO)) {
-      TokenHaloFunction.setHalo(tokenInContext, value);
+      TokenHaloFunctions.setHalo(tokenInContext, value);
       return;
     } else if (varname.equals(TOKEN_NAME)) {
       if (value.toString().equals("")) {

src/main/java/net/rptools/maptool/client/ServerCommandClientImpl.java

@@ -672,6 +672,16 @@ public void toggleLightSourceOnToken(Token token, boolean toggleOn, LightSource
             .build());
   }
 
+  @Override
+  public void toggleHaloSourceOnToken(Token token, boolean toggleOn, Halo halo) {
+    var update = toggleOn ? Token.Update.addHalo : Token.Update.removeHalo;
+    // We only need to send the ID of the halo source.
+    updateTokenProperty(
+        token,
+        update,
+        TokenPropertyValueDto.newBuilder().setHaloId(halo.getId().toString()).build());
+  }
+
   public void setTokenMaskTopology(
       Token token, @Nullable Area area, Zone.TopologyType topologyType) {
     if (area == null) {