Scaleform Studio Lua API Reference: scaleform.physics.Body object reference
Description
Interface for physics properties of a vgx actor.
Constructors and accessors 
Other related reference items
Functions
self : |
The physics body currently in use. |
boolean |
Returns true if the body is active and false otherwise. |
self : |
The physics body currently in use. |
number |
The angle of the body. |
self : |
The physics body currently in use. |
number |
Angular damping of the body. |
self : |
The physics body currently in use. |
number |
The angular velocity. |
self : |
The physics body currently in use. | |
impulse : | number |
The angular impulse applied. |
| This function does not return any values. |
self : |
The physics body currently in use. | |
force : |
The force applied to the object. | |
point : |
The world point at which the force is applied. |
| This function does not return any values. |
self : |
The physics body currently in use. | |
center : |
The force applied to the body's center. |
| This function does not return any values. |
self : |
The physics body currently in use. | |
impulse : |
The impulse applied to the point. | |
point : |
The point at which the impulse is applied. |
| This function does not return any values. |
self : |
The physics body currently in use. | |
impulse : |
The impulse to be applied. |
| This function does not return any values. |
self : |
The physics body currently in use. | |
torque : | number |
The torque applied to the body. |
| This function does not return any values. |
This affects the angular velocity.
self : |
The physics body currently in use. |
boolean |
Returns true if the body is awake and false otherwise. |
 |
Determines the bullet status of the body, whether the flag is enabled/disabled to detect continuous collision.
|
self : |
The physics body currently in use. |
boolean |
Returns true if enabled to detect continuous collision and false otherwise. |
self : |
The physics body currently in use. |
|
The body component which owns the physics body. |
self : |
The physics body currently in use. | |
index : | integer |
The index at which the fixture is returned from 1 to fixture count. |
|
The fixture attached to a body. |
self : |
The physics body currently in use. |
number |
The gravity scale on the body. |
self : |
The physics body currently in use. |
number |
Inertia of the body. |
self : |
The physics body currently in use. |
|
The list of Joints that are attached to this body. The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown. |
self : |
The physics body currently in use. |
number |
Linear damping of the body. |
self : |
The physics body currently in use. |
|
The linear velocity. |
self : |
The physics body currently in use. | |
local : |
The local point coordinates. |
|
Linear velocity of local point. |
self : |
The physics body currently in use. | |
world : |
The world point coordinates. |
|
Linear velocity of world point. |
self : |
The physics body currently in use. |
|
The local position. |
self : |
The physics body currently in use. | |
local : |
The local point coordinates. |
|
The world coordinates. |
self : |
The physics body currently in use. | |
local : |
The coordinates of local vector. |
|
The world coordinates. |
self : |
The physics body currently in use. |
number |
The mass of the body. |
self : |
The physics body currently in use. |
|
The mass data of the body. |
self : |
The physics body currently in use. |
number |
The number of fixtures |
self : |
The physics body currently in use. |
|
The position of the body. |
self : |
The physics body currently in use. |
| This function does not return any values. |
self : |
The physics body currently in use. |
boolean |
Returns true if the body rotation is locked and false otherwise. |
self : |
The physics body currently in use. | |
flag : | boolean |
A flag to set/unset active nature of body. |
| This function does not return any values. |
An inactive body is not simulated and cannot be collided with or woken up.
self : |
The physics body currently in use. | |
damping : | number |
The angular damping of the body. |
| This function does not return any values. |
self : |
The physics body currently in use. | |
omega : | number |
The angular velocity. |
| This function does not return any values. |
self : |
The physics body currently in use. | |
flag : | boolean |
A flag to set the body to sleep. |
| This function does not return any values. |
| |
Sets the flag that enables and disables continuous collision detection which is used for very fast moving objects.
|
self : |
The physics body currently in use. | |
flag : | boolean |
A flag to enable/disable continuous collision detection. |
| This function does not return any values. |
self : |
The physics body currently in use. | |
scale : | number |
The gravity scale factor. |
| This function does not return any values. |
self : |
The physics body currently in use. | |
damping : | number |
The linear damping of the body. |
| This function does not return any values. |
self : |
The physics body currently in use. | |
velocity : |
The linear velocity of the body |
| This function does not return any values. |
self : |
The physics body currently in use. | |
data : |
The mass data of the body. |
| This function does not return any values. |
self : |
The physics body currently in use. | |
flag : | boolean |
A flag to lock/unlock rotation. |
| This function does not return any values. |
This causes the mass to be reset.
self : |
The physics body currently in use. | |
flag : | boolean |
A flag to set the sleeping nature of the body. |
| This function does not return any values. |
self : |
The physics body currently in use. | |
pos : |
The position of the body in Physics World coordinates. | |
angle : | number |
The rotation of the body in radians. |
| This function does not return any values. |
Manipulating a body's transform may cause non-physical behavior.
self : |
The physics body currently in use. | |
type : |
The body type. |
| This function does not return any values. |
This may alter the mass and velocity.
self : |
The physics body currently in use. |
boolean |
Returns true if the body is allowed to sleep and false otherwise. |
self : |
The physics body currently in use. |
|
The body type. |
Can be one of Type_Static, Type_Kinematic or Type_Dynamic.
self : |
The physics body currently in use. |
|
The World that own this body. |
self : |
The physics body currently in use. |
|
The world position. |
self : |
The physics body currently in use. | |
world : |
The world point coordinates. |
|
The local point. |
scaleform.physics.Fixture.body (self) : scaleform.physics.BodyReturns the body which owns this fixture.
scaleform.physics.Joint.body_a (self) : scaleform.physics.BodyReturns the first body of the bodies that are currently linked through this joint.
scaleform.physics.Joint.body_b (self) : scaleform.physics.BodyReturns the second body of the bodies that are currently linked through this joint.
scaleform.PhysicsBodyComponent.body (self) : scaleform.physics.BodyReturns the body contained in the physics body component.
scaleform.physics.Fixture.create (body, shape, density) : scaleform.physics.FixtureCreates a fixture and attaches it to the body.
scaleform.physics.World.add_body (self, body) Adds a body to the world/simulation.
scaleform.physics.Body.active (self) : booleanDetermines whether the body is active or not.
self : scaleform.physics.BodyThe physics body currently in use.
boolean
scaleform.physics.BodyInterface for physics properties of a vgx actor. true or false.
scaleform.physics.Body.angle (self) : numberReturns the angle of the body.
self : scaleform.physics.BodyThe physics body currently in use.
numberA numeric value. scaleform.physics.Body.angular_damping (self) : numberGets the angular damping of the body.
self : scaleform.physics.BodyThe physics body currently in use.
number scaleform.physics.Body.angular_velocity (self) : numberReturns the angular velocity of the body.
self : scaleform.physics.BodyThe physics body currently in use.
number scaleform.physics.Body.apply_angular_impulse (self, impulse) Applies an angular impulse.
self : scaleform.physics.BodyThe physics body currently in use.
impulse : numberThe angular impulse applied.
scaleform.physics.Body.apply_force (self, force, point) Applies a force to the object at a given world point.
self : scaleform.physics.BodyThe physics body currently in use.
force : scaleform.PointThe force applied to the object.
point : scaleform.PointThe world point at which the force is applied.
scaleform.PointPoint should be in the form of a table {x=a, y=b}
{ PropertyType : string, x : number, y : number, }
scaleform.physics.Body.apply_force_to_center (self, center) Applies a force to the body's center of mass.
self : scaleform.physics.BodyThe physics body currently in use.
center : scaleform.PointThe force applied to the body's center.
scaleform.physics.Body.apply_linear_impulse (self, impulse, point) Applies an impulse at a point.
self : scaleform.physics.BodyThe physics body currently in use.
impulse : scaleform.PointThe impulse applied to the point.
point : scaleform.PointThe point at which the impulse is applied.
scaleform.physics.Body.apply_linear_impulse_to_center (self, impulse) Applies an impulse to the body's center of mass.
self : scaleform.physics.BodyThe physics body currently in use.
impulse : scaleform.PointThe impulse to be applied.
scaleform.physics.Body.apply_torque (self, torque) Applies a torque.
self : scaleform.physics.BodyThe physics body currently in use.
torque : numberThe torque applied to the body.
scaleform.physics.Body.awake (self) : booleanDetermines whether the body is awake or not.
self : scaleform.physics.BodyThe physics body currently in use.
boolean scaleform.physics.Body.bullet (self) : booleanDetermines the bullet status of the body, whether the flag is enabled/disabled to detect continuous collision.
self : scaleform.physics.BodyThe physics body currently in use.
boolean scaleform.physics.Body.component (self) : scaleform.PhysicsBodyComponentGet the physics body component which owns the physics body.
self : scaleform.physics.BodyThe physics body currently in use.
scaleform.PhysicsBodyComponentThe body component which owns the physics body.
scaleform.PhysicsBodyComponentDescribes a Actor's physical properties.
scaleform.physics.Body.fixture_by_index (self, index) : scaleform.physics.FixtureReturns the fixture at the specified index.
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.A strictly integral numeric value, with no decimal component.
scaleform.physics.FixtureAn interface to attach shapes to the fixtures.
scaleform.physics.Body.gravity_scale (self) : numberGets the gravity scale of the body.
self : scaleform.physics.BodyThe physics body currently in use.
number scaleform.physics.Body.inertia (self) : numberGets the rotational inertia of the body.
self : scaleform.physics.BodyThe physics body currently in use.
number scaleform.physics.Body.joint_list (self) : scaleform.physics.Joint[]Gets a list of Joints that are attached to this body.
self : scaleform.physics.BodyThe physics body currently in use.
scaleform.physics.Joint[]The list of Joints that are attached to this body.
scaleform.physics.JointAn interface for the physics properties of the joint between two physics bodies.
scaleform.physics.Body.linear_damping (self) : numberGets the linear damping of the body.
self : scaleform.physics.BodyThe physics body currently in use.
number scaleform.physics.Body.linear_velocity (self) : scaleform.PointReturns the linear velocity of the body.
self : scaleform.physics.BodyThe physics body currently in use.
scaleform.PointThe linear velocity.
scaleform.physics.Body.linear_velocity_from_local_point (self, local) : scaleform.PointGets the linear velocity of local point attached to this body.
self : scaleform.physics.BodyThe physics body currently in use.
local : scaleform.PointThe local point coordinates.
scaleform.PointLinear velocity of local point.
scaleform.physics.Body.linear_velocity_from_world_point (self, world) : scaleform.PointGets the linear velocity of world point attached to this body.
self : scaleform.physics.BodyThe physics body currently in use.
world : scaleform.PointThe world point coordinates.
scaleform.PointLinear velocity of world point.
scaleform.physics.Body.local_center (self) : scaleform.PointReturns the local position of the body's center of mass.
self : scaleform.physics.BodyThe physics body currently in use.
scaleform.PointThe local position.
scaleform.physics.Body.local_to_world_point (self, local) : scaleform.PointGets the world coordinates of a point given the local coordinates.
self : scaleform.physics.BodyThe physics body currently in use.
local : scaleform.PointThe local point coordinates.
scaleform.PointThe world coordinates.
scaleform.physics.Body.local_to_world_vector (self, local) : scaleform.PointGets the world coordinates of a vector given the local coordinates.
self : scaleform.physics.BodyThe physics body currently in use.
local : scaleform.PointThe coordinates of local vector.
scaleform.PointThe world coordinates.
scaleform.physics.Body.mass (self) : numberGets the mass of the body.
self : scaleform.physics.BodyThe physics body currently in use.
number scaleform.physics.Body.mass_data (self) : scaleform.physics.MassDataReturns the mass data of the body.
self : scaleform.physics.BodyThe physics body currently in use.
scaleform.physics.MassDataThe mass data of the body.
scaleform.physics.MassData (init) : scaleform.physics.MassDataCreate an initialized mass data table.
scaleform.physics.Body.num_fixtures (self) : numberReturns the number of fixtures attached to a body.
self : scaleform.physics.BodyThe physics body currently in use.
number scaleform.physics.Body.position (self) : scaleform.PointReturns the position of the body.
self : scaleform.physics.BodyThe physics body currently in use.
scaleform.PointThe position of the body.
scaleform.physics.Body.reset_mass_data (self) Resets the mass data properties of the body.
self : scaleform.physics.BodyThe physics body currently in use.
scaleform.physics.Body.rotation_fixed (self) : booleanDetermines whether rotation is locked on the body.
self : scaleform.physics.BodyThe physics body currently in use.
boolean scaleform.physics.Body.set_active (self, flag) Sets whether the body is active in the world.
self : scaleform.physics.BodyThe physics body currently in use.
flag : booleanA flag to set/unset active nature of body.
scaleform.physics.Body.set_angular_damping (self, damping) Set the angular damping of the body.
self : scaleform.physics.BodyThe physics body currently in use.
damping : numberThe angular damping of the body.
scaleform.physics.Body.set_angular_velocity (self, omega) Sets the angular velocity of the body.
self : scaleform.physics.BodyThe physics body currently in use.
omega : numberThe angular velocity.
scaleform.physics.Body.set_awake (self, flag) Sets the sleep state of the body.
self : scaleform.physics.BodyThe physics body currently in use.
flag : booleanA flag to set the body to sleep.
scaleform.physics.Body.set_bullet (self, flag) Sets the flag that enables and disables continuous collision detection which is used for very fast moving objects.
self : scaleform.physics.BodyThe physics body currently in use.
flag : booleanA flag to enable/disable continuous collision detection.
scaleform.physics.Body.set_gravity_scale (self, scale) Set the gravity scale on the body.
self : scaleform.physics.BodyThe physics body currently in use.
scale : numberThe gravity scale factor.
scaleform.physics.Body.set_linear_damping (self, damping) Set the linear damping of the body.
self : scaleform.physics.BodyThe physics body currently in use.
damping : numberThe linear damping of the body.
scaleform.physics.Body.set_linear_velocity (self, velocity) Sets the linear velocity of the body.
self : scaleform.physics.BodyThe physics body currently in use.
velocity : scaleform.PointThe linear velocity of the body
scaleform.physics.Body.set_mass_data (self, data) Sets the mass data of the body.
self : scaleform.physics.BodyThe physics body currently in use.
data : scaleform.physics.MassDataThe mass data of the body.
scaleform.physics.Body.set_rotation_fixed (self, flag) Locks or unlocks rotation on an object.
self : scaleform.physics.BodyThe physics body currently in use.
flag : booleanA flag to lock/unlock rotation.
scaleform.physics.Body.set_sleeping_allowed (self, flag) Sets the flag to determine whether the object is able to sleep when in resting contact.
self : scaleform.physics.BodyThe physics body currently in use.
flag : booleanA flag to set the sleeping nature of the body.
scaleform.physics.Body.set_transform (self, pos, angle) Sets the body's position and rotation.This breaks any contacts and wakes the other bodies.
self : scaleform.physics.BodyThe physics body currently in use.
pos : scaleform.PointThe position of the body in Physics World coordinates.
angle : numberThe rotation of the body in radians.
scaleform.physics.Body.set_type (self, type) Set the type of this body.
self : scaleform.physics.BodyThe physics body currently in use.
type : scaleform.physics.BodyTypesThe body type.
scaleform.physics.BodyTypesThe different types of physics bodies.
scaleform.physics.Body.sleeping_allowed (self) : booleanDetermines the sleeping behavior of the body.
self : scaleform.physics.BodyThe physics body currently in use.
boolean scaleform.physics.Body.type (self) : scaleform.physics.BodyTypesGet the type of this body.
self : scaleform.physics.BodyThe physics body currently in use.
scaleform.physics.BodyTypesThe body type.
scaleform.physics.Body.world (self) : scaleform.physics.WorldReturns the World that this body is part of.
self : scaleform.physics.BodyThe physics body currently in use.
scaleform.physics.WorldThe World that own this body.
scaleform.physics.WorldManages all physics entities, dynamic simulation, and asynchronous queries.
scaleform.physics.Body.world_center (self) : scaleform.PointReturns the world position of the body's center of mass.
self : scaleform.physics.BodyThe physics body currently in use.
scaleform.PointThe world position.
scaleform.physics.Body.world_to_local_point (self, world) : scaleform.PointGets a local point relative to the body's origin given a world point.
self : scaleform.physics.BodyThe physics body currently in use.
world : scaleform.PointThe world point coordinates.
scaleform.PointThe local point.
scaleform.physics.Body.world_to_local_vector (self, world) : scaleform.PointGets a local vector given a world vector.
self : scaleform.physics.BodyThe physics body currently in use.
world : scaleform.PointThe coordinates of world vector.
scaleform.PointA local vector.
self : scaleform.physics.FixtureThe fixture currently in use.
scaleform.physics.BodyThe physics body.
self : scaleform.physics.JointThe joint currently in use.
scaleform.physics.BodyThe body linked through the joint.
self : scaleform.physics.JointThe joint currently in use.
scaleform.physics.BodyThe body linked through the joint.
self : scaleform.PhysicsBodyComponentThe physics body component.
scaleform.physics.BodyReturns the created physics body.
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.
self : scaleform.physics.WorldThe physics World that is currently in use.
body : scaleform.physics.BodyThe physics body to be added to the simulation.A string of characters.
init : scaleform.physics.MassData?An table arguments to initialize the returned physics.MassData table with. [more...]
scaleform.physics.MassDataReturns a fully constructed mass data table.
scaleform.physics.ShapeDef (init) : scaleform.physics.ShapeDefCreate an initialized shape definition table.
init : scaleform.physics.ShapeDef?An table arguments to initialize the returned physics.ShapeDef table with. [more...]
scaleform.physics.ShapeDefReturns a fully constructed shape definition 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.