Scaleform Studio Lua API Reference: scaleform.PhysicsWorldComponent object reference

scaleform.PhysicsWorldComponent object reference

Description

Drives the Physics simulation of all child objects that have physical properties

Functions

Parameters

owner :

scaleform.Actor

The parent object of the newly created physics World.

Returns

scaleform.PhysicsWorldComponent

Returns the newly created PhysicsWorldComponent.

Parameters

self :

scaleform.PhysicsWorldComponent

The physics world currently considered.

Returns

scaleform.physics.World

The physics world.

 scaleform.Component
The root type of all actor components.
 scaleform.PhysicsWorldComponent.create (owner) : scaleform.PhysicsWorldComponent
Create a physics world component which drives the physics simulation.
 scaleform.PhysicsBodyComponent.set_world (self, world)
Sets the world that will drive the object's simulation.
 owner : scaleform.Actor
The parent object of the newly created physics World.
 scaleform.PhysicsWorldComponent
Returns the newly created PhysicsWorldComponent.
 scaleform.Actor
Generic objects located in a scene.
 scaleform.PhysicsWorldComponent
Drives the Physics simulation of all child objects that have physical properties
 scaleform.PhysicsWorldComponent.world (self) : scaleform.physics.World
Returns the physics world.
 self : scaleform.PhysicsWorldComponent
The physics world currently considered.
 scaleform.physics.World
The physics world.
 scaleform.physics.World
Manages all physics entities, dynamic simulation, and asynchronous queries.
 self : scaleform.PhysicsBodyComponent
The physics body component that owns the body.
 world : scaleform.PhysicsWorldComponent
The physics world component that the body should be attached to and simulated by.
 scaleform.PhysicsBodyComponent
Describes a Actor's physical properties.
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.