Added setup for version control and finished alias system ready for first pre-release

Signed-off-by: NarcoMarshDev <[email protected]>

Author: NarcoMarshDev

resourceDatabase.rdb

@@ -1 +1,3 @@
-#define ESE_INSTALLED // Always keep this enabled to ensure mod compatiblity with aliases
+#define ESE_INSTALLED // Always keep this enabled to ensure mod compatiblity with additional aliases
+
+bool ESE_IS_INITIALIZED = ESE.Init();

scripts/Game/!ESE_CORE.c

@@ -0,0 +1,40 @@
+// -----------------------------------------------------------------------------------------------------------
+// Enforce Script Extensions - By NarcoMarshmallow
+// 
+// Message me @narcoleptic marshmallow #1188 on discord to give feedback or go to https://github.com/NarcoMarshDev
+// -----------------------------------------------------------------------------------------------------------
+
+// This is a custom config for developing ese internally, it can all be ignored
+
+//#define ESE_DEVMODE // remember to comment off before releases
+
+#ifdef ESE_DEVMODE
+
+//#define ESE_VERBOSE
+//#define ESE_ENABLE_WIP
+//#define ESE_EXPERIMENTAL
+//#define ESE_OBSOLETE
+#define ESE_ALIASES_ALL
+//#define ESE_ALIASES_MATERIALS
+//#define ESE_ALIASES_WEAPONS
+//#define ESE_ALIASES_ATTACHMENTS
+//#define ESE_ALIASES_MAGAZINES
+//#define ESE_ALIASES_EQUIPMENT
+//#define ESE_ALIASES_VEHICLES
+//#define ESE_ALIASES_MATH
+#define ESE_ALIASES_DEBUG
+
+#endif
+
+// -------------------- DO NOT MODIFY BEYOND THIS POINT --------------------
+
+// Pre-processor enable all other alias defines if ESE_ALIASES_ALL is defined
+#ifdef ESE_ALIASES_ALL
+#define ESE_ALIASES_MATERIALS
+#define ESE_ALIASES_WEAPONS
+#define ESE_ALIASES_ATTACHMENTS
+#define ESE_ALIASES_MAGAZINES
+#define ESE_ALIASES_EQUIPMENT
+#define ESE_ALIASES_VEHICLES
+#define ESE_ALIASES_MATH
+#endif

scripts/Game/!ESE_Config_EnforceScriptExtensions.c

@@ -6,9 +6,56 @@
 
 
 // Different functionality of ESE can be enabled or disabled by defining some different values, go to ESE_Config.c to see how
+/**
+ESE Class
 
+Class containing generic static methods and constants
+
+For full documentation check the wiki @ https://github.com/NarcoMarshDev/Enforce-Script-Extensions/wiki/ESE-Class
+
+Code example:
+@code
+	TODO
+@endcode
+*/
 class ESE
-{
+{	
+	static const int VERSION_MAJOR = 0;
+	static const int VERSION_MINOR = 1;
+	static const int VERSION_PATCH = 1;
+	// initialize ese on startup, called in !ESE_CORE.c
+	static bool Init()
+	{
+		if (ESE_IS_INITIALIZED)
+		{
+			Print("ESE.Init() already called", LogLevel.WARNING);
+			return true;
+		}
+		
+		// print version info on init
+		Print("Loaded ESE v" + VERSION_MAJOR + "." + VERSION_MINOR + "." + VERSION_PATCH);
+		if (VERSION_MAJOR == 0)
+		{
+		Print("WARNING: This is a pre-release version of Enforce Script Extensions, future compatibility is not guaranteed!", LogLevel.WARNING);
+		}
+		
+		// get all addons and find the first one (the currently open project)
+		array<string> availableAddons = {};
+		GameProject.GetAvailableAddons(availableAddons);
+		string mainProjectName = GameProject.GetAddonTitle(availableAddons[0]);
+		if (mainProjectName == "Enforce Script Extensions")
+		{
+			#ifdef ESE_DEVMODE
+			Print("ESE is in development mode, remember to goto !ESE_Config_EnforceScriptExtensions.c and disable before release");
+			#endif
+			#ifndef ESE_DEVMODE
+			Print("ESE is not in development mode, goto !ESE_Config_EnforceScriptExtensions.c and enable it to enable all features");
+			#endif
+		}
+				
+		return true;
+	}
+	
 	// Base class for all ESE static methods, if we ever get modding support for core types many of these will get added to their respective classes as well
 
 	// ================================ Entities ================================
@@ -61,13 +108,6 @@ class ESE
 		}
 		return allChildren;
 	}
-	// -----------------------------------------------------------------------------------------------------------
-	// Deletes entity on server side
-	static void DeleteEntity(IEntity ent)
-	{
-		RplComponent.DeleteRplEntity(ent, false);
-	}
-	
 
 	// ================================ Player ================================
 

scripts/Game/ESE.c

@@ -2,15 +2,13 @@
 // Enforce Script Extensions - By NarcoMarshmallow
 // 
 // Message me @narcoleptic marshmallow #1188 on discord to give feedback or go to https://github.com/NarcoMarshDev
-// -----------------------------------------------------------------------------------------------------------
-
-// REMEMBER TO CHANGE THIS TO USING THE DEFINES IN THE PROJECT OPTIONS MENU OR PEOPLE WILL RIOT!!!
-
 /** -------------------------------------------------------- READ THIS --------------------------------------------------------
 
 	Different functionality of ESE can be enabled or disabled by defining some different values. To do so, duplicate this file
 	and name it ' !ESE_Config.c ' and then uncomment whatever #define statements you want, to enable those features.
 
+	Full documentation : https://github.com/NarcoMarshDev/Enforce-Script-Extensions/wiki/Setting-Up-ESE#making-your-ese-config
+
 	-------------------------------------------------------- READ THIS --------------------------------------------------------
 
 @code
@@ -37,27 +35,35 @@
 		#define ESE_ALIASES_VEHICLES	- All base game vehicle ResourceNames (almost, missing some odd variats)
 		#define ESE_ALIASES_MATH 		- Useful mathematical constants and such like
 
+#define ESE_ALIASES_DEBUG
+	- Enables some extra debugging features to help with implementing custom aliases.
+
 @endcode
 */
 
 //#define ESE_VERBOSE
 //#define ESE_ENABLE_WIP
 //#define ESE_EXPERIMENTAL
 //#define ESE_OBSOLETE
-#define ESE_ALIASES_ALL
+//#define ESE_ALIASES_ALL
 //#define ESE_ALIASES_MATERIALS
 //#define ESE_ALIASES_WEAPONS
 //#define ESE_ALIASES_ATTACHMENTS
 //#define ESE_ALIASES_MAGAZINES
+//#define ESE_ALIASES_EQUIPMENT
 //#define ESE_ALIASES_VEHICLES
 //#define ESE_ALIASES_MATH
+//#define ESE_ALIASES_DEBUG
+
+// -------------------- DO NOT MODIFY BEYOND THIS POINT --------------------
 
-// Pre-processor enable all other alias defs if ESE_ALIASES_ALL is defined
+// Pre-processor enable all other alias defines if ESE_ALIASES_ALL is defined
 #ifdef ESE_ALIASES_ALL
 #define ESE_ALIASES_MATERIALS
 #define ESE_ALIASES_WEAPONS
 #define ESE_ALIASES_ATTACHMENTS
 #define ESE_ALIASES_MAGAZINES
+#define ESE_ALIASES_EQUIPMENT
 #define ESE_ALIASES_VEHICLES
 #define ESE_ALIASES_MATH
 #endif

scripts/Game/ESE_Aliases.c

@@ -4,8 +4,9 @@
 // Message me @narcoleptic marshmallow #1188 on discord to give feedback or go to https://github.com/NarcoMarshDev
 // -----------------------------------------------------------------------------------------------------------
 
+#ifdef ESE_EXPERIMENTAL
 class HierarchyMap<Class T>
 {
 
 }
-
+#endif

scripts/Game/!ESE_Config.c scripts/Game/ESE_Config.cscripts/Game/!ESE_Config.c renamed to scripts/Game/ESE_Config.c

@@ -6,16 +6,11 @@ class ESE_TestingEntity : SCR_BaseTriggerEntity
 {
 	protected override void EOnInit(IEntity owner)
 	{
-		ESE_Aliases.DebugRegister();
-		ESE_Aliases.RemoveAliasFromRegister(ESE_Aliases.TEST_WEP_M18_RED);
-		ESE_Aliases.DebugRegister();
+
 	}
 
 	protected override void EOnFrame(IEntity owner, float timeSlice)
 	{
 
-		ResourceName test = ESE_Aliases.WEP_M21;
-		//bool onScreen = ESE.IsEntityOnScreen(owner);
-		//Print("onScreen: " + onScreen);
 	}
 }