UI

The main class

Functions

New

Creates a new instance with the provided properties.

Parameters

• class: string
  The class name of the instance to be created

• props: { [any]: any }
  Properties to be applied to the instance

Returns

• Instance

---

View

Creates a new view (ScreenGui) for your elements. This acts a shortcut and cleaner method for creation of a ScreenGui.

Parameters

• props: { [any]: any }
  Properties to be applied to the instance

Returns

• ScreenGui

---

Update

Updates an instance, writing to its properties.

Parameters

• instance: Instance
  The instance that should be updated

• props: { [any]: any }
  Properties to be applied to the instance

Returns

• Instance

---

State

Parameters

• initial: any
  The initial value that the state is assigned to

Returns

• State

---

Compute

Parameters

• processor: () -> (any)
  The processor function to run when dependencies are changed

• dependencies: { State }
  The dependencies that the computed state relies on

Returns

• Compute

---

Spring

Parameters

• goal: State
  The goal point that the spring should move towards, should be animatable

• damping: number OPTIONAL
  The damping of the spring

• speed: number OPTIONAL
  The speed of the spring

Returns

• Spring

---

Cleanup

Cleans up the provided items as soon as the parent instance is destroyed.

Parameters

• clean: { Instance } | Instance
  The action to create, this is what is returned

Returns

• Action

---

Event

Connects a callback to an event on the instance.

Parameters

• event: string
  The event that should be connected to

• callback: (...any) -> ()
  The callback to run when the provided event is fired

• scope: { any }? OPTIONAL
  A table that the connection is inserted into

Returns

• Action

---

Changed

Allows you to observe changes of properties within an object, and supplies the value of the changed property as a callback argument.

Parameters

• prop: string
  The property that have its changes listened to

• callback: (changed: any) -> ()
  The callback to run when the provided property is changed

• scope: { any }? OPTIONAL
  A table that the connection is inserted into

Returns

• Action

---

Tags

Adds a tag (or multiple) with the provided name to the instance.

Parameters

• names: string
  A list of tags to be applied to the instance

Returns

• Action

---

ForEach

Runs a loop within your code to efficiently create instances or other.

Parameters

• table: { [T]: U }
  The table to iterate through

• iterator: (index: T, value: U) -> (Instance?) The iterator to run on each occurance in the table

Returns

• Action