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/Joint2D.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/Joint2D.xml')
| -rw-r--r-- | doc/classes/Joint2D.xml | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/doc/classes/Joint2D.xml b/doc/classes/Joint2D.xml new file mode 100644 index 000000000..cf685d498 --- /dev/null +++ b/doc/classes/Joint2D.xml @@ -0,0 +1,87 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Joint2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base node for all joint constraints in 2D physics. + </brief_description> + <description> + Base node for all joint constraints in 2D physics. Joints take 2 bodies and apply a custom constraint. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_bias" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_exclude_nodes_from_collision" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_node_a" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + Return the path to the A node for the joint. + </description> + </method> + <method name="get_node_b" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + Return the path to the B node for the joint. + </description> + </method> + <method name="set_bias"> + <return type="void"> + </return> + <argument index="0" name="bias" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_exclude_nodes_from_collision"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_node_a"> + <return type="void"> + </return> + <argument index="0" name="node" type="NodePath"> + </argument> + <description> + Set the path to the A node for the joint. Must be of type [PhysicsBody2D]. + </description> + </method> + <method name="set_node_b"> + <return type="void"> + </return> + <argument index="0" name="node" type="NodePath"> + </argument> + <description> + Set the path to the B node for the joint. Must be of type [PhysicsBody2D]. + </description> + </method> + </methods> + <members> + <member name="bias" type="float" setter="set_bias" getter="get_bias" brief=""> + </member> + <member name="disable_collision" type="bool" setter="set_exclude_nodes_from_collision" getter="get_exclude_nodes_from_collision" brief=""> + </member> + <member name="node_a" type="NodePath" setter="set_node_a" getter="get_node_a" brief=""> + </member> + <member name="node_b" type="NodePath" setter="set_node_b" getter="get_node_b" brief=""> + </member> + </members> + <constants> + </constants> +</class> |