Skip to content

KeyStringChannel

rech edited this page Jun 15, 2026 · 1 revision

Description

A string channel whose value is defined by keyframes.

Remarks

Created via StringChannel.create().

Properties


Name Type Description
keyCount number The number of keys in this channel

Methods


addKey(timing, val)

Description

Add a keyframe to this channel.

Parameters

Name Type Description
timing number Timing of the key
val string String value of the key

Return types

KeyStringChannel

Remarks

_

Example

local ch = StringChannel.create()
ch.addKey(0, "Default")
ch.addKey(1000, "Overlay")

removeKeyAtTiming(timing)

Description

Remove the first key with the exact timing.

Parameters

Name Type Description
timing number Timing of the key to remove

Return types

KeyStringChannel

Remarks

_

Example

ch.removeKeyAtTiming(1000)

Clone this wiki locally