CreateTweenText

Family: Tweening · 2 forms

What it does

CreateTweenText brings a Tweening object into being: it is how the rest of the program comes to have one. It takes tweenID (an integer) and duration (a float), and returns nothing. That is the first of 2 forms. tweenID is the id you are giving a Tween object: every later call names it by that number.

Syntax

1
CreateTweenText(tweenID integer, duration float)
2
CreateTweenText(duration float) → integer

Parameters

NameTypeIn forms
tweenIDinteger1
durationfloatall

What each form returns

1CreateTweenText(1, 1.0)nothing
2tweenText = CreateTweenText(1.0)integer

Example · generated

Form 1, you choose the id yourself

CreateTweenText(1, 1.0)DO  Sync()LOOP

Form 2, the command hands back the id

tweenText = CreateTweenText(1.0)DO  Sync()LOOP

CreateTweenText is called with values of the types its signature asks for. The DO … LOOP is not decoration: a classic BASIC program ends the moment it runs out of lines, and Sync() is what draws the frame.

149 commands in Tweening