Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/comradevanti/unitygameobjectaspect
Aspect-oriented programming for Unity GameObjects
https://github.com/comradevanti/unitygameobjectaspect
aspect aspect-oriented-programming gameobject package unity unity3d utility
Last synced: 30 days ago
JSON representation
Aspect-oriented programming for Unity GameObjects
- Host: GitHub
- URL: https://github.com/comradevanti/unitygameobjectaspect
- Owner: ComradeVanti
- License: unlicense
- Created: 2023-06-13T12:33:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-19T10:32:10.000Z (11 months ago)
- Last Synced: 2025-01-07T11:58:50.585Z (about 1 month ago)
- Topics: aspect, aspect-oriented-programming, gameobject, package, unity, unity3d, utility
- Language: C#
- Homepage:
- Size: 24.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Unity GameObject Aspect
Aspect-oriented programming for Unity GameObjects
[](https://openupm.com/packages/dev.comradevanti.gameobject-aspect/)
[Changelog](./CHANGELOG.md)
**⚠️ Development is paused ⚠️**
No new features will be added or bugs fixed unless requested through an issue.
If you wish to fork this repository and continue the work, you are very welcome
to do so.
---
This package allows the user to define types or classes of GameObjects.
For example you can say that all GameObjects witch contains a `RigidBody` and
a `Collider` are `PhysicsObjects`. Such a type of GameObject is called an
**aspect**.
You can then test if GameObjects have a defined aspect in order to guarantee
that it has required components.
```csharp
// Aspects are interfaces
// They must implement IGameObjectAspect
public interface IPhysicsObject : IGameObjectAspect {
// Add component requirements using read-only properties
public RigidBody RigidBody { get; }
public Collider Collider { get; }
// Any other types of members, such as methods, are not allowed
}
// Attempt to get the aspect from some GameObject
var physicsObject = someGameObject.TryAspect();
// Will be null if game-object does not have the required components
if(phyicsObject != null) {
// Do something with the components
physicsObject.RigidBody ...
phsysicsObject.Collider ...
}
```
## Features
Currently properties of the following types are supported in aspects
- GameObject - Will always point to the host game-object
- Single Components - Searches for the component on the host game-object
- This also works with interfaces such as searching for `IXRInteractable`
Attempt to get an aspect from a `GameObject` using the `TryAspect`extension
method.
```csharp
gameObject.TryAspect();
// You can also use TryAspect on components and other aspects
transform.TryAspect();
someAspect.TryAspect();
```
You can compare aspects using `Equals` which will be true if the stem from the
same game-object.
## Installation
Install via OpenUpm using `openupm add dev.comradevanti.gameobject-aspect`
### Compatibility
Designed with/for Unity 2021.3 and up. Should work on all build targets.
## How it works
We use `System.Emit` to generate an implementation class for your
aspect-interfaces at runtime. This has a slight performance penalty and so the
generated types are cached.
The `TryAspect` methods then attempt to populate all properties defined in the
aspect-interface by resolving the requested components on the given
host game-object.
## Roadmap
- Find game-objects
- Find other aspects
- Support searching on parents
- Support searching in children
- Support searching in custom locations
- Array support
- Nullable support
- Live values
- Setter support
- Useful error messages
- Allow to check if game-object has components without needing access to them (
tag-components)