summaryrefslogtreecommitdiffstats
path: root/doc/classes/PinJoint2D.xml
diff options
context:
space:
mode:
authorDragos Daian <daian.dragos@yahoo.com>2023-09-13 13:45:24 +0200
committerDragos Daian <daian.dragos@yahoo.com>2023-09-26 10:29:23 +0200
commit0fcfb07246dda4412eebf42394a9d0a30081bb16 (patch)
tree131b31432d7b21606bbf0d4ab2b8fb8caf4360ba /doc/classes/PinJoint2D.xml
parentc12d63556b5c1da03a00dd4c45c40e60bd8d68c2 (diff)
downloadredot-engine-0fcfb07246dda4412eebf42394a9d0a30081bb16.tar.gz
Update PinJoint2D API with angle limits and motor speed
add enabled methods for motor and angular limits use correct name to get joint update copyright
Diffstat (limited to 'doc/classes/PinJoint2D.xml')
-rw-r--r--doc/classes/PinJoint2D.xml15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/classes/PinJoint2D.xml b/doc/classes/PinJoint2D.xml
index 6adfc818e7..a252f60312 100644
--- a/doc/classes/PinJoint2D.xml
+++ b/doc/classes/PinJoint2D.xml
@@ -9,6 +9,21 @@
<tutorials>
</tutorials>
<members>
+ <member name="angular_limit_enabled" type="bool" setter="set_angular_limit_enabled" getter="is_angular_limit_enabled" default="false">
+ If [code]true[/code], the pin maximum and minimum rotation, defined by [member angular_limit_lower] and [member angular_limit_upper] are applied.
+ </member>
+ <member name="angular_limit_lower" type="float" setter="set_angular_limit_lower" getter="get_angular_limit_lower" default="0.0">
+ The minimum rotation. Only active if [member angular_limit_enabled] is [code]true[/code].
+ </member>
+ <member name="angular_limit_upper" type="float" setter="set_angular_limit_upper" getter="get_angular_limit_upper" default="0.0">
+ The maximum rotation. Only active if [member angular_limit_enabled] is [code]true[/code].
+ </member>
+ <member name="motor_enabled" type="bool" setter="set_motor_enabled" getter="is_motor_enabled" default="false">
+ When activated, a motor turns the pin.
+ </member>
+ <member name="motor_target_velocity" type="float" setter="set_motor_target_velocity" getter="get_motor_target_velocity" default="0.0">
+ Target speed for the motor. In radians per second.
+ </member>
<member name="softness" type="float" setter="set_softness" getter="get_softness" default="0.0">
The higher this value, the more the bond to the pinned partner can flex.
</member>