MarkerCurve

非推奨を表示

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.

概要

プロパティ

  • 読み取り専用
    複製されていません
    並列読み取り

    Returns the number of markers in the MarkerCurve.

方法

プロパティ

Length

読み取り専用
複製されていません
並列読み取り

Returns the number of markers in the MarkerCurve.

方法

GetMarkerAtIndex

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

パラメータ

index: number

戻り値

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

GetMarkers

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


戻り値

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

InsertMarkerAtTime

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.

パラメータ

time: number

Time at which the marker should be added.

marker: string

String value associated with this marker.


戻り値

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

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

パラメータ

startingIndex: number

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

count: number

How many markers to remove starting from the startingIndex.

既定値: 1

戻り値

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

イベント