Timeline_Event; Timeline_Get; Timeline_Kill; Timeline_Pause - AMX NETLINX PROGRAMMING LANGUAGE Manual

Keywords & Run-Time Library Functions (Cont.)

TIMELINE_EVENT

TIMELINE_GET

TIMELINE_KILL

TIMELINE_PAUSE

NetLinx Programming Language Reference Guide
These events are generated when a timeline's internal timer is equal to one of
the specified times in the times array. The TIMELINE_EVENT must be placed
in the DEFINE_EVENT section of the program.
TIMELINE_EVENT[timelineID]
See the TIMELINE_CREATE function (above) for a more detailed description.
This function returns the value of the specified timeline's timer. The timer indi-
cates the number of milliseconds that have passed since the timeline started.
If the timeline is paused the timer is also paused and subsequent calls to
TIMELINE_GET will return the same value.
LONG TIMELINE_GET (LONG Id)
Parameters:
• Id: A user defined value that uniquely identifies this timeline. Each timeline
must be assigned a unique identifier starting with number one.
Result:
This function returns the specified timeline's internal timer. The timer value
represents the number of milliseconds that have passed since the timeline
started.
TIMELINE_SET (TL1,TIMELINE_GET (TL1)+1000)
// jump ahead 1 second
This function is used to terminate a timeline. Any further references to the
specified timeline ID are invalid.
INTEGER TIMELINE_KILL(LONG Id)
Parameters:
• Id: A user defined value that uniquely identifies this timeline. Each timeline
must be assigned a unique identifier starting with number one.
Result:
• 0: Successful
• 1: Specified timeline ID invalid
TIMELINE_KILL(TL1) // permanently destroy the timeline
This function is used to suspend the execution of a timeline. It may be
restarted from where it left off with the TIMELINE_RESTART function.
INTEGER TIMELINE_PAUSE(LONG Id)
Parameters:
• Id: A user defined value that uniquely identifies this timeline. Each timeline
must be assigned a unique identifier starting with number one.
Result:
• 0: Successful
• 1: Specified timeline ID invalid
TIMELINE_PAUSE(TL1)
Reserved Identifiers
// momentarily suspend the timeline
155