KeyTextChannel

Description

A text channel whose value is defined by interpolating between keyframes.

Remarks

Created via TextChannel.create().

Properties

---

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

Methods

---

setDefaultEasing(easing)

Description

Set the default easing for subsequently added keys.

Parameters

Name	Type	Description
easing	string	The easing type

Return types

KeyTextChannel

Remarks

_

Example

local ch = TextChannel.create()
ch.setDefaultEasing("so")

---

transitionFromStart()

Description

Set keys to transition from the beginning of the text.

Parameters

_

Return types

KeyTextChannel

Remarks

_

Example

ch.transitionFromStart()

---

transitionFromFirstDifference()

Description

Set keys to transition from the first differing character (default).

Parameters

_

Return types

KeyTextChannel

Remarks

_

Example

ch.transitionFromFirstDifference()

---

addKey(timing, val, easing = nil)

Description

Add a keyframe to this channel.

Parameters

Name	Type	Description
timing	number	Timing of the key
val	string	Text value of the key
easing	string	Easing of the key

Return types

KeyTextChannel

Remarks

_

Example

ch.addKey(0, "Hello")
ch.addKey(1000, "World")

---

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

KeyTextChannel

Remarks

_

Example

ch.removeKeyAtTiming(1000)