Scaleform Studio Lua API Reference: scaleform.physics.EdgeShape object reference
scaleform.physics.EdgeShape object reference
Description
Represents an edge shape consisting of a line segment.
Inheritance 
Functions
Parameters
Returns
self : |
The edge shape currently in use. |
boolean |
Returns true if the EdgeShape has a first vertex and false otherwise |
Parameters
Returns
self : |
The edge shape currently in use. |
boolean |
Returns true if the EdgeShape has a fourth vertex and false otherwise |
Parameters
Returns
self : |
The edge shape currently in use. | |
v1 : |
The coordinate of the first edge point. | |
v2 : |
The coordinate of the second edge point. |
| This function does not return any values. |
Parameters
Returns
self : |
The edge shape currently in use. |
|
The coordinate of the first edge point. |
Parameters
Returns
self : |
The edge shape currently in use. |
|
The coordinate of the second edge point. |
Parameters
Returns
self : |
The edge shape currently in use. |
|
The coordinate of the third edge point. |
scaleform.physics.ShapeRepresents shape used in fixtures.
scaleform.physics.EdgeShape.has_vertex_0 (self) : booleanChecks if the EdgeShape has a first edge point.
self : scaleform.physics.EdgeShapeThe edge shape currently in use.
boolean scaleform.physics.EdgeShapeRepresents an edge shape consisting of a line segment. true or false.
scaleform.physics.EdgeShape.has_vertex_3 (self) : booleanChecks if the EdgeShape has a fourth edge point.
self : scaleform.physics.EdgeShapeThe edge shape currently in use.
boolean scaleform.physics.EdgeShape.set_vertices (self, v1, v2) Sets the coordinate points of the edge shape.
self : scaleform.physics.EdgeShapeThe edge shape currently in use.
v1 : scaleform.PointThe coordinate of the first edge point.
v2 : scaleform.PointThe coordinate of the second edge point.
scaleform.PointPoint should be in the form of a table {x=a, y=b}
{ PropertyType : string, x : number, y : number, }
scaleform.physics.EdgeShape.vertex_0 (self) : scaleform.PointGets the coordinate of the first edge point.
self : scaleform.physics.EdgeShapeThe edge shape currently in use.
scaleform.PointThe coordinate of the first edge point.
scaleform.physics.EdgeShape.vertex_1 (self) : scaleform.PointGets the coordinate of the second edge point.
self : scaleform.physics.EdgeShapeThe edge shape currently in use.
scaleform.PointThe coordinate of the second edge point.
scaleform.physics.EdgeShape.vertex_2 (self) : scaleform.PointGets the coordinate of the third edge point.
self : scaleform.physics.EdgeShapeThe edge shape currently in use.
scaleform.PointThe coordinate of the third edge point.
scaleform.physics.EdgeShape.vertex_3 (self) : scaleform.PointGets the coordinate of the fourth edge point.
self : scaleform.physics.EdgeShapeThe edge shape currently in use.
scaleform.PointThe coordinate of the fourth edge point.A string of characters.A numeric value.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.