doc: Sync classref with current source

This commit is contained in:
Rémi Verschelde 2018-02-22 19:02:37 +01:00
parent 07e2461995
commit 46b594054c
8 changed files with 1897 additions and 19 deletions

View File

@ -20,7 +20,7 @@
</argument> </argument>
<argument index="2" name="b8" type="int"> <argument index="2" name="b8" type="int">
</argument> </argument>
<argument index="3" name="a8" type="int"> <argument index="3" name="a8" type="int" default="255">
</argument> </argument>
<description> <description>
Returns a 32 bit color with red, green, blue and alpha channels. Each channel has 8 bits of information ranging from 0 to 255. Returns a 32 bit color with red, green, blue and alpha channels. Each channel has 8 bits of information ranging from 0 to 255.
@ -38,7 +38,7 @@
</return> </return>
<argument index="0" name="name" type="String"> <argument index="0" name="name" type="String">
</argument> </argument>
<argument index="1" name="alpha" type="float"> <argument index="1" name="alpha" type="float" default="1.0">
</argument> </argument>
<description> <description>
Returns a color according to the standardised [code]name[/code] with [code]alpha[/code] ranging from 0 to 1. Returns a color according to the standardised [code]name[/code] with [code]alpha[/code] ranging from 0 to 1.
@ -1131,9 +1131,9 @@
<method name="yield"> <method name="yield">
<return type="GDScriptFunctionState"> <return type="GDScriptFunctionState">
</return> </return>
<argument index="0" name="object" type="Object"> <argument index="0" name="object" type="Object" default="null">
</argument> </argument>
<argument index="1" name="signal" type="String"> <argument index="1" name="signal" type="String" default="&quot;&quot;">
</argument> </argument>
<description> <description>
Stops the function execution and returns the current state. Call [method GDScriptFunctionState.resume] on the state to resume execution. This invalidates the state. Stops the function execution and returns the current state. Call [method GDScriptFunctionState.resume] on the state to resume execution. This invalidates the state.

View File

@ -66,6 +66,16 @@
Return the amount of surfaces that the [code]ArrayMesh[/code] holds. Return the amount of surfaces that the [code]ArrayMesh[/code] holds.
</description> </description>
</method> </method>
<method name="lightmap_unwrap">
<return type="int" enum="Error">
</return>
<argument index="0" name="arg0" type="Transform">
</argument>
<argument index="1" name="arg1" type="float">
</argument>
<description>
</description>
</method>
<method name="regen_normalmaps"> <method name="regen_normalmaps">
<return type="void"> <return type="void">
</return> </return>

View File

@ -12,6 +12,12 @@
<demos> <demos>
</demos> </demos>
<methods> <methods>
<method name="get_length" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
</methods> </methods>
<constants> <constants>
</constants> </constants>

View File

@ -36,6 +36,12 @@
Returns [code]true[/code] if the current host platform is using multiple threads. Returns [code]true[/code] if the current host platform is using multiple threads.
</description> </description>
</method> </method>
<method name="center_window">
<return type="void">
</return>
<description>
</description>
</method>
<method name="delay_msec" qualifiers="const"> <method name="delay_msec" qualifiers="const">
<return type="void"> <return type="void">
</return> </return>
@ -232,6 +238,12 @@
Returns the number of cores available in the host machine. Returns the number of cores available in the host machine.
</description> </description>
</method> </method>
<method name="get_real_window_size" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="get_scancode_string" qualifiers="const"> <method name="get_scancode_string" qualifiers="const">
<return type="String"> <return type="String">
</return> </return>

View File

@ -29,16 +29,6 @@
Disconnect from host. Disconnect from host.
</description> </description>
</method> </method>
<method name="set_no_delay">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Disable Nagle algorithm to improve latency for small packets.
Note that for applications that send large packets, or need to transfer a lot of data, this can reduce total bandwidth.
</description>
</method>
<method name="get_connected_host" qualifiers="const"> <method name="get_connected_host" qualifiers="const">
<return type="String"> <return type="String">
</return> </return>
@ -66,6 +56,16 @@
<description> <description>
</description> </description>
</method> </method>
<method name="set_no_delay">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Disable Nagle algorithm to improve latency for small packets.
Note that for applications that send large packets, or need to transfer a lot of data, this can reduce total bandwidth.
</description>
</method>
</methods> </methods>
<constants> <constants>
<constant name="STATUS_NONE" value="0" enum="Status"> <constant name="STATUS_NONE" value="0" enum="Status">

View File

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VehicleWheel" inherits="Spatial" category="Core" version="3.0-stable"> <class name="VehicleWheel" inherits="Spatial" category="Core" version="3.0-stable">
<brief_description> <brief_description>
Physics object that simulates the behaviour of a wheel. Physics object that simulates the behaviour of a wheel.
</brief_description> </brief_description>
<description> <description>
This node needs to be used as a child node of [VehicleBody] and simulates the behaviour of one of its wheels. This node also acts as a collider to detect if the wheel is touching a surface. This node needs to be used as a child node of [VehicleBody] and simulates the behaviour of one of its wheels. This node also acts as a collider to detect if the wheel is touching a surface.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
@ -34,7 +34,7 @@
The damping applied to the spring when relaxing. This value should be between 0.0 (no damping) and 1.0. This value should always be slighly higher then the [member damping_compression] property. For a [member damping_compression] value of 0.3, try a relaxation value of 0.5 The damping applied to the spring when relaxing. This value should be between 0.0 (no damping) and 1.0. This value should always be slighly higher then the [member damping_compression] property. For a [member damping_compression] value of 0.3, try a relaxation value of 0.5
</member> </member>
<member name="suspension_max_force" type="float" setter="set_suspension_max_force" getter="get_suspension_max_force"> <member name="suspension_max_force" type="float" setter="set_suspension_max_force" getter="get_suspension_max_force">
The maximum force the spring can resist. This value should be higher then a quarter of the [member RigidBody.mass] of the [VehicleBody] or the spring will not carry the weight of the vehicle. Good results are often obtained by a value that is about 3x to 4x this number. The maximum force the spring can resist. This value should be higher then a quarter of the [member RigidBody.mass] of the [VehicleBody] or the spring will not carry the weight of the vehicle. Good results are often obtained by a value that is about 3x to 4x this number.
</member> </member>
<member name="suspension_stiffness" type="float" setter="set_suspension_stiffness" getter="get_suspension_stiffness"> <member name="suspension_stiffness" type="float" setter="set_suspension_stiffness" getter="get_suspension_stiffness">
This value defines the stiffness of the suspension. Use a value lower then 50 for an offroad car, a value between 50 and 100 for a race car and try something around 200 for something like a Formula 1 car. This value defines the stiffness of the suspension. Use a value lower then 50 for an offroad car, a value between 50 and 100 for a race car and try something around 200 for something like a Formula 1 car.
@ -56,7 +56,7 @@
The radius of the wheel in meters. The radius of the wheel in meters.
</member> </member>
<member name="wheel_rest_length" type="float" setter="set_suspension_rest_length" getter="get_suspension_rest_length"> <member name="wheel_rest_length" type="float" setter="set_suspension_rest_length" getter="get_suspension_rest_length">
This is the distance in meters the wheel is lowered from its origin point. Don't set this to 0.0 and move the wheel into position, instead move the origin point of your wheel (the gizmo in Godot) to the position the wheel will take when bottoming out, then use the rest lenght to move the wheel down to the position it should be in when the car is in rest. This is the distance in meters the wheel is lowered from its origin point. Don't set this to 0.0 and move the wheel into position, instead move the origin point of your wheel (the gizmo in Godot) to the position the wheel will take when bottoming out, then use the rest lenght to move the wheel down to the position it should be in when the car is in rest.
</member> </member>
<member name="wheel_roll_influence" type="float" setter="set_roll_influence" getter="get_roll_influence"> <member name="wheel_roll_influence" type="float" setter="set_roll_influence" getter="get_roll_influence">
This value effects the roll of your vehicle. If set to 0.0 for all wheels your vehicle will be prone to rolling over while a value of 1.0 will resist body roll. This value effects the roll of your vehicle. If set to 0.0 for all wheels your vehicle will be prone to rolling over while a value of 1.0 will resist body roll.

View File

@ -302,7 +302,7 @@
Amount of objects in frame. Amount of objects in frame.
</constant> </constant>
<constant name="RENDER_INFO_VERTICES_IN_FRAME" value="1" enum="RenderInfo"> <constant name="RENDER_INFO_VERTICES_IN_FRAME" value="1" enum="RenderInfo">
Amount of vertices in frame. Amount of vertices in frame.
</constant> </constant>
<constant name="RENDER_INFO_MATERIAL_CHANGES_IN_FRAME" value="2" enum="RenderInfo"> <constant name="RENDER_INFO_MATERIAL_CHANGES_IN_FRAME" value="2" enum="RenderInfo">
Amount of material changes in frame. Amount of material changes in frame.

File diff suppressed because it is too large Load Diff