Scaleform Studio Lua API Reference: scaleform.physics.World object reference
Manages all physics entities, dynamic simulation, and asynchronous queries.
This element inherits from:
 |
Adds a body to the world/simulation.
|
Parameters Returns | This function does not return any values. |
Parameters Returns integer |
The position iteration steps.
|
Parameters self : | scaleform.physics.World |
The physics World that is currently in use.
|
iterations : | integer |
The position iteration steps.
|
Returns | This function does not return any values. |
Parameters self : | scaleform.physics.World |
The physics World that is currently in use.
|
iterations : | integer |
The velocity iteration steps.
|
Returns | This function does not return any values. |
Parameters self : | scaleform.physics.World |
The physics World that is to be initialized.
|
gravity : | scaleform.Point? |
The gravity of the world.
The ? notation indicates that this type is optional: there may be zero or one instances of it. |
scale : | number? |
The scale of the world.
The ? notation indicates that this type is optional: there may be zero or one instances of it. |
Returns | This function does not return any values. |
Parameters Returns | This function does not return any values. |
Parameters Returns integer |
The velocity iteration steps.
|
scaleform.EventDispatcher
The base object for managing event listeners and dispatching events to the listeners.
scaleform.physics.Body.world (self) : scaleform.physics.World
Returns the World that this body is part of.
scaleform.PhysicsWorldComponent.world (self) : scaleform.physics.World
Returns the physics world.
scaleform.physics.Joint.create (world, jointDef) : scaleform.physics.Joint
Creates a Joint based on the joint data definition.
scaleform.physics.World.add_body (self, body)
Adds a body to the world/simulation.
self : scaleform.physics.World
The physics World that is currently in use. body : scaleform.physics.Body
The physics body to be added to the simulation. scaleform.physics.World
Manages all physics entities, dynamic simulation, and asynchronous queries.
scaleform.physics.Body
Interface for physics properties of a vgx actor.
scaleform.physics.World.gravity (self) : scaleform.Point
Returns the gravity of the world.
self : scaleform.physics.World
The physics World that is currently in use.
scaleform.Point
Gravity value.
scaleform.Point
Point should be in the form of a table {x=a, y=b}
{ PropertyType : string, x : number, y : number, } scaleform.physics.World.position_iterations (self) : integer
Gets the number of position iterations used in the physics engine.
self : scaleform.physics.World
The physics World that is currently in use. integerA strictly integral numeric value, with no decimal component. scaleform.physics.World.scale (self) : number
Returns the scale value.
self : scaleform.physics.World
The physics World that is currently in use. numberA numeric value. scaleform.physics.World.set_position_iterations (self, iterations)
Sets the number of position iterations used in the physics engine.
self : scaleform.physics.World
The physics World that is currently in use. iterations : integer
The position iteration steps. scaleform.physics.World.set_velocity_iterations (self, iterations)
Sets the number of velocity iterations used in the physics engine.
self : scaleform.physics.World
The physics World that is currently in use. iterations : integer
The velocity iteration steps. scaleform.physics.World.start (self, gravity, scale)
Initializes the physics world.
self : scaleform.physics.World
The physics World that is to be initialized. gravity : scaleform.Point?
The gravity of the world.The ? notation indicates that this type is optional: there may be zero or one instances of it.
scale : number?
The scale of the world.The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.physics.World.stop (self)
Shut downs the physics world.
self : scaleform.physics.World
The physics World that is to be shutdown. scaleform.physics.World.velocity_iterations (self) : integer
Gets the number of velocity iterations used in the physics engine.
self : scaleform.physics.World
The physics World that is currently in use. integer self : scaleform.physics.Body
The physics body currently in use. scaleform.physics.World
The World that own this body. self : scaleform.PhysicsWorldComponent
The physics world currently considered. scaleform.physics.World
The physics world. world : scaleform.physics.World
The World in which the joint exists. jointDef : scaleform.physics.JointDef
The joint data definition to create joint. scaleform.physics.Joint
The newly created Joint.A string of characters. scaleform.PhysicsWorldComponent
Drives the Physics simulation of all child objects that have physical properties
scaleform.physics.JointDef (init) : scaleform.physics.JointDef
Create an initialized joint definition table.
scaleform.physics.Joint
An interface for the physics properties of the joint between two physics bodies.
init : scaleform.physics.JointDef?
An table arguments to initialize the returned physics.JointDef table with. [more...]The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.physics.JointDef
Returns a fully constructed Joint 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.
