Timeline Object

From FusionWiki

Jump to: navigation, search
Timeline Object
General Information
Author: LB
Release Date: 10-10-10
Status: Finished
Last updated: October 10, 2010
Version: 1.0
Build: 249
Developer-only: No
Website: Not available
Download: Download
Runtime Versions
HWA: No
Flash: No
Java: No
Java Mobile: No
Vitalize!: No
Unicode: No

The Timeline Object is an extension for Multimedia Fusion 2 written by LB. It gives you a timeline containing positions, and each position may hold events. Events are created at a position with a name, and referred to later via an index because there may be multiple events with the same name at a single position. Each of these individual events may have multiple named values and strings. Events are triggered by name when time is moving (going either forward or backward). Time may go any speed, but will automatically stop if it hits zero (the beginning of the entire timeline) while going backward.

The help file that comes with the object goes into much more detail, but here are some brief descriptions:

Actions

  • Add Event - Adds an event (by name) to a position in the timeline.
  • Set value in Event - Sets an integer value (by name) in an event (by index) at a position in the timeline.
  • Set String in Event - Sets a string (by name) in an event (by index) at a position in the timeline.
  • Copy Event - Copies an event from one position & index to another position & index.
  • Move Event - Moves an event from one position & index to another position & index.
  • Remove Event - Removes an event (by index) from a position in the timeline.
  • Remove Position - Removes a position and all its events from the timeline. (Note that positions only exist if they have events)
  • Remove Value from Event - Removes a value (by name) from an event (by index) at a position in the timeline.
  • Remove String from Event - Removes a string (by name) from an event (by index) at a position in the timeline.
  • Copy Position - Copies one position to another position, with optional replace or append events.
  • Move Position - Moves one position to another position, with optional replace or append events.
  • Set Time - Sets the time/current position in the timeline to any positive integer value.
  • Set Time Speed - Sets the speed for time to move at to any positive or negative integer value. Events are not skipped when time is faster than one unit per frame.
  • Move to Position - Moves position by position towards the target position triggering events at every position between, including the final position and excluding the current position.
  • Enable/Disable Event Triggering - Allows you to change whether events will be triggered when time is moving. (Useful for double-recording)
  • Load Timeline from String [magical] - Given a Timeline String (An expression exists to get one), this will load an entire timeline from a string, with the option of replacing the current timeline data or adding to it.
  • Save Timeline to File - Saves the entire timeline to a file. If there is an error during this process, it will trigger "On Save/Load Error" and set the error string.
  • Load Timeline from File - Loads a timeline from a file, with the option to append it to the current timeline, or erase the current timeline. If there is an error during this process, it will trigger "On Save/Load Error" and set the error string.


Conditions

  • On Event [Immediate] - Triggers when an event (by name) is reached in the timeline. Events are not skipped when time is faster than one unit per frame. This condition triggers once for each event at a position.
  • Position Exists in Timeline [Negatable] - Returns true if the given Position exists in the timeline. Positions do not exist of they do not have any events in them.
  • Event (Name) Exists at Position [Negatable] - Returns true if any Event by the name given exists at the given Position.
  • Value Exists in Event [Negatable] - Returns true if the value (by name) exists in the event (by index) at the position in the timeline.
  • String Exists in Event [Negatable] - Returns true if the string (by name) exists in the event (by index) at the position in the timeline.
  • On Save/Load Error [Immediate] - Triggers when an error occurs during saving/loading. You can use the Error$ expression to get a nice error string.


Expressions

  • Get Time (Time) - Returns the current time/position in the timeline.
  • Get Time Speed (TimeSpeed) - Returns the speed by which time is currently moving.
  • Get Current Event Name (CurrentEvent$) - Returns the name of the event that is currently being triggered.
  • Get Current Event Index (CurrentEvent) - Returns the index of the event that is currently being triggered.
  • Get Number of Events at Position (EventsAt) - Returns the number of events at a position in the timeline.
  • Get Name at Position & Index (EventAt$) - Returns the name of an event (by index) at a position in the timeline.
  • Get Attached Value (Value) - Returns a value (by name) that is attached to an event (by index) at a position in the timeline.
  • Get Attached String (String$) - Returns a string (by name) that is attached to an event (by index) at a position in the timeline.
  • Advanced
    • Get Number of Values at Position & Index (ValCount) - Returns the number of values in an event (by index) at a position in the timeline.
    • Get Number of Strings at Position & Index (StrCount) - Returns the number of strings in an event (by index) at a position in the timeline.
    • Get Value Name by ID at Position & Index (ValNameByID$) - Gives the name of a value (by index) in an event (by index) at a position in the timeline.
    • Get String Name by ID at Position & Index (StrNameByID$) - Gives the name of a string (by index) in an event (by index) at a position in the timeline.
    • Note: You should not rely on the order of the values and strings, in reality they may be in any order. These expressions are meant only for looping through the values and strings in events.
  • Get Timeline as String (Timeline$) - Returns the entire content of the timeline as a human readable string.
  • Get Error String (Error$) - Returns the last error to occur. This error includes the file that caused it and a nice description of what went wrong.
Retrieved from "http://www.fusionwiki.com/wiki/Timeline_Object"
Personal tools