diff options
Diffstat (limited to 'doc')
58 files changed, 864 insertions, 368 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 5655578459..de5dc18702 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -1190,9 +1190,6 @@ <constant name="ERR_BUG" value="47" enum="Error"> Bug error </constant> - <constant name="ERR_WTF" value="49" enum="Error"> - WTF error (something probably went really wrong) - </constant> <constant name="PROPERTY_HINT_NONE" value="0" enum="PropertyHint"> No hint for edited property. </constant> @@ -1280,7 +1277,7 @@ </constant> <constant name="PROPERTY_USAGE_DEFAULT_INTL" value="71" enum="PropertyUsageFlags"> </constant> - <constant name="PROPERTY_USAGE_NOEDITOR" value="5" enum="PropertyUsageFlags"> + <constant name="PROPERTY_USAGE_NOEDITOR" value="1048581" enum="PropertyUsageFlags"> </constant> <constant name="METHOD_FLAG_NORMAL" value="1" enum="MethodFlags"> Flag for normal method diff --git a/doc/classes/ARVRController.xml b/doc/classes/ARVRController.xml index d813479cf1..47a9341643 100644 --- a/doc/classes/ARVRController.xml +++ b/doc/classes/ARVRController.xml @@ -31,7 +31,7 @@ <return type="bool"> </return> <description> - Returns true if the controller bound to this node is currently active and being tracked. + Returns [code]true[/code] if the bound controller is active. ARVR systems attempt to track active controllers. </description> </method> <method name="get_joystick_axis" qualifiers="const"> @@ -56,7 +56,7 @@ <argument index="0" name="button" type="int"> </argument> <description> - Is the given button currently pressed? + Returns [code]true[/code] if the button at index [code]button[/code] is pressed. </description> </method> </methods> @@ -65,6 +65,7 @@ The controller's id. The first controller that the [ARVRServer] detects will have id 1, the second id 2, the third id 3, etc. When a controller is turned off, it's slot is freed. This ensures controllers will keep the same id even when controllers with lower ids are turned off. </member> <member name="rumble" type="float" setter="set_rumble" getter="get_rumble"> + The degree to which the tracker rumbles. Ranges from [code]0.0[/code] to [code]1.0[/code] with precision [code].01[/code]. If changed, updates [member ARVRPositionalTracker.rumble] accordingly. </member> </members> <signals> @@ -72,14 +73,14 @@ <argument index="0" name="button" type="int"> </argument> <description> - When a button on this controller is pressed, this signal is given. + Emitted when a button on this controller is pressed. </description> </signal> <signal name="button_release"> <argument index="0" name="button" type="int"> </argument> <description> - When a button on this controller is released, this signal is given. + Emitted when a button on this controller is released. </description> </signal> </signals> diff --git a/doc/classes/ARVRPositionalTracker.xml b/doc/classes/ARVRPositionalTracker.xml index f171e4fc5a..88740f5dc1 100644 --- a/doc/classes/ARVRPositionalTracker.xml +++ b/doc/classes/ARVRPositionalTracker.xml @@ -31,35 +31,35 @@ <return type="String"> </return> <description> - If available this returns the name of the controller or anchor point. + Returns the controller or anchor point's name if available. </description> </method> <method name="get_orientation" qualifiers="const"> <return type="Basis"> </return> <description> - Returns the orientation matrix of the controller. + Returns the controller's orientation matrix. </description> </method> <method name="get_position" qualifiers="const"> <return type="Vector3"> </return> <description> - Returns the position of the controller adjusted by world scale. + Returns the world-space controller position. </description> </method> <method name="get_tracks_orientation" qualifiers="const"> <return type="bool"> </return> <description> - Returns true if the orientation of this device is being tracked. + Returns [code]true[/code] if this device tracks orientation. </description> </method> <method name="get_tracks_position" qualifiers="const"> <return type="bool"> </return> <description> - Returns true if the position of this device is being tracked. + Returns [code]true[/code] if this device tracks position. </description> </method> <method name="get_transform" qualifiers="const"> @@ -68,19 +68,20 @@ <argument index="0" name="adjust_by_reference_frame" type="bool"> </argument> <description> - Returns the transform combining the orientation and position of this device. + Returns the transform combining this device's orientation and position. </description> </method> <method name="get_type" qualifiers="const"> <return type="int" enum="ARVRServer.TrackerType"> </return> <description> - Type of tracker. + Returns the tracker's type. </description> </method> </methods> <members> <member name="rumble" type="float" setter="set_rumble" getter="get_rumble"> + The degree to which the tracker rumbles. Ranges from [code]0.0[/code] to [code]1.0[/code] with precision [code].01[/code]. </member> </members> <constants> diff --git a/doc/classes/AStar.xml b/doc/classes/AStar.xml index acbd49afb9..eefdf4d7a7 100644 --- a/doc/classes/AStar.xml +++ b/doc/classes/AStar.xml @@ -47,7 +47,7 @@ Adds a new point at the given position with the given identifier. The algorithm prefers points with lower [code]weight_scale[/code] to form a path. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 1 or larger. [codeblock] var as = AStar.new() - + as.add_point(1, Vector3(1,0,0), 4) # Adds the point (1,0,0) with weight_scale=4 and id=1 [/codeblock] If there already exists a point for the given id, its position and weight scale are updated to the given values. @@ -84,10 +84,10 @@ Creates a segment between the given points. [codeblock] var as = AStar.new() - + as.add_point(1, Vector3(1,1,0)) as.add_point(2, Vector3(0,5,0)) - + as.connect_points(1, 2, false) # If bidirectional=false it's only possible to go from point 1 to point 2 # and not from point 2 to point 1. [/codeblock] @@ -129,12 +129,12 @@ Returns the closest position to [code]to_position[/code] that resides inside a segment between two connected points. [codeblock] var as = AStar.new() - + as.add_point(1, Vector3(0,0,0)) as.add_point(2, Vector3(0,5,0)) - + as.connect_points(1, 2) - + var res = as.get_closest_position_in_segment(Vector3(3,3,0)) # returns (0, 3, 0) [/codeblock] The result is in the segment that goes from [code]y=0[/code] to [code]y=5[/code]. It's the closest position in the segment to the given point. @@ -151,18 +151,18 @@ Returns an array with the ids of the points that form the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path. [codeblock] var as = AStar.new() - + as.add_point(1, Vector3(0,0,0)) as.add_point(2, Vector3(0,1,0), 1) # default weight is 1 as.add_point(3, Vector3(1,1,0)) as.add_point(4, Vector3(2,0,0)) - + as.connect_points(1, 2, false) as.connect_points(2, 3, false) as.connect_points(4, 3, false) as.connect_points(1, 4, false) as.connect_points(5, 4, false) - + var res = as.get_id_path(1, 3) # returns [1, 2, 3] [/codeblock] If you change the 2nd point's weight to 3, then the result will be [code][1, 4, 3][/code] instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2. @@ -223,6 +223,7 @@ <return type="Array"> </return> <description> + Returns an array of all points. </description> </method> <method name="has_point" qualifiers="const"> diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index ac547d20b7..c3933443a0 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -157,6 +157,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns [code]true[/code] if the track at [code]idx[/code] wraps the interpolation loop. Default value: [code]true[/code]. </description> </method> <method name="track_get_interpolation_type" qualifiers="const"> @@ -311,6 +312,7 @@ <argument index="1" name="interpolation" type="bool"> </argument> <description> + If [code]true[/code] the track at [code]idx[/code] wraps the interpolation loop. </description> </method> <method name="track_set_interpolation_type"> diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index e724f24498..6ae0debc3a 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -19,7 +19,7 @@ <argument index="1" name="animation" type="Animation"> </argument> <description> - Add an animation resource to the player, which will be later referenced by the "name" argument. + Adds [code]animation[/code] to the player accessible with the key [code]name[/code]. </description> </method> <method name="advance"> @@ -28,7 +28,7 @@ <argument index="0" name="delta" type="float"> </argument> <description> - Used to skip ahead or skip back in an animation. Delta is the time in seconds to skip. + Shifts position in the animation timeline. Delta is the time in seconds to shift. </description> </method> <method name="animation_get_next" qualifiers="const"> @@ -37,7 +37,7 @@ <argument index="0" name="anim_from" type="String"> </argument> <description> - Return the name of the next animation in the queue. + Returns the name of the next animation in the queue. </description> </method> <method name="animation_set_next"> @@ -48,21 +48,21 @@ <argument index="1" name="anim_to" type="String"> </argument> <description> - Set the name of an animation that will be played after. + Triggers the [code]anim_to[/code] animation when the [code]anim_from[/code] animation completes. </description> </method> <method name="clear_caches"> <return type="void"> </return> <description> - The animation player creates caches for faster access to the nodes it will animate. However, if a specific node is removed, it may not notice it, so clear_caches will force the player to search for the nodes again. + [code]AnimationPlayer[/code] caches animated nodes. It may not notice if a node disappears, so clear_caches forces it to update the cache again. </description> </method> <method name="clear_queue"> <return type="void"> </return> <description> - If animations are queued to play, clear them. + Clears all queued, unplayed animations. </description> </method> <method name="find_animation" qualifiers="const"> @@ -71,7 +71,21 @@ <argument index="0" name="animation" type="Animation"> </argument> <description> - Find an animation name by resource. + Returns the name of [code]animation[/code] or empty string if not found. + </description> + </method> + <method name="get_anim_length" qualifiers="const"> + <return type="float"> + </return> + <description> + Get the length (in seconds) of the currently playing animation. + </description> + </method> + <method name="get_anim_position" qualifiers="const"> + <return type="float"> + </return> + <description> + Get the position (in seconds) of the currently playing animation. </description> </method> <method name="get_animation" qualifiers="const"> @@ -80,21 +94,14 @@ <argument index="0" name="name" type="String"> </argument> <description> - Get an [Animation] resource by requesting a name. + Returns the [Animation] with key [code]name[/code] or [code]null[/code] if not found. </description> </method> <method name="get_animation_list" qualifiers="const"> <return type="PoolStringArray"> </return> <description> - Get the list of names of the animations stored in the player. - </description> - </method> - <method name="get_autoplay" qualifiers="const"> - <return type="String"> - </return> - <description> - Return the name of the animation that will be automatically played when the scene is loaded. + Returns the list of stored animation names. </description> </method> <method name="get_blend_time" qualifiers="const"> @@ -105,42 +112,14 @@ <argument index="1" name="anim_to" type="String"> </argument> <description> - Get the blend time between two animations, referenced by their names. + Get the blend time (in seconds) between two animations, referenced by their names. </description> </method> <method name="get_current_animation" qualifiers="const"> <return type="String"> </return> <description> - Return the name of the animation being played. - </description> - </method> - <method name="get_current_animation_length" qualifiers="const"> - <return type="float"> - </return> - <description> - Get the length (in seconds) of the currently being played animation. - </description> - </method> - <method name="get_current_animation_position" qualifiers="const"> - <return type="float"> - </return> - <description> - Get the position (in seconds) of the currently being played animation. - </description> - </method> - <method name="get_position" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided). - </description> - </method> - <method name="get_speed_scale" qualifiers="const"> - <return type="float"> - </return> - <description> - Get the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is [i]1[/i] (no scaling). + Returns the name of the currently playing animation. </description> </method> <method name="has_animation" qualifiers="const"> @@ -149,21 +128,14 @@ <argument index="0" name="name" type="String"> </argument> <description> - Request whether an [Animation] name exist within the player. - </description> - </method> - <method name="is_active" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if the player is active. + Returns [code]true[/code] if the [code]AnimationPlayer[/code] stores an [Animation] with key [code]name[/code]. </description> </method> <method name="is_playing" qualifiers="const"> <return type="bool"> </return> <description> - Return whether an animation is playing. + Returns [code]true[/code] if playing an animation. </description> </method> <method name="play"> @@ -178,7 +150,7 @@ <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. + Play the animation with key [code]name[/code]. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards. </description> </method> <method name="play_backwards"> @@ -189,7 +161,7 @@ <argument index="1" name="custom_blend" type="float" default="-1"> </argument> <description> - Play a given animation by the animation name in reverse. + Play the animation with key [code]name[/code] in reverse. </description> </method> <method name="queue"> @@ -207,7 +179,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Remove an animation from the player (by supplying the same name used to add it). + Remove the animation with key [code]name[/code]. </description> </method> <method name="rename_animation"> @@ -218,7 +190,7 @@ <argument index="1" name="newname" type="String"> </argument> <description> - Rename an existing animation. + Rename an existing animation with key [code]name[/code] to [code]newname[/code]. </description> </method> <method name="seek"> @@ -229,25 +201,7 @@ <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. - </description> - </method> - <method name="set_active"> - <return type="void"> - </return> - <argument index="0" name="active" type="bool"> - </argument> - <description> - Set the player as active (playing). If false, it will do nothing. - </description> - </method> - <method name="set_autoplay"> - <return type="void"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - Set the name of the animation that will be automatically played when the scene is loaded. + Seek the animation to the [code]seconds[/code] point in time (in seconds). If 'update' is true, the animation updates too, otherwise it updates at process time. </description> </method> <method name="set_blend_time"> @@ -272,22 +226,13 @@ Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play(). </description> </method> - <method name="set_speed_scale"> - <return type="void"> - </return> - <argument index="0" name="speed" type="float"> - </argument> - <description> - Set a speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is [i]1[/i] (no scaling). - </description> - </method> <method name="stop"> <return type="void"> </return> <argument index="0" name="reset" type="bool" default="true"> </argument> <description> - Stop the currently playing animation. + Stop the currently playing animation. If [code]reset[/code] is [code]true[/code], the anim position is reset to [code]0[/code]. </description> </method> <method name="stop_all"> @@ -299,11 +244,23 @@ </method> </methods> <members> - <member name="playback_default_blend_time" type="float" setter="set_default_blend_time" getter="get_default_blend_time"> + <member name="active" type="bool" setter="set_active" getter="is_active"> + If [code]true[/code] updates animations in response to process-related notifications. Default value: [code]true[/code]. + </member> + <member name="autoplay" type="String" setter="set_autoplay" getter="get_autoplay"> + The name of the animation to play when the scene loads. Default value: [code]""[/code]. + </member> + <member name="current_animation" type="String" setter="set_current_animation" getter="get_current_animation"> + The name of the current animation. Default value: [code]""[/code]. </member> <member name="playback_process_mode" type="int" setter="set_animation_process_mode" getter="get_animation_process_mode" enum="AnimationPlayer.AnimationProcessMode"> + The process notification in which to update animations. Default value: [enum ANIMATION_PROCESS_IDLE]. </member> <member name="root_node" type="NodePath" setter="set_root" getter="get_root"> + The node from which node path references will travel. Default value: [code]".."[/code]. + </member> + <member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale"> + The speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default value: [code]1[/code]. </member> </members> <signals> @@ -313,21 +270,21 @@ <argument index="1" name="new_name" type="String"> </argument> <description> - If the currently being played animation changes, this signal will notify of such change. + Emitted when the [Animation] with key [member current_anim] is modified. </description> </signal> <signal name="animation_finished"> <argument index="0" name="name" type="String"> </argument> <description> - Notifies when an animation finished playing. + Emitted when an animation finishes. </description> </signal> <signal name="animation_started"> <argument index="0" name="name" type="String"> </argument> <description> - Notifies when an animation starts playing. + Emitted when an animation starts. </description> </signal> </signals> diff --git a/doc/classes/AnimationTreePlayer.xml b/doc/classes/AnimationTreePlayer.xml index 4fb33eb5a3..37005c3bd3 100644 --- a/doc/classes/AnimationTreePlayer.xml +++ b/doc/classes/AnimationTreePlayer.xml @@ -4,7 +4,7 @@ Animation Player that uses a node graph for the blending. </brief_description> <description> - Animation Player that uses a node graph for the blending. This kind of player is very useful when animating character or other skeleton based rigs, because it can combine several animations to form a desired pose. + A node graph tool for blending multiple animations bound to an [AnimationPlayer]. Especially useful for animating characters or other skeleton-based rigs. It can combine several animations to form a desired pose. </description> <tutorials> </tutorials> @@ -19,7 +19,7 @@ <argument index="1" name="id" type="String"> </argument> <description> - Add a node of a given type in the graph with given id. + Adds a [code]type[/code] node to the graph with name [code]id[/code]. </description> </method> <method name="advance"> @@ -28,6 +28,7 @@ <argument index="0" name="delta" type="float"> </argument> <description> + Shifts position in the animation timeline. Delta is the time in seconds to shift. </description> </method> <method name="animation_node_get_animation" qualifiers="const"> @@ -36,7 +37,7 @@ <argument index="0" name="id" type="String"> </argument> <description> - Returns an animation given its name. + Returns the [AnimationPlayer]'s animation bound to the [code]AnimationTreePlayer[/code]'s animation node with name [code]id[/code]. </description> </method> <method name="animation_node_get_master_animation" qualifiers="const"> @@ -45,6 +46,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns the name of the [member master_player]'s animation bound to this animation node. </description> </method> <method name="animation_node_set_animation"> @@ -55,7 +57,7 @@ <argument index="1" name="animation" type="Animation"> </argument> <description> - Set the animation for an animation node. + Binds a new animation from the [member master_player] to the [code]AnimationTreePlayer[/code]'s animation node with name [code]id[/code]. </description> </method> <method name="animation_node_set_filter_path"> @@ -68,6 +70,7 @@ <argument index="2" name="enable" type="bool"> </argument> <description> + If [code]enable[/code] is [code]true[/code], the animation node with ID [code]id[/code] turns off the track modifying the property at [code]path[/code]. The modified node's children continue to animate. </description> </method> <method name="animation_node_set_master_animation"> @@ -78,6 +81,7 @@ <argument index="1" name="source" type="String"> </argument> <description> + Binds the animation named [code]source[/code] from [member master_player] to the animation node [code]id[/code]. Recalculates caches. </description> </method> <method name="are_nodes_connected" qualifiers="const"> @@ -123,6 +127,7 @@ <argument index="2" name="enable" type="bool"> </argument> <description> + If [code]enable[/code] is [code]true[/code], the blend2 node with ID [code]id[/code] turns off the track modifying the property at [code]path[/code]. The modified node's children continue to animate. </description> </method> <method name="blend3_node_get_amount" qualifiers="const"> @@ -199,6 +204,7 @@ <return type="NodePath"> </return> <description> + Returns the path to the [AnimationPlayer] from which this [code]AnimationTreePlayer[/code] binds animations to animation nodes. </description> </method> <method name="get_node_list"> @@ -423,6 +429,7 @@ <argument index="2" name="enable" type="bool"> </argument> <description> + If [code]enable[/code] is [code]true[/code], the oneshot node with ID [code]id[/code] turns off the track modifying the property at [code]path[/code]. The modified node's children continue to animate. </description> </method> <method name="oneshot_node_start"> @@ -440,13 +447,14 @@ <argument index="0" name="id" type="String"> </argument> <description> - Stops a OneShot node given its name. + Stops the OneShot node with name [code]id[/code]. </description> </method> <method name="recompute_caches"> <return type="void"> </return> <description> + Manually recalculates the cache of track information generated from animation nodes. Needed when external sources modify the animation nodes' state. </description> </method> <method name="remove_node"> @@ -455,6 +463,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Removes the animation node with name [code]id[/code]. </description> </method> <method name="reset"> @@ -496,7 +505,7 @@ <argument index="0" name="id" type="String"> </argument> <description> - Returns time scale value of a TimeScale node given its name. + Returns time scale value of the TimeScale node with name [code]id[/code]. </description> </method> <method name="timescale_node_set_scale"> @@ -507,7 +516,7 @@ <argument index="1" name="scale" type="float"> </argument> <description> - Sets time scale value of a TimeScale node given its name and value. + Sets the time scale of the TimeScale node with name [code]id[/code] to [code]scale[/code]. </description> </method> <method name="timeseek_node_seek"> @@ -518,7 +527,7 @@ <argument index="1" name="seconds" type="float"> </argument> <description> - Sets time seek value of a TimeSeek node given its name and value. + Sets the time seek value of the TimeSeek node with name [code]id[/code] to [code]seconds[/code] </description> </method> <method name="transition_node_delete_input"> @@ -529,6 +538,7 @@ <argument index="1" name="input_idx" type="int"> </argument> <description> + Deletes the input at [code]input_idx[/code] for the transition node with name [code]id[/code]. </description> </method> <method name="transition_node_get_current" qualifiers="const"> @@ -537,6 +547,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns the index of the currently evaluated input for the transition node with name [code]id[/code]. </description> </method> <method name="transition_node_get_input_count" qualifiers="const"> @@ -545,6 +556,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns the number of inputs for the transition node with name [code]id[/code]. </description> </method> <method name="transition_node_get_xfade_time" qualifiers="const"> @@ -553,6 +565,7 @@ <argument index="0" name="id" type="String"> </argument> <description> + Returns the cross fade time for the transition node with name [code]id[/code]. </description> </method> <method name="transition_node_has_input_auto_advance" qualifiers="const"> @@ -563,6 +576,7 @@ <argument index="1" name="input_idx" type="int"> </argument> <description> + Returns [code]true[/code] if the input at [code]input_idx[/code] on transition node with name [code]id[/code] is set to automatically advance to the next input upon completion. </description> </method> <method name="transition_node_set_current"> @@ -573,6 +587,7 @@ <argument index="1" name="input_idx" type="int"> </argument> <description> + The transition node with name [code]id[/code] sets its current input at [code]input_idx[/code]. </description> </method> <method name="transition_node_set_input_auto_advance"> @@ -585,6 +600,7 @@ <argument index="2" name="enable" type="bool"> </argument> <description> + The transition node with name [code]id[/code] advances to its next input automatically when the input at [code]input_idx[/code] completes. </description> </method> <method name="transition_node_set_input_count"> @@ -595,6 +611,7 @@ <argument index="1" name="count" type="int"> </argument> <description> + Resizes the number of inputs available for the transition node with name [code]id[/code]. </description> </method> <method name="transition_node_set_xfade_time"> @@ -605,11 +622,22 @@ <argument index="1" name="time_sec" type="float"> </argument> <description> + The transition node with name [code]id[/code] sets its cross fade time to [code]time_sec[/code]. </description> </method> </methods> <members> <member name="playback_process_mode" type="int" setter="set_animation_process_mode" getter="get_animation_process_mode" enum="AnimationTreePlayer.AnimationProcessMode"> + The thread in which to update animations. Default value: [enum ANIMATION_PROCESS_IDLE]. + </member> + <member name="master_player" type="NodePath" setter="set_master_player" getter="get_master_player"> + The path to the [AnimationPlayer] from which this [code]AnimationTreePlayer[/code] binds animations to animation nodes. + </member> + <member name="base_path" type="NodePath" setter="set_base_path" getter="get_base_path"> + The node from which to relatively access other nodes. Default value: [code]".."[/code]. + </member> + <member name="active" type="bool" setter="set_active" getter="is_active"> + If [code]true[/code] the [code]AnimationTreePlayer[/code] is able to play animations. Default value: [code]false[/code]. </member> </members> <constants> @@ -644,8 +672,10 @@ Transition node. </constant> <constant name="ANIMATION_PROCESS_PHYSICS" value="0" enum="AnimationProcessMode"> + Process animation during the physics process. This is especially useful when animating physics bodies. </constant> <constant name="ANIMATION_PROCESS_IDLE" value="1" enum="AnimationProcessMode"> + Process animation during the idle process. </constant> </constants> </class> diff --git a/doc/classes/Area.xml b/doc/classes/Area.xml index f58aa3cc0a..b74e767fd2 100644 --- a/doc/classes/Area.xml +++ b/doc/classes/Area.xml @@ -17,7 +17,7 @@ <argument index="0" name="bit" type="int"> </argument> <description> - Return an individual bit on the layer mask. + Returns an individual bit on the layer mask. </description> </method> <method name="get_collision_mask_bit" qualifiers="const"> @@ -26,7 +26,7 @@ <argument index="0" name="bit" type="int"> </argument> <description> - Return an individual bit on the collision mask. + Returns an individual bit on the collision mask. </description> </method> <method name="get_overlapping_areas" qualifiers="const"> @@ -69,7 +69,7 @@ <argument index="1" name="value" type="bool"> </argument> <description> - Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. + Set/clear individual bits on the layer mask. This simplifies editing this [code]Area[code]'s layers. </description> </method> <method name="set_collision_mask_bit"> @@ -80,7 +80,7 @@ <argument index="1" name="value" type="bool"> </argument> <description> - Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. + Set/clear individual bits on the collision mask. This simplifies editing which [code]Area[/code] layers this [code]Area[/code] scans. </description> </method> </methods> @@ -125,12 +125,16 @@ The area's priority. Higher priority areas are processed first. Default value: 0. </member> <member name="reverb_bus_amount" type="float" setter="set_reverb_amount" getter="get_reverb_amount"> + The degree to which this area applies reverb to its associated audio. Ranges from [code]0[/code] to [code]1[/code] with [code]0.1[/code] precision. </member> <member name="reverb_bus_enable" type="bool" setter="set_use_reverb_bus" getter="is_using_reverb_bus"> + If [code]true[/code] the area applies reverb to its associated audio. </member> <member name="reverb_bus_name" type="String" setter="set_reverb_bus" getter="get_reverb_bus"> + The reverb bus name to use for this area's associated audio. </member> <member name="reverb_bus_uniformity" type="float" setter="set_reverb_uniformity" getter="get_reverb_uniformity"> + The degree to which this area's reverb is a uniform effect. Ranges from [code]0[/code] to [code]1[/code] with [code]0.1[/code] precision. </member> <member name="space_override" type="int" setter="set_space_override_mode" getter="get_space_override_mode" enum="Area.SpaceOverride"> Override mode for gravity and damping calculations within this area. See the SPACE_OVERRIDE_* constants for values. diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index a7f9a6e09c..9445a1732e 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -284,6 +284,16 @@ </argument> <description> Sort the array using a custom method and return reference to the array. 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. + [codeblock] + class MyCustomSorter: + static func sort(a, b): + if a[0] < b[0]: + return true + return false + + var my_items = [[5, "Potato"], [9, "Rice"], [4, "Tomato"]] + my_items.sort_custom(MyCustomSorter, "sort") + [/codeblock] </description> </method> </methods> diff --git a/doc/classes/AtlasTexture.xml b/doc/classes/AtlasTexture.xml index 33566d9ec1..f1a79bc312 100644 --- a/doc/classes/AtlasTexture.xml +++ b/doc/classes/AtlasTexture.xml @@ -18,6 +18,7 @@ The texture that contains the atlas. Can be any [Texture] subtype. </member> <member name="filter_clip" type="bool" setter="set_filter_clip" getter="has_filter_clip"> + If [code]true[/code] clips the area outside of the region to avoid bleeding of the surrounding texture pixels. </member> <member name="margin" type="Rect2" setter="set_margin" getter="get_margin"> The margin around the region. The [Rect2]'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin. diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml index ac8cc7a445..83e9729bc1 100644 --- a/doc/classes/AudioStreamSample.xml +++ b/doc/classes/AudioStreamSample.xml @@ -11,11 +11,22 @@ <demos> </demos> <methods> + <method name="get_data" qualifiers="const"> + <return type="PoolByteArray"> + </return> + <description> + </description> + </method> + <method name="set_data"> + <return type="void"> + </return> + <argument index="0" name="data" type="PoolByteArray"> + </argument> + <description> + </description> + </method> </methods> <members> - <member name="data" type="PoolByteArray" setter="set_data" getter="get_data"> - Raw audio data. - </member> <member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format"> Audio format. See FORMAT_* constants for values. </member> diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index 5b3b27ec60..a873bd9a27 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -171,10 +171,13 @@ </methods> <members> <member name="x" type="Vector3" setter="" getter=""> + The basis matrix's x vector. </member> <member name="y" type="Vector3" setter="" getter=""> + The basis matrix's y vector. </member> <member name="z" type="Vector3" setter="" getter=""> + The basis matrix's z vector. </member> </members> <constants> diff --git a/doc/classes/BitMap.xml b/doc/classes/BitMap.xml index 9e2cd616f2..39bf46ac3d 100644 --- a/doc/classes/BitMap.xml +++ b/doc/classes/BitMap.xml @@ -75,13 +75,6 @@ </description> </method> </methods> - <members> - <member name="data" type="Dictionary" setter="_set_data" getter="_get_data"> - Returns a [Dictionary] with two keys : - [code]data[/code] : [PoolByteArray] with [code]true[/code]/[code]false[/code] [code]BitMap[/code] data. - [code]size[/code] : The [code]Bitmap[/code]'s size. - </member> - </members> <constants> </constants> </class> diff --git a/doc/classes/BitmapFont.xml b/doc/classes/BitmapFont.xml index 6d98c5e629..2fb7d7d87a 100644 --- a/doc/classes/BitmapFont.xml +++ b/doc/classes/BitmapFont.xml @@ -109,9 +109,6 @@ <member name="ascent" type="float" setter="set_ascent" getter="get_ascent"> Ascent (number of pixels above the baseline). </member> - <member name="chars" type="PoolIntArray" setter="_set_chars" getter="_get_chars"> - The characters in the BitmapFont. - </member> <member name="distance_field" type="bool" setter="set_distance_field_hint" getter="is_distance_field_hint"> If [code]true[/code] distance field hint is enabled. </member> @@ -121,12 +118,6 @@ <member name="height" type="float" setter="set_height" getter="get_height"> Total font height (ascent plus descent) in pixels. </member> - <member name="kernings" type="PoolIntArray" setter="_set_kernings" getter="_get_kernings"> - The font's kernings as [PoolIntArray]. - </member> - <member name="textures" type="Array" setter="_set_textures" getter="_get_textures"> - The font's [Texture]s. - </member> </members> <constants> </constants> diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index 86c89bf4ca..c95691d07f 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -23,6 +23,7 @@ <return type="void"> </return> <description> + Removes any [code]Camera2D[/code] from the ancestor [Viewport]'s internal currently-assigned camera. </description> </method> <method name="force_update_scroll"> @@ -43,24 +44,28 @@ <return type="Vector2"> </return> <description> + Returns the location of the [code]Camera2D[/code]'s screen-center, relative to the origin. </description> </method> <method name="get_custom_viewport" qualifiers="const"> <return type="Node"> </return> <description> + Returns the [Viewport] used by the camera if it is not using the default viewport. </description> </method> <method name="get_h_offset" qualifiers="const"> <return type="float"> </return> <description> + Returns the horizontal offset of the camera. </description> </method> <method name="get_v_offset" qualifiers="const"> <return type="float"> </return> <description> + Returns the vertical offset of the camera. </description> </method> <method name="make_current"> @@ -84,6 +89,7 @@ <argument index="0" name="viewport" type="Node"> </argument> <description> + Assigns a custom [Viewport] node to the [code]Camera2D[/code]. If [code]viewport[/code] is not a [Viewport], it re-assigns the default viewport instead. </description> </method> <method name="set_h_offset"> @@ -92,6 +98,7 @@ <argument index="0" name="ofs" type="float"> </argument> <description> + The camera's horizontal offset is set to [code]ofs[/code]. </description> </method> <method name="set_v_offset"> @@ -100,6 +107,7 @@ <argument index="0" name="ofs" type="float"> </argument> <description> + The camera's vertical offset is set to [code]ofs[/code]. </description> </method> </methods> @@ -170,8 +178,10 @@ </members> <constants> <constant name="ANCHOR_MODE_FIXED_TOP_LEFT" value="0" enum="AnchorMode"> + The camera's position is fixed so that the top-left corner is always at the origin. </constant> <constant name="ANCHOR_MODE_DRAG_CENTER" value="1" enum="AnchorMode"> + The camera's position takes into account vertical/horizontal offsets and the screen size. </constant> </constants> </class> diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index d1524074fd..4a567981e6 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -119,6 +119,7 @@ <argument index="3" name="antialiased" type="bool" default="false"> </argument> <description> + Draw a polyline with a uniform [code]color[/code] and [code]width[/code] and optional antialiasing. </description> </method> <method name="draw_polyline_colors"> @@ -133,6 +134,7 @@ <argument index="3" name="antialiased" type="bool" default="false"> </argument> <description> + Draw a polyline with a uniform [code]width[/code], segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code]. </description> </method> <method name="draw_primitive"> @@ -177,7 +179,7 @@ <argument index="2" name="scale" type="Vector2"> </argument> <description> - Set a custom transform for drawing. Anything drawn afterwards will be transformed by this. + Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this. </description> </method> <method name="draw_set_transform_matrix"> @@ -186,6 +188,7 @@ <argument index="0" name="xform" type="Transform2D"> </argument> <description> + Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this. </description> </method> <method name="draw_string"> @@ -359,6 +362,7 @@ <return type="bool"> </return> <description> + Returns [code]true[/code] if local transform notifications are communicated to children. </description> </method> <method name="is_set_as_toplevel" qualifiers="const"> @@ -372,12 +376,14 @@ <return type="bool"> </return> <description> + Returns [code]true[/code] if global transform notifications are communicated to children. </description> </method> <method name="is_visible_in_tree" qualifiers="const"> <return type="bool"> </return> <description> + Returns [code]true[/code] if the node is in the [SceneTree] and is visible on-screen. </description> </method> <method name="make_canvas_position_local" qualifiers="const"> @@ -386,6 +392,7 @@ <argument index="0" name="screen_point" type="Vector2"> </argument> <description> + Assigns [code]screen_point[/code] as this node's new local transform. </description> </method> <method name="make_input_local" qualifiers="const"> @@ -394,6 +401,7 @@ <argument index="0" name="event" type="InputEvent"> </argument> <description> + Transformations issued by [code]event[/code]'s inputs are applied in local space instead of global space. </description> </method> <method name="set_as_toplevel"> @@ -402,7 +410,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Set as top level. This means that it will not inherit transform from parent canvas items. + Sets as top level. This means that it will not inherit transform from parent canvas items. </description> </method> <method name="set_notify_local_transform"> @@ -411,6 +419,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> + If [code]enable[/code] is [code]true[/code], children will be updated with local transform data. </description> </method> <method name="set_notify_transform"> @@ -419,6 +428,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> + If [code]enable[/code] is [code]true[/code], children will be updated with global transform data. </description> </method> <method name="show"> @@ -438,20 +448,28 @@ </methods> <members> <member name="light_mask" type="int" setter="set_light_mask" getter="get_light_mask"> + The rendering layers in which this [code]CanvasItem[/code] responds to [Light2D] nodes. Default value: [code]1[/code]. </member> <member name="material" type="Material" setter="set_material" getter="get_material"> + The material applied to textures on this [code]CanvasItem[/code]. Default value: [code]null[/code]. </member> <member name="modulate" type="Color" setter="set_modulate" getter="get_modulate"> + The color applied to textures on this [code]CanvasItem[/code]. Default value: [code]Color(1, 1, 1, 1)[/code] (opaque "white"). </member> <member name="self_modulate" type="Color" setter="set_self_modulate" getter="get_self_modulate"> + The color applied to textures on this [code]CanvasItem[/code]. This is not inherited by children [code]CanvasItem[/code]s. Default value: [code]Color(1, 1, 1, 1)[/code] (opaque "white").. </member> <member name="show_behind_parent" type="bool" setter="set_draw_behind_parent" getter="is_draw_behind_parent_enabled"> + If [code]true[/code] the object draws behind its parent. Default value: [code]false[/code]. </member> <member name="show_on_top" type="bool" setter="_set_on_top" getter="_is_on_top"> + If [code]true[/code] the object draws on top of its parent. Default value: [code]true[/code]. </member> <member name="use_parent_material" type="bool" setter="set_use_parent_material" getter="get_use_parent_material"> + If [code]true[/code] the parent [code]CanvasItem[/code]'s [member material] property is used as this one's material. Default value: [code]false[/code]. </member> <member name="visible" type="bool" setter="set_visible" getter="is_visible"> + If [code]true[/code] this [code]CanvasItem[/code] is drawn. Default value: [code]true[/code]. </member> </members> <signals> diff --git a/doc/classes/CanvasItemMaterial.xml b/doc/classes/CanvasItemMaterial.xml index b30261d5bf..81709227ad 100644 --- a/doc/classes/CanvasItemMaterial.xml +++ b/doc/classes/CanvasItemMaterial.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="CanvasItemMaterial" inherits="Material" category="Core" version="3.0-beta"> <brief_description> + A material for [CanvasItem]s. </brief_description> <description> + [code]CanvasItemMaterial[/code]s provide a means of modifying the textures associated with a CanvasItem. They specialize in describing blend and lighting behaviors for textures. Use a [ShaderMaterial] to more fully customize a material's interactions with a [CanvasItem]. </description> <tutorials> </tutorials> @@ -12,26 +14,36 @@ </methods> <members> <member name="blend_mode" type="int" setter="set_blend_mode" getter="get_blend_mode" enum="CanvasItemMaterial.BlendMode"> + The manner in which a material's rendering is applied to underlying textures. </member> <member name="light_mode" type="int" setter="set_light_mode" getter="get_light_mode" enum="CanvasItemMaterial.LightMode"> + The manner in which material reacts to lighting. </member> </members> <constants> <constant name="BLEND_MODE_MIX" value="0" enum="BlendMode"> + Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value. </constant> <constant name="BLEND_MODE_ADD" value="1" enum="BlendMode"> + Additive blending mode. </constant> <constant name="BLEND_MODE_SUB" value="2" enum="BlendMode"> + Subtractive blending mode. </constant> <constant name="BLEND_MODE_MUL" value="3" enum="BlendMode"> + Multiplicative blending mode. </constant> <constant name="BLEND_MODE_PREMULT_ALPHA" value="4" enum="BlendMode"> + Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value. </constant> <constant name="LIGHT_MODE_NORMAL" value="0" enum="LightMode"> + Render the material using both light and non-light sensitive material properties. </constant> <constant name="LIGHT_MODE_UNSHADED" value="1" enum="LightMode"> + Render the material as if there were no light. </constant> <constant name="LIGHT_MODE_LIGHT_ONLY" value="2" enum="LightMode"> + Render the material as if there were only light. </constant> </constants> </class> diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml index 86b788bb44..01c2dd6ba9 100644 --- a/doc/classes/CanvasLayer.xml +++ b/doc/classes/CanvasLayer.xml @@ -15,6 +15,7 @@ <return type="Node"> </return> <description> + Returns the [Viewport] used by the camera if it is not using the default viewport. </description> </method> <method name="get_rotation" qualifiers="const"> @@ -44,6 +45,7 @@ <argument index="0" name="viewport" type="Node"> </argument> <description> + Assigns a custom [Viewport] node to the [code]CanvasLayer[/code]. If [code]viewport[/code] is not a [Viewport], it re-assigns the default viewport instead. </description> </method> <method name="set_rotation"> diff --git a/doc/classes/CenterContainer.xml b/doc/classes/CenterContainer.xml index 0db18aed53..6235a3fec4 100644 --- a/doc/classes/CenterContainer.xml +++ b/doc/classes/CenterContainer.xml @@ -14,6 +14,7 @@ </methods> <members> <member name="use_top_left" type="bool" setter="set_use_top_left" getter="is_using_top_left"> + If [code]true[/code] centers children relative to the [code]CenterContainer[/code]'s top left corner. Default value: [code]false[/code]. </member> </members> <constants> diff --git a/doc/classes/ClassDB.xml b/doc/classes/ClassDB.xml index 37e85d033b..b4d4d0b448 100644 --- a/doc/classes/ClassDB.xml +++ b/doc/classes/ClassDB.xml @@ -35,6 +35,7 @@ <argument index="0" name="class" type="String"> </argument> <description> + Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required. </description> </method> <method name="class_get_integer_constant" qualifiers="const"> diff --git a/doc/classes/CollisionObject.xml b/doc/classes/CollisionObject.xml index 82f65b6d11..5d0984bcdf 100644 --- a/doc/classes/CollisionObject.xml +++ b/doc/classes/CollisionObject.xml @@ -25,6 +25,7 @@ <argument index="4" name="shape_idx" type="int"> </argument> <description> + Accepts unhandled [InputEvent]s. [code]click_position[/code] is the clicked location in world space and [code]click_normal[/code] is the normal vector extending from the clicked surface of the [Shape] at [code]shape_idx[/code]. Connect to the [code]input_event[/code] signal to easily pick up these events. </description> </method> <method name="create_shape_owner"> @@ -134,6 +135,7 @@ <argument index="1" name="shape_id" type="int"> </argument> <description> + Returns the child index of the [Shape] with the given id from the given shape owner. </description> </method> <method name="shape_owner_get_transform" qualifiers="const"> @@ -181,8 +183,10 @@ </methods> <members> <member name="input_capture_on_drag" type="bool" setter="set_capture_input_on_drag" getter="get_capture_input_on_drag"> + If [code]true[/code] the [code]CollisionObject[/code] will continue to receive input events as the mouse is dragged across its shapes. Default value: [code]false[/code]. </member> <member name="input_ray_pickable" type="bool" setter="set_ray_pickable" getter="is_ray_pickable"> + If [code]true[/code] the [CollisionObject]'s shapes will respond to [RayCast]s. Default value: [code]true[/code]. </member> </members> <signals> @@ -198,6 +202,7 @@ <argument index="4" name="shape_idx" type="int"> </argument> <description> + Emitted when [method _input_event] receives an event. See its description for details. </description> </signal> <signal name="mouse_entered"> diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml index ffc79d359d..086513cad5 100644 --- a/doc/classes/CollisionObject2D.xml +++ b/doc/classes/CollisionObject2D.xml @@ -21,6 +21,7 @@ <argument index="2" name="shape_idx" type="int"> </argument> <description> + Accepts unhandled [InputEvent]s. [code]shape_idx[/code] is the child index of the clicked [Shape2D]. Connect to the [code]input_event[/code] signal to easily pick up these events. </description> </method> <method name="create_shape_owner"> @@ -61,6 +62,7 @@ <argument index="0" name="owner_id" type="int"> </argument> <description> + Returns [code]true[/code] if collisions for the shape owner originating from this [code]CollisionObject2D[/code] will not be reported to collided with [code]CollisionObject2D[/code]s. </description> </method> <method name="remove_shape_owner"> @@ -138,6 +140,7 @@ <argument index="1" name="shape_id" type="int"> </argument> <description> + Returns the child index of the [Shape2D] with the given id from the given shape owner. </description> </method> <method name="shape_owner_get_transform" qualifiers="const"> @@ -179,6 +182,7 @@ <argument index="1" name="enable" type="bool"> </argument> <description> + If [code]enable[/code] is [code]true[/code], collisions for the shape owner originating from this [code]CollisionObject2D[/code] will not be reported to collided with [code]CollisionObject2D[/code]s. </description> </method> <method name="shape_owner_set_transform"> @@ -207,7 +211,7 @@ <argument index="2" name="shape_idx" type="int"> </argument> <description> - Emitted when an input event occurs and [code]input_pickable[/code] is [code]true[/code]. + Emitted when an input event occurs and [code]input_pickable[/code] is [code]true[/code]. See [method _input_event] for details. </description> </signal> <signal name="mouse_entered"> diff --git a/doc/classes/ColorPickerButton.xml b/doc/classes/ColorPickerButton.xml index c8a4b850d0..185460eef2 100644 --- a/doc/classes/ColorPickerButton.xml +++ b/doc/classes/ColorPickerButton.xml @@ -18,6 +18,13 @@ Returns the [code]ColorPicker[/code] that this [code]ColorPickerButton[/code] toggles. </description> </method> + <method name="get_popup"> + <return type="PopupPanel"> + </return> + <description> + Returns the control's [PopupPanel] which allows you to connect to Popup Signals. This allows you to handle events when the ColorPicker is shown or hidden. + </description> + </method> </methods> <members> <member name="color" type="Color" setter="set_pick_color" getter="get_pick_color"> diff --git a/doc/classes/Curve.xml b/doc/classes/Curve.xml index 4c9ced63c8..3e1158ca3b 100644 --- a/doc/classes/Curve.xml +++ b/doc/classes/Curve.xml @@ -169,8 +169,6 @@ </method> </methods> <members> - <member name="_data" type="Array" setter="_set_data" getter="_get_data"> - </member> <member name="bake_resolution" type="int" setter="set_bake_resolution" getter="get_bake_resolution"> </member> <member name="max_value" type="float" setter="set_max_value" getter="get_max_value"> diff --git a/doc/classes/Curve2D.xml b/doc/classes/Curve2D.xml index 8b86359cc5..8a857799e6 100644 --- a/doc/classes/Curve2D.xml +++ b/doc/classes/Curve2D.xml @@ -175,9 +175,6 @@ </method> </methods> <members> - <member name="_data" type="Dictionary" setter="_set_data" getter="_get_data"> - The points describing the curve. Value is a [Dictionary] with the keys [code]in[/code], [code]out[/code], and [code]pos[/code]. The key pos is the position of a vertex of the curve, the key in is the vector from that position to the control point before this vertex, the key out is the vector from that position to the controlpoint after this vertex. - </member> <member name="bake_interval" type="float" setter="set_bake_interval" getter="get_bake_interval"> The distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time the [method get_baked_points] or [method get_baked_length] function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. </member> diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml index c758e1d9da..e30ae85617 100644 --- a/doc/classes/Curve3D.xml +++ b/doc/classes/Curve3D.xml @@ -202,8 +202,6 @@ </method> </methods> <members> - <member name="_data" type="Dictionary" setter="_set_data" getter="_get_data"> - </member> <member name="bake_interval" type="float" setter="set_bake_interval" getter="get_bake_interval"> </member> </members> diff --git a/doc/classes/CurveTexture.xml b/doc/classes/CurveTexture.xml index 73126de4aa..f62da8a135 100644 --- a/doc/classes/CurveTexture.xml +++ b/doc/classes/CurveTexture.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="CurveTexture" inherits="Texture" category="Core" version="3.0-beta"> <brief_description> + A texture that shows a curve. </brief_description> <description> + Renders a given [Curve] provided to it. Simplifies the task of drawing curves and/or saving them as image files. </description> <tutorials> </tutorials> @@ -12,8 +14,10 @@ </methods> <members> <member name="curve" type="Curve" setter="set_curve" getter="get_curve"> + The [code]curve[/code] rendered onto the texture. </member> <member name="width" type="int" setter="set_width" getter="get_width"> + The width of the texture. </member> </members> <constants> diff --git a/doc/classes/EditorFileDialog.xml b/doc/classes/EditorFileDialog.xml index e893d92840..1a1c382e59 100644 --- a/doc/classes/EditorFileDialog.xml +++ b/doc/classes/EditorFileDialog.xml @@ -15,179 +15,111 @@ <argument index="0" name="filter" type="String"> </argument> <description> + Adds a comma-delimited file extension filter option to the [code]EditorFileDialog[/code] with an optional semi-colon-delimited label. + Example: "*.tscn, *.scn; Scenes", results in filter text "Scenes (*.tscn, *.scn)". </description> </method> <method name="clear_filters"> <return type="void"> </return> <description> - </description> - </method> - <method name="get_access" qualifiers="const"> - <return type="int" enum="EditorFileDialog.Access"> - </return> - <description> - </description> - </method> - <method name="get_current_dir" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_current_file" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_current_path" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_display_mode" qualifiers="const"> - <return type="int" enum="EditorFileDialog.DisplayMode"> - </return> - <description> - </description> - </method> - <method name="get_mode" qualifiers="const"> - <return type="int" enum="EditorFileDialog.Mode"> - </return> - <description> + Removes all filters except for "All Files (*)". </description> </method> <method name="get_vbox"> <return type="VBoxContainer"> </return> <description> + Returns the [code]VBoxContainer[/code] used to display the file system. </description> </method> <method name="invalidate"> <return type="void"> </return> <description> - </description> - </method> - <method name="is_overwrite_warning_disabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_showing_hidden_files" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_access"> - <return type="void"> - </return> - <argument index="0" name="access" type="int" enum="EditorFileDialog.Access"> - </argument> - <description> - </description> - </method> - <method name="set_current_dir"> - <return type="void"> - </return> - <argument index="0" name="dir" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_current_file"> - <return type="void"> - </return> - <argument index="0" name="file" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_current_path"> - <return type="void"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_disable_overwrite_warning"> - <return type="void"> - </return> - <argument index="0" name="disable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_display_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="EditorFileDialog.DisplayMode"> - </argument> - <description> - </description> - </method> - <method name="set_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="EditorFileDialog.Mode"> - </argument> - <description> - </description> - </method> - <method name="set_show_hidden_files"> - <return type="void"> - </return> - <argument index="0" name="show" type="bool"> - </argument> - <description> + Notify the [code]EditorFileDialog[/code] that its view of the data is no longer accurate. Updates the view contents on next view update. </description> </method> </methods> + <members> + <member name="access" type="int" setter="set_access" getter="get_access" enum="EditorFileDialog.Access"> + The location from which the user may select a file, including [code]res://[/code], [code]user://[/code], and the local file system. + </member> + <member name="current_dir" type="String" setter="set_current_dir" getter="get_current_dir"> + The currently occupied directory. + </member> + <member name="current_file" type="String" setter="set_current_file" getter="get_current_file"> + The currently selected file. + </member> + <member name="current_path" type="String" setter="set_current_path" getter="get_current_path"> + The file system path in the address bar. + </member> + <member name="disable_overwrite_warning" type="bool" setter="set_disable_overwrite_warning" getter="is_overwrite_warning_disabled"> + If [code]true[/code] the [code]EditorFileDialog[/code] will not warn the user before overwriting files. + </member> + <member name="display_mode" type="int" setter="set_display_mode" getter="get_display_mode" enum="EditorFileDialog.DisplayMode"> + The view format in which the [code]EditorFileDialog[/code] displays resources to the user. + </member> + <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="EditorFileDialog.Mode"> + The purpose of the [code]EditorFileDialog[/code]. Changes allowed behaviors. + </member> + <member name="show_hidden_files" type="bool" setter="set_show_hidden_files" getter="is_showing_hidden_files"> + If [code]true[/code] hidden files and directories will be visible in the [code]EditorFileDialog[/code]. + </member> + </members> <signals> <signal name="dir_selected"> <argument index="0" name="dir" type="String"> </argument> <description> + Emitted when a directory is selected. </description> </signal> <signal name="file_selected"> <argument index="0" name="path" type="String"> </argument> <description> + Emitted when a file is selected. </description> </signal> <signal name="files_selected"> <argument index="0" name="paths" type="PoolStringArray"> </argument> <description> + Emitted when multiple files are selected. </description> </signal> </signals> <constants> <constant name="MODE_OPEN_FILE" value="0" enum="Mode"> + The [code]EditorFileDialog[/code] can select only one file. Accepting the window will open the file. </constant> <constant name="MODE_OPEN_FILES" value="1" enum="Mode"> + The [code]EditorFileDialog[/code] can select multiple files. Accepting the window will open all files. </constant> <constant name="MODE_OPEN_DIR" value="2" enum="Mode"> + The [code]EditorFileDialog[/code] can select only one directory. Accepting the window will open the directory. </constant> <constant name="MODE_OPEN_ANY" value="3" enum="Mode"> + The [code]EditorFileDialog[/code] can select a file or directory. Accepting the window will open it. </constant> <constant name="MODE_SAVE_FILE" value="4" enum="Mode"> + The [code]EditorFileDialog[/code] can select only one file. Accepting the window will save the file. </constant> <constant name="ACCESS_RESOURCES" value="0" enum="Access"> + The [code]EditorFileDialog[/code] can only view [code]res://[/code] directory contents. </constant> <constant name="ACCESS_USERDATA" value="1" enum="Access"> + The [code]EditorFileDialog[/code] can only view [code]user://[/code] directory contents. </constant> <constant name="ACCESS_FILESYSTEM" value="2" enum="Access"> + The [code]EditorFileDialog[/code] can view the entire local file system. </constant> <constant name="DISPLAY_THUMBNAILS" value="0" enum="DisplayMode"> + The [code]EditorFileDialog[/code] displays resources as thumbnails. </constant> <constant name="DISPLAY_LIST" value="1" enum="DisplayMode"> + The [code]EditorFileDialog[/code] displays resources as a list of filenames. </constant> </constants> </class> diff --git a/doc/classes/EditorFileSystem.xml b/doc/classes/EditorFileSystem.xml index f577a4676f..54b3accb19 100644 --- a/doc/classes/EditorFileSystem.xml +++ b/doc/classes/EditorFileSystem.xml @@ -33,6 +33,7 @@ <argument index="0" name="path" type="String"> </argument> <description> + Returns a view into the filesystem at [code]path[/code]. </description> </method> <method name="get_scanning_progress" qualifiers="const"> @@ -83,6 +84,7 @@ <argument index="0" name="resources" type="PoolStringArray"> </argument> <description> + Remitted if a resource is reimported. </description> </signal> <signal name="sources_changed"> diff --git a/doc/classes/EditorFileSystemDirectory.xml b/doc/classes/EditorFileSystemDirectory.xml index 50b6f3680c..1a2f73a683 100644 --- a/doc/classes/EditorFileSystemDirectory.xml +++ b/doc/classes/EditorFileSystemDirectory.xml @@ -4,6 +4,7 @@ A diretory for the resource filesystem. </brief_description> <description> + A more generalized, low-level variation of the directory concept. </description> <tutorials> </tutorials> @@ -16,6 +17,7 @@ <argument index="0" name="name" type="String"> </argument> <description> + Returns the index of the directory with name [code]name[/code] or [code]-1[/code] if not found. </description> </method> <method name="find_file_index" qualifiers="const"> @@ -24,6 +26,7 @@ <argument index="0" name="name" type="String"> </argument> <description> + Returns the index of the file with name [code]name[/code] or [code]-1[/code] if not found. </description> </method> <method name="get_file" qualifiers="const"> @@ -32,12 +35,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the name of the file at index [code]idx[/code]. </description> </method> <method name="get_file_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the number of files in this directory. </description> </method> <method name="get_file_import_is_valid" qualifiers="const"> @@ -46,6 +51,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns [code]true[/code] if the file at index [code]idx[/code] imported properly. </description> </method> <method name="get_file_path" qualifiers="const"> @@ -54,6 +60,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the path to the file at index [code]idx[/code]. </description> </method> <method name="get_file_type" qualifiers="const"> @@ -62,24 +69,28 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the file extension of the file at index [code]idx[/code]. </description> </method> <method name="get_name"> <return type="String"> </return> <description> + Returns the name of this directory. </description> </method> <method name="get_parent"> <return type="EditorFileSystemDirectory"> </return> <description> + Returns the parent directory for this directory or null if called on a directory at [code]res://[/code] or [code]user://[/code]. </description> </method> <method name="get_path" qualifiers="const"> <return type="String"> </return> <description> + Returns the path to this directory. </description> </method> <method name="get_subdir"> @@ -88,12 +99,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the subdirectory at index [code]idx[/code]. </description> </method> <method name="get_subdir_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the number of subdirectories in this directory. </description> </method> </methods> diff --git a/doc/classes/EditorScript.xml b/doc/classes/EditorScript.xml index fcc297a1e8..97f126e7f7 100644 --- a/doc/classes/EditorScript.xml +++ b/doc/classes/EditorScript.xml @@ -9,7 +9,7 @@ [codeblock] tool extends EditorScript - + func _run(): print("Hello from the Godot Editor!") [/codeblock] @@ -33,6 +33,8 @@ <argument index="0" name="node" type="Node"> </argument> <description> + Adds [code]node[/code] as a child of the root node in the editor context. + WARNING: The implementation of this method is currently disabled. </description> </method> <method name="get_editor_interface"> diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index 0f7038238e..3387b4a2ed 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -103,6 +103,9 @@ </member> <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="FileDialog.Mode"> </member> + <member name="mode_overrides_title" type="bool" setter="set_mode_overrides_title" getter="is_mode_overriding_title"> + If [code]true[/code], changing the [code]mode[/code] property will set the window title accordingly (e. g. setting mode to [code]MODE_OPEN_FILE[/code] will change the window title to "Open a File"). + </member> <member name="show_hidden_files" type="bool" setter="set_show_hidden_files" getter="is_showing_hidden_files"> </member> </members> @@ -160,6 +163,8 @@ </theme_item> <theme_item name="folder" type="Texture"> </theme_item> + <theme_item name="parent_folder" type="Texture"> + </theme_item> <theme_item name="reload" type="Texture"> </theme_item> </theme_items> diff --git a/doc/classes/GIProbeData.xml b/doc/classes/GIProbeData.xml index 2ac591889c..aba59f57ea 100644 --- a/doc/classes/GIProbeData.xml +++ b/doc/classes/GIProbeData.xml @@ -9,31 +9,161 @@ <demos> </demos> <methods> + <method name="get_bias" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_bounds" qualifiers="const"> + <return type="AABB"> + </return> + <description> + </description> + </method> + <method name="get_cell_size" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_dynamic_data" qualifiers="const"> + <return type="PoolIntArray"> + </return> + <description> + </description> + </method> + <method name="get_dynamic_range" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_energy" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_normal_bias" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_propagation" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_to_cell_xform" qualifiers="const"> + <return type="Transform"> + </return> + <description> + </description> + </method> + <method name="is_compressed" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_interior" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_bias"> + <return type="void"> + </return> + <argument index="0" name="bias" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_bounds"> + <return type="void"> + </return> + <argument index="0" name="bounds" type="AABB"> + </argument> + <description> + </description> + </method> + <method name="set_cell_size"> + <return type="void"> + </return> + <argument index="0" name="cell_size" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_compress"> + <return type="void"> + </return> + <argument index="0" name="compress" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_dynamic_data"> + <return type="void"> + </return> + <argument index="0" name="dynamic_data" type="PoolIntArray"> + </argument> + <description> + </description> + </method> + <method name="set_dynamic_range"> + <return type="void"> + </return> + <argument index="0" name="dynamic_range" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_energy"> + <return type="void"> + </return> + <argument index="0" name="energy" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_interior"> + <return type="void"> + </return> + <argument index="0" name="interior" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_normal_bias"> + <return type="void"> + </return> + <argument index="0" name="bias" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_propagation"> + <return type="void"> + </return> + <argument index="0" name="propagation" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_to_cell_xform"> + <return type="void"> + </return> + <argument index="0" name="to_cell_xform" type="Transform"> + </argument> + <description> + </description> + </method> </methods> - <members> - <member name="bias" type="float" setter="set_bias" getter="get_bias"> - </member> - <member name="bounds" type="AABB" setter="set_bounds" getter="get_bounds"> - </member> - <member name="cell_size" type="float" setter="set_cell_size" getter="get_cell_size"> - </member> - <member name="compress" type="bool" setter="set_compress" getter="is_compressed"> - </member> - <member name="dynamic_data" type="PoolIntArray" setter="set_dynamic_data" getter="get_dynamic_data"> - </member> - <member name="dynamic_range" type="int" setter="set_dynamic_range" getter="get_dynamic_range"> - </member> - <member name="energy" type="float" setter="set_energy" getter="get_energy"> - </member> - <member name="interior" type="bool" setter="set_interior" getter="is_interior"> - </member> - <member name="normal_bias" type="float" setter="set_normal_bias" getter="get_normal_bias"> - </member> - <member name="propagation" type="float" setter="set_propagation" getter="get_propagation"> - </member> - <member name="to_cell_xform" type="Transform" setter="set_to_cell_xform" getter="get_to_cell_xform"> - </member> - </members> <constants> </constants> </class> diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index d10722d411..f3d0c271ac 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -332,8 +332,6 @@ </member> <member name="icon_scale" type="float" setter="set_icon_scale" getter="get_icon_scale"> </member> - <member name="items" type="Array" setter="_set_items" getter="_get_items"> - </member> <member name="max_columns" type="int" setter="set_max_columns" getter="get_max_columns"> </member> <member name="max_text_lines" type="int" setter="set_max_text_lines" getter="get_max_text_lines"> diff --git a/doc/classes/JSON.xml b/doc/classes/JSON.xml index bda205d294..bb48833878 100644 --- a/doc/classes/JSON.xml +++ b/doc/classes/JSON.xml @@ -25,6 +25,10 @@ </return> <argument index="0" name="value" type="Variant"> </argument> + <argument index="1" name="indent" type="String" default=""""> + </argument> + <argument index="2" name="sort_keys" type="bool" default="false"> + </argument> <description> Converts a Variant var to JSON text and returns the result. Useful for serializing data to store or send over the network. </description> diff --git a/doc/classes/LargeTexture.xml b/doc/classes/LargeTexture.xml index 3899254e9d..9d79034dea 100644 --- a/doc/classes/LargeTexture.xml +++ b/doc/classes/LargeTexture.xml @@ -87,14 +87,6 @@ </description> </method> </methods> - <members> - <member name="_data" type="Array" setter="_set_data" getter="_get_data"> - Returns an [Array] with offsets and textures data of each added piece. Schema is [offsets1, texture1, offsets2, texture2, large_texture_size]. - [code]offsets[/code] : [Vector2] offsets of the texture piece. - [code]second[/code] : [StreamTexture] data of the texture piece. - [code]last entry[/code] : [Vector2] size of the entire large texture. - </member> - </members> <constants> </constants> </class> diff --git a/doc/classes/LinkButton.xml b/doc/classes/LinkButton.xml index a6194d129a..82b3a90180 100644 --- a/doc/classes/LinkButton.xml +++ b/doc/classes/LinkButton.xml @@ -30,6 +30,8 @@ </constant> </constants> <theme_items> + <theme_item name="focus" type="StyleBox"> + </theme_item> <theme_item name="font" type="Font"> </theme_item> <theme_item name="font_color" type="Color"> diff --git a/doc/classes/MenuButton.xml b/doc/classes/MenuButton.xml index 6f41f84485..c41c86d693 100644 --- a/doc/classes/MenuButton.xml +++ b/doc/classes/MenuButton.xml @@ -19,10 +19,6 @@ </description> </method> </methods> - <members> - <member name="items" type="Array" setter="_set_items" getter="_get_items"> - </member> - </members> <signals> <signal name="about_to_show"> <description> diff --git a/doc/classes/MeshInstance.xml b/doc/classes/MeshInstance.xml index f754341fef..ac26c2946f 100644 --- a/doc/classes/MeshInstance.xml +++ b/doc/classes/MeshInstance.xml @@ -4,7 +4,7 @@ Node that instances meshes into a scenario. </brief_description> <description> - MeshInstance is a [Node] that takes a [Mesh] resource and adds it to the current scenario by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a single [Mesh] in many places. This allows to reuse geometry and save on resources. When a [Mesh] has to be instanced more than thousands of times at close proximity, consider using a [MultiMesh] in a [MultiMeshInstance] instead. + MeshInstance is a node that takes a [Mesh] resource and adds it to the current scenario by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a single [Mesh] in many places. This allows to reuse geometry and save on resources. When a [Mesh] has to be instanced more than thousands of times at close proximity, consider using a [MultiMesh] in a [MultiMeshInstance] instead. </description> <tutorials> </tutorials> @@ -15,20 +15,21 @@ <return type="void"> </return> <description> - This helper creates a [StaticBody] child [Node] with a [ConvexPolygonShape] [CollisionShape] calculated from the mesh geometry. It's mainly used for testing. + This helper creates a [StaticBody] child node with a [ConvexPolygonShape] collision shape calculated from the mesh geometry. It's mainly used for testing. </description> </method> <method name="create_debug_tangents"> <return type="void"> </return> <description> + This helper creates a [MeshInstance] child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing. </description> </method> <method name="create_trimesh_collision"> <return type="void"> </return> <description> - This helper creates a [StaticBody] child [Node] with a [ConcavePolygonShape] [CollisionShape] calculated from the mesh geometry. It's mainly used for testing. + This helper creates a [StaticBody] child node with a [ConcavePolygonShape] collision shape calculated from the mesh geometry. It's mainly used for testing. </description> </method> <method name="get_surface_material" qualifiers="const"> diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml index ae26641596..ff2d89b2ca 100644 --- a/doc/classes/MultiMesh.xml +++ b/doc/classes/MultiMesh.xml @@ -63,16 +63,12 @@ </method> </methods> <members> - <member name="color_array" type="PoolColorArray" setter="_set_color_array" getter="_get_color_array"> - </member> <member name="color_format" type="int" setter="set_color_format" getter="get_color_format" enum="MultiMesh.ColorFormat"> </member> <member name="instance_count" type="int" setter="set_instance_count" getter="get_instance_count"> </member> <member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh"> </member> - <member name="transform_array" type="PoolVector3Array" setter="_set_transform_array" getter="_get_transform_array"> - </member> <member name="transform_format" type="int" setter="set_transform_format" getter="get_transform_format" enum="MultiMesh.TransformFormat"> </member> </members> diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index 5563c94b35..55a3771d79 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -45,6 +45,20 @@ <description> </description> </method> + <method name="get_vertices" qualifiers="const"> + <return type="PoolVector3Array"> + </return> + <description> + </description> + </method> + <method name="set_vertices"> + <return type="void"> + </return> + <argument index="0" name="vertices" type="PoolVector3Array"> + </argument> + <description> + </description> + </method> </methods> <members> <member name="agent/height" type="float" setter="set_agent_height" getter="get_agent_height"> @@ -75,16 +89,12 @@ </member> <member name="polygon/verts_per_poly" type="float" setter="set_verts_per_poly" getter="get_verts_per_poly"> </member> - <member name="polygons" type="Array" setter="_set_polygons" getter="_get_polygons"> - </member> <member name="region/merge_size" type="float" setter="set_region_merge_size" getter="get_region_merge_size"> </member> <member name="region/min_size" type="float" setter="set_region_min_size" getter="get_region_min_size"> </member> <member name="sample_partition_type/sample_partition_type" type="int" setter="set_sample_partition_type" getter="get_sample_partition_type"> </member> - <member name="vertices" type="PoolVector3Array" setter="set_vertices" getter="get_vertices"> - </member> </members> <constants> <constant name="SAMPLE_PARTITION_WATERSHED" value="0"> diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml index 585566dbf9..663ac4cd67 100644 --- a/doc/classes/NavigationPolygon.xml +++ b/doc/classes/NavigationPolygon.xml @@ -75,6 +75,12 @@ <description> </description> </method> + <method name="get_vertices" qualifiers="const"> + <return type="PoolVector2Array"> + </return> + <description> + </description> + </method> <method name="make_polygons_from_outlines"> <return type="void"> </return> @@ -99,15 +105,15 @@ <description> </description> </method> + <method name="set_vertices"> + <return type="void"> + </return> + <argument index="0" name="vertices" type="PoolVector2Array"> + </argument> + <description> + </description> + </method> </methods> - <members> - <member name="outlines" type="Array" setter="_set_outlines" getter="_get_outlines"> - </member> - <member name="polygons" type="Array" setter="_set_polygons" getter="_get_polygons"> - </member> - <member name="vertices" type="PoolVector2Array" setter="set_vertices" getter="get_vertices"> - </member> - </members> <constants> </constants> </class> diff --git a/doc/classes/NetworkedMultiplayerPeer.xml b/doc/classes/NetworkedMultiplayerPeer.xml index 33ffce9cf9..a7350b3863 100644 --- a/doc/classes/NetworkedMultiplayerPeer.xml +++ b/doc/classes/NetworkedMultiplayerPeer.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="NetworkedMultiplayerPeer" inherits="PacketPeer" category="Core" version="3.0-beta"> <brief_description> + A high-level network interface to simplify multiplayer interactions. </brief_description> <description> + Manages the connection to network peers. Assigns unique IDs to each client connected to the server. </description> <tutorials> </tutorials> @@ -13,31 +15,35 @@ <return type="int" enum="NetworkedMultiplayerPeer.ConnectionStatus"> </return> <description> + Returns the current state of the connection. See [enum ConnectionStatus]. </description> </method> <method name="get_packet_peer" qualifiers="const"> <return type="int"> </return> <description> + Returns the ID of the [code]NetworkedMultiplayerPeer[/code] who sent the most recent packet. </description> </method> <method name="get_unique_id" qualifiers="const"> <return type="int"> </return> <description> + Returns the ID of this [code]NetworkedMultiplayerPeer[/code]. </description> </method> <method name="is_refusing_new_connections" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this [code]NetworkedMultiplayerPeer[/code] is refusing new connections. + Returns [code]true[/code] if this [code]NetworkedMultiplayerPeer[/code] refuses new connections. Default value: [code]false[/code]. </description> </method> <method name="poll"> <return type="void"> </return> <description> + Waits up to 1 second to receive a new network event. </description> </method> <method name="set_refuse_new_connections"> @@ -46,7 +52,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - If [code]endable[/code] is true, this [code]NetworkedMultiplayerPeer[/code] will refuse new connections. + If [code]true[/code] this [code]NetworkedMultiplayerPeer[/code] refuses new connections. Default value: [code]false[/code]. </description> </method> <method name="set_target_peer"> @@ -55,6 +61,7 @@ <argument index="0" name="id" type="int"> </argument> <description> + The peer to which packets will be sent. Default value: [code]0[/code]. </description> </method> <method name="set_transfer_mode"> @@ -63,56 +70,65 @@ <argument index="0" name="mode" type="int" enum="NetworkedMultiplayerPeer.TransferMode"> </argument> <description> + The manner in which to send packets to the [code]target_peer[/code]. See [enum TransferMode]. </description> </method> </methods> <signals> <signal name="connection_failed"> <description> - Emitted when failed to connect to server. + Emitted when a connection attempt fails. </description> </signal> <signal name="connection_succeeded"> <description> - Emitted when successfully connected to server. + Emitted when a connection attempt succeeds. </description> </signal> <signal name="peer_connected"> <argument index="0" name="id" type="int"> </argument> <description> - Emitted by the server when a client is connected. + Emitted by the server when a client connects. </description> </signal> <signal name="peer_disconnected"> <argument index="0" name="id" type="int"> </argument> <description> - Emitted by the server when a client is disconnected. + Emitted by the server when a client disconnects. </description> </signal> <signal name="server_disconnected"> <description> - Emitted by clients when server is disconnected. + Emitted by clients when the server disconnects. </description> </signal> </signals> <constants> <constant name="TRANSFER_MODE_UNRELIABLE" value="0" enum="TransferMode"> + Packets are sent via unordered UDP packets. </constant> <constant name="TRANSFER_MODE_UNRELIABLE_ORDERED" value="1" enum="TransferMode"> + Packets are sent via ordered UDP packets. </constant> <constant name="TRANSFER_MODE_RELIABLE" value="2" enum="TransferMode"> + Packets are sent via TCP packets. </constant> <constant name="CONNECTION_DISCONNECTED" value="0" enum="ConnectionStatus"> + The ongoing connection disconnected. </constant> <constant name="CONNECTION_CONNECTING" value="1" enum="ConnectionStatus"> + A connection attempt is ongoing. </constant> <constant name="CONNECTION_CONNECTED" value="2" enum="ConnectionStatus"> + The connection attempt succeeded. </constant> <constant name="TARGET_PEER_BROADCAST" value="0"> + Packets are sent to the server and then redistributed to other peers. </constant> <constant name="TARGET_PEER_SERVER" value="1"> + Packets are sent to the server alone. </constant> </constants> </class> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 13a25fa48f..e2198c3e15 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -350,6 +350,12 @@ Returns [code]true[/code] if the "node" argument is a direct or indirect child of the current node, otherwise return [code]false[code]. </description> </method> + <method name="is_displayed_folded" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="is_greater_than" qualifiers="const"> <return type="bool"> </return> @@ -641,6 +647,14 @@ Remotely changes property's value on a specific peer identified by [i]peer_id[/i] using an unreliable protocol. </description> </method> + <method name="set_display_folded"> + <return type="void"> + </return> + <argument index="0" name="fold" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_filename"> <return type="void"> </return> @@ -750,10 +764,6 @@ </method> </methods> <members> - <member name="_import_path" type="NodePath" setter="_set_import_path" getter="_get_import_path"> - </member> - <member name="editor/display_folded" type="bool" setter="set_display_folded" getter="is_displayed_folded"> - </member> <member name="pause_mode" type="int" setter="set_pause_mode" getter="get_pause_mode" enum="Node.PauseMode"> </member> </members> diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index 112960d9f8..81978809d7 100644 --- a/doc/classes/Node2D.xml +++ b/doc/classes/Node2D.xml @@ -38,6 +38,12 @@ Returns the [Transform2D] relative to this node's parent. </description> </method> + <method name="get_rotation" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> <method name="global_translate"> <return type="void"> </return> @@ -87,6 +93,14 @@ Applies a rotation to the node, in radians, starting from its current rotation. </description> </method> + <method name="set_rotation"> + <return type="void"> + </return> + <argument index="0" name="radians" type="float"> + </argument> + <description> + </description> + </method> <method name="to_global" qualifiers="const"> <return type="Vector2"> </return> @@ -134,9 +148,6 @@ <member name="position" type="Vector2" setter="set_position" getter="get_position"> Position, relative to the node's parent. </member> - <member name="rotation" type="float" setter="set_rotation" getter="get_rotation"> - Rotation in radians, relative to the node's parent. - </member> <member name="rotation_degrees" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees"> Rotation in degrees, relative to the node's parent. </member> diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index 5f1b6f328c..76265e700a 100644 --- a/doc/classes/OptionButton.xml +++ b/doc/classes/OptionButton.xml @@ -183,8 +183,6 @@ </method> </methods> <members> - <member name="items" type="Array" setter="_set_items" getter="_get_items"> - </member> <member name="selected" type="int" setter="_select_int" getter="get_selected"> </member> </members> diff --git a/doc/classes/PolygonPathFinder.xml b/doc/classes/PolygonPathFinder.xml index 58c14cc920..48c5625e6b 100644 --- a/doc/classes/PolygonPathFinder.xml +++ b/doc/classes/PolygonPathFinder.xml @@ -80,10 +80,6 @@ </description> </method> </methods> - <members> - <member name="data" type="Dictionary" setter="_set_data" getter="_get_data"> - </member> - </members> <constants> </constants> </class> diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 6b36ff9eee..7071d64f2e 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -423,8 +423,6 @@ </member> <member name="hide_on_item_selection" type="bool" setter="set_hide_on_item_selection" getter="is_hide_on_item_selection"> </member> - <member name="items" type="Array" setter="_set_items" getter="_get_items"> - </member> </members> <signals> <signal name="id_pressed"> diff --git a/doc/classes/ProxyTexture.xml b/doc/classes/ProxyTexture.xml new file mode 100644 index 0000000000..2cdcac8775 --- /dev/null +++ b/doc/classes/ProxyTexture.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ProxyTexture" inherits="Texture" category="Core" version="3.0-beta"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="base" type="Texture" setter="set_base" getter="get_base"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml index 1ec16753c2..20e262b664 100644 --- a/doc/classes/RayCast.xml +++ b/doc/classes/RayCast.xml @@ -77,6 +77,7 @@ <argument index="0" name="bit" type="int"> </argument> <description> + Returns [code]true[/code] if the bit index passed is turned on. Note that bit indexes range from 0-19. </description> </method> <method name="get_collision_normal" qualifiers="const"> @@ -126,6 +127,7 @@ <argument index="1" name="value" type="bool"> </argument> <description> + Sets the bit index passed to the [code]value[/code] passed. Note that bit indexes range from 0-19. </description> </method> </methods> @@ -137,7 +139,10 @@ The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. </member> <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled"> - If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. + If [code]true[/code] collisions will be reported. Default value: [code]false[/code]. + </member> + <member name="exclude_parent" type="bool" setter="set_exclude_parent_body" getter="get_exclude_parent_body"> + If [code]true[/code] collisions will be ignored for this RayCast's immediate parent. Default value: [code]true[/code]. </member> </members> <constants> diff --git a/doc/classes/ResourcePreloader.xml b/doc/classes/ResourcePreloader.xml index 1766845bf2..c749529a19 100644 --- a/doc/classes/ResourcePreloader.xml +++ b/doc/classes/ResourcePreloader.xml @@ -67,10 +67,6 @@ </description> </method> </methods> - <members> - <member name="resources" type="Array" setter="_set_resources" getter="_get_resources"> - </member> - </members> <constants> </constants> </class> diff --git a/doc/classes/Shader.xml b/doc/classes/Shader.xml index 543164d92e..082c48dfce 100644 --- a/doc/classes/Shader.xml +++ b/doc/classes/Shader.xml @@ -11,6 +11,12 @@ <demos> </demos> <methods> + <method name="get_code" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> <method name="get_default_texture_param" qualifiers="const"> <return type="Texture"> </return> @@ -33,6 +39,14 @@ <description> </description> </method> + <method name="set_code"> + <return type="void"> + </return> + <argument index="0" name="code" type="String"> + </argument> + <description> + </description> + </method> <method name="set_default_texture_param"> <return type="void"> </return> @@ -44,10 +58,6 @@ </description> </method> </methods> - <members> - <member name="code" type="String" setter="set_code" getter="get_code"> - </member> - </members> <constants> <constant name="MODE_SPATIAL" value="0" enum="Mode"> </constant> diff --git a/doc/classes/SpatialMaterial.xml b/doc/classes/SpatialMaterial.xml index 4e63e6dd11..cf08b0daae 100644 --- a/doc/classes/SpatialMaterial.xml +++ b/doc/classes/SpatialMaterial.xml @@ -79,6 +79,8 @@ </member> <member name="emission_texture" type="Texture" setter="set_texture" getter="get_texture"> </member> + <member name="flags_albedo_tex_force_srgb" type="bool" setter="set_flag" getter="get_flag"> + </member> <member name="flags_fixed_size" type="bool" setter="set_flag" getter="get_flag"> </member> <member name="flags_no_depth_test" type="bool" setter="set_flag" getter="get_flag"> @@ -307,7 +309,9 @@ </constant> <constant name="FLAG_TRIPLANAR_USE_WORLD" value="9" enum="Flags"> </constant> - <constant name="FLAG_MAX" value="12" enum="Flags"> + <constant name="FLAG_ALBEDO_TEXTURE_FORCE_SRGB" value="12" enum="Flags"> + </constant> + <constant name="FLAG_MAX" value="13" enum="Flags"> </constant> <constant name="DIFFUSE_BURLEY" value="0" enum="DiffuseMode"> </constant> diff --git a/doc/classes/SpriteFrames.xml b/doc/classes/SpriteFrames.xml index 0157386573..883a6d4fa8 100644 --- a/doc/classes/SpriteFrames.xml +++ b/doc/classes/SpriteFrames.xml @@ -164,9 +164,6 @@ </method> </methods> <members> - <member name="animations" type="Array" setter="_set_animations" getter="_get_animations"> - An [Array] containing the [code]name[/code], [code]speed[/code], [code]loop[/code], and [code]frames[/code] of each animation. - </member> <member name="frames" type="Array" setter="_set_frames" getter="_get_frames"> </member> </members> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index d5afe28eb8..df48ba3e23 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -470,6 +470,8 @@ </theme_item> <theme_item name="number_color" type="Color"> </theme_item> + <theme_item name="read_only" type="StyleBox"> + </theme_item> <theme_item name="selection_color" type="Color"> </theme_item> <theme_item name="symbol_color" type="Color"> diff --git a/doc/classes/Texture.xml b/doc/classes/Texture.xml index 855a8f12de..52972177bf 100644 --- a/doc/classes/Texture.xml +++ b/doc/classes/Texture.xml @@ -117,22 +117,26 @@ </methods> <constants> <constant name="FLAG_MIPMAPS" value="1" enum="Flags"> - Generate mipmaps, to enable smooth zooming out of the texture. + Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. </constant> <constant name="FLAG_REPEAT" value="2" enum="Flags"> - Repeat (instead of clamp to edge). + Repeats texture (instead of clamp to edge). </constant> <constant name="FLAG_FILTER" value="4" enum="Flags"> - Turn on magnifying filter, to enable smooth zooming in of the texture. + Magnifying filter, to enable smooth zooming in of the texture. </constant> <constant name="FLAGS_DEFAULT" value="7" enum="Flags"> Default flags. Generate mipmaps, repeat, and filter are enabled. </constant> <constant name="FLAG_ANISOTROPIC_FILTER" value="8" enum="Flags"> + Anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios. + More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases. </constant> <constant name="FLAG_CONVERT_TO_LINEAR" value="16" enum="Flags"> + Converts texture to SRGB color space. </constant> <constant name="FLAG_MIRRORED_REPEAT" value="32" enum="Flags"> + Repeats texture with alternate sections mirrored. </constant> <constant name="FLAG_VIDEO_SURFACE" value="4096" enum="Flags"> Texture is a video surface. diff --git a/doc/classes/Translation.xml b/doc/classes/Translation.xml index a684e63e22..cb49c66383 100644 --- a/doc/classes/Translation.xml +++ b/doc/classes/Translation.xml @@ -57,8 +57,6 @@ <members> <member name="locale" type="String" setter="set_locale" getter="get_locale"> </member> - <member name="messages" type="PoolStringArray" setter="_set_messages" getter="_get_messages"> - </member> </members> <constants> </constants> diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 479c0606f2..6627ba15d5 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -24,6 +24,7 @@ <argument index="3" name="bottom" type="RID"> </argument> <description> + Sets images to be rendered in the window margin. </description> </method> <method name="black_bars_set_margins"> @@ -38,12 +39,14 @@ <argument index="3" name="bottom" type="int"> </argument> <description> + Sets margin size, where black bars (or images, if [method black_bars_set_images] was used) are rendered. </description> </method> <method name="canvas_create"> <return type="RID"> </return> <description> + Creates a canvas and returns the assigned [RID]. </description> </method> <method name="canvas_item_add_circle"> @@ -58,6 +61,7 @@ <argument index="3" name="color" type="Color"> </argument> <description> + Adds a circle command to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_clip_ignore"> @@ -68,6 +72,7 @@ <argument index="1" name="ignore" type="bool"> </argument> <description> + If ignore is [code]true[/code], the VisualServer does not perform clipping. </description> </method> <method name="canvas_item_add_line"> @@ -86,6 +91,7 @@ <argument index="5" name="antialiased" type="bool" default="false"> </argument> <description> + Adds a line command to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_mesh"> @@ -98,6 +104,7 @@ <argument index="2" name="skeleton" type="RID"> </argument> <description> + Adds a [Mesh] to the [CanvasItem]'s draw commands. Only affects its aabb at the moment. </description> </method> <method name="canvas_item_add_multimesh"> @@ -110,6 +117,7 @@ <argument index="2" name="skeleton" type="RID"> </argument> <description> + Adds a [MultiMesh] to the [CanvasItem]'s draw commands. Only affects its aabb at the moment. </description> </method> <method name="canvas_item_add_nine_patch"> @@ -138,6 +146,8 @@ <argument index="10" name="normal_map" type="RID"> </argument> <description> + Adds a nine patch image to the [CanvasItem]'s draw commands. + See [NinePatchRect] for more explanation. </description> </method> <method name="canvas_item_add_particles"> @@ -156,6 +166,7 @@ <argument index="5" name="v_frames" type="int"> </argument> <description> + Adds a particles system to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_polygon"> @@ -176,6 +187,7 @@ <argument index="6" name="antialiased" type="bool" default="false"> </argument> <description> + Adds a polygon to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_polyline"> @@ -192,6 +204,7 @@ <argument index="4" name="antialiased" type="bool" default="false"> </argument> <description> + Adds a polyline, which is a line from mutliple points with a width, to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_primitive"> @@ -212,6 +225,7 @@ <argument index="6" name="normal_map" type="RID"> </argument> <description> + Adds a primitive to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_rect"> @@ -224,6 +238,7 @@ <argument index="2" name="color" type="Color"> </argument> <description> + Adds a rectangle to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_set_transform"> @@ -234,6 +249,8 @@ <argument index="1" name="transform" type="Transform2D"> </argument> <description> + Adds a [Transform2D] command to the [CanvasItem]'s draw commands. + This sets the extra_matrix uniform when executed. This affects the later command's of the canvas item. </description> </method> <method name="canvas_item_add_texture_rect"> @@ -254,6 +271,7 @@ <argument index="6" name="normal_map" type="RID"> </argument> <description> + Adds a textured rect to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_texture_rect_region"> @@ -276,6 +294,7 @@ <argument index="7" name="clip_uv" type="bool" default="true"> </argument> <description> + Adds a texture rect with region setting to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_triangle_array"> @@ -298,6 +317,7 @@ <argument index="7" name="normal_map" type="RID"> </argument> <description> + Adds a triangle array to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_clear"> @@ -306,12 +326,14 @@ <argument index="0" name="item" type="RID"> </argument> <description> + Clears the [CanvasItem] and removes all commands in it. </description> </method> <method name="canvas_item_create"> <return type="RID"> </return> <description> + Creates a new [CanvasItem] and returns its [RID]. </description> </method> <method name="canvas_item_set_clip"> @@ -322,6 +344,7 @@ <argument index="1" name="clip" type="bool"> </argument> <description> + Sets clipping for the [CanvasItem]. </description> </method> <method name="canvas_item_set_copy_to_backbuffer"> @@ -334,6 +357,7 @@ <argument index="2" name="rect" type="Rect2"> </argument> <description> + Sets the [CanvasItem] to copy a rect to the backbuffer. </description> </method> <method name="canvas_item_set_custom_rect"> @@ -346,6 +370,7 @@ <argument index="2" name="rect" type="Rect2" default="Rect2( 0, 0, 0, 0 )"> </argument> <description> + Defines a custom drawing rectangle for the [CanvasItem]. </description> </method> <method name="canvas_item_set_distance_field_mode"> @@ -366,6 +391,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + Sets [CanvasItem] to be drawn behind its parent. </description> </method> <method name="canvas_item_set_draw_index"> @@ -376,6 +402,7 @@ <argument index="1" name="index" type="int"> </argument> <description> + Sets the index for the [CanvasItem]. </description> </method> <method name="canvas_item_set_light_mask"> @@ -386,6 +413,7 @@ <argument index="1" name="mask" type="int"> </argument> <description> + The light mask. See [LightOccluder2D] for more information on light masks. </description> </method> <method name="canvas_item_set_material"> @@ -396,6 +424,7 @@ <argument index="1" name="material" type="RID"> </argument> <description> + Sets a new material to the [CanvasItem]. </description> </method> <method name="canvas_item_set_modulate"> @@ -406,6 +435,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> + Sets the color that modulates the [CanvasItem] and its children. </description> </method> <method name="canvas_item_set_parent"> @@ -416,6 +446,7 @@ <argument index="1" name="parent" type="RID"> </argument> <description> + Sets the parent for the [CanvasItem]. </description> </method> <method name="canvas_item_set_self_modulate"> @@ -426,6 +457,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> + Sets the color that modulates the [CanvasItem] without children. </description> </method> <method name="canvas_item_set_sort_children_by_y"> @@ -436,6 +468,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + Sets if [CanvasItem]'s children should be sorted by y-position. </description> </method> <method name="canvas_item_set_transform"> @@ -446,6 +479,7 @@ <argument index="1" name="transform" type="Transform2D"> </argument> <description> + Sets the [CanvasItem]'s [Transform2D]. </description> </method> <method name="canvas_item_set_use_parent_material"> @@ -456,6 +490,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + Sets if the [CanvasItem] uses its parent's material. </description> </method> <method name="canvas_item_set_visible"> @@ -466,6 +501,7 @@ <argument index="1" name="visible" type="bool"> </argument> <description> + Sets if the canvas item (including its children) is visible. </description> </method> <method name="canvas_item_set_z"> @@ -476,6 +512,7 @@ <argument index="1" name="z" type="int"> </argument> <description> + Sets the [CanvasItem]'s z order position. </description> </method> <method name="canvas_item_set_z_as_relative_to_parent"> @@ -486,6 +523,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + If this is enabled, the z-position of the parent will be added to the childrens z-position. </description> </method> <method name="canvas_light_attach_to_canvas"> @@ -496,12 +534,14 @@ <argument index="1" name="canvas" type="RID"> </argument> <description> + Attaches the canvas light to the canvas. Removes it from its previous canvas. </description> </method> <method name="canvas_light_create"> <return type="RID"> </return> <description> + Creates a canvas light. </description> </method> <method name="canvas_light_occluder_attach_to_canvas"> @@ -512,12 +552,14 @@ <argument index="1" name="canvas" type="RID"> </argument> <description> + Attaches a light occluder to the canvas. Removes it from its previous canvas. </description> </method> <method name="canvas_light_occluder_create"> <return type="RID"> </return> <description> + Creates a light occluder. </description> </method> <method name="canvas_light_occluder_set_enabled"> @@ -528,6 +570,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + Enables or disables light occluder. </description> </method> <method name="canvas_light_occluder_set_light_mask"> @@ -538,6 +581,7 @@ <argument index="1" name="mask" type="int"> </argument> <description> + The light mask. See [LightOccluder2D] for more information on light masks </description> </method> <method name="canvas_light_occluder_set_polygon"> @@ -548,6 +592,7 @@ <argument index="1" name="polygon" type="RID"> </argument> <description> + Sets a light occluder's polygon. </description> </method> <method name="canvas_light_occluder_set_transform"> @@ -558,6 +603,7 @@ <argument index="1" name="transform" type="Transform2D"> </argument> <description> + Sets a light occluder's [Transform2D]. </description> </method> <method name="canvas_light_set_color"> @@ -568,6 +614,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> + Sets the color for a light. </description> </method> <method name="canvas_light_set_enabled"> @@ -578,6 +625,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + Enables or disables a canvas light. </description> </method> <method name="canvas_light_set_energy"> @@ -588,6 +636,7 @@ <argument index="1" name="energy" type="float"> </argument> <description> + Sets a canvas light's energy. </description> </method> <method name="canvas_light_set_height"> @@ -598,6 +647,7 @@ <argument index="1" name="height" type="float"> </argument> <description> + Sets a canvas light's height. </description> </method> <method name="canvas_light_set_item_cull_mask"> @@ -608,6 +658,7 @@ <argument index="1" name="mask" type="int"> </argument> <description> + The light mask. See [LightOccluder2D] for more information on light masks </description> </method> <method name="canvas_light_set_item_shadow_cull_mask"> @@ -618,6 +669,7 @@ <argument index="1" name="mask" type="int"> </argument> <description> + The shadow mask. binary about wich layers this canvas light affects wich canvas item's shadows. See [LightOccluder2D] for more information on light masks. </description> </method> <method name="canvas_light_set_layer_range"> @@ -630,6 +682,7 @@ <argument index="2" name="max_layer" type="int"> </argument> <description> + The layer range that gets rendered with this light. </description> </method> <method name="canvas_light_set_mode"> @@ -640,6 +693,7 @@ <argument index="1" name="mode" type="int" enum="VisualServer.CanvasLightMode"> </argument> <description> + The mode of the light, see CANVAS_LIGHT_MODE_* constants. </description> </method> <method name="canvas_light_set_scale"> @@ -660,6 +714,7 @@ <argument index="1" name="size" type="int"> </argument> <description> + Sets the width of the shadow buffer, size gets scaled to the next power of two for this. </description> </method> <method name="canvas_light_set_shadow_color"> @@ -670,6 +725,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> + Sets the color of the canvas light's shadow. </description> </method> <method name="canvas_light_set_shadow_enabled"> @@ -680,6 +736,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + Enables or disables the canvas light's shadow. </description> </method> <method name="canvas_light_set_shadow_filter"> @@ -690,6 +747,7 @@ <argument index="1" name="filter" type="int" enum="VisualServer.CanvasLightShadowFilter"> </argument> <description> + Sets the canvas light's shadow's filter, see CANVAS_LIGHT_SHADOW_FILTER_* constants. </description> </method> <method name="canvas_light_set_shadow_gradient_length"> @@ -700,6 +758,7 @@ <argument index="1" name="length" type="float"> </argument> <description> + Sets the length of the shadow's gradient. </description> </method> <method name="canvas_light_set_shadow_smooth"> @@ -710,6 +769,7 @@ <argument index="1" name="smooth" type="float"> </argument> <description> + Smoothens the shadow. The lower, the more smooth. </description> </method> <method name="canvas_light_set_texture"> @@ -740,6 +800,7 @@ <argument index="1" name="transform" type="Transform2D"> </argument> <description> + Sets the canvas light's [Transform2D]. </description> </method> <method name="canvas_light_set_z_range"> @@ -758,6 +819,7 @@ <return type="RID"> </return> <description> + Creates a new light occluder polygon. </description> </method> <method name="canvas_occluder_polygon_set_cull_mode"> @@ -768,6 +830,7 @@ <argument index="1" name="mode" type="int" enum="VisualServer.CanvasOccluderPolygonCullMode"> </argument> <description> + Sets an occluder polygons cull mode. See CANVAS_OCCLUDER_POLYGON_CULL_MODE_* constants. </description> </method> <method name="canvas_occluder_polygon_set_shape"> @@ -780,6 +843,7 @@ <argument index="2" name="closed" type="bool"> </argument> <description> + Sets the shape of the occluder polygon. </description> </method> <method name="canvas_occluder_polygon_set_shape_as_lines"> @@ -790,6 +854,7 @@ <argument index="1" name="shape" type="PoolVector2Array"> </argument> <description> + Sets the shape of the occluder polygon as lines. </description> </method> <method name="canvas_set_item_mirroring"> @@ -802,6 +867,7 @@ <argument index="2" name="mirroring" type="Vector2"> </argument> <description> + A copy of the canvas item will be drawn with a local offset of the mirroring [Vector2]. </description> </method> <method name="canvas_set_modulate"> @@ -812,6 +878,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> + Modulates all colors in the given canvas. </description> </method> <method name="draw"> @@ -820,12 +887,14 @@ <argument index="0" name="swap_buffers" type="bool" default="true"> </argument> <description> + Draws a frame. </description> </method> <method name="finish"> <return type="void"> </return> <description> + Removes buffers and clears testcubes. </description> </method> <method name="force_draw"> @@ -834,12 +903,14 @@ <argument index="0" name="swap_buffers" type="bool" default="true"> </argument> <description> + Draws a frame. Same as [method draw]. </description> </method> <method name="force_sync"> <return type="void"> </return> <description> + Syncronizes threads. </description> </method> <method name="free"> @@ -848,6 +919,7 @@ <argument index="0" name="rid" type="RID"> </argument> <description> + Tries to free an object in the VisualServer. </description> </method> <method name="get_render_info"> @@ -856,30 +928,35 @@ <argument index="0" name="info" type="int" enum="VisualServer.RenderInfo"> </argument> <description> + Returns a certain information, see RENDER_INFO_* for options. </description> </method> <method name="get_test_cube"> <return type="RID"> </return> <description> + Returns the id of the test cube. Creates one if none exists. </description> </method> <method name="get_test_texture"> <return type="RID"> </return> <description> + Returns the id of the test texture. Creates one if none exists. </description> </method> <method name="get_white_texture"> <return type="RID"> </return> <description> + Returns the id of a white texture. Creates one if none exists. </description> </method> <method name="has_changed" qualifiers="const"> <return type="bool"> </return> <description> + Returns [code]true[/code] if changes have been made to the VisualServer's data. [method draw] is usually called if this happens. </description> </method> <method name="has_feature" qualifiers="const"> @@ -896,12 +973,14 @@ <argument index="0" name="feature" type="String"> </argument> <description> + Returns true, if the OS supports a certain feature. Features might be s3tc, etc, etc2 and pvrtc, </description> </method> <method name="init"> <return type="void"> </return> <description> + Initializes the visual server. </description> </method> <method name="make_sphere_mesh"> @@ -914,12 +993,14 @@ <argument index="2" name="radius" type="float"> </argument> <description> + Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions. </description> </method> <method name="material_create"> <return type="RID"> </return> <description> + Returns an empty material. </description> </method> <method name="material_get_param" qualifiers="const"> @@ -930,6 +1011,7 @@ <argument index="1" name="parameter" type="String"> </argument> <description> + Returns the value of a certain material's parameter. </description> </method> <method name="material_get_shader" qualifiers="const"> @@ -938,6 +1020,7 @@ <argument index="0" name="shader_material" type="RID"> </argument> <description> + Returns the shader of a certain material's shader. Returns an empty RID if the material doesn't have a shader. </description> </method> <method name="material_set_line_width"> @@ -948,6 +1031,7 @@ <argument index="1" name="width" type="float"> </argument> <description> + Sets a materials line width. </description> </method> <method name="material_set_next_pass"> @@ -958,6 +1042,7 @@ <argument index="1" name="next_material" type="RID"> </argument> <description> + Sets an objects next material. </description> </method> <method name="material_set_param"> @@ -970,6 +1055,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> + Sets a materials parameter. </description> </method> <method name="material_set_render_priority"> @@ -980,6 +1066,7 @@ <argument index="1" name="priority" type="int"> </argument> <description> + Sets a material's render priority. </description> </method> <method name="material_set_shader"> @@ -990,6 +1077,7 @@ <argument index="1" name="shader" type="RID"> </argument> <description> + Sets a shader material's shader. </description> </method> <method name="mesh_add_surface_from_arrays"> @@ -1006,6 +1094,7 @@ <argument index="4" name="compress_format" type="int" default="97792"> </argument> <description> + Adds a surface generated from the Arrays to a mesh. See PRIMITIVE_TYPE_* constants for types. </description> </method> <method name="mesh_clear"> @@ -1014,12 +1103,14 @@ <argument index="0" name="mesh" type="RID"> </argument> <description> + Removes all surfaces from a mesh. </description> </method> <method name="mesh_create"> <return type="RID"> </return> <description> + Creates a new mesh. </description> </method> <method name="mesh_get_blend_shape_count" qualifiers="const"> @@ -1028,6 +1119,7 @@ <argument index="0" name="mesh" type="RID"> </argument> <description> + Returns a mesh's blend shape count. </description> </method> <method name="mesh_get_blend_shape_mode" qualifiers="const"> @@ -1036,6 +1128,7 @@ <argument index="0" name="mesh" type="RID"> </argument> <description> + Returns a mesh's blend shape mode. </description> </method> <method name="mesh_get_custom_aabb" qualifiers="const"> @@ -1044,6 +1137,7 @@ <argument index="0" name="mesh" type="RID"> </argument> <description> + Returns a mesh's custom aabb. </description> </method> <method name="mesh_get_surface_count" qualifiers="const"> @@ -1052,6 +1146,7 @@ <argument index="0" name="mesh" type="RID"> </argument> <description> + Returns a mesh's number of surfaces. </description> </method> <method name="mesh_remove_surface"> @@ -1062,6 +1157,7 @@ <argument index="1" name="index" type="int"> </argument> <description> + Removes a mesh's surface. </description> </method> <method name="mesh_set_blend_shape_count"> @@ -1072,6 +1168,7 @@ <argument index="1" name="amount" type="int"> </argument> <description> + Sets a mesh's blend shape count. </description> </method> <method name="mesh_set_blend_shape_mode"> @@ -1082,6 +1179,7 @@ <argument index="1" name="mode" type="int" enum="VisualServer.BlendShapeMode"> </argument> <description> + Sets a mesh's blend shape mode. </description> </method> <method name="mesh_set_custom_aabb"> @@ -1092,6 +1190,7 @@ <argument index="1" name="aabb" type="AABB"> </argument> <description> + Sets a mesh's custom aabb. </description> </method> <method name="mesh_surface_get_aabb" qualifiers="const"> @@ -1102,6 +1201,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns a mesh's surface's aabb. </description> </method> <method name="mesh_surface_get_array" qualifiers="const"> @@ -1112,6 +1212,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns a mesh's surface's vertex buffer. </description> </method> <method name="mesh_surface_get_array_index_len" qualifiers="const"> @@ -1122,6 +1223,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns a mesh's surface's amount of indices. </description> </method> <method name="mesh_surface_get_array_len" qualifiers="const"> @@ -1132,6 +1234,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns a mesh's surface's amount of vertices. </description> </method> <method name="mesh_surface_get_arrays" qualifiers="const"> @@ -1142,6 +1245,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns a mesh's surface's buffer arrays. </description> </method> <method name="mesh_surface_get_blend_shape_arrays" qualifiers="const"> @@ -1152,6 +1256,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns a mesh's surface's arrays for blend shapes </description> </method> <method name="mesh_surface_get_format" qualifiers="const"> @@ -1162,6 +1267,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns the format of a mesh's surface. </description> </method> <method name="mesh_surface_get_index_array" qualifiers="const"> @@ -1172,6 +1278,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns a mesh's surface's index buffer. </description> </method> <method name="mesh_surface_get_material" qualifiers="const"> @@ -1182,6 +1289,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns a mesh's surface's material. </description> </method> <method name="mesh_surface_get_primitive_type" qualifiers="const"> @@ -1192,6 +1300,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns the primitive type of a mesh's surface. </description> </method> <method name="mesh_surface_get_skeleton_aabb" qualifiers="const"> @@ -1202,6 +1311,7 @@ <argument index="1" name="surface" type="int"> </argument> <description> + Returns the aabb of a mesh's surface's skeleton. </description> </method> <method name="mesh_surface_set_material"> @@ -1214,6 +1324,7 @@ <argument index="2" name="material" type="RID"> </argument> <description> + Sets a mesh's surface's material. </description> </method> <method name="request_frame_drawn_callback"> @@ -1240,6 +1351,7 @@ <argument index="2" name="scale" type="bool"> </argument> <description> + Sets a boot image. The color defines the background color and if scale is [code]true[/code], the image will be scaled to fit the screen size. </description> </method> <method name="set_debug_generate_wireframes"> @@ -1262,6 +1374,7 @@ <return type="RID"> </return> <description> + Creates an empty shader. </description> </method> <method name="shader_get_code" qualifiers="const"> @@ -1270,6 +1383,7 @@ <argument index="0" name="shader" type="RID"> </argument> <description> + Returns a shader's code. </description> </method> <method name="shader_get_default_texture_param" qualifiers="const"> @@ -1280,6 +1394,7 @@ <argument index="1" name="name" type="String"> </argument> <description> + Returns a default texture from a shader searched by name. </description> </method> <method name="shader_get_param_list" qualifiers="const"> @@ -1288,6 +1403,7 @@ <argument index="0" name="shader" type="RID"> </argument> <description> + Returns the parameters of a shader. </description> </method> <method name="shader_set_code"> @@ -1298,6 +1414,7 @@ <argument index="1" name="code" type="String"> </argument> <description> + Sets a shader's code. </description> </method> <method name="shader_set_default_texture_param"> @@ -1310,12 +1427,14 @@ <argument index="2" name="texture" type="RID"> </argument> <description> + Sets a shader's default texture. Overwrites the texture given by name. </description> </method> <method name="sky_create"> <return type="RID"> </return> <description> + Creates an empty sky. </description> </method> <method name="sky_set_texture"> @@ -1328,6 +1447,7 @@ <argument index="2" name="radiance_size" type="int"> </argument> <description> + Sets a sky's texture. </description> </method> <method name="sync"> @@ -1350,12 +1470,14 @@ <argument index="4" name="flags" type="int" default="7"> </argument> <description> + Allocates space for a texture's image or video. </description> </method> <method name="texture_create"> <return type="RID"> </return> <description> + Creates an empty texture. </description> </method> <method name="texture_create_from_image"> @@ -1366,12 +1488,14 @@ <argument index="1" name="flags" type="int" default="7"> </argument> <description> + Creates a texture, allocates the space for an image, and fills in the image. </description> </method> <method name="texture_debug_usage"> <return type="Array"> </return> <description> + Returns a list of all the textures and their information. </description> </method> <method name="texture_get_data" qualifiers="const"> @@ -1382,6 +1506,7 @@ <argument index="1" name="cube_side" type="int" enum="VisualServer.CubeMapSide" default="0"> </argument> <description> + Returns a copy of a texture's image unless it's a CubeMap, in wich case it returns the [RID] of the image at one of the cubes sides. </description> </method> <method name="texture_get_flags" qualifiers="const"> @@ -1390,6 +1515,7 @@ <argument index="0" name="texture" type="RID"> </argument> <description> + Returns the flags of a texture. </description> </method> <method name="texture_get_format" qualifiers="const"> @@ -1398,6 +1524,7 @@ <argument index="0" name="texture" type="RID"> </argument> <description> + Returns the format of the texture's image. </description> </method> <method name="texture_get_height" qualifiers="const"> @@ -1406,6 +1533,7 @@ <argument index="0" name="texture" type="RID"> </argument> <description> + Returns the texture's height. </description> </method> <method name="texture_get_path" qualifiers="const"> @@ -1414,6 +1542,7 @@ <argument index="0" name="texture" type="RID"> </argument> <description> + Returns the texture's path. </description> </method> <method name="texture_get_texid" qualifiers="const"> @@ -1422,6 +1551,7 @@ <argument index="0" name="texture" type="RID"> </argument> <description> + Returns the opengl id of the texture's image. </description> </method> <method name="texture_get_width" qualifiers="const"> @@ -1430,6 +1560,7 @@ <argument index="0" name="texture" type="RID"> </argument> <description> + Returns the texture's width. </description> </method> <method name="texture_set_data"> @@ -1442,6 +1573,7 @@ <argument index="2" name="cube_side" type="int" enum="VisualServer.CubeMapSide" default="0"> </argument> <description> + Sets the texture's image data. If it's a CubeMap, it sets the image data at a cube side. </description> </method> <method name="texture_set_flags"> @@ -1452,6 +1584,7 @@ <argument index="1" name="flags" type="int"> </argument> <description> + Sets the texture's flags. See [enum TextureFlags] for options </description> </method> <method name="texture_set_path"> @@ -1462,6 +1595,7 @@ <argument index="1" name="path" type="String"> </argument> <description> + Sets the texture's path. </description> </method> <method name="texture_set_shrink_all_x2_on_set_data"> @@ -1470,6 +1604,7 @@ <argument index="0" name="shrink" type="bool"> </argument> <description> + If [code]true[/code], sets internal processes to shrink all image data to half the size. </description> </method> <method name="texture_set_size_override"> @@ -1482,6 +1617,7 @@ <argument index="2" name="height" type="int"> </argument> <description> + Overwrites the texture's width and height. </description> </method> <method name="textures_keep_original"> @@ -1490,6 +1626,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> + If [code]true[/code], the image will be stored in the texture's images array if overwritten. </description> </method> <method name="viewport_attach_camera"> @@ -1500,6 +1637,7 @@ <argument index="1" name="camera" type="RID"> </argument> <description> + Sets a viewport's camera. </description> </method> <method name="viewport_attach_canvas"> @@ -1510,6 +1648,7 @@ <argument index="1" name="canvas" type="RID"> </argument> <description> + Sets a viewport's canvas. </description> </method> <method name="viewport_attach_to_screen"> @@ -1522,12 +1661,14 @@ <argument index="2" name="screen" type="int" default="0"> </argument> <description> + Attaches a viewport to a screen. </description> </method> <method name="viewport_create"> <return type="RID"> </return> <description> + Creates an empty viewport. </description> </method> <method name="viewport_detach"> @@ -1536,6 +1677,7 @@ <argument index="0" name="viewport" type="RID"> </argument> <description> + Detaches the viewport from the screen. </description> </method> <method name="viewport_get_render_info"> @@ -1546,6 +1688,7 @@ <argument index="1" name="info" type="int" enum="VisualServer.ViewportRenderInfo"> </argument> <description> + Returns a viewport's render info. for options see VIEWPORT_RENDER_INFO* constants. </description> </method> <method name="viewport_get_texture" qualifiers="const"> @@ -1554,6 +1697,7 @@ <argument index="0" name="viewport" type="RID"> </argument> <description> + Returns the viewport's last rendered frame. </description> </method> <method name="viewport_remove_canvas"> @@ -1564,6 +1708,7 @@ <argument index="1" name="canvas" type="RID"> </argument> <description> + Detaches a viewport from a canvas and vice versa. </description> </method> <method name="viewport_set_active"> @@ -1574,6 +1719,7 @@ <argument index="1" name="active" type="bool"> </argument> <description> + If [code]true[/code], sets the viewport active, else sets it inactive. </description> </method> <method name="viewport_set_canvas_layer"> @@ -1586,6 +1732,7 @@ <argument index="2" name="layer" type="int"> </argument> <description> + Sets the renderlayer for a viewport's canvas. </description> </method> <method name="viewport_set_canvas_transform"> @@ -1598,6 +1745,7 @@ <argument index="2" name="offset" type="Transform2D"> </argument> <description> + Sets the transformation of a viewport's canvas. </description> </method> <method name="viewport_set_clear_mode"> @@ -1608,6 +1756,7 @@ <argument index="1" name="clear_mode" type="int" enum="VisualServer.ViewportClearMode"> </argument> <description> + Sets the clear mode of a viewport. See VIEWPORT_CLEAR_MODE_* constants for options. </description> </method> <method name="viewport_set_debug_draw"> @@ -1618,6 +1767,7 @@ <argument index="1" name="draw" type="int" enum="VisualServer.ViewportDebugDraw"> </argument> <description> + Sets the debug draw mode of a viewport. See VIEWPORT_DEBUG_DRAW_* constants for options. </description> </method> <method name="viewport_set_disable_3d"> @@ -1628,6 +1778,7 @@ <argument index="1" name="disabled" type="bool"> </argument> <description> + If [code]true[/code] a viewport's 3D rendering should be disabled. </description> </method> <method name="viewport_set_disable_environment"> @@ -1638,6 +1789,7 @@ <argument index="1" name="disabled" type="bool"> </argument> <description> + If [code]true[/code] rendering of a viewport's environment should be disabled. </description> </method> <method name="viewport_set_global_canvas_transform"> @@ -1648,6 +1800,7 @@ <argument index="1" name="transform" type="Transform2D"> </argument> <description> + Sets the viewport's global transformation matrix. </description> </method> <method name="viewport_set_hdr"> @@ -1658,6 +1811,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + If [code]true[/code] the viewport should render to hdr. </description> </method> <method name="viewport_set_hide_canvas"> @@ -1668,6 +1822,7 @@ <argument index="1" name="hidden" type="bool"> </argument> <description> + If [code]true[/code] the viewport's canvas should not be rendered. </description> </method> <method name="viewport_set_hide_scenario"> @@ -1688,6 +1843,7 @@ <argument index="1" name="msaa" type="int" enum="VisualServer.ViewportMSAA"> </argument> <description> + Sets the anti-aliasing mode. see [enum ViewportMSAA] for options. </description> </method> <method name="viewport_set_parent_viewport"> @@ -1698,6 +1854,7 @@ <argument index="1" name="parent_viewport" type="RID"> </argument> <description> + Sets the viewport's parent to another viewport. </description> </method> <method name="viewport_set_scenario"> @@ -1708,6 +1865,8 @@ <argument index="1" name="scenario" type="RID"> </argument> <description> + Sets a viewport's scenario. + The scenario contains information about the [enum ScenarioDebugMode], environment information, reflection atlas etc. </description> </method> <method name="viewport_set_shadow_atlas_quadrant_subdivision"> @@ -1720,6 +1879,7 @@ <argument index="2" name="subdivision" type="int"> </argument> <description> + Sets the shadow atlas quadrant's subdivision. </description> </method> <method name="viewport_set_shadow_atlas_size"> @@ -1730,6 +1890,7 @@ <argument index="1" name="size" type="int"> </argument> <description> + Sets the size of the shadow atlas's images. </description> </method> <method name="viewport_set_size"> @@ -1742,6 +1903,7 @@ <argument index="2" name="height" type="int"> </argument> <description> + Sets the viewport's width and height. </description> </method> <method name="viewport_set_transparent_background"> @@ -1752,6 +1914,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + If [code]true[/code] the viewport should render its background as transparent. </description> </method> <method name="viewport_set_update_mode"> @@ -1762,6 +1925,7 @@ <argument index="1" name="update_mode" type="int" enum="VisualServer.ViewportUpdateMode"> </argument> <description> + Sets when the viewport should be updated. See VIEWPORT_UPDATE_MODE_* constants for options. </description> </method> <method name="viewport_set_usage"> @@ -1772,6 +1936,7 @@ <argument index="1" name="usage" type="int" enum="VisualServer.ViewportUsage"> </argument> <description> + Sets what should be rendered in the viewport. See VIEWPORT_USAGE_* constants for options. </description> </method> <method name="viewport_set_use_arvr"> @@ -1782,6 +1947,7 @@ <argument index="1" name="use_arvr" type="bool"> </argument> <description> + If [code]true[/code] the viewport should use augmented or virtual reality technologies. See [ARVRInterface]. </description> </method> <method name="viewport_set_vflip"> @@ -1792,6 +1958,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + If [code]true[/code] the viewport's rendering should be flipped vertically. </description> </method> </methods> @@ -1803,160 +1970,232 @@ </signals> <constants> <constant name="NO_INDEX_ARRAY" value="-1"> + Marks an error that shows that the index array is empty. </constant> <constant name="ARRAY_WEIGHTS_SIZE" value="4"> </constant> <constant name="CANVAS_ITEM_Z_MIN" value="-4096"> + The minimum Z-layer for canvas items. </constant> <constant name="CANVAS_ITEM_Z_MAX" value="4096"> + The maximum Z-layer for canvas items. </constant> <constant name="MAX_GLOW_LEVELS" value="7"> </constant> <constant name="MAX_CURSORS" value="8"> </constant> <constant name="MATERIAL_RENDER_PRIORITY_MIN" value="-128"> + The minimum renderpriority of all materials. </constant> <constant name="MATERIAL_RENDER_PRIORITY_MAX" value="127"> + The maximum renderpriority of all materials. </constant> <constant name="CUBEMAP_LEFT" value="0" enum="CubeMapSide"> + Marks the left side of a cubemap. </constant> <constant name="CUBEMAP_RIGHT" value="1" enum="CubeMapSide"> + Marks the right side of a cubemap. </constant> <constant name="CUBEMAP_BOTTOM" value="2" enum="CubeMapSide"> + Marks the bottom side of a cubemap. </constant> <constant name="CUBEMAP_TOP" value="3" enum="CubeMapSide"> + Marks the top side of a cubemap. </constant> <constant name="CUBEMAP_FRONT" value="4" enum="CubeMapSide"> + Marks the front side of a cubemap. </constant> <constant name="CUBEMAP_BACK" value="5" enum="CubeMapSide"> + Marks the back side of a cubemap. </constant> <constant name="TEXTURE_FLAG_MIPMAPS" value="1" enum="TextureFlags"> + Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. </constant> <constant name="TEXTURE_FLAG_REPEAT" value="2" enum="TextureFlags"> + Repeat (instead of clamp to edge). </constant> <constant name="TEXTURE_FLAG_FILTER" value="4" enum="TextureFlags"> + Turn on magnifying filter, to enable smooth zooming in of the texture. </constant> <constant name="TEXTURE_FLAG_ANISOTROPIC_FILTER" value="8" enum="TextureFlags"> + Anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios. + More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases. </constant> <constant name="TEXTURE_FLAG_CONVERT_TO_LINEAR" value="16" enum="TextureFlags"> + Converts texture to SRGB color space. </constant> <constant name="TEXTURE_FLAG_MIRRORED_REPEAT" value="32" enum="TextureFlags"> + Repeat texture with alternate sections mirrored. </constant> <constant name="TEXTURE_FLAG_CUBEMAP" value="2048" enum="TextureFlags"> + Texture is a cubemap. </constant> <constant name="TEXTURE_FLAG_USED_FOR_STREAMING" value="4096" enum="TextureFlags"> + Texture is a video surface. </constant> <constant name="TEXTURE_FLAGS_DEFAULT" value="7" enum="TextureFlags"> + Default flags. Generate mipmaps, repeat, and filter are enabled. </constant> <constant name="SHADER_SPATIAL" value="0" enum="ShaderMode"> + Shader is a 3D shader. </constant> <constant name="SHADER_CANVAS_ITEM" value="1" enum="ShaderMode"> + Shader is a 2D shader. </constant> <constant name="SHADER_PARTICLES" value="2" enum="ShaderMode"> + Shader is a particle shader. </constant> <constant name="SHADER_MAX" value="3" enum="ShaderMode"> + Marks maximum of the shader types array. used internally. </constant> <constant name="ARRAY_VERTEX" value="0" enum="ArrayType"> + Array is a vertex array. </constant> <constant name="ARRAY_NORMAL" value="1" enum="ArrayType"> + Array is a normal array. </constant> <constant name="ARRAY_TANGENT" value="2" enum="ArrayType"> + Array is a tangent array. </constant> <constant name="ARRAY_COLOR" value="3" enum="ArrayType"> + Array is a color array. </constant> <constant name="ARRAY_TEX_UV" value="4" enum="ArrayType"> + Array is a uv coordinates array. </constant> <constant name="ARRAY_TEX_UV2" value="5" enum="ArrayType"> + Array is a uv coordinates array for the second uv coordinates. </constant> <constant name="ARRAY_BONES" value="6" enum="ArrayType"> + Array contains bone information. </constant> <constant name="ARRAY_WEIGHTS" value="7" enum="ArrayType"> + Array is weight information. </constant> <constant name="ARRAY_INDEX" value="8" enum="ArrayType"> + Array is index array. </constant> <constant name="ARRAY_MAX" value="9" enum="ArrayType"> + Marks the maximum of the array types. Used internally. </constant> <constant name="ARRAY_FORMAT_VERTEX" value="1" enum="ArrayFormat"> + Flag used to mark a vertex array. </constant> <constant name="ARRAY_FORMAT_NORMAL" value="2" enum="ArrayFormat"> + Flag used to mark a normal array. </constant> <constant name="ARRAY_FORMAT_TANGENT" value="4" enum="ArrayFormat"> + Flag used to mark a tangent array. </constant> <constant name="ARRAY_FORMAT_COLOR" value="8" enum="ArrayFormat"> + Flag used to mark a color array. </constant> <constant name="ARRAY_FORMAT_TEX_UV" value="16" enum="ArrayFormat"> + Flag used to mark a uv coordinates array. </constant> <constant name="ARRAY_FORMAT_TEX_UV2" value="32" enum="ArrayFormat"> + Flag used to mark a uv coordinates array for the second uv coordinates. </constant> <constant name="ARRAY_FORMAT_BONES" value="64" enum="ArrayFormat"> + Flag used to mark a bone information array. </constant> <constant name="ARRAY_FORMAT_WEIGHTS" value="128" enum="ArrayFormat"> + Flag used to mark a weights array. </constant> <constant name="ARRAY_FORMAT_INDEX" value="256" enum="ArrayFormat"> + Flag used to mark a index array. </constant> <constant name="ARRAY_COMPRESS_VERTEX" value="512" enum="ArrayFormat"> + Flag used to mark a compressed (half float) vertex array. </constant> <constant name="ARRAY_COMPRESS_NORMAL" value="1024" enum="ArrayFormat"> + Flag used to mark a compressed (half float) normal array. </constant> <constant name="ARRAY_COMPRESS_TANGENT" value="2048" enum="ArrayFormat"> + Flag used to mark a compressed (half float) tangent array. </constant> <constant name="ARRAY_COMPRESS_COLOR" value="4096" enum="ArrayFormat"> + Flag used to mark a compressed (half float) color array. </constant> <constant name="ARRAY_COMPRESS_TEX_UV" value="8192" enum="ArrayFormat"> + Flag used to mark a compressed (half float) uv coordinates array. </constant> <constant name="ARRAY_COMPRESS_TEX_UV2" value="16384" enum="ArrayFormat"> + Flag used to mark a compressed (half float) uv coordinates array for the second uv coordinates. </constant> <constant name="ARRAY_COMPRESS_BONES" value="32768" enum="ArrayFormat"> </constant> <constant name="ARRAY_COMPRESS_WEIGHTS" value="65536" enum="ArrayFormat"> + Flag used to mark a compressed (half float) weight array. </constant> <constant name="ARRAY_COMPRESS_INDEX" value="131072" enum="ArrayFormat"> </constant> <constant name="ARRAY_FLAG_USE_2D_VERTICES" value="262144" enum="ArrayFormat"> + Flag used to mark that the array contains 2D vertices. </constant> <constant name="ARRAY_FLAG_USE_16_BIT_BONES" value="524288" enum="ArrayFormat"> + Flag used to mark that the array uses 16 bit bones instead of 8 bit. </constant> <constant name="ARRAY_COMPRESS_DEFAULT" value="97792" enum="ArrayFormat"> + Used to set flags ARRAY_COMPRESS_VERTEX, ARRAY_COMPRESS_NORMAL, ARRAY_COMPRESS_TANGENT, ARRAY_COMPRESS_COLOR, ARRAY_COMPRESS_TEX_UV, ARRAY_COMPRESS_TEX_UV2 and ARRAY_COMPRESS_WEIGHTS quickly. </constant> <constant name="PRIMITIVE_POINTS" value="0" enum="PrimitiveType"> + Primitive to draw consists of points. </constant> <constant name="PRIMITIVE_LINES" value="1" enum="PrimitiveType"> + Primitive to draw consists of lines. </constant> <constant name="PRIMITIVE_LINE_STRIP" value="2" enum="PrimitiveType"> + Primitive to draw consists of a line strip from start to end. </constant> <constant name="PRIMITIVE_LINE_LOOP" value="3" enum="PrimitiveType"> + Primitive to draw consists of a line loop (a line strip with a line between the last and the first vertex). </constant> <constant name="PRIMITIVE_TRIANGLES" value="4" enum="PrimitiveType"> + Primitive to draw consists of triangles. </constant> <constant name="PRIMITIVE_TRIANGLE_STRIP" value="5" enum="PrimitiveType"> + Primitive to draw consists of a triangle strip (the last 3 verticies are always combined to make a triangle). </constant> <constant name="PRIMITIVE_TRIANGLE_FAN" value="6" enum="PrimitiveType"> + Primitive to draw consists of a triangle strip (the last 2 verticies are always combined with the first to make a triangle). </constant> <constant name="PRIMITIVE_MAX" value="7" enum="PrimitiveType"> + Marks the primitive types endpoint. used internally. </constant> <constant name="BLEND_SHAPE_MODE_NORMALIZED" value="0" enum="BlendShapeMode"> </constant> <constant name="BLEND_SHAPE_MODE_RELATIVE" value="1" enum="BlendShapeMode"> </constant> <constant name="LIGHT_DIRECTIONAL" value="0" enum="LightType"> + Is a directional (sun) light. </constant> <constant name="LIGHT_OMNI" value="1" enum="LightType"> + is an omni light. </constant> <constant name="LIGHT_SPOT" value="2" enum="LightType"> + is an spot light. </constant> <constant name="LIGHT_PARAM_ENERGY" value="0" enum="LightParam"> + The light's energy. </constant> <constant name="LIGHT_PARAM_SPECULAR" value="2" enum="LightParam"> + The light's influence on specularity. </constant> <constant name="LIGHT_PARAM_RANGE" value="3" enum="LightParam"> + The light's range. </constant> <constant name="LIGHT_PARAM_ATTENUATION" value="4" enum="LightParam"> + The light's attenuation. </constant> <constant name="LIGHT_PARAM_SPOT_ANGLE" value="5" enum="LightParam"> + The spotlight's angle. </constant> <constant name="LIGHT_PARAM_SPOT_ATTENUATION" value="6" enum="LightParam"> + The spotlight's attenuation. </constant> <constant name="LIGHT_PARAM_CONTACT_SHADOW_SIZE" value="7" enum="LightParam"> + Scales the shadow color. </constant> <constant name="LIGHT_PARAM_SHADOW_MAX_DISTANCE" value="8" enum="LightParam"> </constant> @@ -1973,6 +2212,7 @@ <constant name="LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE" value="14" enum="LightParam"> </constant> <constant name="LIGHT_PARAM_MAX" value="15" enum="LightParam"> + The light parameters endpoint. Used internally. </constant> <constant name="VIEWPORT_UPDATE_DISABLED" value="0" enum="ViewportUpdateMode"> </constant> @@ -1983,28 +2223,40 @@ <constant name="VIEWPORT_UPDATE_ALWAYS" value="3" enum="ViewportUpdateMode"> </constant> <constant name="VIEWPORT_CLEAR_ALWAYS" value="0" enum="ViewportClearMode"> + The viewport is always cleared before drawing. </constant> <constant name="VIEWPORT_CLEAR_NEVER" value="1" enum="ViewportClearMode"> + The viewport is never cleared before drawing. </constant> <constant name="VIEWPORT_CLEAR_ONLY_NEXT_FRAME" value="2" enum="ViewportClearMode"> + The viewport is cleared once, then the clear mode is set to [VIEWPORT_CLEAR_NEVER]. </constant> <constant name="VIEWPORT_MSAA_DISABLED" value="0" enum="ViewportMSAA"> + Multisample antialiasing is disabled. </constant> <constant name="VIEWPORT_MSAA_2X" value="1" enum="ViewportMSAA"> + Multisample antialiasing is set to 2X. </constant> <constant name="VIEWPORT_MSAA_4X" value="2" enum="ViewportMSAA"> + Multisample antialiasing is set to 4X. </constant> <constant name="VIEWPORT_MSAA_8X" value="3" enum="ViewportMSAA"> + Multisample antialiasing is set to 8X. </constant> <constant name="VIEWPORT_MSAA_16X" value="4" enum="ViewportMSAA"> + Multisample antialiasing is set to 16X. </constant> <constant name="VIEWPORT_USAGE_2D" value="0" enum="ViewportUsage"> + The Viewport does not render 3D but samples. </constant> <constant name="VIEWPORT_USAGE_2D_NO_SAMPLING" value="1" enum="ViewportUsage"> + The Viewport does not render 3D and does not sample. </constant> <constant name="VIEWPORT_USAGE_3D" value="2" enum="ViewportUsage"> + The Viewport renders 3D with effects. </constant> <constant name="VIEWPORT_USAGE_3D_NO_EFFECTS" value="3" enum="ViewportUsage"> + The Viewport renders 3D but without effects. </constant> <constant name="VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME" value="0" enum="ViewportRenderInfo"> </constant> @@ -2019,14 +2271,19 @@ <constant name="VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME" value="5" enum="ViewportRenderInfo"> </constant> <constant name="VIEWPORT_RENDER_INFO_MAX" value="6" enum="ViewportRenderInfo"> + Marks end of VIEWPORT_RENDER_INFO* constants. Used internally. </constant> <constant name="VIEWPORT_DEBUG_DRAW_DISABLED" value="0" enum="ViewportDebugDraw"> + Debug draw is disabled. Default setting. </constant> <constant name="VIEWPORT_DEBUG_DRAW_UNSHADED" value="1" enum="ViewportDebugDraw"> + Debug draw sets objects to unshaded. </constant> <constant name="VIEWPORT_DEBUG_DRAW_OVERDRAW" value="2" enum="ViewportDebugDraw"> + Overwrites clear color to [code](0,0,0,0)[/code]. </constant> <constant name="VIEWPORT_DEBUG_DRAW_WIREFRAME" value="3" enum="ViewportDebugDraw"> + Debug draw draws objects in wireframe. </constant> <constant name="SCENARIO_DEBUG_DISABLED" value="0" enum="ScenarioDebugMode"> </constant> @@ -2037,38 +2294,53 @@ <constant name="SCENARIO_DEBUG_SHADELESS" value="3" enum="ScenarioDebugMode"> </constant> <constant name="INSTANCE_NONE" value="0" enum="InstanceType"> + The instance does not have a type. </constant> <constant name="INSTANCE_MESH" value="1" enum="InstanceType"> + The instance is a mesh. </constant> <constant name="INSTANCE_MULTIMESH" value="2" enum="InstanceType"> + The instance is a multimesh. </constant> <constant name="INSTANCE_IMMEDIATE" value="3" enum="InstanceType"> + The instance is an immediate geometry. </constant> <constant name="INSTANCE_PARTICLES" value="4" enum="InstanceType"> + The instance is a particle emitter. </constant> <constant name="INSTANCE_LIGHT" value="5" enum="InstanceType"> + The instance is a light. </constant> <constant name="INSTANCE_REFLECTION_PROBE" value="6" enum="InstanceType"> </constant> <constant name="INSTANCE_GI_PROBE" value="7" enum="InstanceType"> </constant> <constant name="INSTANCE_MAX" value="8" enum="InstanceType"> + The max value for INSTANCE_* constants, used internally. </constant> <constant name="INSTANCE_GEOMETRY_MASK" value="30" enum="InstanceType"> + A combination of the flags of geometry instances (mesh, multimesh, immediate and particles). </constant> <constant name="NINE_PATCH_STRETCH" value="0" enum="NinePatchAxisMode"> + The nine patch gets stretched where needed. </constant> <constant name="NINE_PATCH_TILE" value="1" enum="NinePatchAxisMode"> + The nine patch gets filled with tiles where needed. </constant> <constant name="NINE_PATCH_TILE_FIT" value="2" enum="NinePatchAxisMode"> + The nine patch gets filled with tiles where needed and stretches them a bit if needed. </constant> <constant name="CANVAS_LIGHT_MODE_ADD" value="0" enum="CanvasLightMode"> + Adds light color additive to the canvas. </constant> <constant name="CANVAS_LIGHT_MODE_SUB" value="1" enum="CanvasLightMode"> + Adds light color subtractive to the canvas. </constant> <constant name="CANVAS_LIGHT_MODE_MIX" value="2" enum="CanvasLightMode"> + The light adds color depending on transparency. </constant> <constant name="CANVAS_LIGHT_MODE_MASK" value="3" enum="CanvasLightMode"> + The light adds color depending on mask. </constant> <constant name="CANVAS_LIGHT_FILTER_NONE" value="0" enum="CanvasLightShadowFilter"> </constant> @@ -2083,34 +2355,46 @@ <constant name="CANVAS_LIGHT_FILTER_PCF13" value="5" enum="CanvasLightShadowFilter"> </constant> <constant name="CANVAS_OCCLUDER_POLYGON_CULL_DISABLED" value="0" enum="CanvasOccluderPolygonCullMode"> + Culling of the canvas occluder is disabled. </constant> <constant name="CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE" value="1" enum="CanvasOccluderPolygonCullMode"> + Culling of the canvas occluder is clockwise. </constant> <constant name="CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE" value="2" enum="CanvasOccluderPolygonCullMode"> + Culling of the canvas occluder is counterclockwise. </constant> <constant name="INFO_OBJECTS_IN_FRAME" value="0" enum="RenderInfo"> + The amount of objects in the frame. </constant> <constant name="INFO_VERTICES_IN_FRAME" value="1" enum="RenderInfo"> + The amount of vertices in the frame. </constant> <constant name="INFO_MATERIAL_CHANGES_IN_FRAME" value="2" enum="RenderInfo"> + The amount of modified materials in the frame. </constant> <constant name="INFO_SHADER_CHANGES_IN_FRAME" value="3" enum="RenderInfo"> + The amount of shader rebinds in the frame. </constant> <constant name="INFO_SURFACE_CHANGES_IN_FRAME" value="4" enum="RenderInfo"> + The amount of surface changes in the frame. </constant> <constant name="INFO_DRAW_CALLS_IN_FRAME" value="5" enum="RenderInfo"> + The amount of draw calls in frame. </constant> <constant name="INFO_USAGE_VIDEO_MEM_TOTAL" value="6" enum="RenderInfo"> </constant> <constant name="INFO_VIDEO_MEM_USED" value="7" enum="RenderInfo"> + The amount of vertex memory and texture memory used. </constant> <constant name="INFO_TEXTURE_MEM_USED" value="8" enum="RenderInfo"> + The amount of texture memory used. </constant> <constant name="INFO_VERTEX_MEM_USED" value="9" enum="RenderInfo"> + The amount of vertex memory used. </constant> <constant name="FEATURE_SHADERS" value="0" enum="Features"> </constant> <constant name="FEATURE_MULTITHREADED" value="1" enum="Features"> </constant> </constants> -</class> +</class>
\ No newline at end of file |