diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/base/classes.xml | 1815 |
1 files changed, 1130 insertions, 685 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 0e9b9d333e..2a9350bbdc 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -31,6 +31,7 @@ <argument index="1" name="alpha" type="float"> </argument> <description> + Make a color from color name (color_names.inc) and alpha ranging from 0 to 1. </description> </method> <method name="abs"> @@ -113,6 +114,7 @@ <argument index="0" name="ascii" type="int"> </argument> <description> + Returns a character as String of the given ASCII code. </description> </method> <method name="clamp"> @@ -309,6 +311,10 @@ <argument index="2" name="value" type="float"> </argument> <description> + Returns a normalized value considering the given range. + [codeblock] + inverse_lerp(3, 5, 4) # return 0.5 + [/codeblock] </description> </method> <method name="is_inf"> @@ -335,6 +341,7 @@ <argument index="0" name="var" type="Variant"> </argument> <description> + Returns the length of the given Variant if applicable. It will return character count of a String, element count of an Array, etc. </description> </method> <method name="lerp"> @@ -551,6 +558,10 @@ <argument index="4" name="ostop" type="float"> </argument> <description> + Maps a value from range [istart, istop] to [ostart, ostop]. + [codeblock] + range_lerp(75, 0, 100, -1, 1) # returns 0.5 + [/codeblock] </description> </method> <method name="round"> @@ -667,6 +678,11 @@ <argument index="0" name="type" type="String"> </argument> <description> + Returns whether the given class is exist in [ClassDB]. + [codeblock] + type_exists("Sprite") # returns true + type_exists("Variant") # returns false + [/codeblock] </description> </method> <method name="typeof"> @@ -753,6 +769,7 @@ </methods> <members> <member name="ARVRServer" type="ARVRServer" setter="" getter="" brief=""> + [ARVRServer] singleton </member> <member name="AudioServer" type="AudioServer" setter="" getter="" brief=""> [AudioServer] singleton @@ -1944,18 +1961,25 @@ Variable is of type [Array]. </constant> <constant name="TYPE_RAW_ARRAY" value="20"> + Variable is of type [PoolByteArray]. </constant> <constant name="TYPE_INT_ARRAY" value="21"> + Variable is of type [PoolIntArray]. </constant> <constant name="TYPE_REAL_ARRAY" value="22"> + Variable is of type [PoolRealArray]. </constant> <constant name="TYPE_STRING_ARRAY" value="23"> + Variable is of type [PoolStringArray]. </constant> <constant name="TYPE_VECTOR2_ARRAY" value="24"> + Variable is of type [PoolVector2Array]. </constant> <constant name="TYPE_VECTOR3_ARRAY" value="25"> + Variable is of type [PoolVector3Array]. </constant> <constant name="TYPE_COLOR_ARRAY" value="26"> + Variable is of type [PoolColorArray]. </constant> <constant name="TYPE_MAX" value="27"> </constant> @@ -2274,7 +2298,7 @@ </description> </method> <method name="get_type" qualifiers="const"> - <return type="int"> + <return type="int" enum="ARVRServer.TrackerType"> </return> <description> </description> @@ -2553,7 +2577,7 @@ </argument> <argument index="1" name="pos" type="Vector3"> </argument> - <argument index="2" name="weight_scale" type="float" default="null"> + <argument index="2" name="weight_scale" type="float" default="1.0"> </argument> <description> Add a new point at the given position [code]pos[/code] with the given identifier [code]id[/code]. The [code]weight_scale[/code] has to be 1 or larger. @@ -2584,7 +2608,7 @@ </argument> <argument index="1" name="to_id" type="int"> </argument> - <argument index="2" name="bidirectional" type="bool" default="null"> + <argument index="2" name="bidirectional" type="bool" default="true"> </argument> <description> Create a segment between points [code]id[/code] and [code]to_id[/code]. @@ -2702,7 +2726,7 @@ </argument> <argument index="1" name="right" type="bool" default="false"> </argument> - <argument index="2" name="action" type="String" default="null"> + <argument index="2" name="action" type="String" default=""""> </argument> <description> Add custom button to the dialog and return the created button. @@ -3086,7 +3110,7 @@ </return> <argument index="0" name="type" type="int" enum="Animation.TrackType"> </argument> - <argument index="1" name="at_pos" type="int" default="null"> + <argument index="1" name="at_pos" type="int" default="-1"> </argument> <description> Add a track to the Animation. The track type must be specified as any of the values in the TYPE_* enumeration. @@ -3214,7 +3238,7 @@ </argument> <argument index="1" name="time" type="float"> </argument> - <argument index="2" name="exact" type="bool" default="null"> + <argument index="2" name="exact" type="bool" default="false"> </argument> <description> Find the key index by time in a given track. Optionally, only find it if the exact time is given. @@ -3229,7 +3253,7 @@ </description> </method> <method name="track_get_interpolation_type" qualifiers="const"> - <return type="int"> + <return type="int" enum="Animation.InterpolationType"> </return> <argument index="0" name="idx" type="int"> </argument> @@ -3289,7 +3313,7 @@ </description> </method> <method name="track_get_type" qualifiers="const"> - <return type="int"> + <return type="int" enum="Animation.TrackType"> </return> <argument index="0" name="idx" type="int"> </argument> @@ -3306,7 +3330,7 @@ </argument> <argument index="2" name="key" type="Variant"> </argument> - <argument index="3" name="transition" type="float" default="null"> + <argument index="3" name="transition" type="float" default="1"> </argument> <description> Insert a generic key in a given track. @@ -3472,11 +3496,12 @@ </description> </method> <method name="value_track_get_update_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Animation.UpdateMode"> </return> <argument index="0" name="idx" type="int"> </argument> <description> + Return the update mode of a value track. </description> </method> <method name="value_track_set_update_mode"> @@ -3487,6 +3512,7 @@ <argument index="1" name="mode" type="int" enum="Animation.UpdateMode"> </argument> <description> + Set the update mode (UPDATE_*) of a value track. </description> </method> </methods> @@ -3510,10 +3536,13 @@ Cubic interpolation. </constant> <constant name="UPDATE_CONTINUOUS" value="0"> + Update between keyframes. </constant> <constant name="UPDATE_DISCRETE" value="1"> + Update at the keyframes and hold the value. </constant> <constant name="UPDATE_TRIGGER" value="2"> + Update at the keyframes. </constant> </constants> </class> @@ -3526,7 +3555,7 @@ </description> <methods> <method name="add_animation"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="name" type="String"> </argument> @@ -3551,6 +3580,7 @@ <argument index="0" name="anim_from" type="String"> </argument> <description> + Return the name of the next animation in the queue. </description> </method> <method name="animation_set_next"> @@ -3561,6 +3591,7 @@ <argument index="1" name="anim_to" type="String"> </argument> <description> + Set the name of an animation that will be played after. </description> </method> <method name="clear_caches"> @@ -3603,7 +3634,7 @@ </description> </method> <method name="get_animation_process_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="AnimationPlayer.AnimationProcessMode"> </return> <description> Return the mode in which the animation player processes. See [method set_animation_process_mode]. @@ -3702,13 +3733,13 @@ <method name="play"> <return type="void"> </return> - <argument index="0" name="name" type="String" default="false"> + <argument index="0" name="name" type="String" default=""""> </argument> - <argument index="1" name="custom_blend" type="float" default="1.0"> + <argument index="1" name="custom_blend" type="float" default="-1"> </argument> - <argument index="2" name="custom_speed" type="float" default="-1"> + <argument index="2" name="custom_speed" type="float" default="1.0"> </argument> - <argument index="3" name="from_end" type="bool" default=""""> + <argument index="3" name="from_end" type="bool" default="false"> </argument> <description> Play a given animation by the animation name. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards. @@ -3717,9 +3748,9 @@ <method name="play_backwards"> <return type="void"> </return> - <argument index="0" name="name" type="String" default="-1"> + <argument index="0" name="name" type="String" default=""""> </argument> - <argument index="1" name="custom_blend" type="float" default=""""> + <argument index="1" name="custom_blend" type="float" default="-1"> </argument> <description> Play a given animation by the animation name in reverse. @@ -3759,7 +3790,7 @@ </return> <argument index="0" name="pos_sec" type="float"> </argument> - <argument index="1" name="update" type="bool" default="null"> + <argument index="1" name="update" type="bool" default="false"> </argument> <description> Seek the animation to a given position in time (in seconds). If 'update' is true, the animation will be updated too, otherwise it will be updated at process time. @@ -3933,6 +3964,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns an animation given its name. </description> </method> <method name="animation_node_get_master_animation" qualifiers="const"> @@ -3986,6 +4018,7 @@ <argument index="2" name="dst_input_idx" type="int"> </argument> <description> + Returns whether node [code]id[/code] and [code]dst_id[/code] are connected at the specified slot. </description> </method> <method name="blend2_node_get_amount" qualifiers="const"> @@ -3994,6 +4027,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns the blend amount of a Blend2 node given its name. </description> </method> <method name="blend2_node_set_amount"> @@ -4004,6 +4038,7 @@ <argument index="1" name="blend" type="float"> </argument> <description> + Sets the blend amount of a Blend2 node given its name and value. </description> </method> <method name="blend2_node_set_filter_path"> @@ -4024,6 +4059,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns the blend amount of a Blend3 node given its name. </description> </method> <method name="blend3_node_set_amount"> @@ -4034,6 +4070,7 @@ <argument index="1" name="blend" type="float"> </argument> <description> + Sets the blend amount of a Blend3 node given its name and value. </description> </method> <method name="blend4_node_get_amount" qualifiers="const"> @@ -4042,6 +4079,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns the blend amount of a Blend4 node given its name. </description> </method> <method name="blend4_node_set_amount"> @@ -4052,10 +4090,11 @@ <argument index="1" name="blend" type="Vector2"> </argument> <description> + Sets the blend amount of a Blend4 node given its name and value. </description> </method> <method name="connect_nodes"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="id" type="String"> </argument> @@ -4064,6 +4103,7 @@ <argument index="2" name="dst_input_idx" type="int"> </argument> <description> + Connects node [code]id[/code] to [code]dst_id[/code] at the specified input slot. </description> </method> <method name="disconnect_nodes"> @@ -4074,12 +4114,14 @@ <argument index="1" name="dst_input_idx" type="int"> </argument> <description> + Disconnects nodes connected to [code]id[/code] at the specified input slot. </description> </method> <method name="get_animation_process_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="AnimationTreePlayer.AnimationProcessMode"> </return> <description> + Returns playback process mode of this AnimationTreePlayer. </description> </method> <method name="get_base_path" qualifiers="const"> @@ -4098,12 +4140,14 @@ <return type="PoolStringArray"> </return> <description> + 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"> @@ -4112,6 +4156,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns mix amount of a Mix node given its name. </description> </method> <method name="mix_node_set_amount"> @@ -4122,6 +4167,7 @@ <argument index="1" name="ratio" type="float"> </argument> <description> + Sets mix amount of a Mix node given its name and value. </description> </method> <method name="node_exists" qualifiers="const"> @@ -4159,10 +4205,11 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns position of a node in the graph given its name. </description> </method> <method name="node_get_type" qualifiers="const"> - <return type="int"> + <return type="int" enum="AnimationTreePlayer.NodeType"> </return> <argument index="0" name="id" type="String"> </argument> @@ -4171,7 +4218,7 @@ </description> </method> <method name="node_rename"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="node" type="String"> </argument> @@ -4189,6 +4236,7 @@ <argument index="1" name="screen_pos" type="Vector2"> </argument> <description> + Sets position of a node in the graph given its name and position. </description> </method> <method name="oneshot_node_get_autorestart_delay" qualifiers="const"> @@ -4197,6 +4245,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns autostart delay of a OneShot node given its name. </description> </method> <method name="oneshot_node_get_autorestart_random_delay" qualifiers="const"> @@ -4205,6 +4254,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns autostart random delay of a OneShot node given its name. </description> </method> <method name="oneshot_node_get_fadein_time" qualifiers="const"> @@ -4213,6 +4263,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns fade in time of a OneShot node given its name. </description> </method> <method name="oneshot_node_get_fadeout_time" qualifiers="const"> @@ -4221,6 +4272,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns fade out time of a OneShot node given its name. </description> </method> <method name="oneshot_node_has_autorestart" qualifiers="const"> @@ -4229,6 +4281,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns whether a OneShot node will auto restart given its name. </description> </method> <method name="oneshot_node_is_active" qualifiers="const"> @@ -4237,6 +4290,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns whether a OneShot node is active given its name. </description> </method> <method name="oneshot_node_set_autorestart"> @@ -4247,6 +4301,7 @@ <argument index="1" name="enable" type="bool"> </argument> <description> + Sets autorestart property of a OneShot node given its name and value. </description> </method> <method name="oneshot_node_set_autorestart_delay"> @@ -4257,6 +4312,7 @@ <argument index="1" name="delay_sec" type="float"> </argument> <description> + Sets autorestart delay of a OneShot node given its name and value in seconds. </description> </method> <method name="oneshot_node_set_autorestart_random_delay"> @@ -4267,6 +4323,7 @@ <argument index="1" name="rand_sec" type="float"> </argument> <description> + Sets autorestart random delay of a OneShot node given its name and value in seconds. </description> </method> <method name="oneshot_node_set_fadein_time"> @@ -4277,6 +4334,7 @@ <argument index="1" name="time_sec" type="float"> </argument> <description> + Sets fade in time of a OneShot node given its name and value in seconds. </description> </method> <method name="oneshot_node_set_fadeout_time"> @@ -4287,6 +4345,7 @@ <argument index="1" name="time_sec" type="float"> </argument> <description> + Sets fade out time of a OneShot node given its name and value in seconds. </description> </method> <method name="oneshot_node_set_filter_path"> @@ -4307,6 +4366,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Starts a OneShot node given its name. </description> </method> <method name="oneshot_node_stop"> @@ -4315,6 +4375,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Stops a OneShot node given its name. </description> </method> <method name="recompute_caches"> @@ -4335,6 +4396,7 @@ <return type="void"> </return> <description> + Resets this AnimationTreePlayer. </description> </method> <method name="set_active"> @@ -4343,6 +4405,7 @@ <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_animation_process_mode"> @@ -4351,6 +4414,7 @@ <argument index="0" name="mode" type="int" enum="AnimationTreePlayer.AnimationProcessMode"> </argument> <description> + Sets process mode (ANIMATION_PROCESS_*) of this AnimationTreePlayer. </description> </method> <method name="set_base_path"> @@ -4359,6 +4423,7 @@ <argument index="0" name="path" type="NodePath"> </argument> <description> + Sets base path of this AnimationTreePlayer. </description> </method> <method name="set_master_player"> @@ -4375,6 +4440,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns time scale value of a TimeScale node given its name. </description> </method> <method name="timescale_node_set_scale"> @@ -4385,6 +4451,7 @@ <argument index="1" name="scale" type="float"> </argument> <description> + Sets time scale value of a TimeScale node given its name and value. </description> </method> <method name="timeseek_node_seek"> @@ -4395,6 +4462,7 @@ <argument index="1" name="pos_sec" type="float"> </argument> <description> + Sets time seek value of a TimeSeek node given its name and value. </description> </method> <method name="transition_node_delete_input"> @@ -4490,24 +4558,34 @@ </members> <constants> <constant name="NODE_OUTPUT" value="0"> + Output node. </constant> <constant name="NODE_ANIMATION" value="1"> + Animation node. </constant> <constant name="NODE_ONESHOT" value="2"> + OneShot node. </constant> <constant name="NODE_MIX" value="3"> + Mix node. </constant> <constant name="NODE_BLEND2" value="4"> + Blend2 node. </constant> <constant name="NODE_BLEND3" value="5"> + Blend3 node. </constant> <constant name="NODE_BLEND4" value="6"> + Blend4 node. </constant> <constant name="NODE_TIMESCALE" value="7"> + TimeScale node. </constant> <constant name="NODE_TIMESEEK" value="8"> + TimeSeek node. </constant> <constant name="NODE_TRANSITION" value="9"> + Transition node. </constant> </constants> </class> @@ -4632,7 +4710,7 @@ </description> </method> <method name="get_space_override_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Area.SpaceOverride"> </return> <description> Return the space override mode. @@ -5106,7 +5184,7 @@ </description> </method> <method name="get_space_override_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Area2D.SpaceOverride"> </return> <description> Return the space override mode. @@ -5670,7 +5748,7 @@ <argument index="1" name="func" type="String"> </argument> <description> - Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. + Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. </description> </method> </methods> @@ -5698,9 +5776,9 @@ </argument> <argument index="1" name="arrays" type="Array"> </argument> - <argument index="2" name="blend_shapes" type="Array" default="null"> + <argument index="2" name="blend_shapes" type="Array" default="[ ]"> </argument> - <argument index="3" name="compress_flags" type="int" default="null"> + <argument index="3" name="compress_flags" type="int" default="97792"> </argument> <description> Create a new surface ([method get_surface_count] that will become surf_idx for this. @@ -5726,7 +5804,7 @@ </description> </method> <method name="get_blend_shape_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Mesh.BlendShapeMode"> </return> <description> </description> @@ -5819,7 +5897,7 @@ </description> </method> <method name="surface_get_primitive_type" qualifiers="const"> - <return type="int"> + <return type="int" enum="Mesh.PrimitiveType"> </return> <argument index="0" name="surf_idx" type="int"> </argument> @@ -6630,7 +6708,7 @@ </description> </method> <method name="get_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="AudioEffectDistortion.Mode"> </return> <description> </description> @@ -6780,7 +6858,7 @@ </description> </method> <method name="get_db" qualifiers="const"> - <return type="int"> + <return type="int" enum="AudioEffectFilter.FilterDB"> </return> <description> </description> @@ -7340,7 +7418,7 @@ </argument> <argument index="1" name="effect" type="AudioEffect"> </argument> - <argument index="2" name="at_pos" type="int" default="null"> + <argument index="2" name="at_pos" type="int" default="-1"> </argument> <description> </description> @@ -7434,7 +7512,7 @@ </description> </method> <method name="get_speaker_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="AudioServer.SpeakerMode"> </return> <description> </description> @@ -7720,7 +7798,7 @@ </description> </method> <method name="get_mix_target" qualifiers="const"> - <return type="int"> + <return type="int" enum="AudioStreamPlayer.MixTarget"> </return> <description> </description> @@ -8032,7 +8110,7 @@ </description> </method> <method name="get_attenuation_model" qualifiers="const"> - <return type="int"> + <return type="int" enum="AudioStreamPlayer3D.AttenuationModel"> </return> <description> </description> @@ -8044,7 +8122,7 @@ </description> </method> <method name="get_doppler_tracking" qualifiers="const"> - <return type="int"> + <return type="int" enum="AudioStreamPlayer3D.DopplerTracking"> </return> <description> </description> @@ -8074,7 +8152,7 @@ </description> </method> <method name="get_out_of_range_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="AudioStreamPlayer3D.OutOfRangeMode"> </return> <description> </description> @@ -8390,7 +8468,7 @@ </description> </method> <method name="get_format" qualifiers="const"> - <return type="int"> + <return type="int" enum="AudioStreamSample.Format"> </return> <description> </description> @@ -8408,7 +8486,7 @@ </description> </method> <method name="get_loop_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="AudioStreamSample.LoopMode"> </return> <description> </description> @@ -8510,7 +8588,7 @@ </description> <methods> <method name="get_copy_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="BackBufferCopy.CopyMode"> </return> <description> Return the copy mode currently applied to the BackBufferCopy (refer to constants section). @@ -8585,7 +8663,7 @@ </description> </method> <method name="get_action_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="BaseButton.ActionMode"> </return> <description> Return the current mode of action (see [method set_action_mode]) (one of the ACTION_MODE_* constants). @@ -8598,14 +8676,14 @@ </description> </method> <method name="get_draw_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="BaseButton.DrawMode"> </return> <description> Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW_* enum. </description> </method> <method name="get_enabled_focus_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Control.FocusMode"> </return> <description> Returns focus access mode used when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]). @@ -8947,8 +9025,10 @@ </class> <class name="BitMap" inherits="Resource" category="Core"> <brief_description> + Boolean matrix. </brief_description> <description> + A two-dimensional array of boolean values, can be used to efficiently store a binary matrix (every matrix element takes only one bit) and query the values using natural cartesian coordinates. </description> <methods> <method name="create"> @@ -8957,6 +9037,7 @@ <argument index="0" name="size" type="Vector2"> </argument> <description> + Creates a bitmap with the specified size, filled with false. </description> </method> <method name="create_from_image_alpha"> @@ -8965,6 +9046,7 @@ <argument index="0" name="image" type="Image"> </argument> <description> + Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to false if the alpha value of the image at that position is 0, and true in other case. </description> </method> <method name="get_bit" qualifiers="const"> @@ -8973,18 +9055,21 @@ <argument index="0" name="pos" type="Vector2"> </argument> <description> + Returns bitmap's value at the specified position. </description> </method> <method name="get_size" qualifiers="const"> <return type="Vector2"> </return> <description> + Returns bitmap's dimensions. </description> </method> <method name="get_true_bit_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the amount of bitmap elements that are set to true. </description> </method> <method name="set_bit"> @@ -8995,6 +9080,7 @@ <argument index="1" name="bit" type="bool"> </argument> <description> + Sets the bitmap's element at the specified position, to the specified value. </description> </method> <method name="set_bit_rect"> @@ -9005,6 +9091,7 @@ <argument index="1" name="bit" type="bool"> </argument> <description> + Sets a rectangular portion of the bitmap to the specified value. </description> </method> </methods> @@ -9030,9 +9117,9 @@ </argument> <argument index="2" name="rect" type="Rect2"> </argument> - <argument index="3" name="align" type="Vector2" default="null"> + <argument index="3" name="align" type="Vector2" default="Vector2( 0, 0 )"> </argument> - <argument index="4" name="advance" type="float" default="null"> + <argument index="4" name="advance" type="float" default="-1"> </argument> <description> Add a character to the font, where [i]character[/i] is the unicode value, [i]texture[/i] is the texture index, [i]rect[/i] is the region in the texture (in pixels!), [i]align[/i] is the (optional) alignment for the character and [i]advance[/i] is the (optional) advance. @@ -9068,7 +9155,7 @@ </description> </method> <method name="create_from_fnt"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> @@ -9080,7 +9167,7 @@ </return> <argument index="0" name="char" type="int"> </argument> - <argument index="1" name="next" type="int" default="null"> + <argument index="1" name="next" type="int" default="0"> </argument> <description> Return the size of a character, optionally taking kerning into account if the next character is provided. @@ -9216,7 +9303,7 @@ </description> </method> <method name="get_alignment" qualifiers="const"> - <return type="int"> + <return type="int" enum="BoxContainer.AlignMode"> </return> <description> Return the alignment of children in the container. @@ -9292,35 +9379,30 @@ <return type="Texture"> </return> <description> - Return the button icon. </description> </method> <method name="get_clip_text" qualifiers="const"> <return type="bool"> </return> <description> - Return the state of the [i]clip_text[/i] property (see [method set_clip_text]) </description> </method> <method name="get_text" qualifiers="const"> <return type="String"> </return> <description> - Return the button text. </description> </method> <method name="get_text_align" qualifiers="const"> - <return type="int"> + <return type="int" enum="Button.TextAlign"> </return> <description> - Return the text alignment policy. </description> </method> <method name="is_flat" qualifiers="const"> <return type="bool"> </return> <description> - Return the state of the [i]flat[/i] property (see [method set_flat]). </description> </method> <method name="set_button_icon"> @@ -9329,7 +9411,6 @@ <argument index="0" name="texture" type="Texture"> </argument> <description> - Set the icon that will be displayed next to the text inside the button area. </description> </method> <method name="set_clip_text"> @@ -9338,7 +9419,6 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the [i]clip_text[/i] property of a Button. When this property is enabled, text that is too large to fit the button is clipped, when disabled (default) the Button will always be wide enough to hold the text. </description> </method> <method name="set_flat"> @@ -9347,7 +9427,6 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the [i]flat[/i] property of a Button. Flat buttons don't display decoration unless hovered or pressed. </description> </method> <method name="set_text"> @@ -9356,7 +9435,6 @@ <argument index="0" name="text" type="String"> </argument> <description> - Set the button text, which will be displayed inside the button area. </description> </method> <method name="set_text_align"> @@ -9365,20 +9443,24 @@ <argument index="0" name="align" type="int" enum="Button.TextAlign"> </argument> <description> - Set the text alignment policy, using one of the ALIGN_* constants. </description> </method> </methods> <members> <member name="align" type="int" setter="set_text_align" getter="get_text_align" brief="" enum="Button.TextAlign"> + Text alignment policy for the button's text, use one of the ALIGN_* constants. </member> <member name="clip_text" type="bool" setter="set_clip_text" getter="get_clip_text" brief=""> + When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. This property is disabled by default. </member> - <member name="flat" type="bool" setter="set_flat" getter="is_flat" brief=""> + <member name="flat" type="bool" setter="set_flat" getter="is_flat" brief="button decoration mode"> + Flat buttons don't display decoration. </member> <member name="icon" type="Texture" setter="set_button_icon" getter="get_button_icon" brief=""> + Button's icon, if text is present the icon will be placed before the text. </member> <member name="text" type="String" setter="set_text" getter="get_text" brief=""> + The button's text that will be displayed inside the button's area. </member> </members> <constants> @@ -9386,7 +9468,7 @@ Align the text to the left. </constant> <constant name="ALIGN_CENTER" value="1"> - Center the text. + Align the text to the center. </constant> <constant name="ALIGN_RIGHT" value="2"> Align the text to the right. @@ -9468,7 +9550,7 @@ </description> </method> <method name="get_doppler_tracking" qualifiers="const"> - <return type="int"> + <return type="int" enum="Camera.DopplerTracking"> </return> <description> </description> @@ -9492,13 +9574,13 @@ </description> </method> <method name="get_keep_aspect_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Camera.KeepAspect"> </return> <description> </description> </method> <method name="get_projection" qualifiers="const"> - <return type="int"> + <return type="int" enum="Camera.Projection"> </return> <description> </description> @@ -9716,7 +9798,7 @@ </description> </method> <method name="get_anchor_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Camera2D.AnchorMode"> </return> <description> </description> @@ -10086,7 +10168,7 @@ </argument> <argument index="3" name="next" type="String"> </argument> - <argument index="4" name="modulate" type="Color" default="null"> + <argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> </argument> <description> Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char. @@ -10112,13 +10194,13 @@ </argument> <argument index="1" name="color" type="Color"> </argument> - <argument index="2" name="uvs" type="PoolVector2Array" default="null"> + <argument index="2" name="uvs" type="PoolVector2Array" default="PoolVector2Array( )"> </argument> - <argument index="3" name="texture" type="Texture" default="PoolVector2Array( )"> + <argument index="3" name="texture" type="Texture" default="null"> </argument> <argument index="4" name="normal_map" type="Texture" default="null"> </argument> - <argument index="5" name="antialiased" type="bool" default="null"> + <argument index="5" name="antialiased" type="bool" default="false"> </argument> <description> Draw a colored polygon of any amount of points, convex or concave. @@ -10133,9 +10215,9 @@ </argument> <argument index="2" name="color" type="Color"> </argument> - <argument index="3" name="width" type="float" default="null"> + <argument index="3" name="width" type="float" default="1.0"> </argument> - <argument index="4" name="antialiased" type="bool" default="null"> + <argument index="4" name="antialiased" type="bool" default="false"> </argument> <description> Draw a line from a 2D point to another, with a given color and width. It can be optionally antialiased. @@ -10148,13 +10230,13 @@ </argument> <argument index="1" name="colors" type="PoolColorArray"> </argument> - <argument index="2" name="uvs" type="PoolVector2Array" default="null"> + <argument index="2" name="uvs" type="PoolVector2Array" default="PoolVector2Array( )"> </argument> - <argument index="3" name="texture" type="Texture" default="PoolVector2Array( )"> + <argument index="3" name="texture" type="Texture" default="null"> </argument> <argument index="4" name="normal_map" type="Texture" default="null"> </argument> - <argument index="5" name="antialiased" type="bool" default="null"> + <argument index="5" name="antialiased" type="bool" default="false"> </argument> <description> Draw a polygon of any amount of points, convex or concave. @@ -10167,9 +10249,9 @@ </argument> <argument index="1" name="color" type="Color"> </argument> - <argument index="2" name="width" type="float" default="null"> + <argument index="2" name="width" type="float" default="1.0"> </argument> - <argument index="3" name="antialiased" type="bool" default="null"> + <argument index="3" name="antialiased" type="bool" default="false"> </argument> <description> </description> @@ -10181,9 +10263,9 @@ </argument> <argument index="1" name="colors" type="PoolColorArray"> </argument> - <argument index="2" name="width" type="float" default="null"> + <argument index="2" name="width" type="float" default="1.0"> </argument> - <argument index="3" name="antialiased" type="bool" default="null"> + <argument index="3" name="antialiased" type="bool" default="false"> </argument> <description> </description> @@ -10199,7 +10281,7 @@ </argument> <argument index="3" name="texture" type="Texture" default="null"> </argument> - <argument index="4" name="width" type="float" default="null"> + <argument index="4" name="width" type="float" default="1.0"> </argument> <argument index="5" name="normal_map" type="Texture" default="null"> </argument> @@ -10214,7 +10296,7 @@ </argument> <argument index="1" name="color" type="Color"> </argument> - <argument index="2" name="filled" type="bool" default="null"> + <argument index="2" name="filled" type="bool" default="true"> </argument> <description> Draw a colored rectangle. @@ -10250,9 +10332,9 @@ </argument> <argument index="2" name="text" type="String"> </argument> - <argument index="3" name="modulate" type="Color" default="null"> + <argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> </argument> - <argument index="4" name="clip_w" type="int" default="null"> + <argument index="4" name="clip_w" type="int" default="-1"> </argument> <description> Draw a string using a custom font. @@ -10276,7 +10358,7 @@ </argument> <argument index="1" name="pos" type="Vector2"> </argument> - <argument index="2" name="modulate" type="Color" default="null"> + <argument index="2" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> </argument> <argument index="3" name="normal_map" type="Texture" default="null"> </argument> @@ -10293,9 +10375,9 @@ </argument> <argument index="2" name="tile" type="bool"> </argument> - <argument index="3" name="modulate" type="Color" default="null"> + <argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> </argument> - <argument index="4" name="transpose" type="bool" default="null"> + <argument index="4" name="transpose" type="bool" default="false"> </argument> <argument index="5" name="normal_map" type="Texture" default="null"> </argument> @@ -10314,11 +10396,11 @@ </argument> <argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> </argument> - <argument index="4" name="transpose" type="bool" default="null"> + <argument index="4" name="transpose" type="bool" default="false"> </argument> <argument index="5" name="normal_map" type="Texture" default="null"> </argument> - <argument index="6" name="clip_uv" type="bool" default="null"> + <argument index="6" name="clip_uv" type="bool" default="true"> </argument> <description> Draw a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. @@ -10729,13 +10811,13 @@ </description> <methods> <method name="get_blend_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="CanvasItemMaterial.BlendMode"> </return> <description> </description> </method> <method name="get_light_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="CanvasItemMaterial.LightMode"> </return> <description> </description> @@ -10955,8 +11037,10 @@ </class> <class name="CapsuleMesh" inherits="PrimitiveMesh" category="Core"> <brief_description> + Class representing a capsule-shaped [PrimitiveMesh]. </brief_description> <description> + Class representing a capsule-shaped [PrimitiveMesh]. </description> <methods> <method name="get_mid_height" qualifiers="const"> @@ -11018,12 +11102,16 @@ </methods> <members> <member name="mid_height" type="float" setter="set_mid_height" getter="get_mid_height" brief=""> + Height of the capsule mesh from the center point. Defaults to 1.0. </member> <member name="radial_segments" type="int" setter="set_radial_segments" getter="get_radial_segments" brief=""> + Number of radial segments on the capsule mesh. Defaults to 64. </member> <member name="radius" type="float" setter="set_radius" getter="get_radius" brief=""> + Radius of the capsule mesh. Defaults to 1.0. </member> <member name="rings" type="int" setter="set_rings" getter="get_rings" brief=""> + Number of rings along the height of the capsule. Defaults to 8. </member> </members> <constants> @@ -11326,7 +11414,7 @@ </return> <argument index="0" name="class" type="String"> </argument> - <argument index="1" name="no_inheritance" type="bool" default="null"> + <argument index="1" name="no_inheritance" type="bool" default="false"> </argument> <description> </description> @@ -11336,7 +11424,7 @@ </return> <argument index="0" name="class" type="String"> </argument> - <argument index="1" name="no_inheritance" type="bool" default="null"> + <argument index="1" name="no_inheritance" type="bool" default="false"> </argument> <description> </description> @@ -11356,7 +11444,7 @@ </return> <argument index="0" name="class" type="String"> </argument> - <argument index="1" name="no_inheritance" type="bool" default="null"> + <argument index="1" name="no_inheritance" type="bool" default="false"> </argument> <description> </description> @@ -11376,7 +11464,7 @@ </return> <argument index="0" name="class" type="String"> </argument> - <argument index="1" name="no_inheritance" type="bool" default="null"> + <argument index="1" name="no_inheritance" type="bool" default="false"> </argument> <description> </description> @@ -11398,7 +11486,7 @@ </argument> <argument index="1" name="method" type="String"> </argument> - <argument index="2" name="no_inheritance" type="bool" default="null"> + <argument index="2" name="no_inheritance" type="bool" default="false"> </argument> <description> </description> @@ -11414,7 +11502,7 @@ </description> </method> <method name="class_set_property" qualifiers="const"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="object" type="Object"> </argument> @@ -12001,7 +12089,7 @@ </description> <methods> <method name="get_build_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="CollisionPolygon2D.BuildMode"> </return> <description> Return whether the polygon is a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]). @@ -12077,8 +12165,10 @@ </class> <class name="CollisionShape" inherits="Spatial" category="Core"> <brief_description> + Node that represents collision shape data in 3D space. </brief_description> <description> + Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an [Area] to give it a detection shape, or add it to a [PhysicsBody] to give create solid object. [b]IMPORTANT[/b]: this is an Editor-only helper to create shapes, use [method get_shape] to get the actual shape. </description> <methods> <method name="get_shape" qualifiers="const"> @@ -12097,6 +12187,7 @@ <return type="void"> </return> <description> + Sets the collision shape's shape to the addition of all its convexed [MeshInstance] siblings geometry. </description> </method> <method name="resource_changed"> @@ -12105,6 +12196,7 @@ <argument index="0" name="resource" type="Resource"> </argument> <description> + If this method exists within a script it will be called whenever the shape resource has been modified. </description> </method> <method name="set_disabled"> @@ -12126,8 +12218,10 @@ </methods> <members> <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" brief=""> + A disabled collision shape has no effect in the world. </member> <member name="shape" type="Shape" setter="set_shape" getter="get_shape" brief=""> + The actual shape owned by this collision shape. </member> </members> <constants> @@ -12135,17 +12229,16 @@ </class> <class name="CollisionShape2D" inherits="Node2D" category="Core"> <brief_description> - Editor-only class for easy editing of shapes. + Node that represents collision shape data in 2D space. </brief_description> <description> - Editor-only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in [CollisionObject2D]. This is not accessible from regular code. + Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an [Area2D] to give it a detection shape, or add it to a [PhysicsBody2D] to give create solid object. [b]IMPORTANT[/b]: this is an Editor-only helper to create shapes, use [method get_shape] to get the actual shape. </description> <methods> <method name="get_shape" qualifiers="const"> <return type="Shape2D"> </return> <description> - Return this shape's [Shape2D]. </description> </method> <method name="is_disabled" qualifiers="const"> @@ -12182,16 +12275,18 @@ <argument index="0" name="shape" type="Shape2D"> </argument> <description> - Set this shape's [Shape2D]. This will not appear as a node, but can be directly edited as a property. </description> </method> </methods> <members> <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" brief=""> + A disabled collision shape has no effect in the world. </member> <member name="one_way_collision" type="bool" setter="set_one_way_collision" getter="is_one_way_collision_enabled" brief=""> + Sets whether this collision shape should only detect collision on one side (top or bottom). </member> <member name="shape" type="Shape2D" setter="set_shape" getter="get_shape" brief=""> + The actual shape owned by this collision shape. </member> </members> <constants> @@ -12759,7 +12854,7 @@ </description> </method> <method name="load"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> @@ -12768,7 +12863,7 @@ </description> </method> <method name="save"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> @@ -12856,23 +12951,23 @@ </class> <class name="Control" inherits="CanvasItem" category="Core"> <brief_description> - Control is the base node for all the GUI components. + Base node for all User Interface components. </brief_description> <description> - Control is the base class Node for all the GUI components. Every GUI component inherits from it, directly or indirectly. In this way, sections of the scene tree made of contiguous control nodes, become user interfaces. - Controls are relative to the parent position and size by using anchors and margins. This ensures that they can adapt easily in most situation to changing dialog and screen sizes. When more flexibility is desired, [Container] derived nodes can be used. + The base class Node for all User Interface components. Every UI node inherits from it. Any scene or portion of a scene tree composed of Control nodes is a User Interface. + Controls use anchors and margins to place themselves relative to their parent. They adapt automatically when their parent or the screen size changes. To build flexible UIs, use built-in [Container] nodes or create your own. Anchors work by defining which margin do they follow, and a value relative to it. Allowed anchoring modes are ANCHOR_BEGIN, where the margin is relative to the top or left margins of the parent (in pixels), ANCHOR_END for the right and bottom margins of the parent and ANCHOR_RATIO, which is a ratio from 0 to 1 in the parent range. - Input device events are first sent to the root controls via the [method Node._input], which distribute it through the tree, then delivers them to the adequate one (under cursor or keyboard focus based) by calling [method MainLoop._input_event]. There is no need to enable input processing on controls to receive such events. To ensure that no one else will receive the event (not even [method Node._unhandled_input]), the control can accept it by calling [method accept_event]. - Only one control can hold the keyboard focus (receiving keyboard events), for that the control must define the focus mode with [method set_focus_mode]. Focus is lost when another control gains it, or the current focus owner is hidden. - It is sometimes desired for a control to ignore mouse/pointer events. This is often the case when placing other controls on top of a button, in such cases. Calling [method set_ignore_mouse] enables this function. - Finally, controls are skinned according to a [Theme]. Setting a [Theme] on a control will propagate all the skinning down the tree. Optionally, skinning can be overridden per each control by calling the add_*_override functions, or from the editor. + Godot sends Input events to the root node first, via [method Node._input]. The method distributes it through the node tree and delivers the input events to the node under the mouse cursor or on focus with the keyboard. To do so, it calls [method MainLoop._input_event]. No need to enable [method Node.set_process_input] on Controls to receive input events. Call [method accept_event] to ensure no other node receives the event, not even [method Node._unhandled_input]. + Only the one Control node in focus receives keyboard events. To do so, the Control must get the focus mode with [method set_focus_mode]. It loses focus when another Control gets it, or if the current Control in focus is hidden. + You'll sometimes want Controls to ignore mouse or touch events. For example, if you place an icon on top of a button. Call [method set_ignore_mouse] for that. + [Theme] resources change the Control's appearance. If you change the [Theme] on a parent Control node, it will propagate to all of its children. You can override parts of the theme on each Control with the add_*_override methods, like [method add_font_override]. You can also override the theme from the editor. </description> <methods> <method name="_get_minimum_size" qualifiers="virtual"> <return type="Vector2"> </return> <description> - Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. + Returns the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. </description> </method> <method name="_gui_input" qualifiers="virtual"> @@ -12887,7 +12982,7 @@ <return type="void"> </return> <description> - Handles the event, no other control will receive it and it will not be sent to nodes waiting on [method Node._unhandled_input] or [method Node._unhandled_key_input]. + Marks the input event as handled. No other Control will receive it, and the input event will not propagate. Not even to nodes listening to [method Node._unhandled_input] or [method Node._unhandled_key_input]. </description> </method> <method name="add_color_override"> @@ -13004,7 +13099,7 @@ </return> <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="type" type="String" default="null"> + <argument index="1" name="type" type="String" default=""""> </argument> <description> </description> @@ -13020,13 +13115,13 @@ </return> <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="type" type="String" default="null"> + <argument index="1" name="type" type="String" default=""""> </argument> <description> </description> </method> <method name="get_cursor_shape" qualifiers="const"> - <return type="int"> + <return type="int" enum="Control.CursorShape"> </return> <argument index="0" name="pos" type="Vector2" default="Vector2( 0, 0 )"> </argument> @@ -13041,7 +13136,7 @@ </description> </method> <method name="get_default_cursor_shape" qualifiers="const"> - <return type="int"> + <return type="int" enum="Control.CursorShape"> </return> <description> Return the default cursor shape for this control. See enum CURSOR_* for the list of shapes. @@ -13063,7 +13158,7 @@ </description> </method> <method name="get_focus_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Control.FocusMode"> </return> <description> Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see [method set_focus_mode]). @@ -13090,7 +13185,7 @@ </return> <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="type" type="String" default="null"> + <argument index="1" name="type" type="String" default=""""> </argument> <description> </description> @@ -13110,7 +13205,7 @@ </description> </method> <method name="get_h_grow_direction" qualifiers="const"> - <return type="int"> + <return type="int" enum="Control.GrowDirection"> </return> <description> </description> @@ -13127,7 +13222,7 @@ </return> <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="type" type="String" default="null"> + <argument index="1" name="type" type="String" default=""""> </argument> <description> </description> @@ -13149,7 +13244,7 @@ </description> </method> <method name="get_mouse_filter" qualifiers="const"> - <return type="int"> + <return type="int" enum="Control.MouseFilter"> </return> <description> Return when the control is ignoring mouse events (even touchpad events send mouse events). @@ -13226,7 +13321,7 @@ </return> <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="type" type="String" default="null"> + <argument index="1" name="type" type="String" default=""""> </argument> <description> </description> @@ -13248,7 +13343,7 @@ </description> </method> <method name="get_v_grow_direction" qualifiers="const"> - <return type="int"> + <return type="int" enum="Control.GrowDirection"> </return> <description> </description> @@ -13278,7 +13373,7 @@ </return> <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="type" type="String" default="null"> + <argument index="1" name="type" type="String" default=""""> </argument> <description> </description> @@ -13296,7 +13391,7 @@ </return> <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="type" type="String" default="null"> + <argument index="1" name="type" type="String" default=""""> </argument> <description> </description> @@ -13321,7 +13416,7 @@ </return> <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="type" type="String" default="null"> + <argument index="1" name="type" type="String" default=""""> </argument> <description> </description> @@ -13339,7 +13434,7 @@ </return> <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="type" type="String" default="null"> + <argument index="1" name="type" type="String" default=""""> </argument> <description> </description> @@ -13365,7 +13460,7 @@ </return> <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="type" type="String" default="null"> + <argument index="1" name="type" type="String" default=""""> </argument> <description> </description> @@ -13404,9 +13499,9 @@ </argument> <argument index="1" name="anchor" type="float"> </argument> - <argument index="2" name="keep_margin" type="bool" default="null"> + <argument index="2" name="keep_margin" type="bool" default="false"> </argument> - <argument index="3" name="push_opposite_anchor" type="bool" default="null"> + <argument index="3" name="push_opposite_anchor" type="bool" default="true"> </argument> <description> </description> @@ -13420,7 +13515,7 @@ </argument> <argument index="2" name="offset" type="float"> </argument> - <argument index="3" name="push_opposite_anchor" type="bool" default="null"> + <argument index="3" name="push_opposite_anchor" type="bool" default="false"> </argument> <description> </description> @@ -13430,7 +13525,7 @@ </return> <argument index="0" name="preset" type="int" enum="Control.LayoutPreset"> </argument> - <argument index="1" name="keep_margin" type="bool" default="null"> + <argument index="1" name="keep_margin" type="bool" default="false"> </argument> <description> </description> @@ -13742,12 +13837,12 @@ <signals> <signal name="focus_entered"> <description> - Emitted when keyboard focus is gained. + Emitted when the node gains keyboard focus. </description> </signal> <signal name="focus_exited"> <description> - Emitted when the keyboard focus is lost. + Emitted when the node loses keyboard focus. </description> </signal> <signal name="gui_input"> @@ -13758,7 +13853,7 @@ </signal> <signal name="minimum_size_changed"> <description> - Emitted when the minimum size of the control changed. + Emitted when the node's minimum size changes. </description> </signal> <signal name="modal_closed"> @@ -13767,22 +13862,22 @@ </signal> <signal name="mouse_entered"> <description> - Emitted when the mouse enters the control area. + Emitted when the mouse enters the control's area. </description> </signal> <signal name="mouse_exited"> <description> - Emitted when the mouse left the control area. + Emitted when the mouse leaves the control's area. </description> </signal> <signal name="resized"> <description> - Emitted when the control changed size. + Emitted when the control changes size. </description> </signal> <signal name="size_flags_changed"> <description> - Emitted when the size flags changed. + Emitted when the size flags change. </description> </signal> </signals> @@ -14016,7 +14111,7 @@ </description> </method> <method name="get_storage" qualifiers="const"> - <return type="int"> + <return type="int" enum="CubeMap.Storage"> </return> <description> </description> @@ -14093,8 +14188,10 @@ </class> <class name="CubeMesh" inherits="PrimitiveMesh" category="Core"> <brief_description> + Generate an axis-aligned cuboid [PrimitiveMesh]. </brief_description> <description> + Generate an axis-aligned cuboid [PrimitiveMesh]. </description> <methods> <method name="get_size" qualifiers="const"> @@ -14156,12 +14253,16 @@ </methods> <members> <member name="size" type="Vector3" setter="set_size" getter="get_size" brief=""> + Size of the cuboid mesh. Defaults to (2, 2, 2). </member> <member name="subdivide_depth" type="int" setter="set_subdivide_depth" getter="get_subdivide_depth" brief=""> + Number of extra edge loops inserted along the z-axis. Defaults to 0. </member> <member name="subdivide_height" type="int" setter="set_subdivide_height" getter="get_subdivide_height" brief=""> + Number of extra edge loops inserted along the y-axis. Defaults to 0. </member> <member name="subdivide_width" type="int" setter="set_subdivide_width" getter="get_subdivide_width" brief=""> + Number of extra edge loops inserted along the x-axis. Defaults to 0. </member> </members> <constants> @@ -14184,7 +14285,7 @@ </argument> <argument index="3" name="left_mode" type="int" enum="Curve.TangentMode" default="0"> </argument> - <argument index="4" name="right_mode" type="int" enum="Curve.TangentMode" default="null"> + <argument index="4" name="right_mode" type="int" enum="Curve.TangentMode" default="0"> </argument> <description> </description> @@ -14226,7 +14327,7 @@ </description> </method> <method name="get_point_left_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Curve.TangentMode"> </return> <argument index="0" name="index" type="int"> </argument> @@ -14250,7 +14351,7 @@ </description> </method> <method name="get_point_right_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Curve.TangentMode"> </return> <argument index="0" name="index" type="int"> </argument> @@ -14411,7 +14512,7 @@ </argument> <argument index="2" name="out" type="Vector2" default="Vector2( 0, 0 )"> </argument> - <argument index="3" name="atpos" type="int" default="null"> + <argument index="3" name="atpos" type="int" default="-1"> </argument> <description> Adds a point to a curve, at position "pos", with control points "in" and "out". @@ -14496,7 +14597,7 @@ </return> <argument index="0" name="offset" type="float"> </argument> - <argument index="1" name="cubic" type="bool" default="null"> + <argument index="1" name="cubic" type="bool" default="false"> </argument> <description> Returns a point within the curve at position "offset", where "offset" is measured as a pixel distance along the curve. @@ -14567,9 +14668,9 @@ <method name="tessellate" qualifiers="const"> <return type="PoolVector2Array"> </return> - <argument index="0" name="max_stages" type="int" default="4"> + <argument index="0" name="max_stages" type="int" default="5"> </argument> - <argument index="1" name="tolerance_degrees" type="float" default="5"> + <argument index="1" name="tolerance_degrees" type="float" default="4"> </argument> <description> Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. @@ -14606,7 +14707,7 @@ </argument> <argument index="2" name="out" type="Vector3" default="Vector3( 0, 0, 0 )"> </argument> - <argument index="3" name="atpos" type="int" default="null"> + <argument index="3" name="atpos" type="int" default="-1"> </argument> <description> Adds a point to a curve, at position "pos", with control points "in" and "out". @@ -14707,7 +14808,7 @@ </return> <argument index="0" name="offset" type="float"> </argument> - <argument index="1" name="cubic" type="bool" default="null"> + <argument index="1" name="cubic" type="bool" default="false"> </argument> <description> Returns a point within the curve at position "offset", where "offset" is measured as a distance in 3D units along the curve. @@ -14790,9 +14891,9 @@ <method name="tessellate" qualifiers="const"> <return type="PoolVector3Array"> </return> - <argument index="0" name="max_stages" type="int" default="4"> + <argument index="0" name="max_stages" type="int" default="5"> </argument> - <argument index="1" name="tolerance_degrees" type="float" default="5"> + <argument index="1" name="tolerance_degrees" type="float" default="4"> </argument> <description> Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. @@ -14851,8 +14952,10 @@ </class> <class name="CylinderMesh" inherits="PrimitiveMesh" category="Core"> <brief_description> + Class representing a cylindrical [PrimitiveMesh]. </brief_description> <description> + Class representing a cylindrical [PrimitiveMesh]. </description> <methods> <method name="get_bottom_radius" qualifiers="const"> @@ -14928,14 +15031,19 @@ </methods> <members> <member name="bottom_radius" type="float" setter="set_bottom_radius" getter="get_bottom_radius" brief=""> + Bottom radius of the cylinder. Defaults to 1.0. </member> <member name="height" type="float" setter="set_height" getter="get_height" brief=""> + Full height of the cylinder. Defaults to 2.0. </member> <member name="radial_segments" type="int" setter="set_radial_segments" getter="get_radial_segments" brief=""> + Number of radial segments on the cylinder. Defaults to 64. </member> <member name="rings" type="int" setter="set_rings" getter="get_rings" brief=""> + Number of edge rings along the height of the cylinder. Defaults to 4. </member> <member name="top_radius" type="float" setter="set_top_radius" getter="get_top_radius" brief=""> + Top radius of the cylinder. Defaults to 1.0. </member> </members> <constants> @@ -15113,7 +15221,7 @@ </description> <methods> <method name="get_shadow_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="DirectionalLight.ShadowMode"> </return> <description> </description> @@ -15191,7 +15299,7 @@ </description> <methods> <method name="change_dir"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="todir" type="String"> </argument> @@ -15201,7 +15309,7 @@ </description> </method> <method name="copy"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="from" type="String"> </argument> @@ -15282,7 +15390,7 @@ </description> </method> <method name="list_dir_begin"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="skip_navigational" type="bool" default="false"> </argument> @@ -15302,7 +15410,7 @@ </description> </method> <method name="make_dir"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> @@ -15312,7 +15420,7 @@ </description> </method> <method name="make_dir_recursive"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> @@ -15322,7 +15430,7 @@ </description> </method> <method name="open"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> @@ -15332,7 +15440,7 @@ </description> </method> <method name="remove"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> @@ -15342,7 +15450,7 @@ </description> </method> <method name="rename"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="from" type="String"> </argument> @@ -15556,7 +15664,7 @@ </description> </method> <method name="get_access" qualifiers="const"> - <return type="int"> + <return type="int" enum="EditorFileDialog.Access"> </return> <description> </description> @@ -15580,13 +15688,13 @@ </description> </method> <method name="get_display_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="EditorFileDialog.DisplayMode"> </return> <description> </description> </method> <method name="get_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="EditorFileDialog.Mode"> </return> <description> </description> @@ -16070,7 +16178,7 @@ </return> <argument index="0" name="object" type="Object"> </argument> - <argument index="1" name="for_property" type="String" default="null"> + <argument index="1" name="for_property" type="String" default=""""> </argument> <description> </description> @@ -16102,7 +16210,7 @@ </description> </method> <method name="save_scene"> - <return type="int"> + <return type="int" enum="Error"> </return> <description> </description> @@ -16112,7 +16220,7 @@ </return> <argument index="0" name="path" type="String"> </argument> - <argument index="1" name="with_preview" type="bool" default="null"> + <argument index="1" name="with_preview" type="bool" default="true"> </argument> <description> </description> @@ -16842,7 +16950,7 @@ </argument> <argument index="1" name="billboard" type="bool" default="false"> </argument> - <argument index="2" name="secondary" type="bool" default="null"> + <argument index="2" name="secondary" type="bool" default="false"> </argument> <description> Add a list of handles (points) which can be used to deform the object being edited. @@ -16856,7 +16964,7 @@ </argument> <argument index="1" name="material" type="Material"> </argument> - <argument index="2" name="billboard" type="bool" default="null"> + <argument index="2" name="billboard" type="bool" default="false"> </argument> <description> Add lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this function during [method redraw]. @@ -16869,7 +16977,7 @@ </argument> <argument index="1" name="billboard" type="bool" default="false"> </argument> - <argument index="2" name="skeleton" type="RID" default="null"> + <argument index="2" name="skeleton" type="RID"> </argument> <description> </description> @@ -16879,7 +16987,7 @@ </return> <argument index="0" name="material" type="Material"> </argument> - <argument index="1" name="default_scale" type="float" default="null"> + <argument index="1" name="default_scale" type="float" default="1"> </argument> <description> Add an unscaled billboard for visualization. Call this function during [method redraw]. @@ -17139,7 +17247,7 @@ </description> </method> <method name="get_background" qualifiers="const"> - <return type="int"> + <return type="int" enum="Environment.BGMode"> </return> <description> </description> @@ -17175,7 +17283,7 @@ </description> </method> <method name="get_dof_blur_far_quality" qualifiers="const"> - <return type="int"> + <return type="int" enum="Environment.DOFBlurQuality"> </return> <description> </description> @@ -17199,7 +17307,7 @@ </description> </method> <method name="get_dof_blur_near_quality" qualifiers="const"> - <return type="int"> + <return type="int" enum="Environment.DOFBlurQuality"> </return> <description> </description> @@ -17265,7 +17373,7 @@ </description> </method> <method name="get_glow_blend_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Environment.GlowBlendMode"> </return> <description> </description> @@ -17421,7 +17529,7 @@ </description> </method> <method name="get_tonemapper" qualifiers="const"> - <return type="int"> + <return type="int" enum="Environment.ToneMapper"> </return> <description> </description> @@ -18370,7 +18478,7 @@ </description> </method> <method name="get_error" qualifiers="const"> - <return type="int"> + <return type="int" enum="Error"> </return> <description> Get the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [@Global Scope]. @@ -18459,7 +18567,7 @@ </description> </method> <method name="open"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> @@ -18470,20 +18578,20 @@ </description> </method> <method name="open_compressed"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> <argument index="1" name="mode_flags" type="int"> </argument> - <argument index="2" name="compression_mode" type="int" default="null"> + <argument index="2" name="compression_mode" type="int" default="0"> </argument> <description> Open a compressed file for reading or writing. The compression_mode can be set as one of the COMPRESSION_* constants. </description> </method> <method name="open_encrypted"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> @@ -18496,7 +18604,7 @@ </description> </method> <method name="open_encrypted_with_pass"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> @@ -18696,7 +18804,7 @@ </description> </method> <method name="get_access" qualifiers="const"> - <return type="int"> + <return type="int" enum="FileDialog.Access"> </return> <description> Return the file access permission of the dialog. @@ -18730,7 +18838,7 @@ </description> </method> <method name="get_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="FileDialog.Mode"> </return> <description> Get the file dialog mode from the MODE_* enum. @@ -18905,9 +19013,9 @@ </argument> <argument index="2" name="string" type="String"> </argument> - <argument index="3" name="modulate" type="Color" default="null"> + <argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> </argument> - <argument index="4" name="clip_w" type="int" default="null"> + <argument index="4" name="clip_w" type="int" default="-1"> </argument> <description> Draw "string" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally clipping the width. "pos" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. @@ -18922,9 +19030,9 @@ </argument> <argument index="2" name="char" type="int"> </argument> - <argument index="3" name="next" type="int" default="null"> + <argument index="3" name="next" type="int" default="-1"> </argument> - <argument index="4" name="modulate" type="Color" default="null"> + <argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> </argument> <description> Draw character "char" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "pos" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character. @@ -19137,6 +19245,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,26 +19261,49 @@ <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> <class name="GDScript" inherits="Script" category="Core"> <brief_description> + A script implemented in the GDScript programming language. </brief_description> <description> + A script implemented in the GDScript programming language. The script exends the functionality of all objects that instance it. + [method new] creates a new instance of the script. [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes. </description> <methods> <method name="get_as_byte_code" qualifiers="const"> <return type="PoolByteArray"> </return> <description> + Returns byte code for the script source code. </description> </method> <method name="new" qualifiers="vararg"> <return type="Object"> </return> <description> + Returns a new instance of the script. + For example: + [codeblock] + var MyClass = load("myclass.gd") + var instance = MyClass.new() + assert(instance.get_script() == MyClass) + [/codeblock] </description> </method> </methods> @@ -19182,9 +19319,9 @@ <method name="bake"> <return type="void"> </return> - <argument index="0" name="from_node" type="Node" default="false"> + <argument index="0" name="from_node" type="Node" default="null"> </argument> - <argument index="1" name="create_visual_debug" type="bool" default="null"> + <argument index="1" name="create_visual_debug" type="bool" default="false"> </argument> <description> </description> @@ -19238,7 +19375,7 @@ </description> </method> <method name="get_subdiv" qualifiers="const"> - <return type="int"> + <return type="int" enum="GIProbe.Subdiv"> </return> <description> </description> @@ -19842,7 +19979,7 @@ </argument> <argument index="3" name="lats" type="int"> </argument> - <argument index="4" name="axis" type="int" enum="Vector3.Axis" default="null"> + <argument index="4" name="axis" type="int" enum="Vector3.Axis" default="2"> </argument> <description> </description> @@ -19856,7 +19993,7 @@ </argument> <argument index="2" name="sides" type="int"> </argument> - <argument index="3" name="axis" type="int" enum="Vector3.Axis" default="null"> + <argument index="3" name="axis" type="int" enum="Vector3.Axis" default="2"> </argument> <description> </description> @@ -20088,7 +20225,7 @@ </description> <methods> <method name="get_cast_shadows_setting" qualifiers="const"> - <return type="int"> + <return type="int" enum="GeometryInstance.ShadowCastingSetting"> </return> <description> </description> @@ -20365,8 +20502,10 @@ </class> <class name="GradientTexture" inherits="Texture" category="Core"> <brief_description> + Gradient filled texture. </brief_description> <description> + Uses a [Gradient] to fill the texture data, the gradient will be filled from left to right using colors obtained from the gradient, this means that the texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see [method set_width]). </description> <methods> <method name="get_gradient" qualifiers="const"> @@ -20394,8 +20533,10 @@ </methods> <members> <member name="gradient" type="Gradient" setter="set_gradient" getter="get_gradient" brief=""> + The [Gradient] that will be used to fill the texture. </member> <member name="width" type="int" setter="set_width" getter="get_width" brief=""> + The number of color samples that will be obtained from the [Gradient]. </member> </members> <constants> @@ -20411,7 +20552,7 @@ </description> <methods> <method name="connect_node"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="from" type="String"> </argument> @@ -20746,7 +20887,7 @@ </description> </method> <method name="get_overlay" qualifiers="const"> - <return type="int"> + <return type="int" enum="GraphNode.Overlay"> </return> <description> </description> @@ -20807,7 +20948,7 @@ <description> </description> </method> - <method name="is_resizeable" qualifiers="const"> + <method name="is_resizable" qualifiers="const"> <return type="bool"> </return> <description> @@ -20862,10 +21003,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 +21063,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> @@ -21141,7 +21282,7 @@ </argument> <argument index="3" name="item" type="int"> </argument> - <argument index="4" name="orientation" type="int" default="null"> + <argument index="4" name="orientation" type="int" default="0"> </argument> <description> </description> @@ -21183,11 +21324,11 @@ </return> <argument index="0" name="enabled" type="bool"> </argument> - <argument index="1" name="clipabove" type="bool" default="0"> + <argument index="1" name="clipabove" type="bool" default="true"> </argument> - <argument index="2" name="floor" type="int" default="true"> + <argument index="2" name="floor" type="int" default="0"> </argument> - <argument index="3" name="axis" type="int" enum="Vector3.Axis" default="null"> + <argument index="3" name="axis" type="int" enum="Vector3.Axis" default="0"> </argument> <description> </description> @@ -21399,15 +21540,15 @@ </description> </method> <method name="connect_to_host"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="host" type="String"> </argument> <argument index="1" name="port" type="int"> </argument> - <argument index="2" name="use_ssl" type="bool" default="null"> + <argument index="2" name="use_ssl" type="bool" default="false"> </argument> - <argument index="3" name="verify_host" type="bool" default="null"> + <argument index="3" name="verify_host" type="bool" default="true"> </argument> <description> Connect to a host. This needs to be done before any requests are sent. @@ -21453,7 +21594,7 @@ </description> </method> <method name="get_status" qualifiers="const"> - <return type="int"> + <return type="int" enum="HTTPClient.Status"> </return> <description> Returns a STATUS_* enum constant. Need to call [method poll] in order to get status updates. @@ -21481,7 +21622,7 @@ </description> </method> <method name="poll"> - <return type="int"> + <return type="int" enum="Error"> </return> <description> This needs to be called in order to have any request processed. Check results with [method get_status] @@ -21509,7 +21650,7 @@ </description> </method> <method name="request"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="method" type="int" enum="HTTPClient.Method"> </argument> @@ -21517,7 +21658,7 @@ </argument> <argument index="2" name="headers" type="PoolStringArray"> </argument> - <argument index="3" name="body" type="String" default="null"> + <argument index="3" name="body" type="String" default=""""> </argument> <description> Sends a request to the connected host. The url is what is normally behind the hostname, i.e. in [code]http://somehost.com/index.php[/code], url would be "index.php". @@ -21532,7 +21673,7 @@ </description> </method> <method name="request_raw"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="method" type="int" enum="HTTPClient.Method"> </argument> @@ -21549,7 +21690,7 @@ </description> </method> <method name="send_body_data"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="body" type="PoolByteArray"> </argument> @@ -21558,7 +21699,7 @@ </description> </method> <method name="send_body_text"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="body" type="String"> </argument> @@ -21778,7 +21919,7 @@ </description> </method> <method name="get_http_client_status" qualifiers="const"> - <return type="int"> + <return type="int" enum="HTTPClient.Status"> </return> <description> Return the current status of the underlying [HTTPClient]. @@ -21799,17 +21940,17 @@ </description> </method> <method name="request"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="url" type="String"> </argument> - <argument index="1" name="custom_headers" type="PoolStringArray" default="0"> + <argument index="1" name="custom_headers" type="PoolStringArray" default="PoolStringArray( )"> </argument> <argument index="2" name="ssl_validate_domain" type="bool" default="true"> </argument> - <argument index="3" name="method" type="int" enum="HTTPClient.Method" default="PoolStringArray( )"> + <argument index="3" name="method" type="int" enum="HTTPClient.Method" default="0"> </argument> - <argument index="4" name="request_data" type="String" default="null"> + <argument index="4" name="request_data" type="String" default=""""> </argument> <description> </description> @@ -22045,7 +22186,7 @@ </description> </method> <method name="get_resolve_item_status" qualifiers="const"> - <return type="int"> + <return type="int" enum="IP.ResolverStatus"> </return> <argument index="0" name="id" type="int"> </argument> @@ -22058,7 +22199,7 @@ </return> <argument index="0" name="host" type="String"> </argument> - <argument index="1" name="ip_type" type="int" enum="IP.Type" default="null"> + <argument index="1" name="ip_type" type="int" enum="IP.Type" default="3"> </argument> <description> Resolve a given hostname, blocking. Resolved hostname is returned as an IPv4 or IPv6 depending on "ip_type". @@ -22069,7 +22210,7 @@ </return> <argument index="0" name="host" type="String"> </argument> - <argument index="1" name="ip_type" type="int" enum="IP.Type" default="null"> + <argument index="1" name="ip_type" type="int" enum="IP.Type" default="3"> </argument> <description> Create a queue item for resolving a given hostname to an IPv4 or IPv6 depending on "ip_type". The queue ID is returned, or RESOLVER_INVALID_ID on error. @@ -22180,7 +22321,7 @@ </description> </method> <method name="compress"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="mode" type="int" enum="Image.CompressMode"> </argument> @@ -22249,13 +22390,13 @@ </description> </method> <method name="decompress"> - <return type="int"> + <return type="int" enum="Error"> </return> <description> </description> </method> <method name="detect_alpha" qualifiers="const"> - <return type="int"> + <return type="int" enum="Image.AlphaMode"> </return> <description> </description> @@ -22294,7 +22435,7 @@ </description> </method> <method name="generate_mipmaps"> - <return type="int"> + <return type="int" enum="Error"> </return> <description> </description> @@ -22307,7 +22448,7 @@ </description> </method> <method name="get_format" qualifiers="const"> - <return type="int"> + <return type="int" enum="Image.Format"> </return> <description> Return the format of the [Image], one of [Image].FORMAT_*. @@ -22392,7 +22533,7 @@ </description> </method> <method name="load"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> @@ -22425,7 +22566,7 @@ </argument> <argument index="1" name="height" type="int"> </argument> - <argument index="2" name="interpolation" type="int" enum="Image.Interpolation" default="null"> + <argument index="2" name="interpolation" type="int" enum="Image.Interpolation" default="1"> </argument> <description> </description> @@ -22439,7 +22580,7 @@ </description> </method> <method name="save_png" qualifiers="const"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> @@ -22606,7 +22747,7 @@ </argument> <argument index="2" name="format" type="int" enum="Image.Format"> </argument> - <argument index="3" name="flags" type="int" default="null"> + <argument index="3" name="flags" type="int" default="7"> </argument> <description> Create a new [ImageTexture] with "width" and "height". @@ -22619,14 +22760,14 @@ </return> <argument index="0" name="image" type="Image"> </argument> - <argument index="1" name="flags" type="int" default="null"> + <argument index="1" name="flags" type="int" default="7"> </argument> <description> Create a new [ImageTexture] from an [Image] with "flags" from [Texture].FLAG_*. </description> </method> <method name="get_format" qualifiers="const"> - <return type="int"> + <return type="int" enum="Image.Format"> </return> <description> Return the format of the [ImageTexture], one of [Image].FORMAT_*. @@ -22640,7 +22781,7 @@ </description> </method> <method name="get_storage" qualifiers="const"> - <return type="int"> + <return type="int" enum="ImageTexture.Storage"> </return> <description> Return the storage type. One of [ImageTexture].STORAGE_*. @@ -22719,7 +22860,7 @@ </argument> <argument index="2" name="radius" type="float"> </argument> - <argument index="3" name="add_uv" type="bool" default="null"> + <argument index="3" name="add_uv" type="bool" default="true"> </argument> <description> Simple helper to draw a uvsphere, with given latitudes, longitude and radius. @@ -22840,7 +22981,7 @@ </return> <argument index="0" name="mapping" type="String"> </argument> - <argument index="1" name="update_existing" type="bool" default="null"> + <argument index="1" name="update_existing" type="bool" default="false"> </argument> <description> Add a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices. @@ -22974,7 +23115,7 @@ </description> </method> <method name="get_mouse_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Input.MouseMode"> </return> <description> Return the mouse mode. See the constants for more information. @@ -23065,7 +23206,7 @@ </return> <argument index="0" name="image" type="Resource"> </argument> - <argument index="1" name="hotspot" type="Vector2" default="null"> + <argument index="1" name="hotspot" type="Vector2" default="Vector2( 0, 0 )"> </argument> <description> </description> @@ -23088,7 +23229,7 @@ </argument> <argument index="2" name="strong_magnitude" type="float"> </argument> - <argument index="3" name="duration" type="float" default="null"> + <argument index="3" name="duration" type="float" default="0"> </argument> <description> Starts to vibrate the joypad. Joypads usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely). @@ -23153,6 +23294,7 @@ </class> <class name="InputEvent" inherits="Resource" category="Core"> <brief_description> + Generic input event </brief_description> <description> </description> @@ -23163,24 +23305,28 @@ <argument index="0" name="event" type="InputEvent"> </argument> <description> + Returns true if this input event matches the event passed. </description> </method> <method name="as_text" qualifiers="const"> <return type="String"> </return> <description> + Returns a [String] representation of the event. </description> </method> <method name="get_device" qualifiers="const"> <return type="int"> </return> <description> + Returns the id of the device that generated the event. </description> </method> <method name="get_id" qualifiers="const"> <return type="int"> </return> <description> + Returns the id of the event. </description> </method> <method name="is_action" qualifiers="const"> @@ -23189,7 +23335,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Return if this input event matches a pre-defined action, no matter the type. + Returns true if this input event matches a pre-defined action, no matter the type. </description> </method> <method name="is_action_pressed" qualifiers="const"> @@ -23198,7 +23344,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Return whether the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. + Returns true if the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. </description> </method> <method name="is_action_released" qualifiers="const"> @@ -23207,7 +23353,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Return whether the given action is released (i.e. not pressed). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. + Returns true if the given action is released (i.e. not pressed). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. </description> </method> <method name="is_action_type" qualifiers="const"> @@ -23220,14 +23366,14 @@ <return type="bool"> </return> <description> - Return if this input event is an echo event (only for events of type KEY, it will return false for other types). + Returns true if this input event is an echo event (only for events of type KEY, it will return false for other types). </description> </method> <method name="is_pressed" qualifiers="const"> <return type="bool"> </return> <description> - Return if this input event is pressed. Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. + Returns true if this input event is pressed. Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. </description> </method> <method name="set_device"> @@ -23259,7 +23405,7 @@ </return> <argument index="0" name="xform" type="Transform2D"> </argument> - <argument index="1" name="local_ofs" type="Vector2" default="null"> + <argument index="1" name="local_ofs" type="Vector2" default="Vector2( 0, 0 )"> </argument> <description> </description> @@ -24139,7 +24285,7 @@ </return> <argument index="0" name="icon" type="Texture"> </argument> - <argument index="1" name="selectable" type="bool" default="null"> + <argument index="1" name="selectable" type="bool" default="true"> </argument> <description> Adds an item to the item list with no text, only an icon. @@ -24152,7 +24298,7 @@ </argument> <argument index="1" name="icon" type="Texture" default="null"> </argument> - <argument index="2" name="selectable" type="bool" default="null"> + <argument index="2" name="selectable" type="bool" default="true"> </argument> <description> Adds an item to the item list with specified text. Specify an icon of null for a list item with no icon. @@ -24194,7 +24340,7 @@ </description> </method> <method name="get_icon_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="ItemList.IconMode"> </return> <description> </description> @@ -24210,7 +24356,7 @@ </return> <argument index="0" name="pos" type="Vector2"> </argument> - <argument index="1" name="exact" type="bool" default="null"> + <argument index="1" name="exact" type="bool" default="false"> </argument> <description> Given a position within the control return the item (if any) at that point. @@ -24288,7 +24434,7 @@ </description> </method> <method name="get_select_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="ItemList.SelectMode"> </return> <description> </description> @@ -24370,7 +24516,7 @@ </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="single" type="bool" default="null"> + <argument index="1" name="single" type="bool" default="true"> </argument> <description> Select the item at the specified index. @@ -24844,108 +24990,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 +25034,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"> @@ -24991,13 +25047,13 @@ </return> <argument index="0" name="linear_velocity" type="Vector3"> </argument> - <argument index="1" name="floor_normal" type="Vector3" default="4"> + <argument index="1" name="floor_normal" type="Vector3" default="Vector3( 0, 0, 0 )"> </argument> <argument index="2" name="slope_stop_min_velocity" type="float" default="0.05"> </argument> - <argument index="3" name="max_bounces" type="int" default="Vector3( 0, 0, 0 )"> + <argument index="3" name="max_slides" type="int" default="4"> </argument> - <argument index="4" name="floor_max_angle" type="float" default="null"> + <argument index="4" name="floor_max_angle" type="float" default="0.785398"> </argument> <description> </description> @@ -25186,13 +25242,13 @@ </return> <argument index="0" name="linear_velocity" type="Vector2"> </argument> - <argument index="1" name="floor_normal" type="Vector2" default="4"> + <argument index="1" name="floor_normal" type="Vector2" default="Vector2( 0, 0 )"> </argument> <argument index="2" name="slope_stop_min_velocity" type="float" default="5"> </argument> - <argument index="3" name="max_bounces" type="int" default="Vector2( 0, 0 )"> + <argument index="3" name="max_bounces" type="int" default="4"> </argument> - <argument index="4" name="floor_max_angle" type="float" default="null"> + <argument index="4" name="floor_max_angle" type="float" default="0.785398"> </argument> <description> </description> @@ -25224,6 +25280,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. @@ -25233,7 +25389,7 @@ </description> <methods> <method name="get_align" qualifiers="const"> - <return type="int"> + <return type="int" enum="Label.Align"> </return> <description> Return the alignment mode (any of the ALIGN_* enumeration values). @@ -25289,7 +25445,7 @@ </description> </method> <method name="get_valign" qualifiers="const"> - <return type="int"> + <return type="int" enum="Label.VAlign"> </return> <description> Return the vertical alignment mode (any of the VALIGN_* enumeration values). @@ -25814,7 +25970,7 @@ </description> </method> <method name="get_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Light2D.Mode"> </return> <description> Return the current mode set to the Light2D. @@ -25835,7 +25991,7 @@ </description> </method> <method name="get_shadow_filter" qualifiers="const"> - <return type="int"> + <return type="int" enum="Light2D.ShadowFilter"> </return> <description> </description> @@ -26154,10 +26310,10 @@ </class> <class name="LightOccluder2D" inherits="Node2D" category="Core"> <brief_description> - Occludes light cast by a Light2D, thus casting shadows. + Occludes light cast by a Light2D, casting shadows. </brief_description> <description> - Occludes light cast by a Light2D, thus casting shadows. The LightOccluder2D must be provided with a shape (see OccluderPolygon2D) that allows the shadow to be computed. This shape affects the resulting shadow, while the shape of the representating asset shadowed does not actually affect shadows. + Occludes light cast by a Light2D, casting shadows. The LightOccluder2D must be provided with an [OccluderPolygon2D] in order for the shadow to be computed. </description> <methods> <method name="get_occluder_light_mask" qualifiers="const"> @@ -26195,8 +26351,10 @@ </methods> <members> <member name="light_mask" type="int" setter="set_occluder_light_mask" getter="get_occluder_light_mask" brief=""> + The LightOccluder2D's light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s). </member> <member name="occluder" type="OccluderPolygon2D" setter="set_occluder_polygon" getter="get_occluder_polygon" brief=""> + The [OccluderPolygon2D] used to compute the shadow. </member> </members> <constants> @@ -26204,8 +26362,10 @@ </class> <class name="Line2D" inherits="Node2D" category="Core"> <brief_description> + A 2D line. </brief_description> <description> + A line through several points in 2D space. </description> <methods> <method name="add_point"> @@ -26214,10 +26374,11 @@ <argument index="0" name="pos" type="Vector2"> </argument> <description> + Add a point at the x/y position in the supplied [Vector2] </description> </method> <method name="get_begin_cap_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="LineCapMode"> </return> <description> </description> @@ -26229,7 +26390,7 @@ </description> </method> <method name="get_end_cap_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="LineCapMode"> </return> <description> </description> @@ -26241,7 +26402,7 @@ </description> </method> <method name="get_joint_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="LineJointMode"> </return> <description> </description> @@ -26285,7 +26446,7 @@ </description> </method> <method name="get_texture_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="LineTextureMode"> </return> <description> </description> @@ -26302,6 +26463,7 @@ <argument index="0" name="i" type="int"> </argument> <description> + Remove the point at index 'i' from the line. </description> </method> <method name="set_begin_cap_mode"> @@ -26503,9 +26665,10 @@ </description> </method> <method name="get_align" qualifiers="const"> - <return type="int"> + <return type="int" enum="LineEdit.Align"> </return> <description> + Return the align mode of the [LineEdit]. </description> </method> <method name="get_cursor_pos" qualifiers="const"> @@ -26532,18 +26695,21 @@ <return type="PopupMenu"> </return> <description> + Return the [PopupMenu] of this [LineEdit]. </description> </method> <method name="get_placeholder" qualifiers="const"> <return type="String"> </return> <description> + Return the placeholder text. </description> </method> <method name="get_placeholder_alpha" qualifiers="const"> <return type="float"> </return> <description> + Return transparency of the placeholder text. </description> </method> <method name="get_text" qualifiers="const"> @@ -26573,16 +26739,23 @@ <argument index="0" name="option" type="int"> </argument> <description> + Execute a given action as defined in the MENU_* enum. </description> </method> <method name="select"> <return type="void"> </return> - <argument index="0" name="from" type="int" default="-1"> + <argument index="0" name="from" type="int" default="0"> </argument> - <argument index="1" name="to" type="int" default="0"> + <argument index="1" name="to" type="int" default="-1"> </argument> <description> + Select the text inside [LineEdit] by the given character positions. [code]from[/code] is default to the beginning. [code]to[/code] is default to the end. + [codeblock] + select() # select all + select(5) # select from the fifth character to the end. + select(2, 5) # select from the second to the fifth character. + [/codeblock] </description> </method> <method name="select_all"> @@ -26598,6 +26771,7 @@ <argument index="0" name="align" type="int" enum="LineEdit.Align"> </argument> <description> + Set text alignment of the [LineEdit]. </description> </method> <method name="set_cursor_pos"> @@ -26641,6 +26815,7 @@ <argument index="0" name="text" type="String"> </argument> <description> + Set the placeholder text. </description> </method> <method name="set_placeholder_alpha"> @@ -26649,6 +26824,7 @@ <argument index="0" name="alpha" type="float"> </argument> <description> + Set transparency of the placeholder text. </description> </method> <method name="set_secret"> @@ -26712,24 +26888,34 @@ </signals> <constants> <constant name="ALIGN_LEFT" value="0"> + Align left. </constant> <constant name="ALIGN_CENTER" value="1"> + Align center. </constant> <constant name="ALIGN_RIGHT" value="2"> + Align right. </constant> <constant name="ALIGN_FILL" value="3"> + Align fill. </constant> <constant name="MENU_CUT" value="0"> + Cut (Copy and clear). </constant> <constant name="MENU_COPY" value="1"> + Copy the selected text. </constant> <constant name="MENU_PASTE" value="2"> + Paste the clipboard text over the selected text. </constant> <constant name="MENU_CLEAR" value="3"> + Clear the text. </constant> <constant name="MENU_SELECT_ALL" value="4"> + Select all text. </constant> <constant name="MENU_UNDO" value="5"> + Undo an action. </constant> <constant name="MENU_MAX" value="6"> </constant> @@ -26821,7 +27007,7 @@ </description> </method> <method name="get_underline_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="LinkButton.UnderlineMode"> </return> <description> Returns the underline mode for this button. @@ -26932,6 +27118,7 @@ <return type="void"> </return> <description> + Called before the program exits. </description> </method> <method name="_idle" qualifiers="virtual"> @@ -26940,12 +27127,14 @@ <argument index="0" name="delta" type="float"> </argument> <description> + Called each idle frame with time since last call as an only argument. </description> </method> <method name="_initialize" qualifiers="virtual"> <return type="void"> </return> <description> + Called once during initialization. </description> </method> <method name="_input_event" qualifiers="virtual"> @@ -27072,6 +27261,7 @@ <argument index="0" name="base64_str" type="String"> </argument> <description> + Return [PoolByteArray] of a given base64 encoded String. </description> </method> <method name="base64_to_utf8"> @@ -27080,6 +27270,7 @@ <argument index="0" name="base64_str" type="String"> </argument> <description> + Return utf8 String of a given base64 encoded String. </description> </method> <method name="base64_to_variant"> @@ -27088,6 +27279,7 @@ <argument index="0" name="base64_str" type="String"> </argument> <description> + Return [Variant] of a given base64 encoded String. </description> </method> <method name="raw_to_base64"> @@ -27096,6 +27288,7 @@ <argument index="0" name="array" type="PoolByteArray"> </argument> <description> + Return base64 encoded String of a given [PoolByteArray]. </description> </method> <method name="utf8_to_base64"> @@ -27104,6 +27297,7 @@ <argument index="0" name="utf8_str" type="String"> </argument> <description> + Return base64 encoded String of a given utf8 String. </description> </method> <method name="variant_to_base64"> @@ -27112,6 +27306,7 @@ <argument index="0" name="variant" type="Variant"> </argument> <description> + Return base64 encoded String of a given [Variant]. </description> </method> </methods> @@ -27191,6 +27386,7 @@ <signals> <signal name="about_to_show"> <description> + Emitted when [PopupMenu] of this MenuButton is about to show. </description> </signal> </signals> @@ -27299,7 +27495,7 @@ </description> </method> <method name="commit_to_surface"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="mesh" type="ArrayMesh"> </argument> @@ -27307,7 +27503,7 @@ </description> </method> <method name="create_from_surface"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="mesh" type="ArrayMesh"> </argument> @@ -27727,6 +27923,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> @@ -27867,7 +28071,7 @@ </description> </method> <method name="get_color_format" qualifiers="const"> - <return type="int"> + <return type="int" enum="MultiMesh.ColorFormat"> </return> <description> </description> @@ -27905,7 +28109,7 @@ </description> </method> <method name="get_transform_format" qualifiers="const"> - <return type="int"> + <return type="int" enum="MultiMesh.TransformFormat"> </return> <description> </description> @@ -28042,7 +28246,7 @@ </description> </method> <method name="try_lock"> - <return type="int"> + <return type="int" enum="Error"> </return> <description> Try locking this [Mutex], does not block. Returns [OK] on success else [ERR_BUSY]. @@ -28146,7 +28350,7 @@ </argument> <argument index="1" name="end" type="Vector3"> </argument> - <argument index="2" name="use_collision" type="bool" default="null"> + <argument index="2" name="use_collision" type="bool" default="false"> </argument> <description> </description> @@ -28158,7 +28362,7 @@ </argument> <argument index="1" name="end" type="Vector3"> </argument> - <argument index="2" name="optimize" type="bool" default="null"> + <argument index="2" name="optimize" type="bool" default="true"> </argument> <description> </description> @@ -28244,7 +28448,7 @@ </argument> <argument index="1" name="end" type="Vector2"> </argument> - <argument index="2" name="optimize" type="bool" default="null"> + <argument index="2" name="optimize" type="bool" default="true"> </argument> <description> </description> @@ -28574,35 +28778,37 @@ </description> </method> <method name="create_client"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="ip" type="String"> </argument> <argument index="1" name="port" type="int"> </argument> - <argument index="2" name="in_bandwidth" type="int" default="null"> + <argument index="2" name="in_bandwidth" type="int" default="0"> </argument> - <argument index="3" name="out_bandwidth" type="int" default="null"> + <argument index="3" name="out_bandwidth" type="int" default="0"> </argument> <description> + Create client that connects to a server at address [code]ip[/code] using specified [code]port[/code]. </description> </method> <method name="create_server"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="port" type="int"> </argument> - <argument index="1" name="max_clients" type="int" default="0"> + <argument index="1" name="max_clients" type="int" default="32"> </argument> - <argument index="2" name="in_bandwidth" type="int" default="32"> + <argument index="2" name="in_bandwidth" type="int" default="0"> </argument> - <argument index="3" name="out_bandwidth" type="int" default="null"> + <argument index="3" name="out_bandwidth" type="int" default="0"> </argument> <description> + Create server that listens to connections via [code]port[/code]. </description> </method> <method name="get_compression_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="NetworkedMultiplayerENet.CompressionMode"> </return> <description> </description> @@ -28644,7 +28850,7 @@ </description> <methods> <method name="get_connection_status" qualifiers="const"> - <return type="int"> + <return type="int" enum="NetworkedMultiplayerPeer.ConnectionStatus"> </return> <description> </description> @@ -28665,6 +28871,7 @@ <return type="bool"> </return> <description> + Return whether this [NetworkedMultiplayerPeer] is refusing new connections. </description> </method> <method name="poll"> @@ -28679,6 +28886,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> + If [code]endable[/code] is true, this [NetworkedMultiplayerPeer] will refuse new connections. </description> </method> <method name="set_target_peer"> @@ -28701,26 +28909,31 @@ <signals> <signal name="connection_failed"> <description> + Emitted when failed to connect to server. </description> </signal> <signal name="connection_succeeded"> <description> + Emitted when successfully connected to server. </description> </signal> <signal name="peer_connected"> <argument index="0" name="id" type="int"> </argument> <description> + Emitted by the server when a client is connected. </description> </signal> <signal name="peer_disconnected"> <argument index="0" name="id" type="int"> </argument> <description> + Emitted by the server when a client is disconnected. </description> </signal> <signal name="server_disconnected"> <description> + Emitted by clients when server is disconnected. </description> </signal> </signals> @@ -28916,7 +29129,7 @@ </description> <methods> <method name="get_h_axis_stretch_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="NinePatchRect.AxisStretchMode"> </return> <description> </description> @@ -28942,7 +29155,7 @@ </description> </method> <method name="get_v_axis_stretch_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="NinePatchRect.AxisStretchMode"> </return> <description> </description> @@ -29089,6 +29302,7 @@ <argument index="0" name="event" type="InputEvent"> </argument> <description> + Called when there is a change to input devices. Propagated through the node tree until a Node consumes it. </description> </method> <method name="_process" qualifiers="virtual"> @@ -29116,6 +29330,7 @@ <argument index="0" name="event" type="InputEvent"> </argument> <description> + Propagated to all nodes when the previous InputEvent is not consumed by any nodes. </description> </method> <method name="_unhandled_key_input" qualifiers="virtual"> @@ -29131,7 +29346,7 @@ </return> <argument index="0" name="node" type="Node"> </argument> - <argument index="1" name="legible_unique_name" type="bool" default="null"> + <argument index="1" name="legible_unique_name" type="bool" default="false"> </argument> <description> Add a child [Node]. Nodes can have as many children as they want, but every child must have a unique name. Children nodes are automatically deleted when the parent node is deleted, so deleting a whole scene is performed by deleting its topmost node. @@ -29143,7 +29358,7 @@ </return> <argument index="0" name="group" type="String"> </argument> - <argument index="1" name="persistent" type="bool" default="null"> + <argument index="1" name="persistent" type="bool" default="false"> </argument> <description> Add a node to a group. Groups are helpers to name and organize a subset of nodes, like for example "enemies" or "collectables". A [Node] can be in any number of groups. Nodes can be assigned a group at any time, but will not be added to it until they are inside the scene tree (see [method is_inside_tree]). @@ -29173,7 +29388,7 @@ </argument> <argument index="1" name="recursive" type="bool" default="true"> </argument> - <argument index="2" name="owned" type="bool" default="null"> + <argument index="2" name="owned" type="bool" default="true"> </argument> <description> Find a descendant of this node whose name matches [code]mask[/code] as in [method String.match] (i.e. case sensitive, but '*' matches zero or more characters and '?' matches any single character except '.'). Note that it does not match against the full path, just against individual node names. @@ -29310,15 +29525,17 @@ </description> </method> <method name="get_pause_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Node.PauseMode"> </return> <description> + Return the pause mode (PAUSE_MODE_*) of this Node. </description> </method> <method name="get_position_in_parent" qualifiers="const"> <return type="int"> </return> <description> + Return the order in the node tree branch, i.e. if called by the first child Node, return 0. </description> </method> <method name="get_process_delta_time" qualifiers="const"> @@ -29338,6 +29555,7 @@ <return type="SceneTree"> </return> <description> + Return a [SceneTree] that this node is inside. </description> </method> <method name="get_viewport" qualifiers="const"> @@ -29352,6 +29570,7 @@ <argument index="0" name="path" type="NodePath"> </argument> <description> + Return whether the node that a given [NodePath] points too exists. </description> </method> <method name="has_node_and_resource" qualifiers="const"> @@ -29405,12 +29624,14 @@ <argument index="0" name="group" type="String"> </argument> <description> + Return whether this Node is in the specified group. </description> </method> <method name="is_inside_tree" qualifiers="const"> <return type="bool"> </return> <description> + Return whether this Node is inside a [SceneTree]. </description> </method> <method name="is_network_master" qualifiers="const"> @@ -29483,7 +29704,7 @@ </argument> <argument index="1" name="args" type="Array" default="[ ]"> </argument> - <argument index="2" name="parent_first" type="bool" default="null"> + <argument index="2" name="parent_first" type="bool" default="false"> </argument> <description> Calls the method (if present) with the arguments given in "args" on this Node and recursively on all children. If the parent_first argument is true then the method will be called on the current [Node] first, then on all children. If it is false then the children will get called first. @@ -29502,6 +29723,7 @@ <return type="void"> </return> <description> + Queues a node for deletion at the end of the current frame. When deleted, all of its children nodes will be deleted as well. This method ensures it's safe to delete the node, contrary to [method Object.free]. Use [method Object.is_queued_for_deletion] to know whether a node will be deleted at the end of the frame. </description> </method> <method name="raise"> @@ -29541,7 +29763,7 @@ </return> <argument index="0" name="node" type="Node"> </argument> - <argument index="1" name="keep_data" type="bool" default="null"> + <argument index="1" name="keep_data" type="bool" default="false"> </argument> <description> Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost. @@ -29551,6 +29773,7 @@ <return type="void"> </return> <description> + Request that [code]_ready[/code] be called again. </description> </method> <method name="rpc" qualifiers="vararg"> @@ -29711,7 +29934,7 @@ </return> <argument index="0" name="id" type="int"> </argument> - <argument index="1" name="recursive" type="bool" default="null"> + <argument index="1" name="recursive" type="bool" default="true"> </argument> <description> </description> @@ -29731,6 +29954,7 @@ <argument index="0" name="mode" type="int" enum="Node.PauseMode"> </argument> <description> + Set pause mode (PAUSE_MODE_*) of this Node. </description> </method> <method name="set_process"> @@ -29801,10 +30025,12 @@ </signal> <signal name="tree_entered"> <description> + Emitted when Node enters the tree. </description> </signal> <signal name="tree_exited"> <description> + Emitted when Node exits the tree. </description> </signal> </signals> @@ -29849,18 +30075,25 @@ <constant name="RPC_MODE_DISABLED" value="0"> </constant> <constant name="RPC_MODE_REMOTE" value="1"> + Call a method remotely. </constant> <constant name="RPC_MODE_SYNC" value="2"> + Call a method both remotely and locally. </constant> <constant name="RPC_MODE_MASTER" value="3"> + Call a method if the Node is Master. </constant> <constant name="RPC_MODE_SLAVE" value="4"> + Call a method if the Node is Slave. </constant> <constant name="PAUSE_MODE_INHERIT" value="0"> + Inherits pause mode from parent. For root node, it is equivalent to PAUSE_MODE_STOP. </constant> <constant name="PAUSE_MODE_STOP" value="1"> + Stop processing when SceneTree is paused. </constant> <constant name="PAUSE_MODE_PROCESS" value="2"> + Continue to process regardless of SceneTree pause state. </constant> <constant name="DUPLICATE_SIGNALS" value="1"> </constant> @@ -30009,7 +30242,7 @@ </return> <argument index="0" name="delta" type="float"> </argument> - <argument index="1" name="scaled" type="bool" default="null"> + <argument index="1" name="scaled" type="bool" default="false"> </argument> <description> Apply a local translation on X axis to the 2D node according to the 'delta' of the process. If 'scaled' is false, the movement is normalized. @@ -30020,7 +30253,7 @@ </return> <argument index="0" name="delta" type="float"> </argument> - <argument index="1" name="scaled" type="bool" default="null"> + <argument index="1" name="scaled" type="bool" default="false"> </argument> <description> Apply a local translation on Y axis to the 2D node according to the 'delta' of the process. If 'scaled' is false, the movement is normalized. @@ -30287,7 +30520,7 @@ </return> <argument index="0" name="text" type="String"> </argument> - <argument index="1" name="title" type="String" default="null"> + <argument index="1" name="title" type="String" default=""Alert!""> </argument> <description> Displays a modal dialog box utilizing the host OS. @@ -30355,7 +30588,7 @@ </argument> <argument index="2" name="blocking" type="bool"> </argument> - <argument index="3" name="output" type="Array" default="null"> + <argument index="3" name="output" type="Array" default="[ ]"> </argument> <description> Execute the binary file in given path, optionally blocking until it returns. A process ID is returned. @@ -30504,7 +30737,7 @@ </description> </method> <method name="get_power_state"> - <return type="int"> + <return type="int" enum="PowerState"> </return> <description> </description> @@ -30557,7 +30790,7 @@ </description> </method> <method name="get_screen_orientation" qualifiers="const"> - <return type="int"> + <return type="int" enum="_OS.ScreenOrientation"> </return> <description> Returns the current screen orientation, the return value will be one of the SCREEN_ORIENTATION constants in this class. @@ -30778,7 +31011,7 @@ </description> </method> <method name="kill"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="pid" type="int"> </argument> @@ -30799,7 +31032,7 @@ </description> </method> <method name="native_video_play"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> @@ -30938,7 +31171,7 @@ </description> </method> <method name="set_thread_name"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="name" type="String"> </argument> @@ -31025,7 +31258,7 @@ </description> </method> <method name="shell_open"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="uri" type="String"> </argument> @@ -31182,7 +31415,7 @@ </return> <argument index="0" name="signal" type="String"> </argument> - <argument index="1" name="arguments" type="Array" default="null"> + <argument index="1" name="arguments" type="Array" default="[ ]"> </argument> <description> Add a user signal (can be added anytime). Arguments are optional, but can be added as an array of dictionaries, each containing "name" and "type" (from [@Global Scope] TYPE_*). @@ -31222,7 +31455,7 @@ </description> </method> <method name="connect"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="signal" type="String"> </argument> @@ -31230,9 +31463,9 @@ </argument> <argument index="2" name="method" type="String"> </argument> - <argument index="3" name="binds" type="Array" default="null"> + <argument index="3" name="binds" type="Array" default="[ ]"> </argument> - <argument index="4" name="flags" type="int" default="null"> + <argument index="4" name="flags" type="int" default="0"> </argument> <description> Connect a signal to a method at a target (member function). Binds are optional and are passed as extra arguments to the call. Flags specify optional deferred or one shot connections, see enum CONNECT_*. A signal can only be connected once to a method, and it will throw an error if already connected. If you want to avoid this, use [method is_connected] to check. @@ -31415,7 +31648,7 @@ </return> <argument index="0" name="what" type="int"> </argument> - <argument index="1" name="reversed" type="bool" default="null"> + <argument index="1" name="reversed" type="bool" default="false"> </argument> <description> Notify the object of something. @@ -31517,7 +31750,7 @@ </description> <methods> <method name="get_cull_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="OccluderPolygon2D.CullMode"> </return> <description> </description> @@ -31585,13 +31818,13 @@ </description> <methods> <method name="get_shadow_detail" qualifiers="const"> - <return type="int"> + <return type="int" enum="OmniLight.ShadowDetail"> </return> <description> </description> </method> <method name="get_shadow_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="OmniLight.ShadowMode"> </return> <description> </description> @@ -31652,7 +31885,7 @@ </return> <argument index="0" name="label" type="String"> </argument> - <argument index="1" name="id" type="int" default="null"> + <argument index="1" name="id" type="int" default="-1"> </argument> <description> Add an item, with text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end. @@ -31865,7 +32098,7 @@ </description> <methods> <method name="add_file"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="pck_path" type="String"> </argument> @@ -31875,7 +32108,7 @@ </description> </method> <method name="flush"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="verbose" type="bool"> </argument> @@ -31883,7 +32116,7 @@ </description> </method> <method name="pck_start"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="pck_name" type="String"> </argument> @@ -31923,7 +32156,7 @@ </description> <methods> <method name="pack"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="value" type="Variant"> </argument> @@ -31988,7 +32221,7 @@ </description> </method> <method name="pack"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="path" type="Node"> </argument> @@ -32033,7 +32266,7 @@ </description> </method> <method name="get_packet_error" qualifiers="const"> - <return type="int"> + <return type="int" enum="Error"> </return> <description> Return the error state of the last packet received (via [method get_packet] and [method get_var]). @@ -32053,7 +32286,7 @@ </description> </method> <method name="put_packet"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="buffer" type="PoolByteArray"> </argument> @@ -32062,7 +32295,7 @@ </description> </method> <method name="put_var"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="var" type="Variant"> </argument> @@ -32168,13 +32401,13 @@ </description> </method> <method name="listen"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="port" type="int"> </argument> <argument index="1" name="bind_address" type="String" default=""*""> </argument> - <argument index="2" name="recv_buf_size" type="int" default="null"> + <argument index="2" name="recv_buf_size" type="int" default="65536"> </argument> <description> Make this [PacketPeerUDP] listen on the "port" binding to "bind_address" with a buffer size "recv_buf_size". @@ -32184,7 +32417,7 @@ </description> </method> <method name="set_dest_address"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="host" type="String"> </argument> @@ -32195,7 +32428,7 @@ </description> </method> <method name="wait"> - <return type="int"> + <return type="int" enum="Error"> </return> <description> Wait for a packet to arrive on the listening port, see [method listen]. @@ -32474,7 +32707,7 @@ </description> </method> <method name="get_draw_order" qualifiers="const"> - <return type="int"> + <return type="int" enum="Particles.DrawOrder"> </return> <description> </description> @@ -32775,7 +33008,7 @@ </description> </method> <method name="get_draw_order" qualifiers="const"> - <return type="int"> + <return type="int" enum="Particles2D.DrawOrder"> </return> <description> </description> @@ -33127,7 +33360,7 @@ </description> </method> <method name="get_emission_shape" qualifiers="const"> - <return type="int"> + <return type="int" enum="ParticlesMaterial.EmissionShape"> </return> <description> </description> @@ -33617,7 +33850,7 @@ </description> </method> <method name="get_rotation_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="PathFollow.RotationMode"> </return> <description> Returns the rotation mode. The constants below list which axes are allowed to rotate for each mode. @@ -34192,7 +34425,7 @@ </return> <argument index="0" name="shape" type="Physics2DShapeQueryParameters"> </argument> - <argument index="1" name="max_results" type="int" default="null"> + <argument index="1" name="max_results" type="int" default="32"> </argument> <description> Check the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. The resulting array contains a list of points where the shape intersects another. Like with [method intersect_shape], the number of returned results can be limited to save processing time. @@ -34221,13 +34454,13 @@ </return> <argument index="0" name="point" type="Vector2"> </argument> - <argument index="1" name="max_results" type="int" default="2147483647"> + <argument index="1" name="max_results" type="int" default="32"> </argument> <argument index="2" name="exclude" type="Array" default="[ ]"> </argument> - <argument index="3" name="collision_layer" type="int" default="32"> + <argument index="3" name="collision_layer" type="int" default="2147483647"> </argument> - <argument index="4" name="type_mask" type="int" default="null"> + <argument index="4" name="type_mask" type="int" default="15"> </argument> <description> Check whether a point is inside any shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: @@ -34248,9 +34481,9 @@ </argument> <argument index="2" name="exclude" type="Array" default="[ ]"> </argument> - <argument index="3" name="collision_layer" type="int" default="null"> + <argument index="3" name="collision_layer" type="int" default="2147483647"> </argument> - <argument index="4" name="type_mask" type="int" default="null"> + <argument index="4" name="type_mask" type="int" default="15"> </argument> <description> Intersect a ray in a given space. The returned object is a dictionary with the following fields: @@ -34270,7 +34503,7 @@ </return> <argument index="0" name="shape" type="Physics2DShapeQueryParameters"> </argument> - <argument index="1" name="max_results" type="int" default="null"> + <argument index="1" name="max_results" type="int" default="32"> </argument> <description> Check the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: @@ -34319,7 +34552,7 @@ </argument> <argument index="1" name="shape" type="RID"> </argument> - <argument index="2" name="transform" type="Transform2D" default="null"> + <argument index="2" name="transform" type="Transform2D" default="Transform2D( 1, 0, 0, 1, 0, 0 )"> </argument> <description> Add a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. @@ -34413,7 +34646,7 @@ </description> </method> <method name="area_get_space_override_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Physics2DServer.AreaSpaceOverrideMode"> </return> <argument index="0" name="area" type="RID"> </argument> @@ -34596,7 +34829,7 @@ </argument> <argument index="1" name="shape" type="RID"> </argument> - <argument index="2" name="transform" type="Transform2D" default="null"> + <argument index="2" name="transform" type="Transform2D" default="Transform2D( 1, 0, 0, 1, 0, 0 )"> </argument> <description> Add a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. @@ -34638,9 +34871,9 @@ <method name="body_create"> <return type="RID"> </return> - <argument index="0" name="mode" type="int" enum="Physics2DServer.BodyMode" default="false"> + <argument index="0" name="mode" type="int" enum="Physics2DServer.BodyMode" default="2"> </argument> - <argument index="1" name="init_sleeping" type="bool" default="2"> + <argument index="1" name="init_sleeping" type="bool" default="false"> </argument> <description> Create a physics body. The first parameter can be any value from constants BODY_MODE*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time. @@ -34665,7 +34898,7 @@ </description> </method> <method name="body_get_continuous_collision_detection_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Physics2DServer.CCDMode"> </return> <argument index="0" name="body" type="RID"> </argument> @@ -34683,7 +34916,7 @@ </description> </method> <method name="body_get_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Physics2DServer.BodyMode"> </return> <argument index="0" name="body" type="RID"> </argument> @@ -35006,7 +35239,7 @@ </argument> <argument index="2" name="motion" type="Vector2"> </argument> - <argument index="3" name="margin" type="float" default="null"> + <argument index="3" name="margin" type="float" default="0.08"> </argument> <argument index="4" name="result" type="Physics2DTestMotionResult" default="null"> </argument> @@ -35023,7 +35256,7 @@ </argument> <argument index="2" name="body_a" type="RID"> </argument> - <argument index="3" name="body_b" type="RID" default="null"> + <argument index="3" name="body_b" type="RID"> </argument> <description> Create a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself. @@ -35080,9 +35313,9 @@ </argument> <argument index="2" name="anchor_b" type="Vector2"> </argument> - <argument index="3" name="body_a" type="RID" default="null"> + <argument index="3" name="body_a" type="RID"> </argument> - <argument index="4" name="body_b" type="RID" default="null"> + <argument index="4" name="body_b" type="RID"> </argument> <description> Create a groove joint between two bodies. If not specified, the bodyies are assumed to be the joint itself. @@ -35100,7 +35333,7 @@ </description> </method> <method name="joint_get_type" qualifiers="const"> - <return type="int"> + <return type="int" enum="Physics2DServer.JointType"> </return> <argument index="0" name="joint" type="RID"> </argument> @@ -35128,7 +35361,7 @@ </argument> <argument index="1" name="body_a" type="RID"> </argument> - <argument index="2" name="body_b" type="RID" default="null"> + <argument index="2" name="body_b" type="RID"> </argument> <description> Create a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself. @@ -35162,7 +35395,7 @@ </description> </method> <method name="shape_get_type" qualifiers="const"> - <return type="int"> + <return type="int" enum="Physics2DServer.ShapeType"> </return> <argument index="0" name="shape" type="RID"> </argument> @@ -36150,7 +36383,7 @@ </return> <argument index="0" name="shape" type="PhysicsShapeQueryParameters"> </argument> - <argument index="1" name="max_results" type="int" default="null"> + <argument index="1" name="max_results" type="int" default="32"> </argument> <description> </description> @@ -36172,9 +36405,9 @@ </argument> <argument index="2" name="exclude" type="Array" default="[ ]"> </argument> - <argument index="3" name="collision_layer" type="int" default="null"> + <argument index="3" name="collision_layer" type="int" default="2147483647"> </argument> - <argument index="4" name="type_mask" type="int" default="null"> + <argument index="4" name="type_mask" type="int" default="15"> </argument> <description> </description> @@ -36184,7 +36417,7 @@ </return> <argument index="0" name="shape" type="PhysicsShapeQueryParameters"> </argument> - <argument index="1" name="max_results" type="int" default="null"> + <argument index="1" name="max_results" type="int" default="32"> </argument> <description> </description> @@ -36218,7 +36451,7 @@ </argument> <argument index="1" name="shape" type="RID"> </argument> - <argument index="2" name="transform" type="Transform" default="null"> + <argument index="2" name="transform" type="Transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> </argument> <description> </description> @@ -36302,7 +36535,7 @@ </description> </method> <method name="area_get_space_override_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="PhysicsServer.AreaSpaceOverrideMode"> </return> <argument index="0" name="area" type="RID"> </argument> @@ -36460,7 +36693,7 @@ </argument> <argument index="1" name="shape" type="RID"> </argument> - <argument index="2" name="transform" type="Transform" default="null"> + <argument index="2" name="transform" type="Transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> </argument> <description> </description> @@ -36508,15 +36741,15 @@ <method name="body_create"> <return type="RID"> </return> - <argument index="0" name="mode" type="int" enum="PhysicsServer.BodyMode" default="false"> + <argument index="0" name="mode" type="int" enum="PhysicsServer.BodyMode" default="2"> </argument> - <argument index="1" name="init_sleeping" type="bool" default="2"> + <argument index="1" name="init_sleeping" type="bool" default="false"> </argument> <description> </description> </method> <method name="body_get_axis_lock" qualifiers="const"> - <return type="int"> + <return type="int" enum="PhysicsServer.BodyAxisLock"> </return> <argument index="0" name="body" type="RID"> </argument> @@ -36548,7 +36781,7 @@ </description> </method> <method name="body_get_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="PhysicsServer.BodyMode"> </return> <argument index="0" name="body" type="RID"> </argument> @@ -37038,7 +37271,7 @@ </description> </method> <method name="joint_get_type" qualifiers="const"> - <return type="int"> + <return type="int" enum="PhysicsServer.JointType"> </return> <argument index="0" name="joint" type="RID"> </argument> @@ -37138,7 +37371,7 @@ </description> </method> <method name="shape_get_type" qualifiers="const"> - <return type="int"> + <return type="int" enum="PhysicsServer.ShapeType"> </return> <argument index="0" name="shape" type="RID"> </argument> @@ -37842,8 +38075,10 @@ </class> <class name="PlaneMesh" inherits="PrimitiveMesh" category="Core"> <brief_description> + Class representing a planar [PrimitiveMesh]. </brief_description> <description> + Class representing a planar [PrimitiveMesh]. This flat mesh does not have a thickness. </description> <methods> <method name="get_size" qualifiers="const"> @@ -37891,10 +38126,13 @@ </methods> <members> <member name="size" type="Vector2" setter="set_size" getter="get_size" brief=""> + Size of the generated plane. Defaults to (2.0, 2.0). </member> <member name="subdivide_depth" type="int" setter="set_subdivide_depth" getter="get_subdivide_depth" brief=""> + Number of subdivision along the z-axis. Defaults to 0. </member> <member name="subdivide_width" type="int" setter="set_subdivide_width" getter="get_subdivide_width" brief=""> + Number of subdivision along the x-axis. Defaults to 0. </member> </members> <constants> @@ -39021,7 +39259,7 @@ </argument> <argument index="1" name="id" type="int" default="-1"> </argument> - <argument index="2" name="accel" type="int" default="null"> + <argument index="2" name="accel" type="int" default="0"> </argument> <description> Add a new checkable item with text "label". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. @@ -39034,7 +39272,7 @@ </argument> <argument index="1" name="id" type="int" default="-1"> </argument> - <argument index="2" name="global" type="bool" default="null"> + <argument index="2" name="global" type="bool" default="false"> </argument> <description> </description> @@ -39046,9 +39284,9 @@ </argument> <argument index="1" name="label" type="String"> </argument> - <argument index="2" name="id" type="int" default="null"> + <argument index="2" name="id" type="int" default="-1"> </argument> - <argument index="3" name="accel" type="int" default="null"> + <argument index="3" name="accel" type="int" default="0"> </argument> <description> Add a new checkable item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be @@ -39062,9 +39300,9 @@ </argument> <argument index="1" name="shortcut" type="ShortCut"> </argument> - <argument index="2" name="id" type="int" default="null"> + <argument index="2" name="id" type="int" default="-1"> </argument> - <argument index="3" name="global" type="bool" default="null"> + <argument index="3" name="global" type="bool" default="false"> </argument> <description> </description> @@ -39076,9 +39314,9 @@ </argument> <argument index="1" name="label" type="String"> </argument> - <argument index="2" name="id" type="int" default="null"> + <argument index="2" name="id" type="int" default="-1"> </argument> - <argument index="3" name="accel" type="int" default="null"> + <argument index="3" name="accel" type="int" default="0"> </argument> <description> Add a new item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index. @@ -39091,9 +39329,9 @@ </argument> <argument index="1" name="shortcut" type="ShortCut"> </argument> - <argument index="2" name="id" type="int" default="null"> + <argument index="2" name="id" type="int" default="-1"> </argument> - <argument index="3" name="global" type="bool" default="null"> + <argument index="3" name="global" type="bool" default="false"> </argument> <description> </description> @@ -39105,7 +39343,7 @@ </argument> <argument index="1" name="id" type="int" default="-1"> </argument> - <argument index="2" name="accel" type="int" default="null"> + <argument index="2" name="accel" type="int" default="0"> </argument> <description> Add a new item with text "label". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index. @@ -39125,7 +39363,7 @@ </argument> <argument index="1" name="id" type="int" default="-1"> </argument> - <argument index="2" name="global" type="bool" default="null"> + <argument index="2" name="global" type="bool" default="false"> </argument> <description> </description> @@ -39137,7 +39375,7 @@ </argument> <argument index="1" name="submenu" type="String"> </argument> - <argument index="2" name="id" type="int" default="null"> + <argument index="2" name="id" type="int" default="-1"> </argument> <description> Adds an item with a submenu. The submenu is the name of a child PopupMenu node that would be shown when the item is clicked. An id can optionally be provided, but if is isn't provided, one will be created from the index. @@ -39407,7 +39645,7 @@ </argument> <argument index="1" name="shortcut" type="ShortCut"> </argument> - <argument index="2" name="global" type="bool" default="null"> + <argument index="2" name="global" type="bool" default="false"> </argument> <description> </description> @@ -39552,8 +39790,10 @@ </class> <class name="PrimitiveMesh" inherits="Mesh" category="Core"> <brief_description> + Base class for all primitive meshes. Handles applying a [Material] to a primitive mesh. </brief_description> <description> + Base class for all primitive meshes. Handles applying a [Material] to a primitive mesh. </description> <methods> <method name="get_material" qualifiers="const"> @@ -39573,6 +39813,7 @@ </methods> <members> <member name="material" type="Material" setter="set_material" getter="get_material" brief=""> + The current [Material] of the primitive mesh. </member> </members> <constants> @@ -39580,8 +39821,10 @@ </class> <class name="PrismMesh" inherits="PrimitiveMesh" category="Core"> <brief_description> + Class representing a prism-shaped [PrimitiveMesh]. </brief_description> <description> + Class representing a prism-shaped [PrimitiveMesh]. </description> <methods> <method name="get_left_to_right" qualifiers="const"> @@ -39657,14 +39900,19 @@ </methods> <members> <member name="left_to_right" type="float" setter="set_left_to_right" getter="get_left_to_right" brief=""> + Displacement of of the upper edge along the x-axis. 0.0 positions edge straight above the bottome left edge. Defaults to 0.5 (positioned on the midpoint). </member> <member name="size" type="Vector3" setter="set_size" getter="get_size" brief=""> + Size of the prism. Defaults to (2.0, 2.0, 2.0). </member> <member name="subdivide_depth" type="int" setter="set_subdivide_depth" getter="get_subdivide_depth" brief=""> + Number of added edge loops along the z-axis. Defaults to 0. </member> <member name="subdivide_height" type="int" setter="set_subdivide_height" getter="get_subdivide_height" brief=""> + Number of added edge loops along the y-axis. Defaults to 0. </member> <member name="subdivide_width" type="int" setter="set_subdivide_width" getter="get_subdivide_width" brief=""> + Number of added edge loops along the x-axis. Defaults to 0. </member> </members> <constants> @@ -39767,7 +40015,7 @@ </description> </method> <method name="get_texture_size" qualifiers="const"> - <return type="int"> + <return type="int" enum="ProceduralSky.TextureSize"> </return> <description> </description> @@ -40108,13 +40356,13 @@ </description> </method> <method name="save"> - <return type="int"> + <return type="int" enum="Error"> </return> <description> </description> </method> <method name="save_custom"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="file" type="String"> </argument> @@ -40214,8 +40462,10 @@ </class> <class name="QuadMesh" inherits="PrimitiveMesh" category="Core"> <brief_description> + Class representing a square mesh. </brief_description> <description> + Class representing a square mesh with size (2,2,0). Consider using a [PlaneMesh] if you require a differently sized plane. </description> <methods> </methods> @@ -40575,11 +40825,11 @@ Query the closest object intersecting a ray. </brief_description> <description> - A RayCast represents a line from its origin to its destination position [code]cast_to[/code], it is used to query the 3D space in order to find the closest object intersecting with the ray. + A RayCast represents a line from its origin to its destination position, [code]cast_to[/code]. It is used to query the 3D space in order to find the closest object along the path of the ray. - RayCast can ignore some objects by adding them to the exception list via [code]add_exception[/code], setting proper filtering with layers, or by filtering object types with type masks. + RayCast can ignore some objects by adding them to the exception list via [code]add_exception[/code], by setting proper filtering with collision layers, or by filtering object types with type masks. - Only enabled raycasts will be able to query the space and report collisions! + Only enabled raycasts will be able to query the space and report collisions. RayCast calculates intersection every fixed frame (see [Node]), and the result is cached so it can be used later until the next frame. If multiple queries are required between fixed frames (or during the same frame) use [method force_raycast_update] after adjusting the raycast. </description> @@ -40590,7 +40840,7 @@ <argument index="0" name="node" type="Object"> </argument> <description> - Adds a collision exception so the ray does not report collisions with the specified [code]node[/code]. + Adds a collision exception so the ray does not report collisions with the specified node. </description> </method> <method name="add_exception_rid"> @@ -40599,20 +40849,22 @@ <argument index="0" name="rid" type="RID"> </argument> <description> + Adds a collision exception so the ray does not report collisions with the specified [RID]. </description> </method> <method name="clear_exceptions"> <return type="void"> </return> <description> - Removes all collision exception for this ray. + Removes all collision exceptions for this ray. </description> </method> <method name="force_raycast_update"> <return type="void"> </return> <description> - Updates the collision information in case if this object's properties changed during the current frame (for example position, rotation or the cast_point). Note, [code]set_enabled[/code] is not required for this to work. + Updates the collision information for the ray. + Use this method to update the collision information immediately instead of waiting for the next [code]_fixed_process[/code] call, for example if the ray or its parent has changed state. Note: [code]enabled == true[/code] is not required for this to work. </description> </method> <method name="get_cast_to" qualifiers="const"> @@ -40626,14 +40878,24 @@ <return type="Object"> </return> <description> - Return the closest object the ray is pointing to. Note that this does not consider the length of the vector, so you must also use [method is_colliding] to check if the object returned is actually colliding with the ray. + Return the closest object the ray is pointing to. Note that this does not consider the length of the ray, so you must also use [method is_colliding] to check if the object returned is actually colliding with the ray. + Example: + [codeblock] + if RayCast.is_colliding(): + var collider = RayCast.get_collider() + [/codeblock] </description> </method> <method name="get_collider_shape" qualifiers="const"> <return type="int"> </return> <description> - Returns the collision shape of the closest object the ray is pointing to. + Returns the collision shape of the closest object the ray is pointing to. Note that this does not consider the length of the ray, so you must also use [method is_colliding] to check if the object returned is actually colliding with the ray. + Example: + [codeblock] + if RayCast.is_colliding(): + var shape = RayCast.get_collider_shape() + [/codeblock] </description> </method> <method name="get_collision_layer" qualifiers="const"> @@ -40647,14 +40909,14 @@ <return type="Vector3"> </return> <description> - Returns the normal of the intersecting object shape face containing the collision point. + Returns the normal of the intersecting object's shape at the collision point. </description> </method> <method name="get_collision_point" qualifiers="const"> <return type="Vector3"> </return> <description> - Returns collision point. This point is in [b]global[/b] coordinate system. + Returns the collision point at which the ray intersects the closest object. Note: this point is in the [b]global[/b] coordinate system. </description> </method> <method name="get_type_mask" qualifiers="const"> @@ -40675,7 +40937,7 @@ <return type="bool"> </return> <description> - Returns whether this raycast is enabled or not. + Returns whether the ray is enabled or not. </description> </method> <method name="remove_exception"> @@ -40684,7 +40946,7 @@ <argument index="0" name="node" type="Object"> </argument> <description> - Removes a collision exception so the ray does report collisions with the specified [code]node[/code]. + Removes a collision exception so the ray does report collisions with the specified node. </description> </method> <method name="remove_exception_rid"> @@ -40693,6 +40955,7 @@ <argument index="0" name="rid" type="RID"> </argument> <description> + Removes a collision exception so the ray does report collisions with the specified [RID]. </description> </method> <method name="set_cast_to"> @@ -40701,7 +40964,7 @@ <argument index="0" name="local_point" type="Vector3"> </argument> <description> - Sets to which point ray should be casted. This point is in [b]local[/b] coordinate system. + Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code]. </description> </method> <method name="set_collision_layer"> @@ -40734,12 +40997,20 @@ </methods> <members> <member name="cast_to" type="Vector3" setter="set_cast_to" getter="get_cast_to" brief=""> + The ray's destination point, relative to the RayCast's [code]position[/code]. </member> <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" brief=""> + The RayCast's collison layer(s). Only bodies in the same collision layer(s) will be detected. </member> <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled" brief=""> + If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. </member> <member name="type_mask" type="int" setter="set_type_mask" getter="get_type_mask" brief=""> + Object types to detect using a logical sum (OR operation) of type constants defined in [Physics2DDirectSpaceState]. + Example: + [codeblock] + RayCast.type_mask = Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY + [/codeblock] </member> </members> <constants> @@ -41486,7 +41757,7 @@ </description> </method> <method name="get_update_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="ReflectionProbe.UpdateMode"> </return> <description> </description> @@ -41672,7 +41943,7 @@ </description> </method> <method name="compile"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="pattern" type="String"> </argument> @@ -41715,7 +41986,7 @@ </argument> <argument index="1" name="offset" type="int" default="0"> </argument> - <argument index="2" name="end" type="int" default="null"> + <argument index="2" name="end" type="int" default="-1"> </argument> <description> Searches the text for the compiled pattern. Returns a [RegExMatch] container of the first matching reult if found, otherwise null. The region to search within can be specified without modifying where the start and end anchor would be. @@ -41730,9 +42001,9 @@ </argument> <argument index="2" name="all" type="bool" default="false"> </argument> - <argument index="3" name="offset" type="int" default="null"> + <argument index="3" name="offset" type="int" default="0"> </argument> - <argument index="4" name="end" type="int" default="null"> + <argument index="4" name="end" type="int" default="-1"> </argument> <description> Searches the text for the compiled pattern and replaces it with the specified string. Escapes and backreferences such as [code]\1[/code] and [code]\g<name>[/code] expanded and resolved. By default only the first instance is replaced but it can be changed for all instances (global replacement). The region to search within can be specified without modifying where the start and end anchor would be. @@ -42153,14 +42424,14 @@ </description> </method> <method name="poll"> - <return type="int"> + <return type="int" enum="Error"> </return> <description> Poll the load. If OK is returned, this means poll will have to be called again. If ERR_FILE_EOF is returned, them the load has finished and the resource can be obtained by calling [method get_resource]. </description> </method> <method name="wait"> - <return type="int"> + <return type="int" enum="Error"> </return> <description> </description> @@ -42209,7 +42480,7 @@ </argument> <argument index="1" name="type_hint" type="String" default=""""> </argument> - <argument index="2" name="p_no_cache" type="bool" default="null"> + <argument index="2" name="p_no_cache" type="bool" default="false"> </argument> <description> </description> @@ -42219,7 +42490,7 @@ </return> <argument index="0" name="path" type="String"> </argument> - <argument index="1" name="type_hint" type="String" default="null"> + <argument index="1" name="type_hint" type="String" default=""""> </argument> <description> Load a resource interactively, the returned object allows to load with high granularity. @@ -42327,13 +42598,13 @@ </description> </method> <method name="save"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> <argument index="1" name="resource" type="Resource"> </argument> - <argument index="2" name="flags" type="int" default="null"> + <argument index="2" name="flags" type="int" default="0"> </argument> <description> Save a resource to disk, to a given path. @@ -42380,7 +42651,7 @@ </description> </method> <method name="append_bbcode"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="bbcode" type="String"> </argument> @@ -42474,7 +42745,7 @@ </description> </method> <method name="parse_bbcode"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="bbcode" type="String"> </argument> @@ -42738,6 +43009,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"> @@ -42791,7 +43064,7 @@ </description> </method> <method name="get_axis_lock" qualifiers="const"> - <return type="int"> + <return type="int" enum="RigidBody.AxisLock"> </return> <description> Return the current axis lock of the body. One of AXIS_LOCK_* enum. @@ -42854,7 +43127,7 @@ </description> </method> <method name="get_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="RigidBody.Mode"> </return> <description> Return the current body mode, see [method set_mode]. @@ -43069,38 +43342,55 @@ </methods> <members> <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp" brief=""> + Dampens rotational forces of the Rigid body by the 'angular_damp' rate. </member> <member name="angular_velocity" type="Vector3" setter="set_angular_velocity" getter="get_angular_velocity" brief=""> + The current rotational velocity of the Rigid body </member> <member name="axis_lock" type="int" setter="set_axis_lock" getter="get_axis_lock" brief="" enum="RigidBody.AxisLock"> + Locks the rotational forces to a particular axis, preventing rotations on other axes. </member> <member name="bounce" type="float" setter="set_bounce" getter="get_bounce" brief=""> + Bounciness of the Rigid body. </member> <member name="can_sleep" type="bool" setter="set_can_sleep" getter="is_able_to_sleep" brief=""> + If true, the Rigid body will no longer calculate forces when there is no movement and will act as a static body. It will wake up when other forces are applied through other collisions or when the 'apply_impulse' method is used. </member> <member name="contact_monitor" type="bool" setter="set_contact_monitor" getter="is_contact_monitor_enabled" brief=""> + If true, the Rigid body will emit signals when it collides with another Rigid body. </member> <member name="contacts_reported" type="int" setter="set_max_contacts_reported" getter="get_max_contacts_reported" brief=""> + The maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. </member> <member name="continuous_cd" type="bool" setter="set_use_continuous_collision_detection" getter="is_using_continuous_collision_detection" brief=""> + Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fast-moving objects. </member> <member name="custom_integrator" type="bool" setter="set_use_custom_integrator" getter="is_using_custom_integrator" brief=""> + If true, internal force integration will be disabled (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined. </member> <member name="friction" type="float" setter="set_friction" getter="get_friction" brief=""> + The body friction, from 0 (frictionless) to 1 (max friction). </member> <member name="gravity_scale" type="float" setter="set_gravity_scale" getter="get_gravity_scale" brief=""> + The 'gravity_scale' for this Rigid body will be multiplied by the global 3d gravity setting found in "Project > Project Settings > Physics > 3d". A value of 1 will be normal gravity, 2 will apply double gravity, and 0.5 will apply half gravity to this object. </member> <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp" brief=""> + The linear damp for this body. Default of -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden. </member> <member name="linear_velocity" type="Vector3" setter="set_linear_velocity" getter="get_linear_velocity" brief=""> + The body linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may run in another thread and runs at a different granularity. Use [method _integrate_forces] as your process loop for precise control of the body state. </member> <member name="mass" type="float" setter="set_mass" getter="get_mass" brief=""> + The body mass. </member> <member name="mode" type="int" setter="set_mode" getter="get_mode" brief="" enum="RigidBody.Mode"> + The body mode from the MODE_* enum. Modes include: MODE_STATIC, MODE_KINEMATIC, MODE_RIGID, and MODE_CHARACTER. </member> <member name="sleeping" type="bool" setter="set_sleeping" getter="is_sleeping" brief=""> + The current 'sleeping' state of the Rigid body. </member> <member name="weight" type="float" setter="set_weight" getter="get_weight" brief=""> + The body weight given standard earth-weight (gravity 9.8). </member> </members> <signals> @@ -43251,7 +43541,7 @@ </description> </method> <method name="get_continuous_collision_detection_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="RigidBody2D.CCDMode"> </return> <description> Return whether this body is using continuous collision detection. @@ -43307,7 +43597,7 @@ </description> </method> <method name="get_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="RigidBody2D.Mode"> </return> <description> Return the current body mode, see [method set_mode]. @@ -43762,7 +44052,7 @@ </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="for_parent" type="bool" default="null"> + <argument index="1" name="for_parent" type="bool" default="false"> </argument> <description> </description> @@ -43850,7 +44140,7 @@ </description> </method> <method name="change_scene"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> @@ -43858,7 +44148,7 @@ </description> </method> <method name="change_scene_to"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="packed_scene" type="PackedScene"> </argument> @@ -43870,7 +44160,7 @@ </return> <argument index="0" name="time_sec" type="float"> </argument> - <argument index="1" name="pause_mode_process" type="bool" default="null"> + <argument index="1" name="pause_mode_process" type="bool" default="true"> </argument> <description> </description> @@ -44020,7 +44310,7 @@ </description> </method> <method name="reload_current_scene"> - <return type="int"> + <return type="int" enum="Error"> </return> <description> </description> @@ -44131,7 +44421,7 @@ </argument> <argument index="2" name="minsize" type="Vector2"> </argument> - <argument index="3" name="shrink" type="int" default="null"> + <argument index="3" name="shrink" type="int" default="1"> </argument> <description> </description> @@ -44256,17 +44546,18 @@ </class> <class name="Script" inherits="Resource" category="Core"> <brief_description> - Base class for scripts. + A class stored as a resource. </brief_description> <description> - Base class for scripts. Any script that is loaded becomes one of these resources, which can then create instances. + A class stored as a resource. The script exends the functionality of all objects that instance it. + The 'new' method of a script subclass creates a new instance. [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes. </description> <methods> <method name="can_instance" qualifiers="const"> <return type="bool"> </return> <description> - Return true if this script can be instance (ie not a library). + Returns true if the script can be instanced. </description> </method> <method name="get_node_type" qualifiers="const"> @@ -44279,7 +44570,7 @@ <return type="String"> </return> <description> - Return the script source code (if available). + Returns the script source code, or an empty string if source code is not available. </description> </method> <method name="has_script_signal" qualifiers="const"> @@ -44288,13 +44579,14 @@ <argument index="0" name="signal_name" type="String"> </argument> <description> + Returns true if the script, or a base class, defines a signal with the given name. </description> </method> <method name="has_source_code" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the script contains source code. + Returns true if the script contains non-empty source code. </description> </method> <method name="instance_has" qualifiers="const"> @@ -44303,21 +44595,24 @@ <argument index="0" name="base_object" type="Object"> </argument> <description> - Return true if a given object uses an instance of this script. + Returns true if 'base_object' is an instance of this script. </description> </method> <method name="is_tool" qualifiers="const"> <return type="bool"> </return> <description> + Returns true if the script is a tool script. A tool script can run in the editor. </description> </method> <method name="reload"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="keep_state" type="bool" default="false"> + If true, preserve existing script instances and subclasses. </argument> <description> + Reloads the script's class implementation. Returns an error code. </description> </method> <method name="set_source_code"> @@ -44326,7 +44621,7 @@ <argument index="0" name="source" type="String"> </argument> <description> - Set the script source code. + Sets the script source code. Does not reload the class implementation. </description> </method> </methods> @@ -44550,14 +44845,14 @@ </description> <methods> <method name="post"> - <return type="int"> + <return type="int" enum="Error"> </return> <description> Lowers the [Semaphore], allowing one more thread in. </description> </method> <method name="wait"> - <return type="int"> + <return type="int" enum="Error"> </return> <description> Tries to wait for the [Semaphore], if its value is zero, blocks until non-zero. @@ -44602,7 +44897,7 @@ </description> </method> <method name="get_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Shader.Mode"> </return> <description> </description> @@ -45067,7 +45362,7 @@ </description> <methods> <method name="get_radiance_size" qualifiers="const"> - <return type="int"> + <return type="int" enum="Sky.RadianceSize"> </return> <description> </description> @@ -45294,16 +45589,17 @@ </class> <class name="Spatial" inherits="Node" category="Core"> <brief_description> - Base class for all 3D nodes. + Most basic 3D game object, parent of all 3D related nodes. </brief_description> <description> - Spatial is the base for every type of 3D [Node]. It contains a 3D [Transform] which can be set or get as local or global. If a Spatial [Node] has Spatial children, their transforms will be relative to the parent. + Most basic 3D game object, with a 3D [Transform] and visibility settings. All 3D physics nodes and sprites inherit from Spatial. Use Spatial as a parent node to move, scale, rotate and show/hide children in a 3D project. </description> <methods> <method name="get_gizmo" qualifiers="const"> <return type="SpatialGizmo"> </return> <description> + Return the SpatialGizmo for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor. </description> </method> <method name="get_global_transform" qualifiers="const"> @@ -45357,6 +45653,7 @@ <return type="World"> </return> <description> + Return current [World] resource this Spatial node is registered to. </description> </method> <method name="global_rotate"> @@ -45367,6 +45664,7 @@ <argument index="1" name="radians" type="float"> </argument> <description> + Rotate current node along normal [Vector3] by angle in radians in Global space. </description> </method> <method name="global_translate"> @@ -45375,42 +45673,49 @@ <argument index="0" name="offset" type="Vector3"> </argument> <description> + Move current node by [Vector3] offset in Global space. </description> </method> <method name="hide"> <return type="void"> </return> <description> + Disable rendering of this node. Change Spatial Visible property to false. </description> </method> <method name="is_local_transform_notification_enabled" qualifiers="const"> <return type="bool"> </return> <description> + Returns whether node sends notification that its local transformation changed. Spatial will not propagate this by default. </description> </method> <method name="is_set_as_toplevel" qualifiers="const"> <return type="bool"> </return> <description> + Returns whether this node is set as Toplevel, ignoring its parent node transformations. </description> </method> <method name="is_transform_notification_enabled" qualifiers="const"> <return type="bool"> </return> <description> + Returns whether node sends notification that its transformation changed. Spatial will not propagate this by default. </description> </method> <method name="is_visible" qualifiers="const"> <return type="bool"> </return> <description> + Returns whether this node is set to be visible. </description> </method> <method name="is_visible_in_tree" qualifiers="const"> <return type="bool"> </return> <description> + Returns whether this node is visible, taking into consideration that its parents visibility. </description> </method> <method name="look_at"> @@ -45421,6 +45726,7 @@ <argument index="1" name="up" type="Vector3"> </argument> <description> + Rotates itself to point into direction of target position. Operations take place in global space. </description> </method> <method name="look_at_from_pos"> @@ -45433,12 +45739,14 @@ <argument index="2" name="up" type="Vector3"> </argument> <description> + Moves itself to specified position and then rotates itself to point into direction of target position. Operations take place in global space. </description> </method> <method name="orthonormalize"> <return type="void"> </return> <description> + Reset this node transformations (like scale, skew and taper) preserving its rotation and translation. Performs orthonormalization on this node [Transform3D]. </description> </method> <method name="rotate"> @@ -45449,6 +45757,7 @@ <argument index="1" name="radians" type="float"> </argument> <description> + Rotates node in local space on given normal [Vector3] by angle in radians. </description> </method> <method name="rotate_x"> @@ -45457,6 +45766,7 @@ <argument index="0" name="radians" type="float"> </argument> <description> + Rotates node in local space on X axis by angle in radians. </description> </method> <method name="rotate_y"> @@ -45465,6 +45775,7 @@ <argument index="0" name="radians" type="float"> </argument> <description> + Rotates node in local space on Y axis by angle in radians. </description> </method> <method name="rotate_z"> @@ -45473,6 +45784,7 @@ <argument index="0" name="radians" type="float"> </argument> <description> + Rotates node in local space on Z axis by angle in radians. </description> </method> <method name="set_as_toplevel"> @@ -45481,6 +45793,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> + Makes this node ignore its parents tranformations. Node tranformations are only in global space. </description> </method> <method name="set_gizmo"> @@ -45489,6 +45802,7 @@ <argument index="0" name="gizmo" type="SpatialGizmo"> </argument> <description> + Set [SpatialGizmo] for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor. </description> </method> <method name="set_global_transform"> @@ -45497,13 +45811,14 @@ <argument index="0" name="global" type="Transform"> </argument> <description> - Set the transform globally, relative to worldspace. + Set the transform globally, relative to world space. </description> </method> <method name="set_identity"> <return type="void"> </return> <description> + Reset all tranformations for this node. Set its [Transform3D] to identity matrix. </description> </method> <method name="set_ignore_transform_notification"> @@ -45512,6 +45827,7 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> + Set whether this node ignores notification that its transformation changed. </description> </method> <method name="set_notify_local_transform"> @@ -45520,6 +45836,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> + Set whether this node sends notification that its local transformation changed. Spatial will not propagate this by default. </description> </method> <method name="set_notify_transform"> @@ -45528,6 +45845,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> + Set whether this node sends notification that its transformation changed. Spatial will not propagate this by default. </description> </method> <method name="set_rotation"> @@ -45554,6 +45872,7 @@ <argument index="0" name="scale" type="Vector3"> </argument> <description> + Set the scale. </description> </method> <method name="set_transform"> @@ -45585,6 +45904,7 @@ <return type="void"> </return> <description> + Enable rendering of this node. Change Spatial Visible property to false. </description> </method> <method name="to_global" qualifiers="const"> @@ -45593,6 +45913,7 @@ <argument index="0" name="local_point" type="Vector3"> </argument> <description> + Tranform [Vector3] from this node local space to world space. </description> </method> <method name="to_local" qualifiers="const"> @@ -45601,6 +45922,7 @@ <argument index="0" name="global_point" type="Vector3"> </argument> <description> + Tranform [Vector3] from world space to this node local space. </description> </method> <method name="translate"> @@ -45609,46 +45931,60 @@ <argument index="0" name="offset" type="Vector3"> </argument> <description> + Change node position by given offset [Vector3]. </description> </method> <method name="update_gizmo"> <return type="void"> </return> <description> + Update [SpatialGizmo] of this node. </description> </method> </methods> <members> <member name="global_transform" type="Transform" setter="set_global_transform" getter="get_global_transform" brief=""> + World space (global) [Transform] of this node. </member> <member name="rotation" type="Vector3" setter="set_rotation" getter="get_rotation" brief=""> + Local euler rotation in radians of this node. </member> <member name="rotation_deg" type="Vector3" setter="set_rotation_deg" getter="get_rotation_deg" brief=""> + Local euler rotation in degrees of this node. </member> <member name="scale" type="Vector3" setter="set_scale" getter="get_scale" brief=""> + Local scale of this node. </member> <member name="transform" type="Transform" setter="set_transform" getter="get_transform" brief=""> + Local space [Transform] of this node. </member> <member name="translation" type="Vector3" setter="set_translation" getter="get_translation" brief=""> + Local translation of this node. </member> <member name="visible" type="bool" setter="set_visible" getter="is_visible" brief=""> + Visibility of this node. Toggles if this node is rendered. </member> </members> <signals> <signal name="visibility_changed"> <description> + Emitted when node visibility changed. </description> </signal> </signals> <constants> <constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29" enum=""> - Spatial nodes receive this notification with their global transform changes. This means that either the current or a parent node changed its transform. + Spatial nodes receive this notification when their global transform changes. This means that either the current or a parent node changed its transform. + In order for NOTIFICATION_TRANSFORM_CHANGED to work user first needs to ask for it, with set_notify_transform(true). </constant> <constant name="NOTIFICATION_ENTER_WORLD" value="41" enum=""> + Spatial nodes receive this notification when they are registered to new [World] resource. </constant> <constant name="NOTIFICATION_EXIT_WORLD" value="42" enum=""> + Spatial nodes receive this notification when they are unregistered from current [World] resource. </constant> <constant name="NOTIFICATION_VISIBILITY_CHANGED" value="43" enum=""> + Spatial nodes receive this notification when their visibility changes. </constant> </constants> </class> @@ -45687,19 +46023,19 @@ </description> </method> <method name="get_ao_texture_channel" qualifiers="const"> - <return type="int"> + <return type="int" enum="SpatialMaterial.TextureChannel"> </return> <description> </description> </method> <method name="get_billboard_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="SpatialMaterial.BillboardMode"> </return> <description> </description> </method> <method name="get_blend_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="SpatialMaterial.BlendMode"> </return> <description> </description> @@ -45717,7 +46053,7 @@ </description> </method> <method name="get_cull_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="SpatialMaterial.CullMode"> </return> <description> </description> @@ -45735,7 +46071,7 @@ </description> </method> <method name="get_depth_draw_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="SpatialMaterial.DepthDrawMode"> </return> <description> </description> @@ -45747,19 +46083,19 @@ </description> </method> <method name="get_detail_blend_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="SpatialMaterial.BlendMode"> </return> <description> </description> </method> <method name="get_detail_uv" qualifiers="const"> - <return type="int"> + <return type="int" enum="SpatialMaterial.DetailUV"> </return> <description> </description> </method> <method name="get_diffuse_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="SpatialMaterial.DiffuseMode"> </return> <description> </description> @@ -45811,7 +46147,7 @@ </description> </method> <method name="get_metallic_texture_channel" qualifiers="const"> - <return type="int"> + <return type="int" enum="SpatialMaterial.TextureChannel"> </return> <description> </description> @@ -45853,7 +46189,7 @@ </description> </method> <method name="get_refraction_texture_channel" qualifiers="const"> - <return type="int"> + <return type="int" enum="SpatialMaterial.TextureChannel"> </return> <description> </description> @@ -45877,7 +46213,7 @@ </description> </method> <method name="get_roughness_texture_channel" qualifiers="const"> - <return type="int"> + <return type="int" enum="SpatialMaterial.TextureChannel"> </return> <description> </description> @@ -45889,7 +46225,7 @@ </description> </method> <method name="get_specular_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="SpatialMaterial.SpecularMode"> </return> <description> </description> @@ -45908,6 +46244,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 +46632,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> @@ -46410,6 +46760,8 @@ </member> <member name="flags_vertex_lighting" type="bool" setter="set_flag" getter="get_flag" brief=""> </member> + <member name="flags_world_triplanar" type="bool" setter="set_flag" getter="get_flag" brief=""> + </member> <member name="metallic" type="float" setter="set_metallic" getter="get_metallic" brief=""> </member> <member name="metallic_specular" type="float" setter="set_specular" getter="get_specular" brief=""> @@ -46482,6 +46834,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=""> @@ -46526,15 +46884,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_REFRACTION" value="12"> </constant> - <constant name="TEXTURE_DETAIL_MASK" value="12"> + <constant name="TEXTURE_DETAIL_MASK" value="13"> </constant> - <constant name="TEXTURE_DETAIL_ALBEDO" value="13"> + <constant name="TEXTURE_DETAIL_ALBEDO" value="14"> </constant> - <constant name="TEXTURE_DETAIL_NORMAL" value="14"> + <constant name="TEXTURE_DETAIL_NORMAL" value="15"> </constant> - <constant name="TEXTURE_MAX" value="15"> + <constant name="TEXTURE_MAX" value="16"> </constant> <constant name="DETAIL_UV_1" value="0"> </constant> @@ -46558,11 +46918,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_DETAIL" value="10"> + <constant name="FEATURE_REFRACTION" value="10"> </constant> - <constant name="FEATURE_MAX" value="11"> + <constant name="FEATURE_DETAIL" value="11"> + </constant> + <constant name="FEATURE_MAX" value="12"> </constant> <constant name="BLEND_MODE_MIX" value="0"> </constant> @@ -46604,15 +46966,17 @@ </constant> <constant name="FLAG_UV2_USE_TRIPLANAR" value="8"> </constant> - <constant name="FLAG_AO_ON_UV2" value="9"> + <constant name="FLAG_AO_ON_UV2" value="10"> + </constant> + <constant name="FLAG_USE_ALPHA_SCISSOR" value="11"> </constant> - <constant name="FLAG_USE_ALPHA_SCISSOR" value="10"> + <constant name="FLAG_TRIPLANAR_USE_WORLD" value="9"> </constant> - <constant name="FLAG_MAX" value="11"> + <constant name="FLAG_MAX" value="12"> </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> @@ -46698,8 +47062,10 @@ </class> <class name="SphereMesh" inherits="PrimitiveMesh" category="Core"> <brief_description> + Class representing a spherical [PrimitiveMesh]. </brief_description> <description> + Class representing a spherical [PrimitiveMesh]. </description> <methods> <method name="get_height" qualifiers="const"> @@ -46775,14 +47141,19 @@ </methods> <members> <member name="height" type="float" setter="set_height" getter="get_height" brief=""> + Full height of the sphere. Defaults to 2.0. </member> <member name="is_hemisphere" type="bool" setter="set_is_hemisphere" getter="get_is_hemisphere" brief=""> + Determines whether a full sphere or a hemisphere is created. Attention: To get a regular hemisphere the height and radius of the sphere have to equal. Defaults to false. </member> <member name="radial_segments" type="int" setter="set_radial_segments" getter="get_radial_segments" brief=""> + Number of radial segments on the sphere. Defaults to 64. </member> <member name="radius" type="float" setter="set_radius" getter="get_radius" brief=""> + Radius of sphere. Defaults to 1.0. </member> <member name="rings" type="int" setter="set_rings" getter="get_rings" brief=""> + Number of segments along the height of the sphere. Defaults to 32. </member> </members> <constants> @@ -46902,7 +47273,7 @@ </description> <methods> <method name="get_dragger_visibility" qualifiers="const"> - <return type="int"> + <return type="int" enum="SplitContainer.DraggerVisibility"> </return> <description> Return visibility of the split dragger (one of [DRAGGER_VISIBLE], [DRAGGER_HIDDEN] or [DRAGGER_HIDDEN_COLLAPSED]). @@ -47358,13 +47729,13 @@ </description> <methods> <method name="get_alpha_cut_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="SpriteBase3D.AlphaCutMode"> </return> <description> </description> </method> <method name="get_axis" qualifiers="const"> - <return type="int"> + <return type="int" enum="Vector3.Axis"> </return> <description> </description> @@ -47574,7 +47945,7 @@ </argument> <argument index="1" name="frame" type="Texture"> </argument> - <argument index="2" name="atpos" type="int" default="null"> + <argument index="2" name="atpos" type="int" default="-1"> </argument> <description> </description> @@ -47782,12 +48153,16 @@ </methods> <members> <member name="bounce" type="float" setter="set_bounce" getter="get_bounce" brief=""> + The body bounciness. </member> <member name="constant_angular_velocity" type="Vector3" setter="set_constant_angular_velocity" getter="get_constant_angular_velocity" brief=""> + The constant angular velocity for the body. This does not rotate the body, but affects other bodies that touch it, as if it was in a state of rotation. </member> <member name="constant_linear_velocity" type="Vector3" setter="set_constant_linear_velocity" getter="get_constant_linear_velocity" brief=""> + The constant linear velocity for the body. This does not move the body, but affects other bodies that touch it, as if it was in a state of movement. </member> <member name="friction" type="float" setter="set_friction" getter="get_friction" brief=""> + The body friction, from 0 (frictionless) to 1 (full friction). </member> </members> <constants> @@ -48053,7 +48428,7 @@ </description> </method> <method name="put_data"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="data" type="PoolByteArray"> </argument> @@ -48228,7 +48603,7 @@ </description> <methods> <method name="accept_stream"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="stream" type="StreamPeer"> </argument> @@ -48236,13 +48611,13 @@ </description> </method> <method name="connect_to_stream"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="stream" type="StreamPeer"> </argument> <argument index="1" name="validate_certs" type="bool" default="false"> </argument> - <argument index="2" name="for_hostname" type="String" default="null"> + <argument index="2" name="for_hostname" type="String" default=""""> </argument> <description> Connect to a peer using an underlying [StreamPeer] "stream", when "validate_certs" is true, [StreamPeerSSL] will validate that the certificate presented by the peer matches the "for_hostname". @@ -48256,7 +48631,7 @@ </description> </method> <method name="get_status" qualifiers="const"> - <return type="int"> + <return type="int" enum="StreamPeerSSL.Status"> </return> <description> Return the status of the connection, one of STATUS_* enum. @@ -48287,7 +48662,7 @@ </description> <methods> <method name="connect_to_host"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="host" type="String"> </argument> @@ -48319,7 +48694,7 @@ </description> </method> <method name="get_status" qualifiers="const"> - <return type="int"> + <return type="int" enum="StreamPeerTCP.Status"> </return> <description> Return the status of the connection, one of STATUS_* enum. @@ -48360,7 +48735,7 @@ </description> </method> <method name="load"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> @@ -49206,10 +49581,26 @@ </class> <class name="StyleBoxFlat" inherits="StyleBox" category="Core"> <brief_description> - Stylebox of a single color. + Customizable Stylebox with a given set of parameters. (no texture required) </brief_description> <description> - Stylebox of a single color. Displays the stylebox of a single color, alternatively a border with light/dark colors can be assigned. + This stylebox can be used to achieve all kinds of looks without the need of a texture. Those properties are customizable: + - Color + - Border width (individual width for each border) + - Rounded corners (individual radius for each corner) + - Shadow + About corner radius: + Setting corner radius to high values is allowed. As soon as corners would overlap the stylebox will switch to a relative system. Example: + [codeblock] + height = 30 + corner_radius_top_left = 50 + corner_raidus_bottom_left = 100 + [/codeblock] + The relative system now would take the 1:2 ratio of the two left corners to calculate the actual corner width. Both corners added will [b]never[/b] be more than the height. Result: + [codeblock] + corner_radius_top_left: 10 + corner_raidus_bottom_left: 20 + [/codeblock] </description> <methods> <method name="get_aa_size" qualifiers="const"> @@ -49453,46 +49844,69 @@ </methods> <members> <member name="anti_aliasing" type="bool" setter="set_anti_aliased" getter="is_anti_aliased" brief=""> + Anti Aliasing draws a small ring around edges. This ring fades to transparent. As a result edges look much smoother. This is only noticable when using rounded corners. </member> <member name="anti_aliasing_size" type="int" setter="set_aa_size" getter="get_aa_size" brief=""> + This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect. </member> <member name="bg_color" type="Color" setter="set_bg_color" getter="get_bg_color" brief=""> + The background color of the stylebox. </member> <member name="border_blend" type="bool" setter="set_border_blend" getter="get_border_blend" brief=""> + When set to true, the border will fade into the background color. </member> <member name="border_color" type="Color" setter="set_border_color" getter="get_border_color" brief=""> + Sets the color of the border. </member> <member name="border_width_bottom" type="int" setter="set_border_width" getter="get_border_width" brief=""> + Border width for the bottom border. </member> <member name="border_width_left" type="int" setter="set_border_width" getter="get_border_width" brief=""> + Border width for the left border. </member> <member name="border_width_right" type="int" setter="set_border_width" getter="get_border_width" brief=""> + Border width for the right border. </member> <member name="border_width_top" type="int" setter="set_border_width" getter="get_border_width" brief=""> + Border width for the top border. </member> <member name="corner_detail" type="int" setter="set_corner_detail" getter="get_corner_detail" brief=""> + This sets the amount of vertices used for each corner. Higher values result in rounder corners but take more processing power to compute. When choosing a value you should take the corner radius ([method set_corner_radius]) into account. + For corner radius smaller than 10: 4-5 should be enough + For corner radius smaller than 30: 8-12 should be enough ... </member> <member name="corner_radius_bottom_left" type="int" setter="set_corner_radius" getter="get_corner_radius" brief=""> + The corner radius of the bottom left corner. When set to 0 the corner is not rounded. </member> <member name="corner_radius_bottom_right" type="int" setter="set_corner_radius" getter="get_corner_radius" brief=""> + The corner radius of the bottom right corner. When set to 0 the corner is not rounded. </member> <member name="corner_radius_top_left" type="int" setter="set_corner_radius" getter="get_corner_radius" brief=""> + The corner radius of the top left corner. When set to 0 the corner is not rounded. </member> <member name="corner_radius_top_right" type="int" setter="set_corner_radius" getter="get_corner_radius" brief=""> + The corner radius of the top right corner. When set to 0 the corner is not rounded. </member> <member name="draw_center" type="bool" setter="set_draw_center" getter="is_draw_center_enabled" brief=""> + Toggels drawing of the inner part of the stylebox. </member> <member name="expand_margin_bottom" type="float" setter="set_expand_margin" getter="get_expand_margin" brief=""> + Expands the stylebox outside of the control rect on the bottom edge. Useful in combination with border_width_bottom. To draw a border outside the control rect. </member> <member name="expand_margin_left" type="float" setter="set_expand_margin" getter="get_expand_margin" brief=""> + Expands the stylebox outside of the control rect on the left edge. Useful in combination with border_width_left. To draw a border outside the control rect. </member> <member name="expand_margin_right" type="float" setter="set_expand_margin" getter="get_expand_margin" brief=""> + Expands the stylebox outside of the control rect on the right edge. Useful in combination with border_width_right. To draw a border outside the control rect. </member> <member name="expand_margin_top" type="float" setter="set_expand_margin" getter="get_expand_margin" brief=""> + Expands the stylebox outside of the control rect on the top edge. Useful in combination with border_width_top. To draw a border outside the control rect. </member> <member name="shadow_color" type="Color" setter="set_shadow_color" getter="get_shadow_color" brief=""> + The color of the shadow. (This has no effect when shadow_size < 1) </member> <member name="shadow_size" type="int" setter="set_shadow_size" getter="get_shadow_size" brief=""> + The shadow size in pixels. </member> </members> <constants> @@ -49515,7 +49929,7 @@ </description> </method> <method name="get_h_axis_stretch_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="StyleBoxTexture.AxisStretchMode"> </return> <description> </description> @@ -49553,7 +49967,7 @@ </description> </method> <method name="get_v_axis_stretch_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="StyleBoxTexture.AxisStretchMode"> </return> <description> </description> @@ -49794,15 +50208,15 @@ </return> <argument index="0" name="vertexes" type="PoolVector3Array"> </argument> - <argument index="1" name="uvs" type="PoolVector2Array" default="PoolVector3Array( )"> + <argument index="1" name="uvs" type="PoolVector2Array" default="PoolVector2Array( )"> </argument> - <argument index="2" name="colors" type="PoolColorArray" default="PoolVector2Array( )"> + <argument index="2" name="colors" type="PoolColorArray" default="PoolColorArray( )"> </argument> - <argument index="3" name="uv2s" type="PoolVector2Array" default="PoolColorArray( )"> + <argument index="3" name="uv2s" type="PoolVector2Array" default="PoolVector2Array( )"> </argument> - <argument index="4" name="normals" type="PoolVector3Array" default="PoolVector2Array( )"> + <argument index="4" name="normals" type="PoolVector3Array" default="PoolVector3Array( )"> </argument> - <argument index="5" name="tangents" type="Array" default="null"> + <argument index="5" name="tangents" type="Array" default="[ ]"> </argument> <description> Insert a triangle fan made of array data into [Mesh] being constructed. @@ -49947,11 +50361,11 @@ </description> </method> <method name="listen"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="port" type="int"> </argument> - <argument index="1" name="bind_address" type="String" default="null"> + <argument index="1" name="bind_address" type="String" default=""*""> </argument> <description> Listen on the "port" binding to "bind_address". @@ -50021,7 +50435,7 @@ </description> </method> <method name="get_tab_align" qualifiers="const"> - <return type="int"> + <return type="int" enum="TabContainer.TabAlign"> </return> <description> Return tab alignment, from the ALIGN_* enum. @@ -50216,9 +50630,9 @@ <method name="add_tab"> <return type="void"> </return> - <argument index="0" name="title" type="String" default="null"> + <argument index="0" name="title" type="String" default=""""> </argument> - <argument index="1" name="icon" type="Texture" default=""""> + <argument index="1" name="icon" type="Texture" default="null"> </argument> <description> </description> @@ -50238,13 +50652,13 @@ </description> </method> <method name="get_tab_align" qualifiers="const"> - <return type="int"> + <return type="int" enum="Tabs.TabAlign"> </return> <description> </description> </method> <method name="get_tab_close_display_policy" qualifiers="const"> - <return type="int"> + <return type="int" enum="Tabs.CloseButtonDisplayPolicy"> </return> <description> </description> @@ -50480,7 +50894,7 @@ </argument> <argument index="2" name="color" type="Color"> </argument> - <argument index="3" name="line_only" type="bool" default="null"> + <argument index="3" name="line_only" type="bool" default="false"> </argument> <description> Add color region (given the delimiters) and its colors. @@ -50585,7 +50999,7 @@ </return> <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="adjust_viewport" type="bool" default="null"> + <argument index="1" name="adjust_viewport" type="bool" default="true"> </argument> <description> </description> @@ -50595,7 +51009,7 @@ </return> <argument index="0" name="line" type="int"> </argument> - <argument index="1" name="adjust_viewport" type="bool" default="null"> + <argument index="1" name="adjust_viewport" type="bool" default="true"> </argument> <description> </description> @@ -51028,7 +51442,7 @@ </argument> <argument index="2" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> </argument> - <argument index="3" name="transpose" type="bool" default="null"> + <argument index="3" name="transpose" type="bool" default="false"> </argument> <argument index="4" name="normal_map" type="Texture" default="null"> </argument> @@ -51044,9 +51458,9 @@ </argument> <argument index="2" name="tile" type="bool"> </argument> - <argument index="3" name="modulate" type="Color" default="null"> + <argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> </argument> - <argument index="4" name="transpose" type="bool" default="null"> + <argument index="4" name="transpose" type="bool" default="false"> </argument> <argument index="5" name="normal_map" type="Texture" default="null"> </argument> @@ -51064,11 +51478,11 @@ </argument> <argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> </argument> - <argument index="4" name="transpose" type="bool" default="null"> + <argument index="4" name="transpose" type="bool" default="false"> </argument> <argument index="5" name="normal_map" type="Texture" default="null"> </argument> - <argument index="6" name="clip_uv" type="bool" default="null"> + <argument index="6" name="clip_uv" type="bool" default="true"> </argument> <description> </description> @@ -51199,7 +51613,7 @@ </description> </method> <method name="get_stretch_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="TextureButton.StretchMode"> </return> <description> </description> @@ -51490,14 +51904,14 @@ </class> <class name="TextureRect" inherits="Control" category="Core"> <brief_description> - Control Frame that draws a texture. + Control that draws a texture. </brief_description> <description> - Control frame that simply draws an assigned texture. It can stretch or not. It's a simple way to just show an image in a UI. + Control that draws a texture. </description> <methods> <method name="get_stretch_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="TextureRect.StretchMode"> </return> <description> </description> @@ -51541,10 +51955,13 @@ </methods> <members> <member name="expand" type="bool" setter="set_expand" getter="has_expand" brief=""> + If [code]true[/code] texture will expand to fit. Default value: [code]false[/code]. </member> <member name="stretch_mode" type="int" setter="set_stretch_mode" getter="get_stretch_mode" brief="" enum="TextureRect.StretchMode"> + Stretch mode of the texture. Use STRETCH_* constants as value. </member> <member name="texture" type="Texture" setter="set_texture" getter="get_texture" brief=""> + The [Texture] resource for the node. </member> </members> <constants> @@ -51890,7 +52307,7 @@ </description> </method> <method name="start"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="instance" type="Object"> </argument> @@ -51898,7 +52315,7 @@ </argument> <argument index="2" name="userdata" type="Variant" default="null"> </argument> - <argument index="3" name="priority" type="int" default="null"> + <argument index="3" name="priority" type="int" default="1"> </argument> <description> Start a new [Thread], it will run "method" on object "instance" using "userdata" as an argument and running with "priority", one of PRIORITY_* enum. @@ -52038,14 +52455,14 @@ </description> </method> <method name="get_half_offset" qualifiers="const"> - <return type="int"> + <return type="int" enum="TileMap.HalfOffset"> </return> <description> Return the current half offset configuration. </description> </method> <method name="get_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="TileMap.Mode"> </return> <description> Return the orientation mode. @@ -52065,7 +52482,7 @@ </description> </method> <method name="get_tile_origin" qualifiers="const"> - <return type="int"> + <return type="int" enum="TileMap.TileOrigin"> </return> <description> Return the tile origin configuration. @@ -52144,7 +52561,7 @@ </return> <argument index="0" name="mappos" type="Vector2"> </argument> - <argument index="1" name="ignore_half_ofs" type="bool" default="null"> + <argument index="1" name="ignore_half_ofs" type="bool" default="false"> </argument> <description> Return the absolute world position corresponding to the tilemap (grid-based) coordinates given as an argument. @@ -52160,11 +52577,11 @@ </argument> <argument index="2" name="tile" type="int"> </argument> - <argument index="3" name="flip_x" type="bool" default="null"> + <argument index="3" name="flip_x" type="bool" default="false"> </argument> - <argument index="4" name="flip_y" type="bool" default="null"> + <argument index="4" name="flip_y" type="bool" default="false"> </argument> - <argument index="5" name="transpose" type="bool" default="null"> + <argument index="5" name="transpose" type="bool" default="false"> </argument> <description> Set the tile index for the cell referenced by its grid-based X and Y coordinates. @@ -52190,9 +52607,9 @@ </argument> <argument index="2" name="flip_x" type="bool" default="false"> </argument> - <argument index="3" name="flip_y" type="bool" default="null"> + <argument index="3" name="flip_y" type="bool" default="false"> </argument> - <argument index="4" name="transpose" type="bool" default="null"> + <argument index="4" name="transpose" type="bool" default="false"> </argument> <description> Set the tile index for the cell referenced by a Vector2 of grid-based coordinates. @@ -52506,7 +52923,7 @@ </argument> <argument index="2" name="shape_transform" type="Transform2D"> </argument> - <argument index="3" name="one_way" type="bool" default="null"> + <argument index="3" name="one_way" type="bool" default="false"> </argument> <description> </description> @@ -52823,7 +53240,7 @@ </description> </method> <method name="get_timer_process_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Timer.TimerProcessMode"> </return> <description> Return the timer's processing mode. @@ -52955,8 +53372,15 @@ </class> <class name="ToolButton" inherits="Button" category="Core"> <brief_description> + Flat button helper class. </brief_description> <description> + This is a helper class to generate a flat [Button] (see [method Button.set_flat]), creating a ToolButton is equivalent to: + + [codeblock] + var btn = Button.new() + btn.set_flat(true) + [/codeblock] </description> <methods> </methods> @@ -53024,7 +53448,7 @@ </description> </method> <method name="get_visibility_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="TouchScreenButton.VisibilityMode"> </return> <description> </description> @@ -53161,10 +53585,10 @@ </class> <class name="Transform" category="Built-In Types"> <brief_description> - 3D Transformation. + 3D Transformation. 3x4 matrix. </brief_description> <description> - Transform is used to store translation, rotation and scaling transformations. It consists of a Basis "basis" and Vector3 "origin". Transform is used to represent transformations of objects in space, and as such, determine their position, orientation and scale. It is similar to a 3x4 matrix. + Represents one or many transformations in 3D space such as translation, rotation, or scaling. It consists of a [Basis] "basis" and an [Vector3] "origin". It is similar to a 3x4 matrix. </description> <methods> <method name="Transform"> @@ -53179,7 +53603,7 @@ <argument index="3" name="origin" type="Vector3"> </argument> <description> - Construct the Transform from four Vector3. Each axis corresponds to local basis vectors (some of which may be scaled). + Construct the Transform from four [Vector3]. Each axis corresponds to local basis vectors (some of which may be scaled). </description> </method> <method name="Transform"> @@ -53190,7 +53614,7 @@ <argument index="1" name="origin" type="Vector3"> </argument> <description> - Construct the Transform from a Basis and Vector3. + Construct the Transform from a [Basis] and [Vector3]. </description> </method> <method name="Transform"> @@ -53199,7 +53623,7 @@ <argument index="0" name="from" type="Transform2D"> </argument> <description> - Construct the Transform from a Transform2D. + Construct the Transform from a [Transform2D]. </description> </method> <method name="Transform"> @@ -53208,7 +53632,7 @@ <argument index="0" name="from" type="Quat"> </argument> <description> - Construct the Transform from a Quat. The origin will be Vector3(0, 0, 0). + Construct the Transform from a [Quat]. The origin will be Vector3(0, 0, 0). </description> </method> <method name="Transform"> @@ -53217,7 +53641,7 @@ <argument index="0" name="from" type="Basis"> </argument> <description> - Construct the Transform from a Basis. The origin will be Vector3(0, 0, 0). + Construct the Transform from a [Basis]. The origin will be Vector3(0, 0, 0). </description> </method> <method name="affine_inverse"> @@ -53235,13 +53659,14 @@ <argument index="1" name="weight" type="float"> </argument> <description> + Interpolate to other Transform by weight amount (0-1). </description> </method> <method name="inverse"> <return type="Transform"> </return> <description> - Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling). + Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use affine_inverse for transforms with scaling). </description> </method> <method name="looking_at"> @@ -53288,7 +53713,7 @@ <argument index="0" name="ofs" type="Vector3"> </argument> <description> - Translate the transform by the specified displacement. + Translate the transform by the specified offset. </description> </method> <method name="xform"> @@ -53312,10 +53737,10 @@ </methods> <members> <member name="basis" type="Basis" setter="" getter="" brief=""> - The basis is a matrix containing 3 [Vector3] as its columns: X axis, Y axis, and Z axis. These vectors can be interpreted as the basis vectors of local coordinate system travelling with the object. + The basis is a matrix containing 3 [Vector3] as its columns: X axis, Y axis, and Z axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. </member> <member name="origin" type="Vector3" setter="" getter="" brief=""> - The origin of the transform. Which is the translation offset. + The translation offset of the transform. </member> </members> <constants> @@ -53323,10 +53748,10 @@ </class> <class name="Transform2D" category="Built-In Types"> <brief_description> - 3x2 Matrix for 2D transforms. + 2D Transformation. 3x2 matrix. </brief_description> <description> - 3x2 Matrix for 2D transforms. + Represents one or many transformations in 3D space such as translation, rotation, or scaling. It consists of a two [Vector2] x, y and [Vector2] "origin". It is similar to a 3x2 matrix. </description> <methods> <method name="Transform2D"> @@ -53335,6 +53760,7 @@ <argument index="0" name="from" type="Transform"> </argument> <description> + Constructs the [Transform2D] from a 3D [Transform]. </description> </method> <method name="Transform2D"> @@ -53347,6 +53773,7 @@ <argument index="2" name="origin" type="Vector2"> </argument> <description> + Constructs the [Transform2D] from 3 [Vector2] consisting of rows x, y and origin. </description> </method> <method name="Transform2D"> @@ -53357,13 +53784,14 @@ <argument index="1" name="pos" type="Vector2"> </argument> <description> + Constructs the [Transform2D] from rotation angle in radians and position [Vector2]. </description> </method> <method name="affine_inverse"> <return type="Transform2D"> </return> <description> - Return the inverse of the matrix. + Returns the inverse of the matrix. </description> </method> <method name="basis_xform"> @@ -53372,6 +53800,7 @@ <argument index="0" name="v" type="var"> </argument> <description> + Transforms the given vector "v" by this transform basis (no translation). </description> </method> <method name="basis_xform_inv"> @@ -53380,12 +53809,14 @@ <argument index="0" name="v" type="var"> </argument> <description> + Inverse-transforms vector "v" by this transform basis (no translation). </description> </method> <method name="get_origin"> <return type="Vector2"> </return> <description> + Return the origin [Vector2] (translation). </description> </method> <method name="get_rotation"> @@ -53399,6 +53830,7 @@ <return type="Vector2"> </return> <description> + Return the scale. </description> </method> <method name="interpolate_with"> @@ -53409,18 +53841,21 @@ <argument index="1" name="weight" type="float"> </argument> <description> + Interpolate to other Transform2D by weight amount (0-1). </description> </method> <method name="inverse"> <return type="Transform2D"> </return> <description> + Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use affine_inverse for transforms with scaling). </description> </method> <method name="orthonormalized"> <return type="Transform2D"> </return> <description> + Returns a transfrom with the basis orthogonal (90 degrees), and normalized axis vectors. </description> </method> <method name="rotated"> @@ -53429,6 +53864,7 @@ <argument index="0" name="phi" type="float"> </argument> <description> + Rotate the transform by phi. </description> </method> <method name="scaled"> @@ -53437,6 +53873,7 @@ <argument index="0" name="scale" type="Vector2"> </argument> <description> + Scale the transform by the specified 2D scaling factors. </description> </method> <method name="translated"> @@ -53445,6 +53882,7 @@ <argument index="0" name="offset" type="Vector2"> </argument> <description> + Translate the transform by the specified offset. </description> </method> <method name="xform"> @@ -53453,6 +53891,7 @@ <argument index="0" name="v" type="var"> </argument> <description> + Transforms the given vector "v" by this transform. </description> </method> <method name="xform_inv"> @@ -53461,15 +53900,19 @@ <argument index="0" name="v" type="var"> </argument> <description> + Inverse-transforms the given vector "v" by this transform. </description> </method> </methods> <members> <member name="origin" type="Vector2" setter="" getter="" brief=""> + The translation offset of the transform. </member> <member name="x" type="Vector2" setter="" getter="" brief=""> + The X axis of 2x2 basis matrix containing 2 [Vector2] as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. </member> <member name="y" type="Vector2" setter="" getter="" brief=""> + The Y axis of 2x2 basis matrix containing 2 [Vector2] as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. </member> </members> <constants> @@ -53735,7 +54178,7 @@ </return> <argument index="0" name="item" type="Object"> </argument> - <argument index="1" name="column" type="int" default="null"> + <argument index="1" name="column" type="int" default="-1"> </argument> <description> Get the rectangle area of the the specified item. If column is specified, only get the position and size of that column, otherwise get the rectangle containing all columns. @@ -54103,9 +54546,9 @@ </argument> <argument index="2" name="button_idx" type="int" default="-1"> </argument> - <argument index="3" name="disabled" type="bool" default="null"> + <argument index="3" name="disabled" type="bool" default="false"> </argument> - <argument index="4" name="tooltip" type="String" default="null"> + <argument index="4" name="tooltip" type="String" default=""""> </argument> <description> </description> @@ -54163,7 +54606,7 @@ </description> </method> <method name="get_cell_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="TreeItem.TreeCellMode"> </return> <argument index="0" name="column" type="int"> </argument> @@ -54279,7 +54722,7 @@ </description> </method> <method name="get_text_align" qualifiers="const"> - <return type="int"> + <return type="int" enum="TreeItem.TextAlign"> </return> <argument index="0" name="column" type="int"> </argument> @@ -54441,7 +54884,7 @@ </argument> <argument index="1" name="color" type="Color"> </argument> - <argument index="2" name="just_outline" type="bool" default="null"> + <argument index="2" name="just_outline" type="bool" default="false"> </argument> <description> </description> @@ -54557,7 +55000,7 @@ </argument> <argument index="3" name="step" type="float"> </argument> - <argument index="4" name="expr" type="bool" default="null"> + <argument index="4" name="expr" type="bool" default="false"> </argument> <description> </description> @@ -54663,7 +55106,7 @@ </argument> <argument index="7" name="ease_type" type="int" enum="Tween.EaseType"> </argument> - <argument index="8" name="delay" type="float" default="null"> + <argument index="8" name="delay" type="float" default="0"> </argument> <description> Follow [code]method[/code] of [code]object[/code] and apply the returned value on [code]target_method[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]duration[/code] seconds, [code]delay[/code] later. Methods are animated by calling them with consequitive values. @@ -54689,7 +55132,7 @@ </argument> <argument index="7" name="ease_type" type="int" enum="Tween.EaseType"> </argument> - <argument index="8" name="delay" type="float" default="null"> + <argument index="8" name="delay" type="float" default="0"> </argument> <description> Follow [code]property[/code] of [code]object[/code] and apply it on [code]target_property[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Note that [code]target:target_property[/code] would equal [code]object:property[/code] at the end of the tween. @@ -54711,7 +55154,7 @@ </description> </method> <method name="get_tween_process_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Tween.TweenProcessMode"> </return> <description> Returns the process mode that has been set from editor GUI or [method set_tween_process_mode] @@ -54780,7 +55223,7 @@ </argument> <argument index="6" name="ease_type" type="int" enum="Tween.EaseType"> </argument> - <argument index="7" name="delay" type="float" default="null"> + <argument index="7" name="delay" type="float" default="0"> </argument> <description> Animate [code]method[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecuitive values. @@ -54804,7 +55247,7 @@ </argument> <argument index="6" name="ease_type" type="int" enum="Tween.EaseType"> </argument> - <argument index="7" name="delay" type="float" default="null"> + <argument index="7" name="delay" type="float" default="0"> </argument> <description> Animate [code]property[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. @@ -54830,7 +55273,7 @@ </return> <argument index="0" name="object" type="Object"> </argument> - <argument index="1" name="key" type="String" default="null"> + <argument index="1" name="key" type="String" default=""""> </argument> <description> Stop animating and completely remove a tween, given its object and property/method pair. Passing empty String as key will remove all tweens for given object. @@ -54848,7 +55291,7 @@ </return> <argument index="0" name="object" type="Object"> </argument> - <argument index="1" name="key" type="String" default="null"> + <argument index="1" name="key" type="String" default=""""> </argument> <description> Resets a tween to the initial value (the one given, not the one before the tween), given its object and property/method pair. Passing empty String as key will reset all tweens for given object. @@ -54866,7 +55309,7 @@ </return> <argument index="0" name="object" type="Object"> </argument> - <argument index="1" name="key" type="String" default="null"> + <argument index="1" name="key" type="String" default=""""> </argument> <description> Continue animating a stopped tween, given its object and property/method pair. Passing empty String as key will resume all tweens for given object. @@ -54936,7 +55379,7 @@ </return> <argument index="0" name="object" type="Object"> </argument> - <argument index="1" name="key" type="String" default="null"> + <argument index="1" name="key" type="String" default=""""> </argument> <description> Stop animating a tween, given its object and property/method pair. Passing empty String as key will stop all tweens for given object. @@ -54968,7 +55411,7 @@ </argument> <argument index="7" name="ease_type" type="int" enum="Tween.EaseType"> </argument> - <argument index="8" name="delay" type="float" default="null"> + <argument index="8" name="delay" type="float" default="0"> </argument> <description> Animate [code]method[/code] of [code]object[/code] from the value returned by [code]initial.initial_method[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecuitive values. @@ -54994,7 +55437,7 @@ </argument> <argument index="7" name="ease_type" type="int" enum="Tween.EaseType"> </argument> - <argument index="8" name="delay" type="float" default="null"> + <argument index="8" name="delay" type="float" default="0"> </argument> <description> Animate [code]property[/code] of [code]object[/code] from the current value of the [code]initial_val[/code] property of [code]initial[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. @@ -55192,7 +55635,7 @@ </return> <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="merge_mode" type="int" enum="UndoRedo.MergeMode" default="null"> + <argument index="1" name="merge_mode" type="int" enum="UndoRedo.MergeMode" default="0"> </argument> <description> Create a new action. After this is called, do all your calls to [method add_do_method], [method add_undo_method], [method add_do_property] and [method add_undo_property]. @@ -55342,8 +55785,10 @@ </class> <class name="Variant" category="Core"> <brief_description> + The most important data type in Godot. </brief_description> <description> + A Variant takes up only 20 bytes and can store almost any engine datatype inside of it. Variants are rarely used to hold information for long periods of time, instead they are used mainly for communication, editing, serialization and moving data around. </description> <methods> </methods> @@ -56365,13 +56810,13 @@ </description> </method> <method name="get_clear_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Viewport.ClearMode"> </return> <description> </description> </method> <method name="get_debug_draw" qualifiers="const"> - <return type="int"> + <return type="int" enum="Viewport.DebugDraw"> </return> <description> </description> @@ -56405,7 +56850,7 @@ </description> </method> <method name="get_msaa" qualifiers="const"> - <return type="int"> + <return type="int" enum="Viewport.MSAA"> </return> <description> </description> @@ -56426,7 +56871,7 @@ </description> </method> <method name="get_shadow_atlas_quadrant_subdiv" qualifiers="const"> - <return type="int"> + <return type="int" enum="Viewport.ShadowAtlasQuadrantSubdiv"> </return> <argument index="0" name="quadrant" type="int"> </argument> @@ -56461,14 +56906,14 @@ </description> </method> <method name="get_update_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="Viewport.UpdateMode"> </return> <description> Get when the viewport would be updated, will be one of the [code]UPDATE_*[/code] constants. </description> </method> <method name="get_usage" qualifiers="const"> - <return type="int"> + <return type="int" enum="Viewport.Usage"> </return> <description> </description> @@ -56721,7 +57166,7 @@ </argument> <argument index="1" name="size" type="Vector2" default="Vector2( -1, -1 )"> </argument> - <argument index="2" name="margin" type="Vector2" default="null"> + <argument index="2" name="margin" type="Vector2" default="Vector2( 0, 0 )"> </argument> <description> Set the size override of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to [code](-1, -1)[/code], it won't update the size. @@ -57327,7 +57772,7 @@ </argument> <argument index="2" name="node" type="VisualScriptNode"> </argument> - <argument index="3" name="pos" type="Vector2" default="null"> + <argument index="3" name="pos" type="Vector2" default="Vector2( 0, 0 )"> </argument> <description> </description> @@ -57339,7 +57784,7 @@ </argument> <argument index="1" name="default_value" type="Variant" default="null"> </argument> - <argument index="2" name="export" type="bool" default="null"> + <argument index="2" name="export" type="bool" default="false"> </argument> <description> </description> @@ -57353,7 +57798,7 @@ </argument> <argument index="2" name="argname" type="String"> </argument> - <argument index="3" name="index" type="int" default="null"> + <argument index="3" name="index" type="int" default="-1"> </argument> <description> </description> @@ -57377,7 +57822,7 @@ </description> </method> <method name="custom_signal_get_argument_type" qualifiers="const"> - <return type="int"> + <return type="int" enum="Variant.Type"> </return> <argument index="0" name="name" type="String"> </argument> @@ -57765,7 +58210,7 @@ </description> <methods> <method name="get_basic_type" qualifiers="const"> - <return type="int"> + <return type="int" enum="Variant.Type"> </return> <description> </description> @@ -57809,7 +58254,7 @@ </description> <methods> <method name="get_func"> - <return type="int"> + <return type="int" enum="VisualScriptBuiltinFunc.BuiltinFunc"> </return> <description> </description> @@ -57951,7 +58396,7 @@ </description> <methods> <method name="get_constant_type" qualifiers="const"> - <return type="int"> + <return type="int" enum="Variant.Type"> </return> <description> </description> @@ -58001,7 +58446,7 @@ </description> </method> <method name="get_constructor_type" qualifiers="const"> - <return type="int"> + <return type="int" enum="Variant.Type"> </return> <description> </description> @@ -58167,7 +58612,7 @@ </description> <methods> <method name="get_deconstruct_type" qualifiers="const"> - <return type="int"> + <return type="int" enum="Variant.Type"> </return> <description> </description> @@ -58291,13 +58736,13 @@ </description> </method> <method name="get_basic_type" qualifiers="const"> - <return type="int"> + <return type="int" enum="Variant.Type"> </return> <description> </description> </method> <method name="get_call_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="VisualScriptFunctionCall.CallMode"> </return> <description> </description> @@ -58309,7 +58754,7 @@ </description> </method> <method name="get_rpc_call_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="VisualScriptFunctionCall.RPCCallMode"> </return> <description> </description> @@ -58539,7 +58984,7 @@ </description> <methods> <method name="get_action_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="VisualScriptInputAction.Mode"> </return> <description> </description> @@ -58599,7 +59044,7 @@ </description> </method> <method name="get_var_type" qualifiers="const"> - <return type="int"> + <return type="int" enum="Variant.Type"> </return> <description> </description> @@ -58643,7 +59088,7 @@ </description> </method> <method name="get_var_type" qualifiers="const"> - <return type="int"> + <return type="int" enum="Variant.Type"> </return> <description> </description> @@ -58681,7 +59126,7 @@ </description> <methods> <method name="get_math_constant"> - <return type="int"> + <return type="int" enum="VisualScriptMathConstant.MathConstant"> </return> <description> </description> @@ -58753,13 +59198,13 @@ </description> <methods> <method name="get_operator" qualifiers="const"> - <return type="int"> + <return type="int" enum="Variant.Operator"> </return> <description> </description> </method> <method name="get_typed" qualifiers="const"> - <return type="int"> + <return type="int" enum="Variant.Type"> </return> <description> </description> @@ -58843,13 +59288,13 @@ </description> </method> <method name="get_basic_type" qualifiers="const"> - <return type="int"> + <return type="int" enum="Variant.Type"> </return> <description> </description> </method> <method name="get_call_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="VisualScriptPropertyGet.CallMode"> </return> <description> </description> @@ -58957,7 +59402,7 @@ </description> <methods> <method name="get_assign_op" qualifiers="const"> - <return type="int"> + <return type="int" enum="VisualScriptPropertySet.AssignOp"> </return> <description> </description> @@ -58981,13 +59426,13 @@ </description> </method> <method name="get_basic_type" qualifiers="const"> - <return type="int"> + <return type="int" enum="Variant.Type"> </return> <description> </description> </method> <method name="get_call_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="VisualScriptPropertySet.CallMode"> </return> <description> </description> @@ -59133,7 +59578,7 @@ </description> <methods> <method name="get_return_type" qualifiers="const"> - <return type="int"> + <return type="int" enum="Variant.Type"> </return> <description> </description> @@ -59215,7 +59660,7 @@ </description> <methods> <method name="get_typed" qualifiers="const"> - <return type="int"> + <return type="int" enum="Variant.Type"> </return> <description> </description> @@ -59425,7 +59870,7 @@ </description> </method> <method name="get_yield_mode"> - <return type="int"> + <return type="int" enum="VisualScriptYield.YieldMode"> </return> <description> </description> @@ -59481,7 +59926,7 @@ </description> </method> <method name="get_call_mode" qualifiers="const"> - <return type="int"> + <return type="int" enum="VisualScriptYieldSignal.CallMode"> </return> <description> </description> @@ -59570,7 +60015,7 @@ </return> <argument index="0" name="image" type="Image"> </argument> - <argument index="1" name="flags" type="int" default="null"> + <argument index="1" name="flags" type="int" default="7"> </argument> <description> </description> @@ -59924,7 +60369,7 @@ </description> </method> <method name="get_node_type"> - <return type="int"> + <return type="int" enum="XMLParser.NodeType"> </return> <description> Get the type of the current node. Compare with [code]NODE_*[/code] constants. @@ -59947,7 +60392,7 @@ </description> </method> <method name="open"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="file" type="String"> </argument> @@ -59956,7 +60401,7 @@ </description> </method> <method name="open_buffer"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="buffer" type="PoolByteArray"> </argument> @@ -59965,14 +60410,14 @@ </description> </method> <method name="read"> - <return type="int"> + <return type="int" enum="Error"> </return> <description> Read the next node of the file. This returns an error code. </description> </method> <method name="seek"> - <return type="int"> + <return type="int" enum="Error"> </return> <argument index="0" name="pos" type="int"> </argument> |