Add an API event for modified render and full data files

2023-06-19 21:41:42 -05:00
parent 419323bedb
commit e760c6a4e3
4 changed files with 83 additions and 6 deletions
@@ -1,5 +1,6 @@
 package com.seibel.distanthorizons.api.interfaces.data;

+import com.seibel.distanthorizons.api.enums.EDhApiDetailLevel;
 import com.seibel.distanthorizons.api.interfaces.world.IDhApiLevelWrapper;
 import com.seibel.distanthorizons.api.objects.DhApiResult;
 import com.seibel.distanthorizons.api.objects.data.DhApiRaycastResult;
@@ -45,7 +46,8 @@ public interface IDhApiTerrainDataRepo
 	 * 
 	 * @param detailLevel a positive byte defining the detail level of the returned data. <br>
 	 * 					  Every increase doubles the width of the returned area. <br>
-	 * 					  Example values: 0 = block, 1 = 2x2 blocks, 2 = 4x4 blocks, ... 4 = chunk (16x16 blocks), ... 9 = region (512x512 blocks)
+	 * 					  Example values: 0 = block, 1 = 2x2 blocks, 2 = 4x4 blocks, ... 4 = chunk (16x16 blocks), ... 9 = region (512x512 blocks) <br>
+	 * 					  See {@link EDhApiDetailLevel} for more information.
 	 */
 	DhApiResult<DhApiTerrainDataPoint[][][]> getAllTerrainDataAtDetailLevelAndPos(IDhApiLevelWrapper levelWrapper, byte detailLevel, int posX, int posZ);
 	
@@ -0,0 +1,73 @@
+package com.seibel.distanthorizons.api.methods.events.abstractEvents;
+		
+import com.seibel.distanthorizons.api.enums.EDhApiDetailLevel;
+import com.seibel.distanthorizons.api.interfaces.data.IDhApiTerrainDataRepo;
+import com.seibel.distanthorizons.api.methods.events.interfaces.IDhApiEvent;
+import com.seibel.distanthorizons.api.objects.events.DhApiEventDefinition;
+
+/**
+ * @author James Seibel
+ * @version 2023-6-19
+ */
+public abstract class DhApiDataFileChangedEvent implements IDhApiEvent<DhApiDataFileChangedEvent.EventParam>
+{
+	/** 
+	 * Fired after any data files handled by Distant Horizons are modified. <br> 
+	 * Note: this event may not fire immediately after a change happens, 
+	 * this event is only fired after the data is saved to disk.
+	 */
+	public abstract void onDhDataFileChanged(EventParam input);
+	
+	
+	//=========================//
+	// internal DH API methods //
+	//=========================//
+	
+	@Override
+	public final boolean fireEvent(EventParam input)
+	{
+		this.onDhDataFileChanged(input);
+		return false;
+	}
+	
+	public final static DhApiEventDefinition EVENT_DEFINITION = new DhApiEventDefinition(false, false);
+	@Override
+	public final DhApiEventDefinition getEventDefinition() { return EVENT_DEFINITION; }
+	
+	
+	//==================//
+	// parameter object //
+	//==================//
+	
+	/** in order to access the modified data, please use the {@link IDhApiTerrainDataRepo}. */
+	public static class EventParam
+	{
+		/** defines what type of data was modified */
+		public final EDataType dataTypeEnum;
+		
+		/** See {@link EDhApiDetailLevel} for more information on detail levels. */
+		public final byte detailLevel;
+		public final int posX;
+		public final int posZ;
+		
+		
+		public EventParam(EDataType dataTypeEnum, byte detailLevel, int posX, int posZ) 
+		{
+			this.dataTypeEnum = dataTypeEnum;
+			
+			this.detailLevel = detailLevel;
+			this.posX = posX;
+			this.posZ = posZ;
+		}
+	}
+	
+	/** when in doubt, use {@link EDataType#Full}. */
+	public enum EDataType
+	{
+		/** color data, based on the currently selected resource packs */
+		Render,
+		/** ID based data */
+		Full;
+	}
+	
+}