Scaleform Studio Lua API Reference: scaleform.PhysicsBodyComponent object reference
scaleform.PhysicsBodyComponent object reference
Description
Describes a Actor's physical properties.
Inheritance 
Constructors and accessors
Functions
Parameters
Returns
self : |
The physics body component that owns the body. | |
fixture : |
The fixture definition data to create fixture. |
| This function does not return any values. |
Parameters
Returns
self : |
The physics body component. |
|
Returns the created physics body. |
Parameters
Returns
owner : |
The parent object of the newly created physics body component. |
|
Returns the newly created PhysicsBodyComponent. |
Parameters
Returns
self : |
The physics body component that owns the body. | |
bodyParams : |
Data required to create a new physics body. |
| This function does not return any values. |
scaleform.ComponentThe root type of all actor components.
scaleform.physics.Body.component (self) : scaleform.PhysicsBodyComponentGet the physics body component which owns the physics body.
scaleform.PhysicsBodyComponent.create (owner) : scaleform.PhysicsBodyComponentCreate a physics body component.
scaleform.PhysicsBodyComponent.add_fixture (self, fixture) Attaches the fixture to the physics body.
self : scaleform.PhysicsBodyComponentThe physics body component that owns the body.
fixture : scaleform.physics.FixtureDefThe fixture definition data to create fixture.
scaleform.PhysicsBodyComponentDescribes a Actor's physical properties.
scaleform.physics.FixtureDef (init) : scaleform.physics.FixtureDefCreate an initialized fixture definition table.
scaleform.PhysicsBodyComponent.body (self) : scaleform.physics.BodyReturns the body contained in the physics body component.
self : scaleform.PhysicsBodyComponentThe physics body component.
scaleform.physics.BodyReturns the created physics body.
scaleform.physics.BodyInterface for physics properties of a vgx actor.
owner : scaleform.ActorThe parent object of the newly created physics body component.
scaleform.PhysicsBodyComponentReturns the newly created PhysicsBodyComponent.
scaleform.ActorGeneric objects located in a scene.
scaleform.PhysicsBodyComponent.set_body_params (self, bodyParams) Sets the construction parameters to create a new physics body.
self : scaleform.PhysicsBodyComponentThe physics body component that owns the body.
bodyParams : scaleform.physics.BodyConstructParamsData required to create a new physics body.
scaleform.physics.BodyConstructParams (init) : scaleform.physics.BodyConstructParamsCreate an initialized body construct definition table.
scaleform.PhysicsBodyComponent.set_world (self, world) Sets the world that will drive the object's simulation.
self : scaleform.PhysicsBodyComponentThe physics body component that owns the body.
world : scaleform.PhysicsWorldComponentThe physics world component that the body should be attached to and simulated by.
scaleform.PhysicsWorldComponentDrives the Physics simulation of all child objects that have physical properties
self : scaleform.physics.BodyThe physics body currently in use.
scaleform.PhysicsBodyComponentThe body component which owns the physics body.
init : scaleform.physics.FixtureDef?An table arguments to initialize the returned physics.FixtureDef table with. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.physics.FixtureDefReturns a fully constructed fixture definition table.
init : scaleform.physics.BodyConstructParams?An table arguments to initialize the returned physics.BodyConstructParams table with. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.physics.BodyConstructParamsReturns a fully constructed body construct table.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.