Skip to content

Manual.md

Latest commit

 

History

History
166 lines (128 loc) · 5.14 KB

Manual.md

File metadata and controls

166 lines (128 loc) · 5.14 KB

🧩 Variables

Provides a set of interfaces and classes for working with reactive variables, proxy variables, and Unity-specific variable types. It builds on the concept of reactive values but adds more flexibility by allowing variables to act as intermediaries or proxies, which can observe, modify, or synchronize underlying data.

📑 Table of Contents

🗂 Examples of Usage

1️⃣ Variable<T>

 // Create a new variable
IVariable<int> score = new Variable<int>(10);

// Read value
Console.WriteLine(score.Value);  // Output: 10

// Write value
score.Value = 20;
Console.WriteLine(score.Value);  // Output: 20

2️⃣ ReactiveVariable<T>

// Initialize with a starting value
var score = new ReactiveVariable<int>(10);

// Subscribe to changes
score.Subscribe(newValue => Console.WriteLine("Score updated: " + newValue));

// Change the value
score.Value = 20; // Triggers subscription callback

 // Dispose to clear subscriptions
score.Dispose();

3️⃣ InlineVariable<T>

//Create a new proxy of Transform.position
IVariable<Vector3> position = new InlineVariable<Vector3>(
    getter: () => transform.position,
    setter: value => transform.position = value
);

//Move position:
position.Value += Vector3.forward;

🔍 API Reference

🏛️ Specialized Types

🧩 Base Variables

For convenience, several specialized implementations of base variables are provided. It is recommended to use them, as they compare values without relying on EqualityComparer, which makes them slightly faster than the generic Variable<T> version.

  • Common
    • BoolVariable — Boolean variable
    • IntVariable — Integer variable
    • FloatVariable — Float variable
  • Unity
    • QuaternionVariable — Stores a Quaternion
    • Vector2Variable — Stores a Vector2
    • Vector3Variable — Stores a Vector3
    • Vector4Variable — Stores a Vector4
    • Vector2IntVariable — Stores a Vector2Int
    • Vector3IntVariable — Stores a Vector3Int
  • Unity Mathematics
    • int2_variable — Stores an int2
    • int3_variable — Stores an int3
    • int4_variable — Stores an int4
    • float2_variable — Stores a float2
    • float3_variable — Stores a float3
    • float4_variable — Stores a float4
    • quaternion_variable — Stores a quaternion

🧩 Reactive Variables

For convenience, several specialized implementations of reactive variables are provided. It is recommended to use them, as they compare values without relying on EqualityComparer, which makes them slightly faster than the generic ReactiveVariable<T> version.

  • Common
    • ReactiveBool — Boolean reactive variable
    • ReactiveInt — Integer reactive variable
    • ReactiveFloat — Float reactive variable
  • Unity
    • ReactiveQuaternion — Stores a Quaternion
    • ReactiveVector2 — Stores a Vector2
    • ReactiveVector3 — Stores a Vector3
    • ReactiveVector4 — Stores a Vector4
    • ReactiveVector2Int — Stores a Vector2Int
    • ReactiveVector3Int — Stores a Vector3Int
  • Unity Mathematics
    • reactive_int2 — Stores an int2
    • reactive_int3 — Stores an int3
    • reactive_int4 — Stores an int4
    • reactive_float2 — Stores a float2
    • reactive_float3 — Stores a float3
    • reactive_float4 — Stores a float4
    • reactive_quaternion — Stores a quaternion

🧩 Proxy Variables

For convenience, several specialized proxy variable implementations are provided.

  • Player Prefs
    • BoolPrefsVariable — Boolean variable stored in PlayerPrefs
    • IntPrefsVariable — Integer variable stored in PlayerPrefs
    • FloatPrefsVariable — Float variable stored in PlayerPrefs
    • StringPrefsVariable — String variable stored in PlayerPrefs
  • Transform
    • TransformParentVariable — Stores a Transform parent reference
    • TransformPositionVariable — Stores a Vector3 position
    • TransformRotationVariable — Stores a Quaternion rotation
    • TransformScaleVariable — Stores a Vector3 scale