diff options
author | Rémi Verschelde <rverschelde@gmail.com> | 2017-09-13 20:56:01 +0200 |
---|---|---|
committer | Rémi Verschelde <rverschelde@gmail.com> | 2017-09-13 20:56:23 +0200 |
commit | cc30e2a9a503f4b13eb25af2a552a029d6de815b (patch) | |
tree | 39c27f6f290ed95ea13d555202eceafce4c70080 /doc | |
parent | ae4cd72e6283765af26adf12f91611d09dfea95d (diff) |
doc: Sync classref with current source
[ci skip]
Diffstat (limited to 'doc')
-rw-r--r-- | doc/classes/AudioStreamPlayer.xml | 2 | ||||
-rw-r--r-- | doc/classes/AudioStreamPlayer2D.xml | 2 | ||||
-rw-r--r-- | doc/classes/AudioStreamPlayer3D.xml | 2 | ||||
-rw-r--r-- | doc/classes/KinematicBody2D.xml | 111 | ||||
-rw-r--r-- | doc/classes/KinematicCollision2D.xml | 105 | ||||
-rw-r--r-- | doc/classes/NavigationMesh.xml | 278 | ||||
-rw-r--r-- | doc/classes/Tree.xml | 8 | ||||
-rw-r--r-- | doc/classes/TreeItem.xml | 14 |
8 files changed, 418 insertions, 104 deletions
diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index 88e7b9ad9e..64823c3be5 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -121,7 +121,7 @@ </member> <member name="mix_target" type="int" setter="set_mix_target" getter="get_mix_target" enum="AudioStreamPlayer.MixTarget"> </member> - <member name="play" type="bool" setter="_set_playing" getter="_is_active"> + <member name="playing" type="bool" setter="_set_playing" getter="is_playing"> </member> <member name="stream" type="AudioStream" setter="set_stream" getter="get_stream"> </member> diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index 879f618c06..f2464ddac4 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -153,7 +153,7 @@ </member> <member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance"> </member> - <member name="play" type="bool" setter="_set_playing" getter="_is_active"> + <member name="playing" type="bool" setter="_set_playing" getter="is_playing"> </member> <member name="stream" type="AudioStream" setter="set_stream" getter="get_stream"> </member> diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index 8c5238ac40..668e0cc0d2 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -295,7 +295,7 @@ </member> <member name="out_of_range_mode" type="int" setter="set_out_of_range_mode" getter="get_out_of_range_mode" enum="AudioStreamPlayer3D.OutOfRangeMode"> </member> - <member name="play" type="bool" setter="_set_playing" getter="_is_active"> + <member name="playing" type="bool" setter="_set_playing" getter="is_playing"> </member> <member name="stream" type="AudioStream" setter="set_stream" getter="get_stream"> </member> diff --git a/doc/classes/KinematicBody2D.xml b/doc/classes/KinematicBody2D.xml index 448389e950..26c7c6125d 100644 --- a/doc/classes/KinematicBody2D.xml +++ b/doc/classes/KinematicBody2D.xml @@ -13,109 +13,28 @@ <demos> </demos> <methods> - <method name="get_collision_collider" qualifiers="const"> - <return type="Object"> - </return> - <argument index="0" name="collision" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_collision_collider_id" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="collision" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_collision_collider_metadata" qualifiers="const"> - <return type="Variant"> - </return> - <argument index="0" name="collision" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_collision_collider_shape" qualifiers="const"> - <return type="Object"> - </return> - <argument index="0" name="collision" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_collision_collider_shape_index" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="collision" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_collision_collider_velocity" qualifiers="const"> - <return type="Vector2"> - </return> - <argument index="0" name="collision" type="int"> - </argument> - <description> - Return the velocity of the body that collided with this one. - </description> - </method> - <method name="get_collision_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_collision_local_shape" qualifiers="const"> - <return type="Object"> - </return> - <argument index="0" name="collision" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_collision_normal" qualifiers="const"> - <return type="Vector2"> - </return> - <argument index="0" name="collision" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_collision_position" qualifiers="const"> + <method name="get_floor_velocity" qualifiers="const"> <return type="Vector2"> </return> - <argument index="0" name="collision" type="int"> - </argument> <description> </description> </method> - <method name="get_collision_remainder" qualifiers="const"> - <return type="Vector2"> + <method name="get_safe_margin" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="collision" type="int"> - </argument> <description> </description> </method> - <method name="get_collision_travel" qualifiers="const"> - <return type="Vector2"> + <method name="get_slide_collision"> + <return type="KinematicCollision2D"> </return> - <argument index="0" name="collision" type="int"> + <argument index="0" name="slide_idx" type="int"> </argument> <description> </description> </method> - <method name="get_floor_velocity" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_safe_margin" qualifiers="const"> - <return type="float"> + <method name="get_slide_count" qualifiers="const"> + <return type="int"> </return> <description> </description> @@ -138,22 +57,12 @@ <description> </description> </method> - <method name="move"> - <return type="Dictionary"> + <method name="move_and_collide"> + <return type="KinematicCollision2D"> </return> <argument index="0" name="rel_vec" type="Vector2"> </argument> <description> - Move the body in the given direction, stopping if there is an obstacle. If as a result of a movement there will be any collision then informations about this collision will be in returned dictionary. Dictionary will contains those keys: - - "position" - collision position - - "normal" - collision normal - - "local_shape" - id of this kinematic body shape that took part in a collision - - "travel" - traveled movement before being stopped - - "remainder" - remaining movement before being stopped - - "collider_id" - id of the collider, it can be used when dealing with [Physics2DServer] - - "collider" - colliding body - - "collider_shape_index" - index of the colliding shape, inside collider body "collider_metadata" - If the body did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead. Please note that this method is less user friendly than [method move_and_slide]. If you don't want to program each edge case manually, then it's recommended to use [method move_and_slide] instead. </description> </method> <method name="move_and_slide"> diff --git a/doc/classes/KinematicCollision2D.xml b/doc/classes/KinematicCollision2D.xml new file mode 100644 index 0000000000..4ef35066d0 --- /dev/null +++ b/doc/classes/KinematicCollision2D.xml @@ -0,0 +1,105 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="KinematicCollision2D" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_collider" qualifiers="const"> + <return type="Object"> + </return> + <description> + </description> + </method> + <method name="get_collider_id" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_collider_metadata" qualifiers="const"> + <return type="Variant"> + </return> + <description> + </description> + </method> + <method name="get_collider_shape" qualifiers="const"> + <return type="Object"> + </return> + <description> + </description> + </method> + <method name="get_collider_shape_index" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_collider_velocity" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_local_shape" qualifiers="const"> + <return type="Object"> + </return> + <description> + </description> + </method> + <method name="get_normal" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_position" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_remainder" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_travel" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + </methods> + <members> + <member name="collider" type="Object" setter="" getter="get_collider"> + </member> + <member name="collider_id" type="int" setter="" getter="get_collider_id"> + </member> + <member name="collider_metadata" type="Variant" setter="" getter="get_collider_metadata"> + </member> + <member name="collider_shape" type="Object" setter="" getter="get_collider_shape"> + </member> + <member name="collider_shape_index" type="int" setter="" getter="get_collider_shape_index"> + </member> + <member name="collider_velocity" type="Vector2" setter="" getter="get_collider_velocity"> + </member> + <member name="local_shape" type="Object" setter="" getter="get_local_shape"> + </member> + <member name="normal" type="Vector2" setter="" getter="get_normal"> + </member> + <member name="position" type="Vector2" setter="" getter="get_position"> + </member> + <member name="remainder" type="Vector2" setter="" getter="get_remainder"> + </member> + <member name="travel" type="Vector2" setter="" getter="get_travel"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index c1bce2b410..788fadfd77 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -31,6 +31,84 @@ <description> </description> </method> + <method name="get_agent_height" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_agent_max_climb" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_agent_max_slope" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_agent_radius"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_cell_height" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_cell_size" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_detail_sample_distance" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_detail_sample_max_error" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_edge_max_error" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_edge_max_length" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_filter_ledge_spans" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_filter_low_hanging_obstacles" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_filter_walkable_low_height_spans" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="get_polygon"> <return type="PoolIntArray"> </return> @@ -45,12 +123,164 @@ <description> </description> </method> + <method name="get_region_merge_size" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_region_min_size" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_sample_partition_type" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="get_vertices" qualifiers="const"> <return type="PoolVector3Array"> </return> <description> </description> </method> + <method name="get_verts_per_poly" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_agent_height"> + <return type="void"> + </return> + <argument index="0" name="agent_height" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_agent_max_climb"> + <return type="void"> + </return> + <argument index="0" name="agent_max_climb" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_agent_max_slope"> + <return type="void"> + </return> + <argument index="0" name="agent_max_slope" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_agent_radius"> + <return type="void"> + </return> + <argument index="0" name="agent_radius" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_cell_height"> + <return type="void"> + </return> + <argument index="0" name="cell_height" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_cell_size"> + <return type="void"> + </return> + <argument index="0" name="cell_size" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_detail_sample_distance"> + <return type="void"> + </return> + <argument index="0" name="detail_sample_dist" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_detail_sample_max_error"> + <return type="void"> + </return> + <argument index="0" name="detail_sample_max_error" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_edge_max_error"> + <return type="void"> + </return> + <argument index="0" name="edge_max_error" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_edge_max_length"> + <return type="void"> + </return> + <argument index="0" name="edge_max_length" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_filter_ledge_spans"> + <return type="void"> + </return> + <argument index="0" name="filter_ledge_spans" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_filter_low_hanging_obstacles"> + <return type="void"> + </return> + <argument index="0" name="filter_low_hanging_obstacles" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_filter_walkable_low_height_spans"> + <return type="void"> + </return> + <argument index="0" name="filter_walkable_low_height_spans" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_region_merge_size"> + <return type="void"> + </return> + <argument index="0" name="region_merge_size" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_region_min_size"> + <return type="void"> + </return> + <argument index="0" name="region_min_size" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_sample_partition_type"> + <return type="void"> + </return> + <argument index="0" name="sample_partition_type" type="int"> + </argument> + <description> + </description> + </method> <method name="set_vertices"> <return type="void"> </return> @@ -59,13 +289,61 @@ <description> </description> </method> + <method name="set_verts_per_poly"> + <return type="void"> + </return> + <argument index="0" name="verts_per_poly" type="float"> + </argument> + <description> + </description> + </method> </methods> <members> + <member name="agent/height" type="float" setter="set_agent_height" getter="get_agent_height"> + </member> + <member name="agent/max_climb" type="float" setter="set_agent_max_climb" getter="get_agent_max_climb"> + </member> + <member name="agent/max_slope" type="float" setter="set_agent_max_slope" getter="get_agent_max_slope"> + </member> + <member name="agent/radius" type="float" setter="set_agent_radius" getter="get_agent_radius"> + </member> + <member name="cell/height" type="float" setter="set_cell_height" getter="get_cell_height"> + </member> + <member name="cell/size" type="float" setter="set_cell_size" getter="get_cell_size"> + </member> + <member name="detail/sample_distance" type="float" setter="set_detail_sample_distance" getter="get_detail_sample_distance"> + </member> + <member name="detail/sample_max_error" type="float" setter="set_detail_sample_max_error" getter="get_detail_sample_max_error"> + </member> + <member name="edge/max_error" type="float" setter="set_edge_max_error" getter="get_edge_max_error"> + </member> + <member name="edge/max_length" type="float" setter="set_edge_max_length" getter="get_edge_max_length"> + </member> + <member name="filter/filter_walkable_low_height_spans" type="bool" setter="set_filter_walkable_low_height_spans" getter="get_filter_walkable_low_height_spans"> + </member> + <member name="filter/ledge_spans" type="bool" setter="set_filter_ledge_spans" getter="get_filter_ledge_spans"> + </member> + <member name="filter/low_hanging_obstacles" type="bool" setter="set_filter_low_hanging_obstacles" getter="get_filter_low_hanging_obstacles"> + </member> + <member name="polygon/verts_per_poly" type="float" setter="set_verts_per_poly" getter="get_verts_per_poly"> + </member> <member name="polygons" type="Array" setter="_set_polygons" getter="_get_polygons"> </member> + <member name="region/merge_size" type="float" setter="set_region_merge_size" getter="get_region_merge_size"> + </member> + <member name="region/min_size" type="float" setter="set_region_min_size" getter="get_region_min_size"> + </member> + <member name="sample_partition_type/sample_partition_type" type="int" setter="set_sample_partition_type" getter="get_sample_partition_type"> + </member> <member name="vertices" type="PoolVector3Array" setter="set_vertices" getter="get_vertices"> </member> </members> <constants> + <constant name="SAMPLE_PARTITION_WATERSHED" value="0" enum=""> + </constant> + <constant name="SAMPLE_PARTITION_MONOTONE" value="1" enum=""> + </constant> + <constant name="SAMPLE_PARTITION_LAYERS" value="2" enum=""> + </constant> </constants> </class> diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index 68228ed803..a92a51049b 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -113,6 +113,14 @@ Get the flags of the current drop mode. </description> </method> + <method name="get_drop_section_at_pos" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + </description> + </method> <method name="get_edited" qualifiers="const"> <return type="TreeItem"> </return> diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index 48159946fa..02c264cbff 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -99,6 +99,12 @@ <description> </description> </method> + <method name="get_custom_minimum_height" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="get_expand_right" qualifiers="const"> <return type="bool"> </return> @@ -383,6 +389,14 @@ <description> </description> </method> + <method name="set_custom_minimum_height"> + <return type="void"> + </return> + <argument index="0" name="height" type="int"> + </argument> + <description> + </description> + </method> <method name="set_disable_folding"> <return type="void"> </return> |