Răsfoiți Sursa

RayShape, Shape, SphereShape

Linus 8 ani în urmă
părinte
comite
c3b79b1e07
3 a modificat fișierele cu 8 adăugiri și 0 ștergeri
  1. 3 0
      doc/classes/RayShape.xml
  2. 2 0
      doc/classes/Shape.xml
  3. 3 0
      doc/classes/SphereShape.xml

+ 3 - 0
doc/classes/RayShape.xml

@@ -1,8 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="RayShape" inherits="Shape" category="Core" version="3.0.alpha.custom_build">
 	<brief_description>
+		Ray shape for 3D collisions.
 	</brief_description>
 	<description>
+		Ray shape for 3D collisions, which can be set into a [PhysicsBody] or [Area]. A ray is not really a collision body, instead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters.
 	</description>
 	<tutorials>
 	</tutorials>
@@ -26,6 +28,7 @@
 	</methods>
 	<members>
 		<member name="length" type="float" setter="set_length" getter="get_length">
+			The ray's length.
 		</member>
 	</members>
 	<constants>

+ 2 - 0
doc/classes/Shape.xml

@@ -1,8 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="Shape" inherits="Resource" category="Core" version="3.0.alpha.custom_build">
 	<brief_description>
+		Base class for all 3D shape resources.
 	</brief_description>
 	<description>
+		Base class for all 3D shape resources. All 3D shapes that inherit from this can be set into a [PhysicsBody] or [Area].
 	</description>
 	<tutorials>
 	</tutorials>

+ 3 - 0
doc/classes/SphereShape.xml

@@ -1,8 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="SphereShape" inherits="Shape" category="Core" version="3.0.alpha.custom_build">
 	<brief_description>
+		Sphere shape for 3D collisions.
 	</brief_description>
 	<description>
+		Sphere shape for 3D collisions, which can be set into a [PhysicsBody] or [Area]. This shape is useful for modeling sphere-like 3D objects.
 	</description>
 	<tutorials>
 	</tutorials>
@@ -26,6 +28,7 @@
 	</methods>
 	<members>
 		<member name="radius" type="float" setter="set_radius" getter="get_radius">
+			The sphere's radius. The shape's diameter is double the radius.
 		</member>
 	</members>
 	<constants>