asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #11349 from willt/getsetmove

Browse source 
[DOCS] added member descriptions to various shapes

[ci skip]
This commit is contained in:
Rémi Verschelde 2017-09-17 22:42:10 +02:00 committed by GitHub
commit a829c77a58
7 changed files with 25 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/classes/CapsuleShape.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CapsuleShape" inherits="Shape" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Capsule shape resource.
Capsule shape for collisions.
</brief_description>
<description>
Capsule shape resource, which can be set into a [PhysicsBody] or area.
Capsule shape for collisions.
</description>
<tutorials>
</tutorials>
@ -46,8 +46,10 @@
</methods>
<members>
<member name="height" type="float" setter="set_height" getter="get_height">
The capsule's height.
</member>
<member name="radius" type="float" setter="set_radius" getter="get_radius">
The capsule's radius.
</member>
</members>
<constants>

6
doc/classes/CapsuleShape2D.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CapsuleShape2D" inherits="Shape2D" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Capsule 2D shape resource for physics.
Capsule shape for 2D collisions.
</brief_description>
<description>
Capsule 2D shape resource for physics. A capsule (or sometimes called "pill") is like a line grown in all directions. It has a radius and a height, and is often useful for modeling biped characters.
Capsule shape for 2D collisions.
</description>
<tutorials>
</tutorials>
@ -46,8 +46,10 @@
</methods>
<members>
<member name="height" type="float" setter="set_height" getter="get_height">
The capsule's height.
</member>
<member name="radius" type="float" setter="set_radius" getter="get_radius">
The capsules's radius.
</member>
</members>
<constants>

5
doc/classes/CircleShape2D.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CircleShape2D" inherits="Shape2D" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Circular Shape for 2D Physics.
Circular shape for 2D collisions.
</brief_description>
<description>
Circular Shape for 2D Physics. This shape is useful for modeling balls or small characters and its collision detection with everything else is very fast.
Circular shape for 2D collisions. This shape is useful for modeling balls or small characters and its collision detection with everything else is very fast.
</description>
<tutorials>
</tutorials>
@ -30,6 +30,7 @@
</methods>
<members>
<member name="radius" type="float" setter="set_radius" getter="get_radius">
The circle's radius.
</member>
</members>
<constants>

6
doc/classes/LineShape2D.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="LineShape2D" inherits="Shape2D" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Line shape for 2D collision objects.
Line shape for 2D collisions.
</brief_description>
<description>
Line shape for 2D collision objects. It works like a 2D plane and will not allow any body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame.
Line shape for 2D collisions. It works like a 2D plane and will not allow any body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame.
</description>
<tutorials>
</tutorials>
@ -46,8 +46,10 @@
</methods>
<members>
<member name="d" type="float" setter="set_d" getter="get_d">
The line's distance from the origin.
</member>
<member name="normal" type="Vector2" setter="set_normal" getter="get_normal">
The line's normal.
</member>
</members>
<constants>

5
doc/classes/RayShape2D.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="RayShape2D" inherits="Shape2D" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Ray 2D shape resource for physics.
Ray shape for 2D collisions.
</brief_description>
<description>
Ray 2D shape resource for physics. 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.
Ray shape for 2D collisions. 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>
@ -30,6 +30,7 @@
</methods>
<members>
<member name="length" type="float" setter="set_length" getter="get_length">
The ray's length.
</member>
</members>
<constants>

5
doc/classes/RectangleShape2D.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="RectangleShape2D" inherits="Shape2D" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Rectangle Shape for 2D Physics.
Rectangle shape for 2D collisions.
</brief_description>
<description>
Rectangle Shape for 2D Physics. This shape is useful for modeling box-like 2D objects.
Rectangle shape for 2D collisions. This shape is useful for modeling box-like 2D objects.
</description>
<tutorials>
</tutorials>
@ -30,6 +30,7 @@
</methods>
<members>
<member name="extents" type="Vector2" setter="set_extents" getter="get_extents">
The rectangle's half extents. The width and height of this shape is twice the half extents.
</member>
</members>
<constants>

6
doc/classes/SegmentShape2D.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SegmentShape2D" inherits="Shape2D" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Segment Shape for 2D Collision Detection.
Segment shape for 2D collisions.
</brief_description>
<description>
Segment Shape for 2D Collision Detection, consists of two points, 'a' and 'b'.
Segment shape for 2D collisions. Consists of two points, [code]a[/code] and [code]b[/code].
</description>
<tutorials>
</tutorials>
@ -46,8 +46,10 @@
</methods>
<members>
<member name="a" type="Vector2" setter="set_a" getter="get_a">
The segment's first point position.
</member>
<member name="b" type="Vector2" setter="set_b" getter="get_b">
The segment's second point position.
</member>
</members>
<constants>