Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-21 19:42:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde 2017-12-10 00:43:30 +01:00
parent 028f959fb1
commit ce0f894b48
18 changed files with 238 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/classes/Animation.xml
View File

@ -30,6 +30,16 @@
Clear the animation (clear all tracks and reset all).
</description>
</method>
<method name="copy_track">
<return type="void">
</return>
<argument index="0" name="track" type="int">
</argument>
<argument index="1" name="to_animation" type="Animation">
</argument>
<description>
</description>
</method>
<method name="find_track" qualifiers="const">
<return type="int">
</return>
@ -244,6 +254,14 @@
Insert a generic key in a given track.
</description>
</method>
<method name="track_is_enabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
</description>
</method>
<method name="track_is_imported" qualifiers="const">
<return type="bool">
</return>
@ -293,6 +311,16 @@
Remove a key by position (seconds) in a given track.
</description>
</method>
<method name="track_set_enabled">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="track_set_imported">
<return type="void">
</return>

38
doc/classes/AnimationPlayer.xml
View File

@ -74,20 +74,6 @@
Returns the name of [code]animation[/code] or empty string if not found.
</description>
</method>
<method name="get_anim_length" qualifiers="const">
<return type="float">
</return>
<description>
Get the length (in seconds) of the currently playing animation.
</description>
</method>
<method name="get_anim_position" qualifiers="const">
<return type="float">
</return>
<description>
Get the position (in seconds) of the currently playing animation.
</description>
</method>
<method name="get_animation" qualifiers="const">
<return type="Animation">
</return>
@ -115,11 +101,18 @@
Get the blend time (in seconds) between two animations, referenced by their names.
</description>
</method>
<method name="get_current_animation" qualifiers="const">
<return type="String">
<method name="get_current_animation_length" qualifiers="const">
<return type="float">
</return>
<description>
Returns the name of the currently playing animation.
Get the length (in seconds) of the currently playing animation.
</description>
</method>
<method name="get_current_animation_position" qualifiers="const">
<return type="float">
</return>
<description>
Get the position (in seconds) of the currently playing animation.
</description>
</method>
<method name="has_animation" qualifiers="const">
@ -217,15 +210,6 @@
Specify a blend time (in seconds) between two animations, referenced by their names.
</description>
</method>
<method name="set_current_animation">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
</argument>
<description>
Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play().
</description>
</method>
<method name="stop">
<return type="void">
</return>
@ -253,6 +237,8 @@
<member name="current_animation" type="String" setter="set_current_animation" getter="get_current_animation">
The name of the current animation. Default value: [code]""[/code].
</member>
<member name="playback_default_blend_time" type="float" setter="set_default_blend_time" getter="get_default_blend_time">
</member>
<member name="playback_process_mode" type="int" setter="set_animation_process_mode" getter="get_animation_process_mode" enum="AnimationPlayer.AnimationProcessMode">
The process notification in which to update animations. Default value: [enum ANIMATION_PROCESS_IDLE].
</member>

60
doc/classes/AnimationTreePlayer.xml
View File

@ -194,19 +194,6 @@
Disconnects nodes connected to [code]id[/code] at the specified input slot.
</description>
</method>
<method name="get_base_path" qualifiers="const">
<return type="NodePath">
</return>
<description>
</description>
</method>
<method name="get_master_player" qualifiers="const">
<return type="NodePath">
</return>
<description>
Returns the path to the [AnimationPlayer] from which this [code]AnimationTreePlayer[/code] binds animations to animation nodes.
</description>
</method>
<method name="get_node_list">
<return type="PoolStringArray">
</return>
@ -214,13 +201,6 @@
Returns a PoolStringArray containing the name of all nodes.
</description>
</method>
<method name="is_active" qualifiers="const">
<return type="bool">
</return>
<description>
Returns whether this AnimationTreePlayer is active.
</description>
</method>
<method name="mix_node_get_amount" qualifiers="const">
<return type="float">
</return>
@ -473,32 +453,6 @@
Resets this AnimationTreePlayer.
</description>
</method>
<method name="set_active">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Sets whether this AnimationTreePlayer is active. AnimationTreePlayer will start processing if set to active.
</description>
</method>
<method name="set_base_path">
<return type="void">
</return>
<argument index="0" name="path" type="NodePath">
</argument>
<description>
Sets base path of this AnimationTreePlayer.
</description>
</method>
<method name="set_master_player">
<return type="void">
</return>
<argument index="0" name="nodepath" type="NodePath">
</argument>
<description>
</description>
</method>
<method name="timescale_node_get_scale" qualifiers="const">
<return type="float">
</return>
@ -627,17 +581,17 @@
</method>
</methods>
<members>
<member name="playback_process_mode" type="int" setter="set_animation_process_mode" getter="get_animation_process_mode" enum="AnimationTreePlayer.AnimationProcessMode">
The thread in which to update animations. Default value: [enum ANIMATION_PROCESS_IDLE].
</member>
<member name="master_player" type="NodePath" setter="set_master_player" getter="get_master_player">
The path to the [AnimationPlayer] from which this [code]AnimationTreePlayer[/code] binds animations to animation nodes.
<member name="active" type="bool" setter="set_active" getter="is_active">
If [code]true[/code] the [code]AnimationTreePlayer[/code] is able to play animations. Default value: [code]false[/code].
</member>
<member name="base_path" type="NodePath" setter="set_base_path" getter="get_base_path">
The node from which to relatively access other nodes. Default value: [code]".."[/code].
</member>
<member name="active" type="bool" setter="set_active" getter="is_active">
If [code]true[/code] the [code]AnimationTreePlayer[/code] is able to play animations. Default value: [code]false[/code].
<member name="master_player" type="NodePath" setter="set_master_player" getter="get_master_player">
The path to the [AnimationPlayer] from which this [code]AnimationTreePlayer[/code] binds animations to animation nodes.
</member>
<member name="playback_process_mode" type="int" setter="set_animation_process_mode" getter="get_animation_process_mode" enum="AnimationTreePlayer.AnimationProcessMode">
The thread in which to update animations. Default value: [enum ANIMATION_PROCESS_IDLE].
</member>
</members>
<constants>

28
doc/classes/CanvasItem.xml
View File

@ -88,6 +88,34 @@
Draw a line from a 2D point to another, with a given color and width. It can be optionally antialiased.
</description>
</method>
<method name="draw_multiline">
<return type="void">
</return>
<argument index="0" name="points" type="PoolVector2Array">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<argument index="2" name="width" type="float" default="1.0">
</argument>
<argument index="3" name="antialiased" type="bool" default="false">
</argument>
<description>
</description>
</method>
<method name="draw_multiline_colors">
<return type="void">
</return>
<argument index="0" name="points" type="PoolVector2Array">
</argument>
<argument index="1" name="colors" type="PoolColorArray">
</argument>
<argument index="2" name="width" type="float" default="1.0">
</argument>
<argument index="3" name="antialiased" type="bool" default="false">
</argument>
<description>
</description>
</method>
<method name="draw_polygon">
<return type="void">
</return>

22
doc/classes/EditorPlugin.xml
View File

@ -82,6 +82,14 @@
<description>
</description>
</method>
<method name="add_scene_import_plugin">
<return type="void">
</return>
<argument index="0" name="scene_importer" type="EditorSceneImporter">
</argument>
<description>
</description>
</method>
<method name="add_tool_submenu_item">
<return type="void">
</return>
@ -176,6 +184,12 @@
<description>
</description>
</method>
<method name="get_plugin_icon" qualifiers="virtual">
<return type="Object">
</return>
<description>
</description>
</method>
<method name="get_plugin_name" qualifiers="virtual">
<return type="String">
</return>
@ -295,6 +309,14 @@
<description>
</description>
</method>
<method name="remove_scene_import_plugin">
<return type="void">
</return>
<argument index="0" name="scene_importer" type="EditorSceneImporter">
</argument>
<description>
</description>
</method>
<method name="save_external_data" qualifiers="virtual">
<return type="void">
</return>

95
doc/classes/EditorSceneImporter.xml Normal file
View File

@ -0,0 +1,95 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorSceneImporter" inherits="Reference" category="Core" version="3.0-beta">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="_get_extensions" qualifiers="virtual">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="_get_import_flags" qualifiers="virtual">
<return type="int">
</return>
<description>
</description>
</method>
<method name="_import_animation" qualifiers="virtual">
<return type="Animation">
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="flags" type="int">
</argument>
<argument index="2" name="bake_fps" type="int">
</argument>
<description>
</description>
</method>
<method name="_import_scene" qualifiers="virtual">
<return type="Node">
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="flags" type="int">
</argument>
<argument index="2" name="bake_fps" type="int">
</argument>
<description>
</description>
</method>
<method name="import_animation_from_other_importer">
<return type="Animation">
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="flags" type="int">
</argument>
<argument index="2" name="bake_fps" type="int">
</argument>
<description>
</description>
</method>
<method name="import_scene_from_other_importer">
<return type="Node">
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="flags" type="int">
</argument>
<argument index="2" name="bake_fps" type="int">
</argument>
<description>
</description>
</method>
</methods>
<constants>
<constant name="IMPORT_SCENE" value="1">
</constant>
<constant name="IMPORT_ANIMATION" value="2">
</constant>
<constant name="IMPORT_ANIMATION_DETECT_LOOP" value="4">
</constant>
<constant name="IMPORT_ANIMATION_OPTIMIZE" value="8">
</constant>
<constant name="IMPORT_ANIMATION_FORCE_ALL_TRACKS_IN_ALL_CLIPS" value="16">
</constant>
<constant name="IMPORT_ANIMATION_KEEP_VALUE_TRACKS" value="32">
</constant>
<constant name="IMPORT_GENERATE_TANGENT_ARRAYS" value="256">
</constant>
<constant name="IMPORT_FAIL_ON_MISSING_DEPENDENCIES" value="512">
</constant>
<constant name="IMPORT_MATERIALS_IN_INSTANCES" value="1024">
</constant>
<constant name="IMPORT_USE_COMPRESSION" value="2048">
</constant>
</constants>
</class>

6
doc/classes/KinematicBody.xml
View File

@ -102,6 +102,12 @@
</method>
</methods>
<members>
<member name="axis_lock_x" type="bool" setter="set_axis_lock_x" getter="get_axis_lock_x">
</member>
<member name="axis_lock_y" type="bool" setter="set_axis_lock_y" getter="get_axis_lock_y">
</member>
<member name="axis_lock_z" type="bool" setter="set_axis_lock_z" getter="get_axis_lock_z">
</member>
<member name="collision/safe_margin" type="float" setter="set_safe_margin" getter="get_safe_margin">
If the body is at least this close to another body, this body will consider them to be colliding.
</member>

4
doc/classes/Mesh.xml
View File

@ -49,6 +49,10 @@
</description>
</method>
</methods>
<members>
<member name="lightmap_size_hint" type="Vector2" setter="set_lightmap_size_hint" getter="get_lightmap_size_hint">
</member>
</members>
<constants>
<constant name="PRIMITIVE_POINTS" value="0" enum="PrimitiveType">
Render array as points (one vertex equals one point).

2
doc/classes/MeshInstance.xml
View File

@ -22,7 +22,7 @@
<return type="void">
</return>
<description>
This helper creates a [MeshInstance] child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing.
This helper creates a [MeshInstance] child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing.
</description>
</method>
<method name="create_trimesh_collision">

19
doc/classes/PhysicsServer.xml
View File

@ -352,7 +352,7 @@
</description>
</method>
<method name="body_get_axis_lock" qualifiers="const">
<return type="int" enum="PhysicsServer.BodyAxisLock">
<return type="bool">
</return>
<argument index="0" name="body" type="RID">
</argument>
@ -540,10 +540,11 @@
</return>
<argument index="0" name="body" type="RID">
</argument>
<argument index="1" name="axis" type="int" enum="PhysicsServer.BodyAxisLock">
<argument index="1" name="axis" type="int">
</argument>
<argument index="2" name="lock" type="bool">
</argument>
<description>
Locks velocity along one axis to 0 and only allows rotation along this axis, can also be set to disabled which disables this functionality.
</description>
</method>
<method name="body_set_axis_velocity">
@ -1519,17 +1520,5 @@
<constant name="SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS" value="7" enum="SpaceParameter">
Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision.
</constant>
<constant name="BODY_AXIS_LOCK_DISABLED" value="0" enum="BodyAxisLock">
The [Body] can rotate and move freely.
</constant>
<constant name="BODY_AXIS_LOCK_X" value="1" enum="BodyAxisLock">
The [Body] cannot move across x axis can only rotate across x axis.
</constant>
<constant name="BODY_AXIS_LOCK_Y" value="2" enum="BodyAxisLock">
The [Body] cannot move across y axis can only rotate across y axis.
</constant>
<constant name="BODY_AXIS_LOCK_Z" value="3" enum="BodyAxisLock">
The [Body] cannot move across z axis can only rotate across z axis.
</constant>
</constants>
</class>

6
doc/classes/Rect2.xml
View File

@ -37,6 +37,12 @@
Constructs a [code]Rect2[/code] by x, y, width, and height.
</description>
</method>
<method name="abs">
<return type="Rect2">
</return>
<description>
</description>
</method>
<method name="clip">
<return type="Rect2">
</return>

15
doc/classes/RigidBody.xml
View File

@ -59,8 +59,11 @@
<member name="angular_velocity" type="Vector3" setter="set_angular_velocity" getter="get_angular_velocity">
RigidBody's rotational velocity.
</member>
<member name="axis_lock" type="int" setter="set_axis_lock" getter="get_axis_lock" enum="RigidBody.AxisLock">
Locks the rotational forces to a particular axis, preventing rotations on other axes.
<member name="axis_lock_x" type="bool" setter="set_axis_lock_x" getter="get_axis_lock_x">
</member>
<member name="axis_lock_y" type="bool" setter="set_axis_lock_y" getter="get_axis_lock_y">
</member>
<member name="axis_lock_z" type="bool" setter="set_axis_lock_z" getter="get_axis_lock_z">
</member>
<member name="bounce" type="float" setter="set_bounce" getter="get_bounce">
RigidBody's bounciness.
@ -168,13 +171,5 @@
<constant name="MODE_KINEMATIC" value="3" enum="Mode">
Kinematic body. The body behaves like a [KinematicBody], and can only move by user code.
</constant>
<constant name="AXIS_LOCK_DISABLED" value="0" enum="AxisLock">
</constant>
<constant name="AXIS_LOCK_X" value="1" enum="AxisLock">
</constant>
<constant name="AXIS_LOCK_Y" value="2" enum="AxisLock">
</constant>
<constant name="AXIS_LOCK_Z" value="3" enum="AxisLock">
</constant>
</constants>
</class>

2
doc/classes/SurfaceTool.xml
View File

@ -170,6 +170,8 @@
</return>
<argument index="0" name="existing" type="ArrayMesh" default="null">
</argument>
<argument index="1" name="flags" type="int" default="97792">
</argument>
<description>
Returns a constructed [ArrayMesh] from current information passed in. If an existing [ArrayMesh] is passed in as an argument, will add an extra surface to the existing [ArrayMesh].
</description>

11
doc/classes/TextEdit.xml
View File

@ -305,6 +305,15 @@
Enable text wrapping when it goes beyond he edge of what is visible.
</description>
</method>
<method name="toggle_fold_line">
<return type="void">
</return>
<argument index="0" name="line" type="int">
</argument>
<description>
Toggle the folding of the code block at the given line.
</description>
</method>
<method name="undo">
<return type="void">
</return>
@ -428,6 +437,8 @@
</theme_item>
<theme_item name="caret_color" type="Color">
</theme_item>
<theme_item name="code_folding_color" type="Color">
</theme_item>
<theme_item name="completion" type="StyleBox">
</theme_item>
<theme_item name="completion_background_color" type="Color">

2
doc/classes/Texture.xml
View File

@ -133,7 +133,7 @@
More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases.
</constant>
<constant name="FLAG_CONVERT_TO_LINEAR" value="16" enum="Flags">
Converts texture to SRGB color space.
Converts texture to SRGB color space.
</constant>
<constant name="FLAG_MIRRORED_REPEAT" value="32" enum="Flags">
Repeats texture with alternate sections mirrored.

8
doc/classes/VisualServer.xml
View File

@ -647,7 +647,7 @@
<argument index="1" name="height" type="float">
</argument>
<description>
Sets a canvas light's height.
Sets a canvas light's height.
</description>
</method>
<method name="canvas_light_set_item_cull_mask">
@ -1495,7 +1495,7 @@
<return type="Array">
</return>
<description>
Returns a list of all the textures and their information.
Returns a list of all the textures and their information.
</description>
</method>
<method name="texture_get_data" qualifiers="const">
@ -2022,7 +2022,7 @@
More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases.
</constant>
<constant name="TEXTURE_FLAG_CONVERT_TO_LINEAR" value="16" enum="TextureFlags">
Converts texture to SRGB color space.
Converts texture to SRGB color space.
</constant>
<constant name="TEXTURE_FLAG_MIRRORED_REPEAT" value="32" enum="TextureFlags">
Repeat texture with alternate sections mirrored.
@ -2397,4 +2397,4 @@
<constant name="FEATURE_MULTITHREADED" value="1" enum="Features">
</constant>
</constants>
</class>
</class>

4
scene/animation/animation_player.cpp
View File

@ -1327,7 +1327,7 @@ void AnimationPlayer::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_root"), &AnimationPlayer::get_root);
ClassDB::bind_method(D_METHOD("seek", "seconds", "update"), &AnimationPlayer::seek, DEFVAL(false));
ClassDB::bind_method(D_METHOD("get_position"), &AnimationPlayer::get_current_animation_position);
ClassDB::bind_method(D_METHOD("advance", "delta"), &AnimationPlayer::advance);
ClassDB::bind_method(D_METHOD("find_animation", "animation"), &AnimationPlayer::find_animation);
@ -1339,8 +1339,6 @@ void AnimationPlayer::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_current_animation_position"), &AnimationPlayer::get_current_animation_position);
ClassDB::bind_method(D_METHOD("get_current_animation_length"), &AnimationPlayer::get_current_animation_length);
ClassDB::bind_method(D_METHOD("advance", "delta"), &AnimationPlayer::advance);
ADD_GROUP("Playback Options", "playback_");
ADD_PROPERTY(PropertyInfo(Variant::INT, "playback_process_mode", PROPERTY_HINT_ENUM, "Physics,Idle"), "set_animation_process_mode", "get_animation_process_mode");
ADD_PROPERTY(PropertyInfo(Variant::REAL, "playback_default_blend_time", PROPERTY_HINT_RANGE, "0,4096,0.01"), "set_default_blend_time", "get_default_blend_time");

2
scene/resources/surface_tool.cpp
View File

@ -990,7 +990,7 @@ void SurfaceTool::_bind_methods() {
ClassDB::bind_method(D_METHOD("create_from", "existing", "surface"), &SurfaceTool::create_from);
ClassDB::bind_method(D_METHOD("append_from", "existing", "surface", "transform"), &SurfaceTool::append_from);
ClassDB::bind_method(D_METHOD("commit", "existing"), &SurfaceTool::commit, DEFVAL(Variant()), DEFVAL(Mesh::ARRAY_COMPRESS_DEFAULT));
ClassDB::bind_method(D_METHOD("commit", "existing", "flags"), &SurfaceTool::commit, DEFVAL(Variant()), DEFVAL(Mesh::ARRAY_COMPRESS_DEFAULT));
}
SurfaceTool::SurfaceTool() {