https://github.com/merpheus-dev/GetComponentAttribute

A simple DI plugin for getting MonoBehaviour components just with an attribute over fields.
https://github.com/merpheus-dev/GetComponentAttribute

attribute csharp getcomponent unity

Last synced: 4 months ago
JSON representation

A simple DI plugin for getting MonoBehaviour components just with an attribute over fields.

• Host: GitHub
• URL: https://github.com/merpheus-dev/GetComponentAttribute
• Owner: merpheus-dev
• Created: 2019-03-01T07:12:38.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-08-10T16:01:42.000Z (almost 5 years ago)
• Last Synced: 2024-02-29T03:09:55.647Z (4 months ago)
• Topics: attribute, csharp, getcomponent, unity
• Language: C#
• Homepage:
• Size: 6.84 KB
• Stars: 20
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Lists

• awesome-unity3d - GetComponentAttribute - A simple DI plugin for getting MonoBehaviour components just with an attribute over fields. (Open Source Repositories / Utilities)
• awesome - merpheus-dev/GetComponentAttribute - A simple DI plugin for getting MonoBehaviour components just with an attribute over fields. (C\#)
• awesome - merpheus-dev/GetComponentAttribute - A simple DI plugin for getting MonoBehaviour components just with an attribute over fields. (C\#)

README

        
# Get Component Attribute

A little attribute that makes Awake/Start GetComponent calls redundant.

Generally in unity, we need to fill fields like this as follows:

```c#

private Rigidbody rigidbody;

void Start(){

    rigidbody = GetComponent();

}

```

But especially while working with teams, if you DI through Scene objects from inspector,

Scene merge conflicts become inevitable. But we shouldn't dirty our code base with those get component methods in various fields.

It will reduce readability.

**This plugin, removes this requirement and takes care of it with an attribute in background before scene begins.**

## Example Usage

```c#

[GetComponent] //Get from same gameobject

private Rigidbody rigidbody;

[GetComponent(GetComponentFrom.SceneObject)] //Scan the scene and get from first object.

private Rigidbody rigidbody;

[GetComponent(GetComponentFrom.TargetGameObject,"MyAwesomeTargetObjectName")] //Get from a target object at scene

private Rigidbody rigidbody;

```

## Installation

Just clone the repo and copy the folder into your project.

## Note

**[!]GetComponentFrom.TargetGameObject currently runs between awake and start methods.**

## TO-DO

- Editor time component fetching

- On-demand(non awake based) runtime component fetching

- Fetch signals(Event driven fetch on runtime)

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## License

[MIT](https://choosealicense.com/licenses/mit/)