MarkerCurve

Show Deprecated

The MarkerCurve instance lets you place markers as string values at certain times on a timeline. The string at each marker cannot exceed 64 characters and must only contain printable characters.

Summary

Properties

Length: number

Returns the number of markers in the MarkerCurve.

READ ONLY
NOT REPLICATED

Events

Methods

GetMarkerAtIndex(index: number): table  

Returns the time and string value of the marker at the provided index.

GetMarkers(): Array  

Returns the time and string value of all markers in the MarkerCurve.

InsertMarkerAtTime(time: number, marker: string): Array  

Inserts a marker with the provided string value at the provided time.

RemoveMarkerAtIndex(startingIndex: number, count: number): number  

Remove several markers in the MarkerCurve starting at the provided index.

Properties

Length

number
Read Only
Not Replicated
Read Parallel

Returns the number of markers in the MarkerCurve.

Events

Methods

GetMarkerAtIndex

table

Returns the time and string value of the marker at the provided index.

Parameters

index: number

Returns

table

A table containing the time and value of the marker at the provided index.

GetMarkers

Array

Returns the time and string value of all markers in the MarkerCurve.


Returns

Array

An array of tables containing the time and value of all markers in the MarkerCurve.

InsertMarkerAtTime

Array

Inserts a marker with the provided string value at the provided time. The provided string cannot exceed 64 characters and must only contain printable characters.

Parameters

time: number

Time at which the marker should be added.

marker: string

String value associated with this marker.


Returns

Array

A table containing a boolean and a number. The boolean is true if the call adds a new marker and false if it modifies an existing marker at the provided time. The number is the index of the added marker.

RemoveMarkerAtIndex

number

Remove several markers in the MarkerCurve starting at the provided index.

Parameters

startingIndex: number

Index of the first marker to be removed in the MarkerCurve.

count: number

How many markers to remove starting from the startingIndex.

Default Value: "1"

Returns

number

How many markers were actually removed (can be less than count if the MarkerCurve was too few markers).