Marks Magic Toolbox
Marks Magic Toolbox is a Work in Progress Unity Asset Package containing fairly standard but also very useful tools every project could use. The goal of this asset package is to create these standard system in the most modular and optimised way I can so it's reusable for all the projects I work on.
Project Details:
Software: Unity, Git
Languages: C#
Duration: ∞ (Undetermined)
Team Size: 1
Workflow: N/A
Tag manager
An "expansion" on the already existing Tag system from Unity. Currently you can only have one tag on an object, this Tag Manager allows you to add as many per object as you'd like. Also including a Remove method and a HasTag check method.
TagManager Extensions
The TagManager Extensions allow programmers to access the new TagManager even more easily. For example, adding a tag to an object, whether or not it has the tagmanger, can be done straight through a game object, gameObject.AddTag("MyTag");. This line of code will check if the object you want to add a tag to already has a manager, if it does not, it will add one and subsequently also add this tag, if it already has a tagmanager or the tag, it will ignore the command and return.
Callable Method Extensions:
TagManagerExtentions.FindAllWithTag("MyTag"); >> Returns a list of all Tag Managers that have this tag.
TagManagerExtentions.FindAllWithTags(myList); >> Returns a list of all Tag Managers that has all the tags in myList.
gameObject.AddTag("MyTag"); >> Adds specific tags to objects.
gameObject.RemoveTag("MyTag"); >> Removes specific tags from objects.
gameObject.RemoveTag(index); >> Overload method. Removes tag at specified index.
gameObject.HasTag("MyTag"); >> Checks if an object has the tag.
gameObject.HasTag(myList); >> Checks if an object has any of the specified tags.
gameObject.HasTags(myList); >> Checks if an object has all the tags in myList.
Time System
The Time System allows the user to implement a simple, lightweight day/night cycle into their game. A large variety of settings can be tweaked for this system, check the Inspector Image below for a full rundown of all the settings.
Transform Extensions
Transform Extensions are Method Extensions with the purpose of both preventing repeating code and to simplify certain processes often performed in code. More on this below:
LookAt()
To use the LookAt() Method Extension, simply call it like any other component method.
Example:
_currentTarget.gameObject.LookAt(_forceDirection);
Note: To use our method instead of the one in Monobehaviour, make sure you call LookAt() from a gameObject and not from a transform.SetPositionX() | SetPositionY() | SetPositionZ()
By default, you sadly can't directly edit the .x/.y/.z values of the position of an object, trying to do so gives an error. In order to circumvent this, you have to write give or take 3 lines of code where you fill a variable with a copy, edit the copy and then set the position to the copy. Therefore, I made a small utility that will automatically do this process for you upon calling one of these Method Extensions, allowing you to cut it down to just 1 line of code.
Example:
Without Method Extension
var myPosition = gameObject.transform.position;
myPosition.x = 30f;
transform.position = myPosition;
With Method Extension
transform.SetPositionX(30f);
Hide()
The Hide() method has the ability to mask objects without having to use methods like SetActive(). It does this by setting the scale of the object to a Vector3.zer (0,0,0). The advantage this offers over methods such as SetActive() is that you can you still run scripts and/or coroutines on an object using the Hide() method.
Example:
Hide Object
_currentTarget.gameObject.Hide();
Note: The bool in Hide() true by default, there it does not have to be set when called.Reveal Object
_currentTarget.gameObject.Hide(false);
Note: At the moment, Hide(false) sets the scale of the object back to a Vector3.one (1,1,1). So in cases where you hide an object with scale values that are not a Vector3.one by default, you may want to store the size of your object in a variable before using the Hide(true) method so that you may reset the scale back to this later. This method will be improved upon in the near future.List Extensions
A new addition to the toolbox, List Extensions will simplify the usage of lists, including but not limited to adding overloads to already existing methods.
Currently my List Extensions includes only one such overload:
Contains()
Example:
myList.Contains(compareList);
Note: The Contains() overload allows you to check wether myList includes compareList. The lists do not have to be the same size nor do the items have to be in the same index.
health System
Efficient Health System that does and has everything you'd expect from a health system.
The Health System allows entities to have HealthData. Which does a number of things, including but not limited to:
Track the current amount of Health.
Create "HealthEvents" that can parse data when called.
Contains HealthExtensions, allowing the methods used in this system to be called on any gameObject.
And more.
AddHealth()
This method allows entities to gain health based on the parameter parsed when calling this method.
Example:
gameObject.AddHealth(health);
TakeDamage()
This method allows entities to take damage which removes health based on the paramater parsed when calling this method.
Example:
gameObject.TakeDamage(health);
Resurrect()
This method allows entities to be resurrected.
Example:
gameObject.Resurrect(health);
Die()
This method sets the variables as if the entity no longer has health.
Kill()
This method kills the entity by calling the Die() method.
Example:
gameObject.Kill();
Wave System
Fully configurable and reusable Wave System which can spawn "creatures".
Softlinks:
TagManager (Used for searching dead bodies in a scene, can easily be replaced by another system)
Scene Garbage Cleaner
System that clears "garbage bodies" from the scene once the amount of garbage bodies exceeds the configurable amount.
*This is all to be expanded on later