Browse Source

Documented soft body pinning methods

Bengt Söderström 4 years ago
parent
commit
3a323c4b97
1 changed files with 23 additions and 0 deletions
  1. 23 0
      doc/classes/SoftBody3D.xml

+ 23 - 0
doc/classes/SoftBody3D.xml

@@ -42,6 +42,20 @@
 			<description>
 			<description>
 			</description>
 			</description>
 		</method>
 		</method>
+		<method name="get_point_transform">
+			<return type="Vector3" />
+			<argument index="0" name="point_index" type="int" />
+			<description>
+				Returns local translation of a vertex in the surface array.
+			</description>
+		</method>
+		<method name="is_point_pinned" qualifiers="const">
+			<return type="bool" />
+			<argument index="0" name="point_index" type="int" />
+			<description>
+				Returns [code]true[/code] if vertex is set to pinned.
+			</description>
+		</method>
 		<method name="remove_collision_exception_with">
 		<method name="remove_collision_exception_with">
 			<return type="void" />
 			<return type="void" />
 			<argument index="0" name="body" type="Node" />
 			<argument index="0" name="body" type="Node" />
@@ -65,6 +79,15 @@
 				Sets individual bits on the collision mask. Use this if you only need to change one layer's value.
 				Sets individual bits on the collision mask. Use this if you only need to change one layer's value.
 			</description>
 			</description>
 		</method>
 		</method>
+		<method name="set_point_pinned">
+			<return type="void" />
+			<argument index="0" name="point_index" type="int" />
+			<argument index="1" name="pinned" type="bool" />
+			<argument index="2" name="attachment_path" type="NodePath" default="NodePath(&quot;&quot;)" />
+			<description>
+				Sets the pinned state of a surface vertex. When set to [code]true[/code], the optional [code]attachment_path[/code] can define a [Node3D] the pinned vertex will be attached to.
+			</description>
+		</method>
 	</methods>
 	</methods>
 	<members>
 	<members>
 		<member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" default="1">
 		<member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" default="1">