Scaleform Studio Lua API Reference: scaleform.physics.Fixture object reference
scaleform.physics.Fixture object reference
Description
An interface to attach shapes to the fixtures.
Constructors and accessors 
Functions
Parameters
Returns
self : |
The fixture currently in use. | |
index : | number |
The child index of the fixture proxy. |
|
The AABB for the fixture currently in use. |
This AABB may be stale. If you need a more accurate AABB, compute it using the shape and the body transform.
Parameters
Returns
self : |
The fixture currently in use. |
|
The physics body. |
Parameters
Returns
self : |
The fixture currently in use. | |
input : |
The input line end point. | |
index : | integer |
The index of the child the ray gets cast against. |
boolean |
Returns true if the ray cast hit something otherwise false. |
|
the output line end point if the operation is successful. |
Parameters
Returns
body : |
The physics body to which the fixture is attached. | |
shape : |
The shape definition data. | |
density : | number |
Density of the body. |
|
The newly created Fixture. |
Parameters
Returns
self : |
The fixture currently in use. |
number |
The density of the fixture. |
Parameters
Returns
self : |
The fixture to destroy. |
| This function does not return any values. |
Parameters
Returns
self : |
The fixture currently in use. |
|
The collision filter used for the fixture. |
Parameters
Returns
self : |
The fixture currently in use. |
number |
The friction of the fixture. |
Parameters
Returns
self : |
The fixture currently in use. |
|
The mass data for the fixture. |
The mass data is based on the density and the shape. The rotational inertia is about the shape's origin.
Parameters
Returns
self : |
The fixture currently in use. |
|
The material data definition. |
Parameters
Returns
self : |
The fixture currently in use. |
| This function does not return any values. |
Parameters
Returns
self : |
The fixture currently in use. |
number |
The restitution value. |
Parameters
Returns
self : |
The fixture currently in use. |
boolean |
Whether fixture is a sensor or not. |
Parameters
Returns
self : |
The fixture currently in use. | |
density : | number |
The density of the fixture. |
| This function does not return any values. |
Parameters
Returns
self : |
The fixture currently in use. | |
filter : |
The filter used to define the collision of the fixture. |
| This function does not return any values. |
Parameters
Returns
self : |
The fixture currently in use. | |
friction : | number |
The friction of the fixture. |
| This function does not return any values. |
Parameters
Returns
self : |
The fixture currently in use. | |
material : |
The material data definition. |
| This function does not return any values. |
Parameters
Returns
self : |
The fixture currently in use. | |
restitution : | number |
The restitution value. |
| This function does not return any values. |
Parameters
Returns
self : |
The fixture currently in use. | |
sensor : | boolean |
A flag to determine whether fixture is a sensor or not. |
| This function does not return any values. |
Parameters
Returns
self : |
The fixture currently in use. |
|
The shape of the fixture. |
Parameters
Returns
self : |
The fixture currently in use. | |
pt : |
The point tested for. |
boolean |
Whether the point is in the fixture or not. |
scaleform.physics.Body.fixture_by_index (self, index) : scaleform.physics.FixtureReturns the fixture at the specified index.
scaleform.physics.Fixture.create (body, shape, density) : scaleform.physics.FixtureCreates a fixture and attaches it to the body.
scaleform.physics.Fixture.aabb_by_index (self, index) : scaleform.RectGet the fixture's AABB.
self : scaleform.physics.FixtureThe fixture currently in use.
index : numberThe child index of the fixture proxy.
scaleform.RectThe AABB for the fixture currently in use.
scaleform.physics.FixtureAn interface to attach shapes to the fixtures. A numeric value.
scaleform.RectA rectangle based upon two points.
{ x1 : number, x2 : number, y1 : number, y2 : number, }
scaleform.physics.Fixture.body (self) : scaleform.physics.BodyReturns the body which owns this fixture.
self : scaleform.physics.FixtureThe fixture currently in use.
scaleform.physics.BodyThe physics body.
scaleform.physics.BodyInterface for physics properties of a vgx actor.
scaleform.physics.Fixture.cast_ray (self, input, index) : boolean, scaleform.physics.RayCastOutputCast a ray against this shape of the fixture.
self : scaleform.physics.FixtureThe fixture currently in use.
input : scaleform.physics.RayCastInputThe input line end point.
index : integerThe index of the child the ray gets cast against.
boolean scaleform.physics.RayCastOutputthe output line end point if the operation is successful.
scaleform.physics.RayCastInput (init) : scaleform.physics.RayCastInputCreate an initialized ray cast input table. A strictly integral numeric value, with no decimal component.true or false.
scaleform.physics.RayCastOutput (init) : scaleform.physics.RayCastOutputCreate an initialized ray cast output table.
body : scaleform.physics.BodyThe physics body to which the fixture is attached.
shape : scaleform.physics.ShapeDefThe shape definition data.
density : numberDensity of the body.
scaleform.physics.FixtureThe newly created Fixture.
scaleform.physics.ShapeDef (init) : scaleform.physics.ShapeDefCreate an initialized shape definition table.
scaleform.physics.Fixture.density (self) : numberGets the density of the fixture.
self : scaleform.physics.FixtureThe fixture currently in use.
number scaleform.physics.Fixture.destroy (self) Destroys the fixture and detaches it from the body.
self : scaleform.physics.FixtureThe fixture to destroy.
scaleform.physics.Fixture.filter_data (self) : scaleform.physics.CollisionFilterGets the filter data used to filter collision between objects.
self : scaleform.physics.FixtureThe fixture currently in use.
scaleform.physics.CollisionFilterThe collision filter used for the fixture.
scaleform.physics.CollisionFilter (init) : scaleform.physics.CollisionFilterCreate an initialized collision filter table.
scaleform.physics.Fixture.friction (self) : numberGets the friction of the fixture.
self : scaleform.physics.FixtureThe fixture currently in use.
number scaleform.physics.Fixture.mass_data (self) : scaleform.physics.MassDataGets the mass data for this fixture.
self : scaleform.physics.FixtureThe fixture currently in use.
scaleform.physics.MassDataThe mass data for the fixture.
scaleform.physics.MassData (init) : scaleform.physics.MassDataCreate an initialized mass data table.
scaleform.physics.Fixture.material (self) : scaleform.physics.MaterialDefGets the material data of the fixture.
self : scaleform.physics.FixtureThe fixture currently in use.
scaleform.physics.MaterialDefThe material data definition.
scaleform.physics.MaterialDef (init) : scaleform.physics.MaterialDefCreate an initialized material definition table.
scaleform.physics.Fixture.refilter (self) Resets the filter used for the fixture.
self : scaleform.physics.FixtureThe fixture currently in use.
scaleform.physics.Fixture.restitution (self) : numberGets the restitution of the fixture.
self : scaleform.physics.FixtureThe fixture currently in use.
number scaleform.physics.Fixture.sensor (self) : booleanDetermines whether the fixture is a sensor (non-solid surface) or not).
self : scaleform.physics.FixtureThe fixture currently in use.
boolean scaleform.physics.Fixture.set_density (self, density) Sets the density of the fixture.
self : scaleform.physics.FixtureThe fixture currently in use.
density : numberThe density of the fixture.
scaleform.physics.Fixture.set_filter_data (self, filter) Sets the filter data used to filter collision between objects.
self : scaleform.physics.FixtureThe fixture currently in use.
filter : scaleform.physics.CollisionFilterThe filter used to define the collision of the fixture.
scaleform.physics.Fixture.set_friction (self, friction) Sets the friction of the fixture.
self : scaleform.physics.FixtureThe fixture currently in use.
friction : numberThe friction of the fixture.
scaleform.physics.Fixture.set_material (self, material) Sets the material data for the fixture.
self : scaleform.physics.FixtureThe fixture currently in use.
material : scaleform.physics.MaterialDefThe material data definition.
scaleform.physics.Fixture.set_restitution (self, restitution) Sets the restitution of the fixture.
self : scaleform.physics.FixtureThe fixture currently in use.
restitution : numberThe restitution value.
scaleform.physics.Fixture.set_sensor (self, sensor) Defines if a fixture is a sensor (non-solid surface).
self : scaleform.physics.FixtureThe fixture currently in use.
sensor : booleanA flag to determine whether fixture is a sensor or not.
scaleform.physics.Fixture.shape (self) : scaleform.ShapeComponentReturns the shape of the fixture.
self : scaleform.physics.FixtureThe fixture currently in use.
scaleform.ShapeComponentThe shape of the fixture.
scaleform.ShapeComponentAn interface to shape component.
scaleform.physics.Fixture.test_point (self, pt) : booleanTest a point for containment in this fixture.
self : scaleform.physics.FixtureThe fixture currently in use.
pt : scaleform.PointThe point tested for.
boolean scaleform.PointPoint should be in the form of a table {x=a, y=b}
{ PropertyType : string, x : number, y : number, }
scaleform.physics.Fixture.type (self) : scaleform.physics.ShapeTypesReturns the type of the shape.
self : scaleform.physics.FixtureThe fixture currently considered.
scaleform.physics.ShapeTypesThe type of the shape.
scaleform.physics.ShapeTypesThe different types of shapes.
self : scaleform.physics.BodyThe physics body currently in use.
index : integerThe index at which the fixture is returned from 1 to fixture count.
scaleform.physics.FixtureThe fixture attached to a body.
init : scaleform.physics.RayCastInput?An table arguments to initialize the returned physics.RayCastInput table with. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.physics.RayCastInputReturns a fully constructed ray cast input table.
init : scaleform.physics.RayCastOutput?An table arguments to initialize the returned physics.RayCastOutput table with. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.physics.RayCastOutputReturns a fully constructed ray cast output table.
init : scaleform.physics.ShapeDef?An table arguments to initialize the returned physics.ShapeDef table with. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.physics.ShapeDefReturns a fully constructed shape definition table.
init : scaleform.physics.CollisionFilter?An table arguments to initialize the returned physics.CollisionFilter table with. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.physics.CollisionFilterReturns a fully constructed collision filter table.
init : scaleform.physics.MassData?An table arguments to initialize the returned physics.MassData table with. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.physics.MassDataReturns a fully constructed mass data table.
init : scaleform.physics.MaterialDef?An table arguments to initialize the returned physics.MaterialDef table with. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.physics.MaterialDefReturns a fully constructed material definition table.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.