Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bgsulz/Reflectors-for-Unity
Ultra-powerful and blazing fast reflection utilities for Unity.
https://github.com/bgsulz/Reflectors-for-Unity
Last synced: about 1 month ago
JSON representation
Ultra-powerful and blazing fast reflection utilities for Unity.
- Host: GitHub
- URL: https://github.com/bgsulz/Reflectors-for-Unity
- Owner: bgsulz
- License: mit
- Created: 2022-04-04T04:30:53.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-24T22:33:34.000Z (12 months ago)
- Last Synced: 2024-08-02T05:11:55.529Z (4 months ago)
- Language: C#
- Size: 75.2 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-blazingly-fast - Reflectors-for-Unity - Ultra-powerful and blazing fast reflection utilities for Unity. (C#)
README
# Reflectors for Unity
**Fast and powerful reflection utilities for Unity.**
| [Documentation](Documentation) | [Benchmarks](Documentation/Benchmarks.md) |
| - | - |
### How fast is it, really?
Hopefully, fast enough!
| Field access | Elapsed time (ticks/100,000 accesses) | Ratio vs. compiled |
| - | - | - |
| Compiled | 37,515 | 1x |
| Getter | 43,204 | 1.152x |
| Reflection | 317,665 | 8.468x |
### Quick Start Guide
This works by building a `Getter` or `Setter` object. These objects can be used to read or write to a specific property of a specific type.
1. Call the `Build` method to construct one, passing in a root type (`SpriteRenderer`, in this case) and a property name ("color".)
2. Pass in the type of the named property ("color") as a generic type parameter (`Color`.)
3. Use the `GetValue` or `SetValue` method on an object of the root type.
```cs
public SpriteRenderer root;
private Getter _getter;
private Setter _setter;
void Awake()
{
_getter = Getter.Build(typeof(SpriteRenderer), "color");
_setter = Setter.Build(typeof(SpriteRenderer), "color");
}
void Start()
{
var retrievedColor = _getter.GetValue(root);
_setter.SetValue(root, Color.yellow);
}
```
#### How does this work?
`Getter` and `Setter` are simply wrappers around code that compiled a LINQ `Expression` via the C# [expression tree API.](https://learn.microsoft.com/en-us/dotnet/csharp/advanced-topics/expression-trees/expression-trees-building)
More benchmarks can be found [here.](Documentation/Benchmarks.md)
***
## Extra Applications
This repository includes a couple common applications for which `Getter`s and `Setter`s are useful.
### PropertyReference
Dynamically reference a field, property, or parameter-less method on any Object.
_Great for consolidating scripts whose only difference is a type!_
```cs
[SerializeField] private PropertyReference colorProperty;
private void Start()
{
colorProperty.Initialize();
GetComponent().color = colorProperty.Value;
}
```
This is similar to building a `Getter`, but:
- It references a specific property on a specific object, not any object of the root type.
- It has a really nice custom property drawer.
***
### ShowIf
Easy, dynamic custom Inspector. Only uses PropertyDrawers for total compatibility with existing custom editors.
```cs
public bool shouldUseRaycast;
[ShowIf("shouldUseRaycast")] public float raycastLength;
[HideIf("shouldUseRaycast")] public float detectionRadius;
public bool useCustomTitle;
[DisableIf("useCustomTitle")] public string defaultTitle;
[EnableIf("useCustomTitle")] public string overrideTitle;
```
***
## How do I add this to Unity?
It's easy!
#### If you have Git...
1. Open the Unity Editor. On the top ribbon, click Window > Package Manager.
2. Click the + button in the upper left corner, and click "Add package from git url..."
3. Enter "https://github.com/bgsulz/Reflectors-for-Unity.git"
4. Enjoy!
#### If you don't have Git (or want to modify the code)...
1. Click the big green "Code" button and click Download ZIP.
2. Extract the contents of the .zip into your Unity project's Assets folder.
3. Enjoy!