Scaleform Studio Lua API Reference: scaleform.physics.MouseJoint object reference
scaleform.physics.MouseJoint object reference
Description
A mouse joint for controlling objects with the mouse.
Inheritance 
Functions
Parameters
Returns
self : |
The mouse joint in use. |
number |
The frequency in hz. |
Parameters
Returns
self : |
The mouse joint in use. |
number |
The force on the joint. |
Parameters
Returns
self : |
The mouse joint in use. | |
dmp : | number |
The damping ratio. |
| This function does not return any values. |
Parameters
Returns
self : |
The mouse joint in use. | |
freq : | number |
The frequency in hz. |
| This function does not return any values. |
Parameters
Returns
self : |
The mouse joint in use. | |
force : | number |
The force on the joint. |
| This function does not return any values. |
Used to prevent violent reactions when multiple dynamic bodies interact.
Parameters
Returns
self : |
The mouse joint currently considered. | |
target : |
The target point. |
| This function does not return any values. |
This initially coincides with the body's anchor point.
scaleform.physics.JointAn interface for the physics properties of the joint between two physics bodies.
scaleform.physics.MouseJoint.damping_ratio (self) : numberGets the damping ratio.
self : scaleform.physics.MouseJointThe mouse joint in use.
number scaleform.physics.MouseJointA mouse joint for controlling objects with the mouse. A numeric value.
scaleform.physics.MouseJoint.frequency (self) : numberGets the frequency in hz.
self : scaleform.physics.MouseJointThe mouse joint in use.
number scaleform.physics.MouseJoint.max_force (self) : numberGets the highest allowed force.
self : scaleform.physics.MouseJointThe mouse joint in use.
number scaleform.physics.MouseJoint.set_damping_ratio (self, dmp) Sets the damping ratio.
self : scaleform.physics.MouseJointThe mouse joint in use.
dmp : numberThe damping ratio.
scaleform.physics.MouseJoint.set_frequency (self, freq) Sets the frequency in hz.
self : scaleform.physics.MouseJointThe mouse joint in use.
freq : numberThe frequency in hz.
scaleform.physics.MouseJoint.set_max_force (self, force) Sets the highest allowed force.
self : scaleform.physics.MouseJointThe mouse joint in use.
force : numberThe force on the joint.
scaleform.physics.MouseJoint.set_target (self, target) Sets the target point.
self : scaleform.physics.MouseJointThe mouse joint currently considered.
target : scaleform.PointThe target point.
scaleform.PointPoint should be in the form of a table {x=a, y=b}
{ PropertyType : string, x : number, y : number, }
scaleform.physics.MouseJoint.target (self) : scaleform.PointGets the target point.
self : scaleform.physics.MouseJointThe mouse joint currently considered.
scaleform.PointThe target point.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.