diff options
| author | Rémi Verschelde | 2017-04-07 22:08:11 +0200 |
|---|---|---|
| committer | Rémi Verschelde | 2017-04-07 22:08:11 +0200 |
| commit | 6f489fbb2ec3662acb27d537a83cd5a906fd1b86 (patch) | |
| tree | 71351e55c2925891d02194a510fa0b52f6344be9 | |
| parent | 64d8eeb4a17a9e97d1e459d4579c0d089b730e08 (diff) | |
| download | godot-6f489fbb2ec3662acb27d537a83cd5a906fd1b86.tar.gz godot-6f489fbb2ec3662acb27d537a83cd5a906fd1b86.tar.zst godot-6f489fbb2ec3662acb27d537a83cd5a906fd1b86.zip | |
classref: Sync with current source
Diffstat (limited to '')
| -rw-r--r-- | doc/base/classes.xml | 321 |
1 files changed, 264 insertions, 57 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 0f3e1a3f0..cc2954c89 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<doc version="2.1.1.stable.custom_build" name="Engine Types"> +<doc version="2.1.stable.custom_build" name="Engine Types"> <class name="@GDScript" category="Core"> <brief_description> Built-in GDScript functions. @@ -2159,6 +2159,22 @@ <description> </description> <methods> + <method name="_compute_cost" qualifiers="virtual"> + <argument index="0" name="from_id" type="int"> + </argument> + <argument index="1" name="to_id" type="int"> + </argument> + <description> + </description> + </method> + <method name="_estimate_cost" qualifiers="virtual"> + <argument index="0" name="from_id" type="int"> + </argument> + <argument index="1" name="to_id" type="int"> + </argument> + <description> + </description> + </method> <method name="add_point"> <argument index="0" name="id" type="int"> </argument> @@ -8880,6 +8896,28 @@ <constants> </constants> </class> +<class name="ColorFrame" inherits="Control" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_frame_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="set_frame_color"> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> <class name="ColorPicker" inherits="BoxContainer" category="Core"> <brief_description> Color picker control. @@ -9853,8 +9891,6 @@ </description> </method> <method name="has_point" qualifiers="virtual"> - <return type="bool"> - </return> <argument index="0" name="point" type="Vector2"> </argument> <description> @@ -12776,6 +12812,14 @@ Return a md5 String representing the file at the given path or an empty [String] on failure. </description> </method> + <method name="get_modified_time" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="file" type="String"> + </argument> + <description> + </description> + </method> <method name="get_pascal_string"> <return type="String"> </return> @@ -13736,6 +13780,42 @@ <description> </description> </method> + <method name="get_closest_point_to_segment_2d"> + <return type="Vector2"> + </return> + <argument index="0" name="point" type="Vector2"> + </argument> + <argument index="1" name="s1" type="Vector2"> + </argument> + <argument index="2" name="s2" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="get_closest_point_to_segment_uncapped"> + <return type="Vector3"> + </return> + <argument index="0" name="point" type="Vector3"> + </argument> + <argument index="1" name="s1" type="Vector3"> + </argument> + <argument index="2" name="s2" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="get_closest_point_to_segment_uncapped_2d"> + <return type="Vector2"> + </return> + <argument index="0" name="point" type="Vector2"> + </argument> + <argument index="1" name="s1" type="Vector2"> + </argument> + <argument index="2" name="s2" type="Vector2"> + </argument> + <description> + </description> + </method> <method name="get_closest_points_between_segments"> <return type="Vector3Array"> </return> @@ -15268,12 +15348,6 @@ Set connection to use, for this client. </description> </method> - <method name="set_ip_type"> - <argument index="0" name="ip_type" type="int"> - </argument> - <description> - </description> - </method> <method name="set_read_chunk_size"> <argument index="0" name="bytes" type="int"> </argument> @@ -15517,12 +15591,6 @@ Set the file to download into. Outputs the response body into the file. </description> </method> - <method name="set_ip_type"> - <argument index="0" name="ip_type" type="int"> - </argument> - <description> - </description> - </method> <method name="set_max_redirects"> <argument index="0" name="amount" type="int"> </argument> @@ -16271,6 +16339,12 @@ Returns an [Array] containing the device IDs of all currently connected joysticks. </description> </method> + <method name="get_gravity"> + <return type="Vector3"> + </return> + <description> + </description> + </method> <method name="get_gyroscope"> <return type="Vector3"> </return> @@ -16432,6 +16506,12 @@ Returns true or false depending on whether mouse button is pressed or not. You can pass BUTTON_*, which are pre-defined constants listed in [@Global Scope]. </description> </method> + <method name="parse_input_event"> + <argument index="0" name="event" type="InputEvent"> + </argument> + <description> + </description> + </method> <method name="remove_joy_mapping"> <argument index="0" name="guid" type="String"> </argument> @@ -18804,6 +18884,16 @@ Return true if there would be a collision if the body moved in the given direction. </description> </method> + <method name="test_move_from"> + <return type="bool"> + </return> + <argument index="0" name="from" type="Matrix32"> + </argument> + <argument index="1" name="rel_vec" type="Vector2"> + </argument> + <description> + </description> + </method> </methods> <constants> </constants> @@ -22151,8 +22241,11 @@ </return> <argument index="0" name="use_instancing" type="bool" default="false"> </argument> + <argument index="1" name="flags" type="int" default="7"> + </argument> <description> - Duplicate the node, returning a new [Node]. If [code]use_instancing[/code] is true, the duplicated node will be a new instance of the original [PackedScene], if not it will be an independent node. The duplicated node has the same group assignments and signals as the original one. + Duplicate the node, returning a new [Node]. If [code]use_instancing[/code] is true, the duplicated node will be a new instance of the original [PackedScene], if not it will be an independent node. + The flags are used to define what attributes (groups, signals, scripts) should be duplicated, as specified by the DUPLICATE_* constants. The default value is all of them. </description> </method> <method name="find_node" qualifiers="const"> @@ -22604,6 +22697,12 @@ </constant> <constant name="PAUSE_MODE_PROCESS" value="2"> </constant> + <constant name="DUPLICATE_SIGNALS" value="1"> + </constant> + <constant name="DUPLICATE_GROUPS" value="2"> + </constant> + <constant name="DUPLICATE_SCRIPTS" value="4"> + </constant> </constants> </class> <class name="Node2D" inherits="CanvasItem" category="Core"> @@ -24710,7 +24809,7 @@ </return> <argument index="0" name="port" type="int"> </argument> - <argument index="1" name="bind_address" type="String" default="*"> + <argument index="1" name="bind_address" type="String" default=""*""> </argument> <argument index="2" name="recv_buf_size" type="int" default="65536"> </argument> @@ -24721,12 +24820,6 @@ If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc), the peer will only listen on the interface with that addresses (or fail if no interface with the given address exists). </description> </method> - <method name="set_ip_type"> - <argument index="0" name="ip_type" type="int"> - </argument> - <description> - </description> - </method> <method name="set_send_address"> <return type="int"> </return> @@ -25399,6 +25492,12 @@ <description> </description> </method> + <method name="get_process_mode" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="get_randomness" qualifiers="const"> <return type="float"> </return> @@ -25594,6 +25693,12 @@ <description> </description> </method> + <method name="set_process_mode"> + <argument index="0" name="mode" type="int"> + </argument> + <description> + </description> + </method> <method name="set_randomness"> <argument index="0" name="param" type="int"> </argument> @@ -27200,6 +27305,22 @@ Return whether a body can move in a given direction. Apart from the boolean return value, a [Physics2DTestMotionResult] can be passed to return additional information in. </description> </method> + <method name="body_test_motion_from"> + <return type="bool"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="from" type="Matrix32"> + </argument> + <argument index="2" name="motion" type="Vector2"> + </argument> + <argument index="3" name="margin" type="float" default="0.08"> + </argument> + <argument index="4" name="result" type="Physics2DTestMotionResult" default="NULL"> + </argument> + <description> + </description> + </method> <method name="damped_spring_joint_create"> <return type="RID"> </return> @@ -32569,6 +32690,14 @@ <description> </description> </method> + <method name="remove_line"> + <return type="bool"> + </return> + <argument index="0" name="arg0" type="int"> + </argument> + <description> + </description> + </method> <method name="scroll_to_line"> <argument index="0" name="line" type="int"> </argument> @@ -33729,22 +33858,22 @@ Return the pitch scale for the given sample. </description> </method> - <method name="sample_get_volume_db" qualifiers="const"> - <return type="float"> + <method name="sample_get_priority" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="name" type="String"> </argument> <description> - Return the volume (in dB) for the given sample. + Return the priority for the given sample. </description> </method> - <method name="sample_get_priority" qualifiers="const"> - <return type="int"> + <method name="sample_get_volume_db" qualifiers="const"> + <return type="float"> </return> <argument index="0" name="name" type="String"> </argument> <description> - Return the priority for the given sample. + Return the volume (in dB) for the given sample. </description> </method> <method name="sample_set_pitch_scale"> @@ -33756,22 +33885,22 @@ Set the pitch scale for the given sample. </description> </method> - <method name="sample_set_volume_db"> + <method name="sample_set_priority"> <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="db" type="float"> + <argument index="1" name="priority" type="int"> </argument> <description> - Set the volume (in dB) for the given sample. + Set the priority for the given sample. </description> </method> - <method name="sample_set_priority"> + <method name="sample_set_volume_db"> <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="priority" type="int"> + <argument index="1" name="db" type="float"> </argument> <description> - Set the priority for the given sample. + Set the volume (in dB) for the given sample. </description> </method> </methods> @@ -34654,6 +34783,12 @@ <description> </description> </method> + <method name="is_input_handled"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="is_paused" qualifiers="const"> <return type="bool"> </return> @@ -38370,12 +38505,6 @@ Return whether this peer is connected. Returns true while connecting and connected. </description> </method> - <method name="set_ip_type"> - <argument index="0" name="ip_type" type="int"> - </argument> - <description> - </description> - </method> </methods> <constants> <constant name="STATUS_NONE" value="0"> @@ -39851,7 +39980,7 @@ </return> <argument index="0" name="port" type="int"> </argument> - <argument index="1" name="bind_address" type="String" default="*"> + <argument index="1" name="bind_address" type="String" default=""*""> </argument> <description> Listen on the "port" binding to "bind_address". @@ -39860,12 +39989,6 @@ If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc), the server will only listen on the interface with that addresses (or fail if no interface with the given address exists). </description> </method> - <method name="set_ip_type"> - <argument index="0" name="ip_type" type="int"> - </argument> - <description> - </description> - </method> <method name="stop"> <description> Stop listening. @@ -39905,13 +40028,6 @@ Return the current tab index that is being shown. </description> </method> - <method name="get_previous_tab" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the previous tab index that was being shown. - </description> - </method> <method name="get_current_tab_control" qualifiers="const"> <return type="Control"> </return> @@ -39925,6 +40041,13 @@ <description> </description> </method> + <method name="get_previous_tab" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the previous tab index that was being shown. + </description> + </method> <method name="get_tab_align" qualifiers="const"> <return type="int"> </return> @@ -40027,8 +40150,8 @@ </argument> <description> Emitted when a tab is being selected, even if it is the same tab. - </description> - </signal> + </description> + </signal> </signals> <constants> </constants> @@ -40869,6 +40992,18 @@ <description> </description> </method> + <method name="get_resize_mode" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_stretch_mode" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="get_texture_scale" qualifiers="const"> <return type="Vector2"> </return> @@ -40917,6 +41052,18 @@ <description> </description> </method> + <method name="set_resize_mode"> + <argument index="0" name="p_mode" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_stretch_mode"> + <argument index="0" name="p_mode" type="int"> + </argument> + <description> + </description> + </method> <method name="set_texture_scale"> <argument index="0" name="scale" type="Vector2"> </argument> @@ -40925,6 +41072,22 @@ </method> </methods> <constants> + <constant name="STRETCH_SCALE_ON_EXPAND" value="0"> + </constant> + <constant name="STRETCH_SCALE" value="1"> + </constant> + <constant name="STRETCH_TILE" value="2"> + </constant> + <constant name="STRETCH_KEEP" value="3"> + </constant> + <constant name="STRETCH_KEEP_CENTERED" value="4"> + </constant> + <constant name="STRETCH_KEEP_ASPECT" value="5"> + </constant> + <constant name="STRETCH_KEEP_ASPECT_CENTERED" value="6"> + </constant> + <constant name="STRETCH_KEEP_ASPECT_COVERED" value="7"> + </constant> </constants> </class> <class name="TextureFrame" inherits="Control" category="Core"> @@ -40999,6 +41162,8 @@ </constant> <constant name="STRETCH_KEEP_ASPECT_CENTERED" value="6"> </constant> + <constant name="STRETCH_KEEP_ASPECT_COVERED" value="7"> + </constant> </constants> </class> <class name="TextureProgress" inherits="Range" category="Core"> @@ -41582,6 +41747,12 @@ Return an array of all cells containing a tile from the tileset (i.e. a tile index different from -1). </description> </method> + <method name="get_used_rect"> + <return type="Rect2"> + </return> + <description> + </description> + </method> <method name="is_cell_transposed" qualifiers="const"> <return type="bool"> </return> @@ -42270,6 +42441,12 @@ <description> </description> </method> + <method name="get_shape" qualifiers="const"> + <return type="Object"> + </return> + <description> + </description> + </method> <method name="get_texture" qualifiers="const"> <return type="Object"> </return> @@ -42300,6 +42477,18 @@ <description> </description> </method> + <method name="is_shape_centered" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_shape_visible" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="set_action"> <argument index="0" name="action" type="String"> </argument> @@ -42318,6 +42507,24 @@ <description> </description> </method> + <method name="set_shape"> + <argument index="0" name="shape" type="Object"> + </argument> + <description> + </description> + </method> + <method name="set_shape_centered"> + <argument index="0" name="bool" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_shape_visible"> + <argument index="0" name="bool" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_texture"> <argument index="0" name="texture" type="Object"> </argument> |
