Scaleform Studio Lua API Reference: scaleform.Easing object reference

scaleform.Easing object reference

Description

Represents an easing functor.

Functions

Parameters

self :

scaleform.Easing

The easing functor to use.

t :

number

The current time, between 0 and duration inclusive (in ms).

b :

number

The initial value of the animation property.

c :

number

The total change in the animation property.

d :

number

The duration of the motion (in ms).

Returns

number

Returns the interpolated value.

Parameters

self :

scaleform.Easing

The easing functor to use.

t :

number

The current time, between 0 and duration inclusive (in ms).

b :

number

The initial value of the animation property.

c :

number

The total change in the animation property.

d :

number

The duration of the motion (in ms).

Returns

number

Returns the interpolated value.

Parameters

self :

scaleform.Easing

The easing functor to use.

t :

number

The current time, between 0 and duration inclusive (in ms).

b :

number

The initial value of the animation property.

c :

number

The total change in the animation property.

d :

number

The duration of the motion (in ms).

Returns

number

Returns the interpolated value.

Parameters

self :

scaleform.Easing

The easing functor to use.

Returns

scaleform.EasingTypes

Returns the type of the Easing functor.

 scaleform.Tweener.transition (self) : scaleform.Easing
Returns the transition (easing) set on the tween.
 scaleform.Easing.ease_in (self, t, b, c, d) : number
Starts motion from zero velocity and then accelerates motion.
 self : scaleform.Easing
The easing functor to use.
 t : number
The current time, between 0 and duration inclusive (in ms).
 b : number
The initial value of the animation property.
 c : number
The total change in the animation property.
 d : number
The duration of the motion (in ms).
 number  scaleform.Easing
Represents an easing functor.
A numeric value.  scaleform.Easing.ease_in_out (self, t, b, c, d) : number
Combines both ease_in and ease_out.
 self : scaleform.Easing
The easing functor to use.
 t : number
The current time, between 0 and duration inclusive (in ms).
 b : number
The initial value of the animation property.
 c : number
The total change in the animation property.
 d : number
The duration of the motion (in ms).
 number  scaleform.Easing.ease_out (self, t, b, c, d) : number
Starts motion fast and then decelerates to zero velocity.
 self : scaleform.Easing
The easing functor to use.
 t : number
The current time, between 0 and duration inclusive (in ms).
 b : number
The initial value of the animation property.
 c : number
The total change in the animation property.
 d : number
The duration of the motion (in ms).
 number  scaleform.Easing.easing_type (self) : scaleform.EasingTypes
Returns the type of the Easing functor, scaleform.EasingTypes.
 self : scaleform.Easing
The easing functor to use.
 scaleform.EasingTypes
Returns the type of the Easing functor.
 scaleform.EasingTypes
The type of easing performed.
 self : scaleform.Tweener
The tweener whose property is set.
 scaleform.Easing
Returns the easing function object.
 scaleform.Tweener
A Lua interface to Tweener.
Indicates a table.
This documentation uses the term table to mean an anonymous, temporary Lua table that contains named data values. You typically use these tables to pass data or settings to a function, or to hold data returned by a function.
Indicates an object.
This documentation uses the term object to mean a named Lua table or userdata value that maintains a state. Some object types may have multiple instances existing at the same time, each with its own state; these objects typically have creation functions or accessors that you must call in order to get an instance. Some object types have only one instance, which you always access through the object's name.
Indicates a named variable within a namespace, object or table; or an element within an enumeration.Indicates a code sample.Indicates an enumeration.
This documentation uses the term enumeration to mean a named Lua table that contains only a set of constant values. These values typically identify a predefined set of options for some setting or behavior. You might pass an enumeration value to a function, or test the value returned by a function against the items in the enumeration to see which option is currently set.
Indicates a named variable within a namespace or object that has a pre-set constant value.Indicates a category: a semantic grouping of related API elements.Indicates a namespace.
This documentation uses the term namespace to mean a named Lua table that exists in only one single instance, intended as a container for an interface of related objects, functions and data variables.
Indicates an output value returned by a function.Indicates a named function within a namespace or object.Indicates an input parameter for a function.