Scaleform Studio Lua API Reference: scaleform.physics.CircleShape object reference
scaleform.physics.CircleShape object reference
Description
Represents a circle that extends the shape and adds a radius and a local position.
Inheritance 
Functions
Parameters
Returns
self : |
The circle shape currently used. |
integer |
Number of vertices in the shape. |
Parameters
Returns
self : |
The circle shape currently in use. |
|
The position of the circle shape. |
Parameters
Returns
self : |
The circle shape currently in use. |
number |
The radius of the circle shape. |
Parameters
Returns
self : |
The circle shape currently in use. | |
position : |
The position of the circle shape. |
| This function does not return any values. |
Parameters
Returns
self : |
The circle shape currently in use. | |
rad : | number |
The radius of the circle shape. |
| This function does not return any values. |
Parameters
Returns
self : |
The circle shape currently used. | |
dir : |
The specified direction. |
|
The supporting vertex of the shape. |
Parameters
Returns
self : |
The circle shape currently used. | |
dir : |
The specified direction. |
integer |
The index of the supporting vertex |
scaleform.physics.ShapeRepresents shape used in fixtures.
scaleform.physics.CircleShape.num_vertices (self) : integerReturns the number of vertices the shape has.
self : scaleform.physics.CircleShapeThe circle shape currently used.
integer scaleform.physics.CircleShapeRepresents a circle that extends the shape and adds a radius and a local position. A strictly integral numeric value, with no decimal component.
scaleform.physics.CircleShape.position (self) : scaleform.PointReturns the position of the circle shape.
self : scaleform.physics.CircleShapeThe circle shape currently in use.
scaleform.PointThe position of the circle shape.
scaleform.PointPoint should be in the form of a table {x=a, y=b}
{ PropertyType : string, x : number, y : number, }
scaleform.physics.CircleShape.radius (self) : numberReturns the radius of the circle shape.
self : scaleform.physics.CircleShapeThe circle shape currently in use.
numberA numeric value. scaleform.physics.CircleShape.set_position (self, position) Sets the position of the circle shape.
self : scaleform.physics.CircleShapeThe circle shape currently in use.
position : scaleform.PointThe position of the circle shape.
scaleform.physics.CircleShape.set_radius (self, rad) Sets the radius of the circle shape.
self : scaleform.physics.CircleShapeThe circle shape currently in use.
rad : numberThe radius of the circle shape.
scaleform.physics.CircleShape.support_vertex (self, dir) : scaleform.PointGets the supporting vertex in the given direction.
self : scaleform.physics.CircleShapeThe circle shape currently used.
dir : scaleform.PointThe specified direction.
scaleform.PointThe supporting vertex of the shape.
scaleform.physics.CircleShape.support_vertex_index (self, dir) : integerGets the supporting vertex index in the given direction.
self : scaleform.physics.CircleShapeThe circle shape currently used.
dir : scaleform.PointThe specified direction.
integer scaleform.physics.CircleShape.vertex_by_index (self, index) : scaleform.PointReturns the vertex of the shape at the specified index.
self : scaleform.physics.CircleShapeThe circle shape currently in use.
index : integerThe index at which the vertex is returned.
scaleform.PointThe shape vertex.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.