LinearVelocity
LinearVelocity : Constraint
Overview
LinearVelocity provides options for controlling velocity along lines, planes, or vectors with force limit and raint mode properties.
Description
LinearVelocity is a class in Overdare Studio's development framework that derives from the base class Constraint. This class implements Lua API reference for controlling linear velocity raints between two physics objects or actors within game scenarios. Its main purpose is to enable developers to manage and set specific parameters for physical interactions between connected actors, ensuring real-time simulation and motion control. It allows users to apply raint modes (line, plane, or vector) and adjust properties such as force limits and relative targets for applied parts, creating predictable and realistic physics simulations in Overdare Studio
Properties
ForceLimitMode
Enum.ForceLimitMode
ForceLimitMode is a property in the LinearVelocity class representing an enumeration (Enum.ForceLimitMode) that defines how force limits are applied during simulations. This property allows users to specify the mode of restriction for force applied on linear velocity constraints. Typically, it can include modes such as "PerAxis" or "Total," where:
PerAxis: Limits the force independently along each axis (X, Y, Z).
Total: Restricts the cumulative force magnitude irrespective of direction.
By configuring this property, developers can tailor the physical behaviors of LinearVelocity for more realistic and precise motion control during simulations.
Code Samples
ForceLimitsEnabled
bool
The given text appears to contain a detailed description of the ForceLimitsEnabled property within the context of the LinearVelocity class in LuaAPI framework or a similar physics simulation environment. This property is represented as a boolean value and controls whether force limits are applied to Linear Velocity raints during simulations. When set to true, it enforces maximum force limits specified by other properties like MaxForce to prevent excessive forces that may cause unrealistic behavior in the system. If ForceLimitsEnabled is set to false, no force limit is imposed on the raint and the physics engine can apply unlimited forces without restrictions. This property
Code Samples
LineDirection
Vector3
LineDirection is a property within the LinearVelocity class in the context of LUA API framework. It represents the primary direction for raining linear velocity along a line when VelocityConstraintMode is set to "Line" or "Plane". This property is crucial for determining how the applied force will be limited within these modes of operation, and it is typically stored as a vector3 type. When LineDirection operates in conjunction with other properties like PrimaryTangentAxis, SecondaryTangentAxis, PlaneVelocity or RelativeTo, it enables precise control over the linear velocity raints within various scenarios in
Code Samples
LineVelocity
number
LineLinearVelocity refers to a Lua script component in the Unreal Engine that implements linear velocity raints between two physics actors connected by a raint. It allows controlling an object's velocity relative to another object or world space through various modes (Line, Plane, Vector) and force limit options. The LinearVelocity class, derived from Constraint, provides properties like LineVelocity for setting the desired linear velocity along specific axes or modes during simulation or gameplay. This property represents a number value used when VelocityConstraintMode is set to Line mode, which rains the velocity along that particular line. The Line
Code Samples
MaxAxesForce
Vector3
MaxAxesForce is a property belonging to the LinearVelocity class, which appears to be part of a physics engine or simulation framework in C++. The property is of type vector3, representing a vector with three number values typically corresponding to X, Y, and Z components. In this context, MaxAxesForce defines the maximum force limits along primary and secondary tangent axes when the velocity raint mode is set to "Plane". It helps control or limit how much force can be applied along specific tangential directions within the plane defined by the secondary tangent axis during a simulation. The property can
Code Samples
MaxForce
number
The description and usage of the "MaxForce" property in various contexts involve its role in controlling the force limits applied by linear velocity raints or raint components in physics simulations, often within game engines or simulation frameworks. In these scenarios, MaxForce is represented as a number value that signifies the upper limit for the magnitude of force vectors imposed on objects to ensure realistic behavior and prevent unintended outcomes during simulation. The property can be accessed through getter/setter functions and its value can be adjusted dynamically in code or through scripting tools. This property is commonly found within classes related to linear velocity raints, such as
Code Samples
PlaneVelocity
Vector2
PlaneVelocity is a property in a custom game or physics library, likely in Lua API, implemented within the LinearVelocity class. It represents a Vector2 type value that specifies velocity components along tangent directions when VelocityConstraintMode is set to Plane. This mode enables controlling linear velocity of an applied part confined within a defined plane during simulation or animation, while respecting the relationship between its velocity and primary/secondary tangent axes relative to World or Local Actuator positions. The property can be edited, replicated, and potentially manipulated using Blueprint functionality in the Unreal Engine
Code Samples
RelativeTo
Enum.ActuatorRelativeTo
The task involves extracting specific information from a given long text containing multiple instances of code snippets, property descriptions, and class definitions related to computer programming or physics engines in different programming languages such as C++ and Lua. The primary focus is on identifying specific properties, classes, variables, functions, and their associated descriptions to provide a clear understanding of the given input.
Code Samples
PrimaryTangentAxis
Vector3
It specifies the main direction tangential to the plane or point of linear velocity constraint. Represented as a Vector3, it allows precise control over the behavior of the velocity application during simulations. This property is primarily used in conjunction with PlaneVelocity, SecondaryTangentAxis, and related configuration settings to achieve realistic and predictable physical interactions within the defined system. The PrimaryTangentAxis serves as a key component in customizing the plane of operation for constrained velocity modes.
Code Samples
SecondaryTangentAxis
Vector3
It specifies the secondary direction tangential to the plane or the point of linear velocity constraint. Represented as a Vector3, this property works in tandem with PrimaryTangentAxis and PlaneVelocity to control the behavior of velocity constraints effectively during simulation. SecondaryTangentAxis is critical for defining the orientation and behavior of the applied constraints in plane or vector velocity modes, enabling high levels of precision and customization for physical simulations.
Code Samples
VectorVelocity
Vector3
It is represented as a Vector3 and allows the user to set or retrieve the desired velocity vector in 3D space. This property is particularly useful when Velocity
Code Samples
VelocityConstraintMode
Enum.VelocityConstranumberMode
It controls the mode of applying velocity constraints, determining whether the velocity is restricted along a line, within a plane, or as a vector in 3D space. The property is represented as an enumeration (Enum.VelocityConstraintMode) and allows users to select specific behaviors for the associated LinearVelocity constraint. This property is instrumental in defining the motion constraints between two objects or within a given system, ensuring precision and realistic simulation results.