luxe: toggle

• Toggle

---

Toggle

import "luxe: toggle" for Toggle

  import "luxe: toggle" for Toggle

  //set up variables
  var toggle = Toggle.create()
  var handle = Strings.add("A")

  //set up value
  Toggle.set(toggle, handle, true)

  Log.print("value: %(Toggle.get(toggle, handle))") //true

  Toggle.set(toggle, handle, false) //turn off once
  Toggle.set(toggle, handle, false) //turn off twice
  Toggle.set(toggle, handle, true) //turn on once

  //still false here because toggle counts amount of times turned off
  Log.print("value: %(Toggle.get(toggle, handle))")

Toggle.create(.)

Toggle.create() : Toggle

Create a new Toggle instance.

Toggle.valid(.)

Toggle.valid(toggle : Toggle) : Bool

Does the toggle instance exists.

Toggle.destroy(.)

Toggle.destroy(toggle : Toggle) : None

Destroy the toggle instance and associated data.

Toggle.set(…)

Toggle.set(toggle : Toggle, handle : Num, state : Bool) : None

Turn the value associated with a handle on or off. This counts how often its been turned off and has to be turned on again as often to be counted as on again.

turn off(state = false) -> turn off -> turn on -> get state is false, even though last action was setting it to true, but the internal “off count” is still at 1.

The internal “off count” is never less than 0.

Toggle.get(..)

Toggle.get(toggle : Toggle, handle : Num) : Bool

Check the state of the handle.

Toggle.get(.)

Toggle.get(toggle : Toggle) : Bool

Get if all handles are true/on. Returns false if any are false.

Toggle.filter(..)

Toggle.filter(toggle : Toggle, handles : List) : List

Takes a list of handles and returns those that are true in the Toggle.

Toggle.link(…)

Toggle.link(toggle : Toggle, from_handle : Num, to_handle : Num) : None

Links two values, so that the from_handle value will be considered false if any of the to_handle values associated with it are false. Recursive links will not be taken into consideration. One handle can be linked to a maximum of 8 other values. Both handles have to be set at least once before for the link to be created.

  import "luxe: toggle" for Toggle

  //set up variables
  var toggle = Toggle.create()
  var handleA = Strings.add("A")
  var handleB = Strings.add("B")
  var handleC = Strings.add("C")

  //set up internal values
  Toggle.set(toggle, handleA, true)
  Toggle.set(toggle, handleB, true)
  Toggle.set(toggle, handleC, true)

  //set up links
  Toggle.link(toggle, handleB, handleA)
  Toggle.link(toggle, handleC, handleB)

  //all true
  Log.print("A:%(Toggle.get(toggle, handleA)) - B:%(Toggle.get(toggle, handleB)) - C: %(Toggle.get(toggle, handleC))")

  Toggle.set(toggle, handleA, false)

  //A is disabled directly, B is disabled by link, but link is not propagated to C, C is still `true`
  Log.print("A:%(Toggle.get(toggle, handleA)) - B:%(Toggle.get(toggle, handleB)) - C: %(Toggle.get(toggle, handleC))")