AMX NETLINX PROGRAMMING LANGUAGE, Manual

Page: 172 / 246

Reserved Identifiers
156 NetLinx Programming Language Reference Guide
Keywords & Run-Time Library Functions (Cont.)
TIMELINE_RELOAD
This function is used to change the array times of a timeline. The new array of
times takes affect immediately even if the timeline is currently executing. If the
timeline is executing when this function is called the timeline continues to exe-
cute and the next matching time from the new array triggers an event.
INTEGER TIMELINE_RELOAD(LONG Id, LONG Times[],LONG
Length)
Parameters:
•
Id
: A user defined value that uniquely identifies this timeline. Each timeline
must be assigned a unique identifier starting with number one.
•
Times
: An array of times where each time specifies when a
TIMELINE_EVENT
will be triggered. The times in the array must utilize the
same time base (
TIMELINE_RELATIVE
or
TIMELINE_ABSOLUTE
) as
determined by the original call to
TIMELINE_CREATE
. The NetLinx master
makes an internal copy of the values in the array allowing the user to modify
the passed in array as desired without affecting the operation of the timeline.
•
Length
: The count of times in the Times array.
Result:
• 0: Successful
• 1: Timeline ID already in use
• 2: Specified array is not an array of LONGs.
• 3: Specified length is greater than the length of the passed array.
• 4: Out of memory
TimeArray[1] = 1000
TimeArray[2] = 1500
TimeArray[3] = 2000
TIMELINE_RELOAD(TL1,TimeArray,3) // Modify the timeline
TIMELINE_RESTART
This function is used to continue execution of a timeline that was suspended
with
TIMELINE_PAUSE
.
INTEGER TIMELINE_RESTART(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_RESTART(TL1) // continue the timeline
TIMELINE_SET
This function is used to modify the current timer value of a timeline. The time-
line's timer is immediately set to the new value regardless of whether the time-
line is executing or not.
INTEGER TIMELINE_SET (LONG Id, LONG Timer)
Parameters:
•
Id
: A user defined value that uniquely identifies this timeline. Each timeline
must be assigned a unique identifier starting with number one.
•
Timer
: The new value for the timeline's internal timer.
Result:
• 0: Successful
• 1: Specified timeline ID invalid
• 2: Specified timer value out of range
TIMELINE_SET (TL1,0) // start it over again