https://github.com/incantium/auto-reference
Never use GetComponent in Awake or Start anymore. This attribute automatically references it for you.
https://github.com/incantium/auto-reference
attribute csharp developer-tool package unity
Last synced: about 2 hours ago
JSON representation
Never use GetComponent in Awake or Start anymore. This attribute automatically references it for you.
- Host: GitHub
- URL: https://github.com/incantium/auto-reference
- Owner: Incantium
- License: mit
- Created: 2024-11-30T22:38:20.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-10T18:22:06.000Z (about 1 year ago)
- Last Synced: 2025-02-20T21:52:25.123Z (12 months ago)
- Topics: attribute, csharp, developer-tool, package, unity
- Language: C#
- Homepage:
- Size: 37.1 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Auto Reference
## Overview
Are you tired writing [`GetComponent`](https://docs.unity3d.com/ScriptReference/GameObject.GetComponent.html) in each
script to reference another script, even though this can never go wrong (when using
[`[RequireComponent]`](https://docs.unity3d.com/6000.0/Documentation/ScriptReference/RequireComponent.html))? This
package named Auto Reference solves that problem by automatically referencing other script without any extra code.
## Installation instructions
- Open the [Package Manager](https://docs.unity3d.com/Manual/upm-ui.html) in a Unity project.
- Click on the "+" button to add a new package.
- Click on "Install package from git URL...".
- Put in `https://github.com/Incantium/Auto-Reference.git`.
- Click on "Install" or press enter.
- Enjoy!
## Limitations
- Auto Reference is build for static references that do **not** change. For example, referencing a component on the same
(or closely related) game object is a valid way to use Auto Reference. This package does **not** automatically
reference a component when adding/removing during gameplay.
- Auto Reference can only automatically reference classes that are serializable through the Unity Editor (see
[Component](https://docs.unity3d.com/ScriptReference/Component.html)).
- Auto Reference works incorrectly when a prefab in a scene auto references a game object outside the prefab's scope.
This is a known bug.
## Workflow
Originally, you may have code like this:
```csharp
using UnityEngine;
[RequireComponent(typeof(RigidBody))]
public class ExampleClass : MonoBehaviour
{
private RigidBody rb;
private void Start()
{
rb = GetComponent();
}
}
```
But with Auto Reference, you can enhance it to this:
```csharp
using Incantium.Attributes;
using UnityEngine;
[RequireComponent(typeof(RigidBody))]
public class BetterExampleClass : MonoBehaviour
{
[SerializeField]
[Auto Reference]
private RigidBody rb;
}
```
## References
| Class | Description |
|------------------------------------------|-------------------------------------------------------------------------|
| [Auto Reference](API~/AutoReference.md) | The Auto Reference attribute to automatically reference another script. |
| [IReferenceable](API~/IReferenceable.md) | Interface for other classes able to be auto referenced. |
| [Target](API~/Target.md) | The target location of the automatically referenced script. |
## Frequently Asked Questions
### Which Unity versions are compatible with this package?
This package is heavily tested in `Unity 2022.3.44f1` and `Unity 6000.0.25f1`. It is expected that this package also
works in older and newer versions of the Unity Editor because it is not dependent on any other Unity packages.
### Why does a warning appear when I use Auto Reference?
This warning shows up when the field to be auto referenced is not referenceable through the Unity Editor (like all
primitive data structures such as integers, floats, and booleans). Only the classes inherited from
[Component](https://docs.unity3d.com/ScriptReference/Component.html) are referenceable through the Unity Editor. The
exception is the [IReferenceable](API~/IReferenceable.md) interface, which also makes it possible to be auto
referenced.
### It is possible for custom classes to be auto referenced?
Yes. It is possible for classes that don't inherit from
[Component](https://docs.unity3d.com/ScriptReference/Component.html) to be auto referenced, such as
[serializable](https://learn.microsoft.com/en-us/dotnet/api/system.serializableattribute?view=net-9.0) classes. These
classes need to implement the [IReferenceable](API~/IReferenceable.md) interface to function properly with the
Auto Reference attribute.