Adding support for other mods to add their own ESE Aliases using #ifdef ESE_INSTALLED

Author: NarcoMarshDev

README.md

@@ -1,2 +1,6 @@
 # Enforce-Script-Extensions
-A collection of new types and methods for Arma Reforger to help streamline the scripting experience
+A collection of new data types, methods, aliases etc. for Arma Reforger to help streamline the scripting experience.
+# Installation
+ESE will be released on the workshop at a date TBA. If you want to use it now however, clone this repo and add it as an existing project in the enfusion workbench, BUT BE CAREFUL! Things are changing a lot still, and using these pre-release versions may cause compatibility issues when it releases. I would hightly recommend renaming all the files and classes to "OLD_ESE..." so they remain seperate from release versions.
+# Contributing & Suggestions
+If you have any code you'd like me to add, or more vague suggestions for functionality to add, feel free to create a discussion and let me know!

addon.gproj

@@ -5,4 +5,25 @@ GameProject {
  Dependencies {
   "58D0FB3206B6F859" "5614BBCCBB55ED1C"
  }
+ Configurations {
+  GameProjectConfig PC {
+   ScriptProjectManagerSettings ScriptProjectManagerSettings "{AC4BE58770485E4B}" {
+    Configurations {
+     ScriptConfigurationClass workbench {
+      Defines + {
+       "ESE_ALIASES_ALL"
+      }
+     }
+    }
+   }
+  }
+  GameProjectConfig XBOX_ONE {
+  }
+  GameProjectConfig XBOX_SERIES {
+  }
+  GameProjectConfig PS4 {
+  }
+  GameProjectConfig HEADLESS {
+  }
+ }
 }

resourceDatabase.rdb

@@ -21,7 +21,7 @@ class ESE_array<Class T> : array<T>
 		}
 		str = temp;
 	}
-
+	// -----------------------------------------------------------------------------------------------------------
 	// Converts contents of array to string if array type is string, will return false if not array<string>
 	bool ToStringTextOnly(out string str)
 	{
@@ -36,13 +36,13 @@ class ESE_array<Class T> : array<T>
 		str = temp;
 		return true;
 	}
-	
+	// -----------------------------------------------------------------------------------------------------------
 	// Returns data type of array
 	typename GetType()
 	{
 		return T;
 	}
-	
+	// -----------------------------------------------------------------------------------------------------------
 	// Casts contents of array to template type of the new array and copies the contents to it
 	bool CastToNewArray(inout ESE_array newArray)
 	{

scripts/Core/proto/ESE_Types.c

@@ -4,6 +4,7 @@
 // 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 --------------------------------------------------------
 
@@ -33,16 +34,18 @@
 		#define ESE_ALIASES_WEAPONS		- All base game weapon ResourceNames
 		#define ESE_ALIASES_ATTACHMENTS	- All base game attachment ResourceNames
 		#define ESE_ALIASES_MAGAZINES 	- All base game magazine ResourceNames
+		#define ESE_ALIASES_VEHICLES	- All base game vehicle ResourceNames (almost, missing some odd variats)
 		#define ESE_ALIASES_MATH 		- Useful mathematical constants and such like
 
 @endcode
 */
+#define ESE_INSTALLED // Always keep this enabled to ensure mod compatiblity with aliases
 
-#define ESE_VERBOSE
+//#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

scripts/Game/!ESE_Config.c

@@ -38,6 +38,7 @@ class ESE
 		}
 		return allChildren;
 	}
+	// -----------------------------------------------------------------------------------------------------------
 	// See ESE.GetAllChildren - Returns only entities of given type
 	static array<IEntity> GetAllChildrenByType(IEntity parent, typename childClass)
 	{
@@ -60,6 +61,7 @@ class ESE
 		}
 		return allChildren;
 	}
+	// -----------------------------------------------------------------------------------------------------------
 	// Deletes entity on server side
 	static void DeleteEntity(IEntity ent)
 	{
@@ -74,30 +76,31 @@ class ESE
 	{
 		return ChimeraCharacter.Cast( GetGame().GetPlayerManager().GetPlayerControlledEntity(playerId) );
 	}
-	
+	// -----------------------------------------------------------------------------------------------------------
 	// Returns player controlled entity of local machine
 	static ChimeraCharacter GetLocalPlayerEntity()
 	{
 		return ChimeraCharacter.Cast( GetGame().GetPlayerController().GetControlledEntity() );
 	}
-	
+	// -----------------------------------------------------------------------------------------------------------
 	// Returns player id of given entity, returns 0 if not controlled by player
 	static int GetPlayerId(IEntity ent)
 	{
 		return GetGame().GetPlayerManager().GetPlayerIdFromControlledEntity(ent);
 	}
-	
+	// -----------------------------------------------------------------------------------------------------------
 	// Returns currently equipped weapon of given player character, returns null if weapon is holstered
 	static BaseWeaponComponent GetCurrentWeapon(ChimeraCharacter player)
 	{
 		return player.GetCharacterController().GetWeaponManagerComponent().GetCurrentWeapon();
 	}
-	
+	// -----------------------------------------------------------------------------------------------------------
+	// Pretty obvious
 	static void HolsterCurrentWeapon(ChimeraCharacter player)
 	{
 		player.GetCharacterController().SelectWeapon(null);
 	}
-	
+	// -----------------------------------------------------------------------------------------------------------
 	// Returns alive state of given entity
 	static bool IsEntityAlive(IEntity entity)
 	{
@@ -107,7 +110,7 @@ class ESE
 		else
 			return true;
 	}
-	
+	// -----------------------------------------------------------------------------------------------------------
 	#ifdef ESE_ENABLE_WIP
 	/**
 	TODO - MAKE SURE THIS WORKS AS INTENDED ON LOCAL PLAYERS WHEN CALLED
@@ -129,6 +132,7 @@ class ESE
 		return screenPos[2] > 0 && screenPos[0] > 0 && screenPos[0] < width && screenPos[1] > 0 && screenPos[1] < height);
 	}
 	#endif
+	// -----------------------------------------------------------------------------------------------------------
 	/**
 	Outputs all available magazines for a given weapon and character into a MagazineComponent array
 	@code

scripts/Game/ESE.c

@@ -39,6 +39,7 @@ class ESE_Entities
 
 		return GetGame().SpawnEntityPrefab(prefab, GetGame().GetWorld(), spawnParams);
 	}
+	// -----------------------------------------------------------------------------------------------------------
 	/**
 	Creates new entity from prefab at a players position
 	@code
@@ -62,11 +63,13 @@ class ESE_Entities
 
 		return GetGame().SpawnEntityPrefab(prefab, player.GetWorld(), spawnParams);
 	}
+	// -----------------------------------------------------------------------------------------------------------
 	// Deletes entity on server side
 	static void DeleteEntity(IEntity ent)
 	{
 		RplComponent.DeleteRplEntity(ent, false);
 	}
+	// -----------------------------------------------------------------------------------------------------------
 	static void DeleteEntityByRplId(RplId id)
 	{
 		IEntity ent = IEntity.Cast(Replication.FindItem(id));
@@ -100,7 +103,7 @@ class ESE_Entities
 			child = child.GetSibling();
 		}
 	}
-	
+	// -----------------------------------------------------------------------------------------------------------
 	static void EnableCollisions(IEntity ent, int layerMask = 0xffffffff)
 	{
 		Physics.CreateStatic(ent, layerMask);
@@ -142,7 +145,7 @@ class ESE_Entities
 			}
 		}
 	}
-	
+	// -----------------------------------------------------------------------------------------------------------
 	/**
 	Restores materials of entity and optionally it's children back to its original state
 	\param entity - entity to have materials reset
@@ -207,7 +210,7 @@ class ESE_Entities
 		vector screenPos = workspace.ProjWorldToScreenNative(worldPos, GetGame().GetWorld());
 		return screenPos[2] > 0 && screenPos[0] > 0 && screenPos[0] < width && screenPos[1] > 0 && screenPos[1] < height);
 	}
-	
+	// -----------------------------------------------------------------------------------------------------------
 	//TODO - Not sure why it's not working but don't use it for now, may have to go back to the GetParent() -> GetAllChildren() type system
 	static void GetAllSiblings(IEntity ent, notnull inout array<IEntity> allSiblings)
 	{

scripts/Game/ESE_Entities.c

@@ -5,5 +5,47 @@
 // -----------------------------------------------------------------------------------------------------------
 class ESE_IO
 {
+	static int ReadFileAsArray(string path, inout array<string> arr, int length)
+	{
+		FileHandle f = FileIO.OpenFile(path, FileMode.READ);
+		int readLen = f.ReadFile(arr, length);
+		return readLen;
+	}
+	// -----------------------------------------------------------------------------------------------------------
+	#ifdef ESE_ENABLE_WIP
+	static string ReadFileAsString(string path)
+	{
+		// TODO
+	}
+	#endif
+	// -----------------------------------------------------------------------------------------------------------
+	/**
+	Generate globally unique id, returns a string that can be used as a token
+	This code comes from armazac's Overthrow mod, credit:
+	https://github.com/ArmaOverthrow/Overthrow.Arma4/blob/main/Scripts/Game/Components/Player/OVT_PlayerIdentityComponent.c
+	*/
+	static string GenerateGUID()
+	{
+			
+		int year = 0;
+		int month = 0;
+		int day = 0;	
+		System.GetYearMonthDayUTC(year, month, day);
 
+		int hour = 0;
+		int minute = 0;
+		int second = 0;			
+		System.GetHourMinuteSecondUTC(hour, minute, second);
+		
+		string s = ""+year+month+day+hour+minute+second;
+	
+		//Add some random numbers (Reference: https://eager.io/blog/how-long-does-an-id-need-to-be/)
+		int i = s_AIRandomGenerator.RandFloatXY(0, 16777215);
+		s += i.ToString();
+	
+		i = s_AIRandomGenerator.RandFloatXY(0, 16777215);
+		s += i.ToString();
+		
+		return s;
+	}
 }

scripts/Game/ESE_IO.c

@@ -44,6 +44,7 @@ class ESE_Math
 		}
 		return vec;
 	}
+	// -----------------------------------------------------------------------------------------------------------