Scaleform Studio Lua API Reference: scaleform.Size table reference

scaleform.Size table reference
Data Members
expand all | collapse all

Description

Width should be in the form of a table {width=a, height=b}

Data Members

height : number
Height dimension
width : number
Width dimension
 scaleform.Actor.dimensions (self) : scaleform.Size
Gets the dimensions of the actor.  scaleform.Size (init) : scaleform.Size
Create an initialized size table.  scaleform.Stage.dimensions () : scaleform.Size
Gets the dimensions of the stage in pixels.  scaleform.TextComponent.text_dimensions (self) : scaleform.Size
Returns dimensions of the text component.  scaleform.VisualComponent.dimensions (self) : scaleform.Size?
Get the component dimensions in stage space.  Matrix2F.AppendScaling (self, scale) : Matrix2F
Appends a scale change to the matrix.  scaleform.Actor.set_dimensions (self, size)
Sets the dimensions of the actor.  scaleform.ShapeComponent.draw_ellipse (self, center, size) : boolean
Draws a ellipse using current line and fill styles.  scaleform.ShapeComponent.draw_round_rect (self, rect, radii) : boolean
Draws a rounded rect using current line and fill styles.  scaleform.Stage.set_dimensions (size)
Sets the dimensions of the stage in pixels.  scaleform.TextComponent.set_dimensions (self, dim)
Sets the dimensions of the text component.  scaleform.Size.height : number
Height dimension A numeric value.  scaleform.Size.width : number
Width dimension  self : scaleform.Actor
The actor whose dimension is retrieved.  scaleform.Size
The dimension set for the actor.  init : scaleform.Size?
An table arguments to initialize the returned scaleform.Size table with. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Size
Returns a fully constructed size table.  scaleform.Size
The size of the stage.  self : scaleform.TextComponent
The text component currently in use.  scaleform.Size
The dimensions of the text component.  self : scaleform.VisualComponent
The visual component to get the dimensions of.  scaleform.Size?
Returns the size of the component or nil if there are no dimensions.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  self : Matrix2F
The 2D matrix currently in use.  scale : scaleform.Size
The scaling factor applied.  Matrix2F
The modified matrix.  self : scaleform.Actor
The actor whose dimension is set.  size : scaleform.Size
The dimension to set for the actor.  self : scaleform.ShapeComponent
The shape component to draw the ellipse in.  center : scaleform.Point
The location of the center of the circle relative to the registration point of the parent actor.  size : scaleform.Size
The width and height of the ellipse.  boolean  self : scaleform.ShapeComponent
The shape component to draw the rounded rect in.  rect : scaleform.Rect
The rect relative to the registration point of the parent actor.  radii : scaleform.Size
The radii the ellipse used to draw the rounded corners.  boolean  size : scaleform.Size
The size of the stage.  self : scaleform.TextComponent
The text component whose dimensions is set.  dim : scaleform.Size
The size of the text component.  scaleform.Actor
Generic objects located in a scene.  scaleform.Size
Width should be in the form of a table {width=a, height=b}
{ height : number, width : number, }  scaleform.TextComponent
Represent the text field.  scaleform.VisualComponent
An interface to the visual component.  Matrix2F
A two-dimensional matrix in row-major order.  scaleform.ShapeComponent
An interface to shape component.  scaleform.Point
Point should be in the form of a table {x=a, y=b}
{ PropertyType : string, x : number, y : number, }true or false.  scaleform.Rect
A rectangle based upon two points.
{ x1 : number, x2 : number, y1 : number, y2 : number, }A string of characters.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.
Please send us your comment about this page