# UrFairy UrFairy (Your fairy) is a set of useful extensions for development in Unity. ## Installation Add following url on Unity Package Manager - `https://git@github.com/beinteractive/UrFairy.git?path=Assets/UrFairy` ## List of extensions Extensions for `Vector3` - [`.X()` / `.Y()` / `.Z()`](https://github.com/beinteractive/UrFairy/raw/master/#vector3-xyz) - One Liner Modification Extensions for `Transform` - [`.LocalPosition()`](https://github.com/beinteractive/UrFairy/raw/master/#transform-localposition) - One Liner Modification - [`.LocalRotation()`](https://github.com/beinteractive/UrFairy/raw/master/#transform-localrotation) - One Liner Modification - [`.LocalEulerAngles()`](https://github.com/beinteractive/UrFairy/raw/master/#transform-localeulerangles) - One Liner Modification - [`.LocalScale()`](https://github.com/beinteractive/UrFairy/raw/master/#transform-localscale) - One Liner Modification - [`.Position()`](https://github.com/beinteractive/UrFairy/raw/master/#transform-position) - One Liner Modification - [`.Rotation()`](https://github.com/beinteractive/UrFairy/raw/master/#transform-rotation) - One Liner Modification - [`.EulerAngles()`](https://github.com/beinteractive/UrFairy/raw/master/#transform-eulerangles) - One Liner Modification - [`.Identity()`](https://github.com/beinteractive/UrFairy/raw/master/#transform-identity) - Reset Transform - [`.Children()`](https://github.com/beinteractive/UrFairy/raw/master/#transform-children) - Traversing Hierarchy - [`.FindDesendant()`](https://github.com/beinteractive/UrFairy/raw/master/#transform-finddesendant) - Finding Desendant Extensions for `Color` - [`.R()` / `.G()` / `.B()` / `.A()`](https://github.com/beinteractive/UrFairy/raw/master/#color-rgba) - One Liner Modification - [`.HSV()`](https://github.com/beinteractive/UrFairy/raw/master/#color-hsv) - Manipulating HSV Extensions for `Material` - [`.Color()`](https://github.com/beinteractive/UrFairy/raw/master/#material-color) - One Liner Modification - [`.Float()`](https://github.com/beinteractive/UrFairy/raw/master/#material-float) - One Liner Modification - [`.Keyword()`](https://github.com/beinteractive/UrFairy/raw/master/#material-keyword) - One Liner Modification Extensions for `Renderer` - [`.Material()`](https://github.com/beinteractive/UrFairy/raw/master/#renderer-material) - One Liner Modification - [`.Materials()`](https://github.com/beinteractive/UrFairy/raw/master/#renderer-materials) - One Liner Modification Extensions for `int` - [`.Color()`](https://github.com/beinteractive/UrFairy/raw/master/#int-color) - Hex to Color - [`.RandomSign()`](https://github.com/beinteractive/UrFairy/raw/master/#int-randomsign) - Random Sign Extensions for `float` - [`.RandomSign()`](https://github.com/beinteractive/UrFairy/raw/master/#float-randomsign) - Random Sign Extensions for `MonoBehaviour` - [`.Delay()`](https://github.com/beinteractive/UrFairy/raw/master/#monobehaviour-delay-frames) - Delay Frames - [`.Delay()`](https://github.com/beinteractive/UrFairy/raw/master/#monobehaviour-delay-seconds) - Delay Seconds Extensions for `IEnumerable` - [`.AsEnumerable()`](https://github.com/beinteractive/UrFairy/raw/master/#ienumerable-asenumerable) - Object to Enumerable - [`.CombineFirst()`](https://github.com/beinteractive/UrFairy/raw/master/#ienumerable-combinefirst) - Appending Object to First - [`.CombineLast()`](https://github.com/beinteractive/UrFairy/raw/master/#ienumerable-combinelast) - Appending Object to Last - [`.Sample()`](https://github.com/beinteractive/UrFairy/raw/master/#ienumerable-sample) - Picking Random Object - [`.Shuffle()`](https://github.com/beinteractive/UrFairy/raw/master/#ienumerable-shuffle) - Enumerating in Random Order - [`.IsEmpty()`](https://github.com/beinteractive/UrFairy/raw/master/#ienumerable-isempty) - Is Collection Empty - [`.Each()`](https://github.com/beinteractive/UrFairy/raw/master/#ienumerable-each) - Enumerating Elements - [`.EachWithIndex()`](https://github.com/beinteractive/UrFairy/raw/master/#ienumerable-eachwithindex) - Enumerating Elements with Indicies Extensions for `IEnumerable where T : UnityEngine.Object` - [`.ActiveObjects()`](https://github.com/beinteractive/UrFairy/raw/master/#ienumerable-activeobjects) - Enumerating Not Destroyed Elements Extensions for `IEnumerable where T : UnityEngine.Component` - [`.Actives()`](https://github.com/beinteractive/UrFairy/raw/master/#ienumerable-actives) - Enumerating Not Destroyed Elements Extensions for `List` - [`.Shuffle()`](https://github.com/beinteractive/UrFairy/raw/master/#list-shuffle) - Shuffling Extensions for `Dictionary` - [`.QueryObject()`](https://github.com/beinteractive/UrFairy/raw/master/#dictionary-queryobject) - Nullsafe Querying Extensions for `Dictionary where V : UnityEngine.Object` - [`.Query()`](https://github.com/beinteractive/UrFairy/raw/master/#dictionary-query) - Nullsafe Querying Extensions for `` - [`.Tap()`](https://github.com/beinteractive/UrFairy/raw/master/#t-tap) - [`.IfJust()`](https://github.com/beinteractive/UrFairy/raw/master/#t-ifjust) - [`.IfNothing()`](https://github.com/beinteractive/UrFairy/raw/master/#t-ifnothing) Other - [`Rnd`](https://github.com/beinteractive/UrFairy/raw/master/#rnd) - PCG Random Number Generator - [`Interpolations`](https://github.com/beinteractive/UrFairy/raw/master/#interpolations) - Time Based Interpolation Alghorithms Editor Extensions - [`Spacebar Hand Tool`](https://github.com/beinteractive/UrFairy/raw/master/#spacebar-hand-tool) - [`Capture Screenshot`](https://github.com/beinteractive/UrFairy/raw/master/#capture-screenshot) ## Extensions for `Vector3` ### `.X()` / `.Y()` / `.Z()` - One Liner Modification Returns a new value with modifying a specified component value: ```C# var v = new Vector3(1f, 2f, 3f); var p = v.X(10f).Y(20f); // p = Vector3(10f, 20f, 3f) ``` Relative value version: ```C# var v = new Vector3(1f, 2f, 3f); var p = v.X(x => x + 10f).Y(y => y + 20f); // p = Vector3(11f, 22f, 3f) ``` ## Extensions for `Transform` ### `.LocalPosition()` - One Liner Modification Set a new value with modifying a current value: ```C# // Set localPosition.x to 10f g.transform.LocalPosition(p => p.X(10f)); ``` ### `.LocalRotation()` - One Liner Modification Set a new value with modifying a current value: ```C# // Multiply localRotation and quaternion g.transform.LocalRotation(r => r * quaternion); ``` ### `.LocalEulerAngles()` - One Liner Modification Set a new value with modifying a current value: ```C# // Set localEulerAngles.z to 180f g.transform.LocalEulerAngles(r => r.Z(180f)); ``` ### `.LocalScale()` - One Liner Modification Set a new value with modifying a current value: ```C# // Set localScale.y to 2f g.transform.LocalScale(s => s.Y(2f)); ``` ### `.Position()` - One Liner Modification Set a new value with modifying a current value: ```C# // Set position.x to 10f g.transform.Position(p => p.X(10f)); ``` ### `.Rotation()` - One Liner Modification Set a new value with modifying a current value: ```C# // Multiply rotation and quaternion g.transform.Rotation(r => r * quaternion); ``` ### `.EulerAngles()` - One Liner Modification Set a new value with modifying a current value: ```C# // Set eulerAngles.z to 180f g.transform.EulerAngles(r => r.Z(180f)); ``` ### `.Identity()` - Reset Transform Set initial values to position, rotation and scale. ```C# g.transform.Identity(); // Same as: /* g.transform.localPosition = Vector3.zero; g.transform.localRotation = Quaternion.identity; g.transform.localScale = Vector3.one; */ ``` ### `.Children()` - Traversing Hierarchy Enumerates children (not includes desendants): ```C# foreach (var child in transform.Children()) { Debug.Log(child.gameObject.name); } ``` Enumerates children (includes desendants): ```C# foreach (var child in transform.Children(true)) { Debug.Log(child.gameObject.name); } ``` ### `.FindDesendant()` - Finding Desendant Returns a transform that has a specified name by searching transform hierarchy recursive. ```C# var d = transform.FindDesendant("DesendantName"); ``` ## Extensions for `Color` ### `.R()` / `.G()` / `.B()` / `.A()` - One Liner Modification Returns a new value with modifying a specified component value: ```C# var c = Color.white; var v = c.A(0.5f); // v = Color(1f, 1f, 1f, 0.5f) ``` ### `.HSV()` - Manipulating HSV Color to HSV: ```C# var hsv = color.HSV(); ``` Modify HSV: ```C# hsv.s = hsv.s - 0.5f; ``` HSV to Color: ```C# var col = hsv.Color(); ``` ## Extensions for `Material` ### `.Color()` - One Liner Modification Set a new value with modifying existing value (this method is chainable) ```C# m.Color("_Color", c => c.A(0.5f)).Keyword("_ALPHA_BLEND", true); ``` ### `.Float()` - One Liner Modification Set a new value with modifying existing value (this method is chainable) ```C# m.Float("_Alpha", a => a * 0.5f).Keyword("_ALPHA_BLEND", true); ``` ### `.Keyword()` - One Liner Modification Set a new value with modifying existing value (this method is chainable) ```C# m.Keyword("_ENABLE_GRAYSCALE", b => !b).Float("_TIME_SCALE", 0.5f); ``` ## Extensions for `Renderer` ### `.Material()` - One Liner Modification Set a new material with modifying existing material. ```C# r.Material(m => m.Color("_Color", Color.red)); ``` ### `.Materials()` - One Liner Modification Set a new materials with modifying existing materials. ```C# r.Materials(m => m.Keyword("_GRAYSCALE", true)); ``` ## Extensions for `int` ### `.Color()` - Hex to Color Hex value to Color: ```C# var c = 0x112233.Color(); ``` ### `.RandomSign()` - Random Sign Returns positive or negative value randomly ```C# var v = 100.RandomSign(); // 100 or -100 ``` ## Extensions for `float` ### `.RandomSign()` - Random Sign ```C# var v = 100f.RandomSign(); // 100f or -100f ``` ## Extensions for `MonoBehaviour` ### `.Delay()` - Delay Frames Delay one frame: ```C# // this is MonoBehaviour this.Delay(() => { Debug.Log("One frame after"); }); ``` Delay specified frames: ```C# this.Delay(3, () => { Debug.Log("Three frames after"); }); ``` ### `.Delay()` - Delay Seconds ```C# // this is MonoBehaviour this.Delay(3.0f, () => { Debug.Log("Three seconds after"); }); ``` ## Extensions for `IEnumerable` ### `.AsEnumerable()` - Object to Enumerable Convert a single object into IEnumerable. ```C# // e is IEnumerable var e = 100.AsEnumerable(); ``` ### `.CombineFirst()` - Appending Object to First Insert a specified element to first. ```C# var list = new int[] { 1, 2, 3 }; var n = 10; list.CombineFirst(n); // 10, 1, 2, 3 ``` ### `.CombineLast()` - Appending Object to Last Insert a specified element to last. ```C# var list = new int[] { 1, 2, 3 }; var n = 10; list.CombineLast(n); // 1, 2, 3, 10 ``` ### `.Sample()` - Picking Random Object ```C# // Pick a random element var e = list.Sample(); ``` ### `.Shuffle()` - Enumerating in Random Order ```C# var shuffled = list.Shuffle(); ``` ### `.IsEmpty()` - Is Collection Empty ```C# // Whether enumerable doesn`t have any element var b = list.IsEmpty(); ``` ### `.Each()` - Enumerating Elements Same as `each()` in Ruby. ```C# list.Each(e => { Debug.Log(e); }); ``` ### `.EachWithIndex()` - Enumerating Elements with Indicies Same as `each_with_index()` in Ruby. ```C# list.EachWithIndex((e, i) => { Debug.Log($"{i} -> {e}"); }); ``` ## Extensions for `IEnumerable where T : UnityEngine.Object` ### `.ActiveObjects()` - Enumerating Not Destroyed Elements Enumerates objects that is not null (means has not been destroyed yet) ```C# var activeObjects = objects.ActiveObjects(); ``` ## Extensions for `IEnumerable where T : UnityEngine.Component` ### `.Actives()` - Enumerating Not Destroyed Elements Enumerates objects that is not null (means has not been destroyed yet and also related GameObject has not been destroyed) ```C# var actives = components.Actives(); ``` ## Extensions for `List` ### `.Shuffle()` - Shuffling ```C# list.Shuffle(); ``` ## Extensions for `Dictionary` ### `.QueryObject()` - Nullsafe Querying Calls a closure with a object in a dictionary if exists and is not null. ```C# dictionary.QueryObject("Foo", o => Debug.Log(o)); ``` ## Extensions for `Dictionary where V : UnityEngine.Object` ### `.Query()` - Nullsafe Querying Calls a closure with a object in a dictionary if exists and is not null (means has not been destroyed). ```C# gameObjects.Query("Player", g => Debug.Log(g)); ``` ## Extensions for `` ### `.Tap()` Same as `tap()` in Ruby. ```C# particle.main.Tap(m => m.startColor = Color.red); ``` ### `.IfJust()` Calls a closure if object is not null. ```C# // Invoke callback if not null callback.IfJust(f => f()); ``` In .NET 4.6 script backend, it's recommended to use a null conditional operator. ```C# callback?.Invoke(); ``` ### `.IfNothing()` Calls a closure if object is null. ```C# Resources.Load("Prefab").IfNothing(Debug.Log("Prefab is not found")); ``` ## Other ### `Rnd` Implementation of PCG Random Number Generation. ```C# // With specified seed var r = new Rnd(12345U, 678910U); // Auto seed var r = new Rnd(); // float r.Value; // uint r.Value32; // float range r.Range(0.5f, 1.5f); // uint range r.Range(50, 150); ``` ### `Interpolations` Time based interpolation alghrothims from [Klak](https://github.com/keijiro/Klak). By passing a destination value, a current value, a speed and a delta time, an interpolated new current value will be returned. ```C# // Approaching "to" by exponential algorhithm. transform.localPosition = Interpolations.Expo(to, transform.localPosition, 30f, Time.deltaTime); // Approaching "to" by critically damped spring smoothing. transform.localPosition = Interpolations.CriticallyDamped(to, transform.localPosition, 30f, Time.deltaTime); ``` ## Editor Extensions ### `Spacebar Hand Tool` Toggle hand tool while pressing a space key in the scene view like Photoshop. ### `Capture Screenshot` Capture the game view and save png image to project directory by editor menu `UrFairy | Capture Screenshot`. ## License Copyright 2016 Oink Games, Inc. and other contributors. Code licensed under the MIT License: http://opensource.org/licenses/MIT