Skip to content

ReactiveProxyVariable.md

Latest commit

 

History

History
125 lines (86 loc) · 3.25 KB

ReactiveProxyVariable.md

File metadata and controls

125 lines (86 loc) · 3.25 KB

🧩 InlineReactiveVariable<T>

Represents a reactive proxy variable that delegates reading, writing, and subscription operations to external handlers. This is useful when you need to wrap an existing data source or event system and expose it through the unified IReactiveVariable<T> interface.

📑 Table of Contents

🔍 API Reference

🏛️ Type 

public class InlineReactiveVariable<T> : IReactiveVariable<T>
  • Description: Represents a reactive proxy variable that delegates reading, writing, and subscription operations to external handlers.
  • Inheritance: IReactiveVariable<T>
  • Type Parameter: T – The type of the value being proxied.
  • Notes: Supports Odin Inspector

🏗️ Constructors

InlineReactiveVariable(Func<T>, Action<T>)

public InlineReactiveVariable(Func<T> getter, Action<T> setter)
  • Description: Initializes a new instance of ProxyVariable<T> using the provided getter and setter functions.
  • Parameters:
    • getter – A function to retrieve the value.
    • setter – An action to update the value.
    • subscribe – An action to handle the subscription.
    • unsubscribe – An action to handle the unsubscription.
  • Throws: ArgumentNullException if either getter, setter subscription or unsubscription is null.

⚡ Events

OnEvent

event Action<T> OnEvent
  • Description: Triggered whenever the value changes.
  • Parameter: T – The new value after the change.
  • Note: Allows subscribers to react to value changes in a reactive programming pattern.

🔑 Properties

Value

public T Value { get; set; }
  • Description: Gets or sets the current value.
  • Access: Read-write

🏹 Methods

Invoke()

public T Invoke()
  • Description: Invokes the variable and returns its current value.
  • Returns: The current value of type T.

Invoke(T)

public void Invoke(T arg)
  • Description: Sets the value of the variable to the provided argument.
  • Parameter: arg – The new value to assign to the variable.

StartBuild()

public static Builder StartBuild()
  • Description: Begins building a proxy variable using a fluent builder pattern.
  • Returns A new struct instance of the Builder

📝 Notes

  • Integrating external or third-party APIs (e.g., Unity’s Transform, networking states).
  • Adapting existing properties / fields to IReactiveVariable<T> without refactoring.
  • Testing: Makes it easy to substitute mock getters / setters in unit tests.