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

doc: Sync classref with current source

Browse source
This commit is contained in:
Rémi Verschelde 2017-12-11 09:32:25 +01:00
parent 64d104756c
commit 237be766d4
4 changed files with 42 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/classes/HTTPClient.xml
View file

@ -203,7 +203,7 @@
<constant name="METHOD_GET" value="0" enum="Method">
HTTP GET method. The GET method requests a representation of the specified resource. Requests using GET should only retrieve data.
</constant>
<constant name="METHOD_HEAD" value="1" enum="Method">#
<constant name="METHOD_HEAD" value="1" enum="Method">
HTTP HEAD method. The HEAD method asks for a response identical to that of a GET request, but without the response body. This is useful to request metadata like HTTP headers or to check if a resource exists.
</constant>
<constant name="METHOD_POST" value="2" enum="Method">

12
doc/classes/KinematicBody.xml
View file

@ -102,11 +102,17 @@
</method>
</methods>
<members>
<member name="axis_lock_x" type="bool" setter="set_axis_lock_x" getter="get_axis_lock_x">
<member name="axis_lock_angular_x" type="bool" setter="set_axis_lock" getter="get_axis_lock">
</member>
<member name="axis_lock_y" type="bool" setter="set_axis_lock_y" getter="get_axis_lock_y">
<member name="axis_lock_angular_y" type="bool" setter="set_axis_lock" getter="get_axis_lock">
</member>
<member name="axis_lock_z" type="bool" setter="set_axis_lock_z" getter="get_axis_lock_z">
<member name="axis_lock_angular_z" type="bool" setter="set_axis_lock" getter="get_axis_lock">
</member>
<member name="axis_lock_linear_x" type="bool" setter="set_axis_lock" getter="get_axis_lock">
</member>
<member name="axis_lock_linear_y" type="bool" setter="set_axis_lock" getter="get_axis_lock">
</member>
<member name="axis_lock_linear_z" type="bool" setter="set_axis_lock" getter="get_axis_lock">
</member>
<member name="collision/safe_margin" type="float" setter="set_safe_margin" getter="get_safe_margin">
If the body is at least this close to another body, this body will consider them to be colliding.

33
doc/classes/PhysicsServer.xml
View file

@ -351,15 +351,6 @@
Creates a physics body. The first parameter can be any value from constants BODY_MODE*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time.
</description>
</method>
<method name="body_get_axis_lock" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="body" type="RID">
</argument>
<description>
Gets the information, which Axis is locked if any. The can be any calue from the constants BODY_AXIS_LOCK*
</description>
</method>
<method name="body_get_collision_layer" qualifiers="const">
<return type="int">
</return>
@ -485,6 +476,16 @@
Returns a body state.
</description>
</method>
<method name="body_is_axis_locked" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="body" type="RID">
</argument>
<argument index="1" name="axis" type="int" enum="PhysicsServer.BodyAxis">
</argument>
<description>
</description>
</method>
<method name="body_is_continuous_collision_detection_enabled" qualifiers="const">
<return type="bool">
</return>
@ -540,7 +541,7 @@
</return>
<argument index="0" name="body" type="RID">
</argument>
<argument index="1" name="axis" type="int">
<argument index="1" name="axis" type="int" enum="PhysicsServer.BodyAxis">
</argument>
<argument index="2" name="lock" type="bool">
</argument>
@ -1520,5 +1521,17 @@
<constant name="SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS" value="7" enum="SpaceParameter">
Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision.
</constant>
<constant name="BODY_AXIS_LINEAR_X" value="1" enum="BodyAxis">
</constant>
<constant name="BODY_AXIS_LINEAR_Y" value="2" enum="BodyAxis">
</constant>
<constant name="BODY_AXIS_LINEAR_Z" value="4" enum="BodyAxis">
</constant>
<constant name="BODY_AXIS_ANGULAR_X" value="8" enum="BodyAxis">
</constant>
<constant name="BODY_AXIS_ANGULAR_Y" value="16" enum="BodyAxis">
</constant>
<constant name="BODY_AXIS_ANGULAR_Z" value="32" enum="BodyAxis">
</constant>
</constants>
</class>

12
doc/classes/RigidBody.xml
View file

@ -59,11 +59,17 @@
<member name="angular_velocity" type="Vector3" setter="set_angular_velocity" getter="get_angular_velocity">
RigidBody's rotational velocity.
</member>
<member name="axis_lock_x" type="bool" setter="set_axis_lock_x" getter="get_axis_lock_x">
<member name="axis_lock_angular_x" type="bool" setter="set_axis_lock" getter="get_axis_lock">
</member>
<member name="axis_lock_y" type="bool" setter="set_axis_lock_y" getter="get_axis_lock_y">
<member name="axis_lock_angular_y" type="bool" setter="set_axis_lock" getter="get_axis_lock">
</member>
<member name="axis_lock_z" type="bool" setter="set_axis_lock_z" getter="get_axis_lock_z">
<member name="axis_lock_angular_z" type="bool" setter="set_axis_lock" getter="get_axis_lock">
</member>
<member name="axis_lock_linear_x" type="bool" setter="set_axis_lock" getter="get_axis_lock">
</member>
<member name="axis_lock_linear_y" type="bool" setter="set_axis_lock" getter="get_axis_lock">
</member>
<member name="axis_lock_linear_z" type="bool" setter="set_axis_lock" getter="get_axis_lock">
</member>
<member name="bounce" type="float" setter="set_bounce" getter="get_bounce">
RigidBody's bounciness.