diff options
| author | Juan Linietsky | 2017-09-12 17:42:36 -0300 |
|---|---|---|
| committer | Juan Linietsky | 2017-09-12 17:45:41 -0300 |
| commit | 4f929a0fdfae24b1ca5acf0b732219119090ee43 (patch) | |
| tree | 730471182cae00f2e47c7430db441d057383d29b /doc/classes/VehicleBody.xml | |
| parent | 175777596ec3521731665dd750fd7087793b10fc (diff) | |
| download | godot-4f929a0fdfae24b1ca5acf0b732219119090ee43.tar.gz godot-4f929a0fdfae24b1ca5acf0b732219119090ee43.tar.zst godot-4f929a0fdfae24b1ca5acf0b732219119090ee43.zip | |
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will
recognize them.
Diffstat (limited to 'doc/classes/VehicleBody.xml')
| -rw-r--r-- | doc/classes/VehicleBody.xml | 110 |
1 files changed, 110 insertions, 0 deletions
diff --git a/doc/classes/VehicleBody.xml b/doc/classes/VehicleBody.xml new file mode 100644 index 000000000..7a805c2a4 --- /dev/null +++ b/doc/classes/VehicleBody.xml @@ -0,0 +1,110 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VehicleBody" inherits="PhysicsBody" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_brake" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_engine_force" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_friction" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_linear_velocity" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + Returns the VehicleBody's velocity vector. To get the absolute speed in scalar value, get the length of the return vector in pixels/second. Example: + [codeblock] + # vehicle is an instance of VehicleBody + var speed = vehicle.get_linear_velocity().length() + [/codeblock] + </description> + </method> + <method name="get_mass" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_steering" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the steering angle (in radians). + </description> + </method> + <method name="set_brake"> + <return type="void"> + </return> + <argument index="0" name="brake" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_engine_force"> + <return type="void"> + </return> + <argument index="0" name="engine_force" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_friction"> + <return type="void"> + </return> + <argument index="0" name="friction" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_mass"> + <return type="void"> + </return> + <argument index="0" name="mass" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_steering"> + <return type="void"> + </return> + <argument index="0" name="steering" type="float"> + </argument> + <description> + Set the steering angle (in radians). + </description> + </method> + </methods> + <members> + <member name="brake" type="float" setter="set_brake" getter="get_brake" brief=""> + </member> + <member name="engine_force" type="float" setter="set_engine_force" getter="get_engine_force" brief=""> + </member> + <member name="friction" type="float" setter="set_friction" getter="get_friction" brief=""> + </member> + <member name="mass" type="float" setter="set_mass" getter="get_mass" brief=""> + </member> + <member name="steering" type="float" setter="set_steering" getter="get_steering" brief=""> + </member> + </members> + <constants> + </constants> +</class> |