diff options
author | Rémi Verschelde <rverschelde@gmail.com> | 2017-09-06 11:35:05 +0200 |
---|---|---|
committer | Rémi Verschelde <rverschelde@gmail.com> | 2017-09-06 11:35:10 +0200 |
commit | 7e2d03bd146a15a7f034ef42b2101987d978a6df (patch) | |
tree | d18d33612df9d65e8fdaaf77b9dd2e3d91a93b71 /doc/base | |
parent | 4d73b778f0e5266504c77641315edd3157afcc8e (diff) |
doc: Sync classref with current source
[ci skip]
Diffstat (limited to 'doc/base')
-rw-r--r-- | doc/base/classes.xml | 291 |
1 files changed, 176 insertions, 115 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 2db6a22d31..8d16585726 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -19137,6 +19137,12 @@ <description> </description> </method> + <method name="is_singleton_gdnative" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="set_library_path"> <return type="void"> </return> @@ -19147,7 +19153,19 @@ <description> </description> </method> + <method name="set_singleton_gdnative"> + <return type="void"> + </return> + <argument index="0" name="singleton" type="bool"> + </argument> + <description> + </description> + </method> </methods> + <members> + <member name="singleton_gdnative" type="bool" setter="set_singleton_gdnative" getter="is_singleton_gdnative" brief=""> + </member> + </members> <constants> </constants> </class> @@ -20807,7 +20825,7 @@ <description> </description> </method> - <method name="is_resizeable" qualifiers="const"> + <method name="is_resizable" qualifiers="const"> <return type="bool"> </return> <description> @@ -20862,10 +20880,10 @@ <description> </description> </method> - <method name="set_resizeable"> + <method name="set_resizable"> <return type="void"> </return> - <argument index="0" name="resizeable" type="bool"> + <argument index="0" name="resizable" type="bool"> </argument> <description> </description> @@ -20922,7 +20940,7 @@ </method> </methods> <members> - <member name="resizeable" type="bool" setter="set_resizeable" getter="is_resizeable" brief=""> + <member name="resizable" type="bool" setter="set_resizable" getter="is_resizable" brief=""> </member> <member name="show_close" type="bool" setter="set_show_close_button" getter="is_close_button_visible" brief=""> </member> @@ -24844,108 +24862,28 @@ Kinematic Characters: KinematicBody also has an api for moving objects (the [method move] method) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. </description> <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="Vector3"> - </return> - <argument index="0" name="collision" type="int"> - </argument> - <description> - </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="Vector3"> - </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="Vector3"> </return> - <argument index="0" name="collision" type="int"> - </argument> <description> </description> </method> - <method name="get_collision_remainder" qualifiers="const"> - <return type="Vector3"> + <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="Vector3"> + <method name="get_slide_collision"> + <return type="KinematicCollision"> </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="Vector3"> - </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> @@ -24968,22 +24906,12 @@ <description> </description> </method> - <method name="move"> - <return type="Dictionary"> + <method name="move_and_collide"> + <return type="KinematicCollision"> </return> <argument index="0" name="rel_vec" type="Vector3"> </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 [PhysicsServer] - - "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"> @@ -24995,7 +24923,7 @@ </argument> <argument index="2" name="slope_stop_min_velocity" type="float" default="0.05"> </argument> - <argument index="3" name="max_bounces" type="int" default="4"> + <argument index="3" name="max_slides" type="int" default="4"> </argument> <argument index="4" name="floor_max_angle" type="float" default="0.785398"> </argument> @@ -25224,6 +25152,106 @@ <constants> </constants> </class> +<class name="KinematicCollision" inherits="Reference" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <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="Vector3"> + </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="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_position" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_remainder" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_travel" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + </methods> + <members> + <member name="collider" type="Object" setter="" getter="get_collider" brief=""> + </member> + <member name="collider_id" type="int" setter="" getter="get_collider_id" brief=""> + </member> + <member name="collider_metadata" type="Variant" setter="" getter="get_collider_metadata" brief=""> + </member> + <member name="collider_shape" type="Object" setter="" getter="get_collider_shape" brief=""> + </member> + <member name="collider_shape_index" type="int" setter="" getter="get_collider_shape_index" brief=""> + </member> + <member name="collider_velocity" type="Vector3" setter="" getter="get_collider_velocity" brief=""> + </member> + <member name="local_shape" type="Object" setter="" getter="get_local_shape" brief=""> + </member> + <member name="normal" type="Vector3" setter="" getter="get_normal" brief=""> + </member> + <member name="position" type="Vector3" setter="" getter="get_position" brief=""> + </member> + <member name="remainder" type="Vector3" setter="" getter="get_remainder" brief=""> + </member> + <member name="travel" type="Vector3" setter="" getter="get_travel" brief=""> + </member> + </members> + <constants> + </constants> +</class> <class name="Label" inherits="Control" category="Core"> <brief_description> Control that displays formatted text. @@ -27727,6 +27755,14 @@ Create a new item in the library, supplied an id. </description> </method> + <method name="find_item_by_name" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> <method name="get_item_list" qualifiers="const"> <return type="PoolIntArray"> </return> @@ -42738,6 +42774,8 @@ </theme_item> <theme_item name="mono_font" type="Font"> </theme_item> + <theme_item name="normal" type="StyleBox"> + </theme_item> <theme_item name="normal_font" type="Font"> </theme_item> <theme_item name="selection_color" type="Color"> @@ -45908,6 +45946,12 @@ <description> </description> </method> + <method name="get_transmission" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> <method name="get_uv1_offset" qualifiers="const"> <return type="Vector3"> </return> @@ -46290,6 +46334,14 @@ <description> </description> </method> + <method name="set_transmission"> + <return type="void"> + </return> + <argument index="0" name="transmission" type="Color"> + </argument> + <description> + </description> + </method> <method name="set_uv1_offset"> <return type="void"> </return> @@ -46484,6 +46536,12 @@ </member> <member name="subsurf_scatter_texture" type="Texture" setter="set_texture" getter="get_texture" brief=""> </member> + <member name="transmission" type="Color" setter="set_transmission" getter="get_transmission" brief=""> + </member> + <member name="transmission_enabled" type="bool" setter="set_feature" getter="get_feature" brief=""> + </member> + <member name="transmission_texture" type="Texture" setter="set_texture" getter="get_texture" brief=""> + </member> <member name="uv1_offset" type="Vector3" setter="set_uv1_offset" getter="get_uv1_offset" brief=""> </member> <member name="uv1_scale" type="Vector3" setter="set_uv1_scale" getter="get_uv1_scale" brief=""> @@ -46528,15 +46586,17 @@ </constant> <constant name="TEXTURE_SUBSURFACE_SCATTERING" value="10"> </constant> - <constant name="TEXTURE_REFRACTION" value="11"> + <constant name="TEXTURE_TRANSMISSION" value="11"> </constant> - <constant name="TEXTURE_DETAIL_MASK" value="12"> + <constant name="TEXTURE_REFRACTION" value="12"> </constant> - <constant name="TEXTURE_DETAIL_ALBEDO" value="13"> + <constant name="TEXTURE_DETAIL_MASK" value="13"> </constant> - <constant name="TEXTURE_DETAIL_NORMAL" value="14"> + <constant name="TEXTURE_DETAIL_ALBEDO" value="14"> </constant> - <constant name="TEXTURE_MAX" value="15"> + <constant name="TEXTURE_DETAIL_NORMAL" value="15"> + </constant> + <constant name="TEXTURE_MAX" value="16"> </constant> <constant name="DETAIL_UV_1" value="0"> </constant> @@ -46560,11 +46620,13 @@ </constant> <constant name="FEATURE_SUBSURACE_SCATTERING" value="8"> </constant> - <constant name="FEATURE_REFRACTION" value="9"> + <constant name="FEATURE_TRANSMISSION" value="9"> + </constant> + <constant name="FEATURE_REFRACTION" value="10"> </constant> - <constant name="FEATURE_DETAIL" value="10"> + <constant name="FEATURE_DETAIL" value="11"> </constant> - <constant name="FEATURE_MAX" value="11"> + <constant name="FEATURE_MAX" value="12"> </constant> <constant name="BLEND_MODE_MIX" value="0"> </constant> @@ -46616,7 +46678,7 @@ </constant> <constant name="DIFFUSE_LAMBERT" value="0"> </constant> - <constant name="DIFFUSE_HALF_LAMBERT" value="1"> + <constant name="DIFFUSE_LAMBERT_WRAP" value="1"> </constant> <constant name="DIFFUSE_OREN_NAYAR" value="2"> </constant> @@ -49230,7 +49292,6 @@ corner_radius_top_left: 10 corner_raidus_bottom_left: 20 [/codeblock] - </description> <methods> <method name="get_aa_size" qualifiers="const"> |