Skip to content

OranBar/AutoAttribute-for-Unity3d

Repository files navigation

AutoAttribute_unity3d

Auto Attributes

This package provides 3 attributes: [Auto], [AutoParent], [AutoChildren]

Autos are field/property attributes that allow to automatically get/fetch components' references at the very start of the application. This solution is presented as equivalent of having an Awake function containing GetComponent calls, without having to worry about ordering or disabled gameObjects.

It runs before all other Awakes (using script execution ordering), so when Awake starts, one can assume that no variable with Auto will throw a null exception. In case a component couldn't be found, Auto will provide with descriptive logging.

[AutoParent] and [AutoChildren] can also be used on Array variables, and respectively has the same behaviour you would expect from a GetComponentsInParents() or GetComponentsInChildren() call.

Auto also works on inactive objects and on private fields.

Auto works by hooking into the awake function of a Manager MonoBehaviour script. The manager is automatically spawned whenever the scene whenever it is saved.

Instantiation

In case of instantiated objects, attach the component AutoReferencer_OnInstantiation to the object that will be instantiated. This object will run its awake before any other component, requesting the Manager to reference the variables with the Auto attribute.

AddComponent

Unfortunately, there is no easy and performant way to know when a component was added to a script. Becuase of that, Auto has a hard time dealing with an AddComponent call. If you need to do an AddComponent of a class that has variables with the [Auto*] attribute, Auto provides an extension method for MonoBehaviour scripts: AddComponent_Auto(). Calling this function, will make sure that the component is AutoReferences immediately after it was added.

Requisites

All scripts using Auto must have their script execution order delay > -500 (This is the value used by the Auto scripts).

Installation

Method 1:

Add this line to the manifest.json file located in the Packages folder

"barbaro.unity3d.auto": "https://github.com/OranBar/AutoAttribute-for-Unity3d.git?path=Assets/Auto_Attribute"

Method 2:

Open the package manager, and select "Add package from git URL". Paste this string as the URL:

https://github.com/OranBar/AutoAttribute-for-Unity3d.git?path=Assets/Auto_Attribute

Method 3:

From the Releases page, download the unitypackage file, and import it in your project.

As soon as the package is installed, you can already make use of the Auto Attributes! If you're using Assembly Definitions, remember to reference Auto's Assembly Definition BarbarO.AutoAttributes.Runtime.