Home › Overview › MainModule

Flux

A reactive state management library that makes it easy to create dynamic user interfaces and game logic

Types

Action type

type Action = {
	callback: (Instance) -> (),
}

Properties

Clean

Flux.Clean: Type.Symbol

A symbol for defining cleanup in Flux.edit and Flux.new

Attribute

Flux.Attribute: Type.Symbol

A symbol for defining attributes in Flux.edit and Flux.new

Event

Flux.Event: Type.Symbol

A symbol for defining events in Flux.edit and Flux.new

Color Module

Flux.Color: Color

Interpolate Module

Flux.Interpolate: Interpolate

State Module

Flux.State: State

Type Module

Flux.Type: Type

Functions

deferUpdates

Flux.deferUpdates(value: boolean?)

Sets the update defer behaviour, defaults to false to improve performance

cleanup

Flux.cleanup(obj: any)

action

Flux.action(callback: (Instance) -> ()): Action

Creates an action to run logic on an instance

edit

Flux.edit<T>(instance: T & Instance, properties: Type.Dict<any>): T

Edits an existing Instance with Flux state bindings and other properties

new

Flux.new(classOrInstance: string | Instance): (Type.Dict<any>) -> Instance

Creates a new Instance with Flux state bindings and other properties

isState from State

Flux.isState(object: any): boolean

Checks if an object is a Flux state

raw from State

Flux.raw<T>(object: T): any

Gets the raw value of a Flux state or returns the input if it's not a state

rawVariadic from State

Flux.rawVariadic(...: any): ...any

Gets the raw values of multiple Flux states or non-state inputs

compute from State

Flux.compute<T>(computation: () -> T): State<T>

Creates a computed state, automatically tracking dependencies

state from State

Flux.state<T>(initialValue: T? | Instance? | State<T>?, property: string?): State<T>

Creates a new Flux state with an initial value

spring from Spring

Flux.spring<T>(goal: State.Stateful<T>, speed: State.Stateful<number>?, damping: State.Stateful<number>?): State.State<T>

Creates a new Flux spring state

tween from Tween

Flux.tween<T>(state: T | Type.Function | State.State<T>, tweenInfo: State.Stateful<TweenInfo>): State.State<T>

Creates a new Flux tween state