Scaleform Studio Lua API Reference: scaleform.RefPoints enumeration reference

scaleform.RefPoints enumeration reference

Description

The relative reference points that can be specified on the actor.

Enumeration values

The reference point of the actor is the bottom center of the actor bounds.
The reference point of the actor is the bottom left of the actor bounds.
The reference point of the actor is the bottom right of the actor bounds.
The reference point of the actor is always the center of the actor bounds.
The reference point of the actor is the center left of the actor bounds.
The reference point of the actor is the center right of the actor bounds.
The reference point is a fixed offset from the center of the actor.
The reference point of the actor is the top center of the actor bounds.
The reference point of the actor is the top left of the actor bounds.
The reference point of the actor is the top right of the actor bounds.
 scaleform.Actor.set_ref_point (self, refPoint)
Sets a reference point for the actor.
 scaleform.RefPoints.BottomCenter
The reference point of the actor is the bottom center of the actor bounds.
 scaleform.RefPoints.BottomLeft
The reference point of the actor is the bottom left of the actor bounds.
 scaleform.RefPoints.BottomRight
The reference point of the actor is the bottom right of the actor bounds.
 scaleform.RefPoints.Center
The reference point of the actor is always the center of the actor bounds.
 scaleform.RefPoints.CenterLeft
The reference point of the actor is the center left of the actor bounds.
 scaleform.RefPoints.CenterRight
The reference point of the actor is the center right of the actor bounds.
 scaleform.RefPoints.Fixed
The reference point is a fixed offset from the center of the actor.
 scaleform.RefPoints.TopCenter
The reference point of the actor is the top center of the actor bounds.
 scaleform.RefPoints.TopLeft
The reference point of the actor is the top left of the actor bounds.
 scaleform.RefPoints.TopRight
The reference point of the actor is the top right of the actor bounds.
 self : scaleform.Actor
The actor to set the ref point on.
 refPoint : scaleform.RefPoints
A special relative type of ref point.
 scaleform.Actor
Generic objects located in a scene.
 scaleform.RefPoints
The relative reference points that can be specified on the actor.
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.