https://github.com/auros/auraextensions

Provides useful extensions for common Unity structs like UnityEngine.Vector3 and UnityEngine.Color
https://github.com/auros/auraextensions

Last synced: 20 days ago
JSON representation

Provides useful extensions for common Unity structs like UnityEngine.Vector3 and UnityEngine.Color

• Host: GitHub
• URL: https://github.com/auros/auraextensions
• Owner: Auros
• License: mit
• Created: 2023-03-28T22:51:55.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-29T06:33:28.000Z (almost 2 years ago)
• Last Synced: 2024-12-16T20:44:39.502Z (24 days ago)
• Language: C#
• Size: 33.2 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AuraExtensions

Provides useful extensions for common Unity structs like `UnityEngine.Vector3` and `UnityEngine.Color`.

This includes `.With[X|Y|Z|W|R|G|B](...)`, `.Only[X|Y|Z|W](...)` and [Deconstruct](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/functional/deconstruct) methods for Unity versions that support C# 9.

## Installation

### OpenUPM

```

openupm add dev.auros.auraextensions

```

### Git URL

```

https://github.com/Auros/AuraExtensions.git?path=/Assets/AuraExtensions

```

## Examples

```cs

// Vector2, Vector3, Vector4

Vector2 vector2 = Vector2.zero; // (0, 0)

vector2 = vector2.WithX(5f); // (5, 0, 0)

vector2 = vector2.WithY(-5f); // (5, -5, 0)

// C# 9 Deconstruct

var (v2x, v2y) = vector2;

// Vector3, Vector4

Vector3 vector3 = Vector3.one; // (1, 1, 1)

vector3 = vector3.WithZ(1.54f); // (1, 1, 1.54)

vector3 = vector3.OnlyX(); // (1, 0, 0)

// C# 9 Deconstruct

var (v3x, v3y, v3z) = vector3;

// Vector4

Vector4 vector4 = Vector4.zero; // (0, 0, 0, 0)

vector4 = vector4.WithW(-0.04f); // (0, 0, 0, -0.04)

// C# 9 Deconstruct

var (v4x, v4y, v4z, v4w) = vector4;

```

```cs

Color color = Color.red; // (1, 0, 0, 1)

color = color.WithG(1f); // (1, 1, 0, 1)

// C# 9 Deconstruct

var (r, g, b) = color;

```

## Compatibility

This library should be compatible with every Unity version that supports at least C# 3.0 (basically all of them).

The minimum supported version is set to Unity 2018.4.

`Deconstruct` support will only work on Unity 2021.2+ (C# 9).