uiz_update_event

uiz_update_event(startupdate, midupdate, endupdate)

This generic function can be called by a uiZ object to notify the user of the object that the state of the object has changed. What exactly these parameters mean differs by object. Right now, not many objects use this functionality but plans to extend this event handling are in the making.

In general, this event is launched when an object changes state. Let's say we have a slider. The slider is in position A, and we click on position B. (We don't drag the slider, we click on an empty space B which moves the slider to that position.) The slider will now animation from A to B. When it starts animation, the uiz_update_event is launched with startUpdate being true. In the steps after that, midUpdate is constantly set to true until the animation stops. When the animation stops, endUpdate is true.

To set what code the uiz_update_event function has to execute, the user of the object (the programmer, you) can use uiz_update_set.

Function

• uiz_update_event(startUpdate, midUpdate, endUpdate): Launch an update event. This should be called from a uiZ object.
  • startUpdate: Whether the object has just started updating.
  • midUpdate: Whether the object is currently continuously updating.
  • endUpdate: Whether the object has just finished updating.
• uiz_update_set(instanceid, uiz_update_script, uiz_update_script_argument): Sets the script to be executed when the given instance has an update.
  • instanceid: What instance should execute the given script upon an update.
  • uiz_update_script: A script id of what to execute. This script gets the following arguments in order:
    • startUpdate: Whether the object has just started updating.
    • midUpdate: Whether the object is currently continuously updating.
    • endUpdate: Whether the object has just finished updating.
    • uiz_update_script_argument: This is an extra argument that can help you identify an object, or identify what should happen.
  • uiz_update_script_argument: This is an extra argument that will be given as argument3 to your uiz_update_script that can help you identify an object, or identify what should happen.