maxmustermann/godot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

doc: Sync classref with current source

Browse source 
Ensure that s/fixed_process/physics_process/ is handled properly.
[ci skip]
This commit is contained in:
Rémi Verschelde 2017-10-11 23:54:43 +02:00
parent c30ab882d7
commit b1f2c31a36
40 changed files with 299 additions and 120 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/classes/ARVRServer.xml
View file

@ -14,7 +14,7 @@
<method name="add_interface">
<return type="void">
</return>
<argument index="0" name="arg0" type="ARVRInterface">
<argument index="0" name="interface" type="ARVRInterface">
</argument>
<description>
Mostly exposed for GDNative based interfaces, this is called to register an available interface with the AR/VR server.
@ -94,7 +94,7 @@
<method name="remove_interface">
<return type="void">
</return>
<argument index="0" name="arg0" type="ARVRInterface">
<argument index="0" name="interface" type="ARVRInterface">
</argument>
<description>
Removes a registered interface, again exposed mostly for GDNative based interfaces.
@ -103,7 +103,7 @@
<method name="set_primary_interface">
<return type="void">
</return>
<argument index="0" name="arg0" type="ARVRInterface">
<argument index="0" name="interface" type="ARVRInterface">
</argument>
<description>
Changes the primary interface to the specified interface. Again mostly exposed for GDNative interfaces.

6
doc/classes/AnimationPlayer.xml
View file

@ -380,11 +380,11 @@
</signal>
</signals>
<constants>
<constant name="ANIMATION_PROCESS_FIXED" value="0">
Process animation on fixed process. This is specially useful when animating kinematic bodies.
<constant name="ANIMATION_PROCESS_PHYSICS" value="0">
Process animation during the physics process. This is specially useful when animating physics bodies.
</constant>
<constant name="ANIMATION_PROCESS_IDLE" value="1">
Process animation on idle process.
Process animation during the idle process.
</constant>
</constants>
</class>

2
doc/classes/AnimationTreePlayer.xml
View file

@ -659,7 +659,7 @@
<constant name="NODE_TRANSITION" value="9">
Transition node.
</constant>
<constant name="ANIMATION_PROCESS_FIXED" value="0">
<constant name="ANIMATION_PROCESS_PHYSICS" value="0">
</constant>
<constant name="ANIMATION_PROCESS_IDLE" value="1">
</constant>

6
doc/classes/Array.xml
View file

@ -178,8 +178,6 @@
</description>
</method>
<method name="invert">
<return type="Array">
</return>
<description>
Reverse the order of the elements in the array (so first element will now be the last) and return reference to the array.
</description>
@ -241,15 +239,11 @@
</description>
</method>
<method name="sort">
<return type="Array">
</return>
<description>
Sort the array using natural order and return reference to the array.
</description>
</method>
<method name="sort_custom">
<return type="Array">
</return>
<argument index="0" name="obj" type="Object">
</argument>
<argument index="1" name="func" type="String">

2
doc/classes/AudioEffectReverb.xml
View file

@ -136,7 +136,7 @@
High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1. Default value: [code]0[/code].
</member>
<member name="predelay_feedback" type="float" setter="set_predelay_msec" getter="get_predelay_msec">
Output percent of predelay. Value can range from 0 to 1. Default value: [code]1[/code].
Output percent of predelay. Value can range from 0 to 1. Default value: [code]1[/code].
</member>
<member name="predelay_msec" type="float" setter="set_predelay_msec" getter="get_predelay_msec">
Time between the original signal and the early reflections of the reverb signal. Default value: [code]150ms[/code].

2
doc/classes/AudioServer.xml
View file

@ -298,7 +298,7 @@
<argument index="1" name="enable" type="bool">
</argument>
<description>
If [code]true[/code] the bus at index [code]bus_idx[/code] is in solo mode.
If [code]true[/code] the bus at index [code]bus_idx[/code] is in solo mode.
</description>
</method>
<method name="set_bus_volume_db">

4
doc/classes/AudioStreamPlayer3D.xml
View file

@ -357,8 +357,8 @@
<constant name="DOPPLER_TRACKING_IDLE_STEP" value="1">
Executes doppler trackin in idle step.
</constant>
<constant name="DOPPLER_TRACKING_FIXED_STEP" value="2">
Executes doppler tracking in fixed step.
<constant name="DOPPLER_TRACKING_PHYSICS_STEP" value="2">
Executes doppler tracking in physics step.
</constant>
</constants>
</class>

2
doc/classes/Camera.xml
View file

@ -267,7 +267,7 @@
<constant name="DOPPLER_TRACKING_IDLE_STEP" value="1">
Simulate Doppler effect by tracking positions of objects that are changed in [code]_process[/code]. Changes in the relative velocity of this Camera compared to those objects affect how Audio is perceived (changing the Audio's [code]pitch shift[/code]).
</constant>
<constant name="DOPPLER_TRACKING_FIXED_STEP" value="2">
<constant name="DOPPLER_TRACKING_PHYSICS_STEP" value="2">
Simulate Doppler effect by tracking positions of objects that are changed in [code]_physics_process[/code]. Changes in the relative velocity of this Camera compared to those objects affect how Audio is perceived (changing the Audio's [code]pitch shift[/code]).
</constant>
</constants>

2
doc/classes/ColorPicker.xml
View file

@ -93,6 +93,8 @@
</theme_item>
<theme_item name="margin" type="int">
</theme_item>
<theme_item name="preset_bg" type="Texture">
</theme_item>
<theme_item name="screen_picker" type="Texture">
</theme_item>
<theme_item name="sv_height" type="int">

2
doc/classes/ColorPickerButton.xml
View file

@ -72,6 +72,8 @@
<constants>
</constants>
<theme_items>
<theme_item name="bg" type="Texture">
</theme_item>
<theme_item name="disabled" type="StyleBox">
</theme_item>
<theme_item name="focus" type="StyleBox">

41
doc/classes/Control.xml
View file

@ -578,6 +578,18 @@
<description>
</description>
</method>
<method name="set_anchors_and_margins_preset">
<return type="void">
</return>
<argument index="0" name="preset" type="int" enum="Control.LayoutPreset">
</argument>
<argument index="1" name="resize_mode" type="int" enum="Control.LayoutPresetMode" default="0">
</argument>
<argument index="2" name="margin" type="int" default="0">
</argument>
<description>
</description>
</method>
<method name="set_anchors_preset">
<return type="void">
</return>
@ -588,15 +600,6 @@
<description>
</description>
</method>
<method name="set_area_as_parent_rect">
<return type="void">
</return>
<argument index="0" name="margin" type="int" default="0">
</argument>
<description>
Change all margins and anchors, so this Control always takes up the same area as the parent Control. This is a helper (see [method set_anchor], [method set_margin]).
</description>
</method>
<method name="set_begin">
<return type="void">
</return>
@ -713,6 +716,18 @@
Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being set depends on the anchor mode.
</description>
</method>
<method name="set_margins_preset">
<return type="void">
</return>
<argument index="0" name="preset" type="int" enum="Control.LayoutPreset">
</argument>
<argument index="1" name="resize_mode" type="int" enum="Control.LayoutPresetMode" default="0">
</argument>
<argument index="2" name="margin" type="int" default="0">
</argument>
<description>
</description>
</method>
<method name="set_mouse_filter">
<return type="void">
</return>
@ -1096,6 +1111,14 @@
<constant name="PRESET_WIDE" value="15">
Snap all 4 anchors to the respective corners of the parent container. Set all 4 margins to 0 after you applied this preset and the [code]Control[/code] will fit its parent container. Use with [method set_anchors_preset].
</constant>
<constant name="PRESET_MODE_MINSIZE" value="0">
</constant>
<constant name="PRESET_MODE_KEEP_HEIGHT" value="2">
</constant>
<constant name="PRESET_MODE_KEEP_WIDTH" value="1">
</constant>
<constant name="PRESET_MODE_KEEP_SIZE" value="3">
</constant>
<constant name="SIZE_EXPAND" value="2">
Tells the parent [Container] to let this node take all the available space on the axis you flag. If multiple neighboring nodes are set to expand, they'll share the space based on their stretch ratio. See [member size_flags_stretch_ratio]. Use with [member size_flags_horizontal] and [member size_flags_vertical].
</constant>

2
doc/classes/Curve.xml
View file

@ -170,7 +170,7 @@
</description>
</method>
<method name="set_point_offset">
<return type="void">
<return type="int">
</return>
<argument index="0" name="index" type="int">
</argument>

4
doc/classes/EditorInterface.xml
View file

@ -84,9 +84,9 @@
<method name="make_mesh_previews">
<return type="Array">
</return>
<argument index="0" name="arg0" type="Array">
<argument index="0" name="meshes" type="Array">
</argument>
<argument index="1" name="arg1" type="int">
<argument index="1" name="preview_size" type="int">
</argument>
<description>
</description>

52
doc/classes/EditorSettings.xml
View file

@ -69,6 +69,14 @@
Get the list of recently visited folders in the file dialog for this project.
</description>
</method>
<method name="get_setting" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="get_settings_path" qualifiers="const">
<return type="String">
</return>
@ -78,6 +86,30 @@
settings/templates - where export templates are located
</description>
</method>
<method name="has_setting" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="property_can_revert">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="property_get_revert">
<return type="Variant">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="set_favorite_dirs">
<return type="void">
</return>
@ -87,6 +119,16 @@
Set the list of favorite directories for this project.
</description>
</method>
<method name="set_initial_value">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="value" type="Variant">
</argument>
<description>
</description>
</method>
<method name="set_recent_dirs">
<return type="void">
</return>
@ -96,6 +138,16 @@
Set the list of recently visited folders in the file dialog for this project.
</description>
</method>
<method name="set_setting">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="value" type="Variant">
</argument>
<description>
</description>
</method>
</methods>
<signals>
<signal name="settings_changed">

10
doc/classes/Environment.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Environment" inherits="Resource" category="Core" version="3.0">
<class name="Environment" inherits="Resource" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Resource for environment nodes (like [WorldEnvironment]) that define multiple rendering options.
</brief_description>
@ -226,7 +226,7 @@
<description>
</description>
</method>
<method name="get_sky_scale" qualifiers="const">
<method name="get_sky_custom_fov" qualifiers="const">
<return type="float">
</return>
<description>
@ -794,7 +794,7 @@
<description>
</description>
</method>
<method name="set_sky_scale">
<method name="set_sky_custom_fov">
<return type="void">
</return>
<argument index="0" name="scale" type="float">
@ -1042,8 +1042,8 @@
<member name="background_sky" type="Sky" setter="set_sky" getter="get_sky">
[Sky] resource defined as background.
</member>
<member name="background_sky_scale" type="float" setter="set_sky_scale" getter="get_sky_scale">
[Sky] resource's scale.
<member name="background_sky_custom_fov" type="float" setter="set_sky_custom_fov" getter="get_sky_custom_fov">
[Sky] resource's custom field of view.
</member>
<member name="dof_blur_far_amount" type="float" setter="set_dof_blur_far_amount" getter="get_dof_blur_far_amount">
Amount of far blur.

6
doc/classes/GDNativeLibrary.xml
View file

@ -9,6 +9,12 @@
<demos>
</demos>
<methods>
<method name="get_active_library_path" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_library_path" qualifiers="const">
<return type="String">
</return>

2
doc/classes/HSlider.xml
View file

@ -19,6 +19,8 @@
</theme_item>
<theme_item name="grabber" type="Texture">
</theme_item>
<theme_item name="grabber_area" type="StyleBox">
</theme_item>
<theme_item name="grabber_disabled" type="Texture">
</theme_item>
<theme_item name="grabber_disabled" type="StyleBox">

14
doc/classes/Input.xml
View file

@ -237,6 +237,20 @@
Returns true or false depending on whether mouse button is pressed or not. You can pass BUTTON_*, which are pre-defined constants listed in [@Global Scope].
</description>
</method>
<method name="joy_connection_changed">
<return type="void">
</return>
<argument index="0" name="device" type="int">
</argument>
<argument index="1" name="connected" type="bool">
</argument>
<argument index="2" name="name" type="String">
</argument>
<argument index="3" name="guid" type="String">
</argument>
<description>
</description>
</method>
<method name="parse_input_event">
<return type="void">
</return>

2
doc/classes/KinematicBody2D.xml
View file

@ -122,4 +122,4 @@
</members>
<constants>
</constants>
</class>
</class>

103
doc/classes/Node.xml
View file

@ -9,7 +9,7 @@
[b]Scene tree:[/b] The [SceneTree] contains the active tree of nodes. When a node is added to the scene tree, it receives the NOTIFICATION_ENTER_TREE notification and its [method _enter_tree] callback is triggered. Children nodes are always added [i]after[/i] their parent node, i.e. the [method _enter_tree] callback of a parent node will be triggered before its child's.
Once all nodes have been added in the scene tree, they receive the NOTIFICATION_READY notification and their respective [method _ready] callbacks are triggered. For groups of nodes, the [method _ready] callback is called in reverse order, from the children up to the parent nodes.
It means that when adding a scene to the scene tree, the following order will be used for the callbacks: [method _enter_tree] of the parent, [method _enter_tree] of the children, [method _ready] of the children and finally [method _ready] of the parent (and that recursively for the whole scene).
[b]Processing:[/b] Nodes can be set to the "process" state, so that they receive a callback on each frame requesting them to process (do something). Normal processing (callback [method _process], toggled with [method set_process]) happens as fast as possible and is dependent on the frame rate, so the processing time [i]delta[/i] is variable. Fixed processing (callback [method _fixed_process], toggled with [method set_fixed_process]) happens a fixed amount of times per second (by default 60) and is useful to link itself to the physics.
[b]Processing:[/b] Nodes can be set to the "process" state, so that they receive a callback on each frame requesting them to process (do something). Normal processing (callback [method _process], toggled with [method set_process]) happens as fast as possible and is dependent on the frame rate, so the processing time [i]delta[/i] is variable. Physics processing (callback [method _physics_process], toggled with [method set_physics_process]) happens a fixed amount of times per second (by default 60) and is useful to link itself to the physics.
Nodes can also process input events. When set, the [method _input] function will be called for each input that the program receives. In many cases, this can be overkill (unless used for simple projects), and the [method _unhandled_input] function might be preferred; it is called when the input event was not handled by anyone else (typically, GUI [Control] nodes), ensuring that the node only receives the events that were meant for it.
To keep track of the scene hierarchy (especially when instancing scenes into other scenes), an "owner" can be set for the node with [method set_owner]. This keeps track of who instanced what. This is mostly useful when writing editors and tools, though.
Finally, when a node is freed with [method free] or [method queue_free], it will also free all its children.
@ -36,17 +36,6 @@
Corresponds to the NOTIFICATION_EXIT_TREE notification in [method Object._notification].
</description>
</method>
<method name="_fixed_process" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="delta" type="float">
</argument>
<description>
Called during the fixed processing step of the main loop. Fixed processing means that the frame rate is synced to the physics, i.e. the [code]delta[/code] variable should be constant.
It is only called if fixed processing has been enabled with [method set_fixed_process].
Corresponds to the NOTIFICATION_FIXED_PROCESS notification in [method Object._notification].
</description>
</method>
<method name="_input" qualifiers="virtual">
<return type="void">
</return>
@ -56,6 +45,17 @@
Called when there is a change to input devices. Propagated through the node tree until a Node consumes it.
</description>
</method>
<method name="_physics_process" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="delta" type="float">
</argument>
<description>
Called during the physics processing step of the main loop. Physics processing means that the frame rate is synced to the physics, i.e. the [code]delta[/code] variable should be constant.
It is only called if physics processing has been enabled with [method set_physics_process].
Corresponds to the NOTIFICATION_PHYSICS_PROCESS notification in [method Object._notification].
</description>
</method>
<method name="_process" qualifiers="virtual">
<return type="void">
</return>
@ -187,13 +187,6 @@
Return a filename that may be contained by the node. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded (see [method set_filename]).
</description>
</method>
<method name="get_fixed_process_delta_time" qualifiers="const">
<return type="float">
</return>
<description>
Return the time elapsed since the last fixed frame (see [method _fixed_process]). This is always the same in fixed processing unless the frames per second is changed in [OS].
</description>
</method>
<method name="get_groups" qualifiers="const">
<return type="Array">
</return>
@ -294,6 +287,13 @@
Return the pause mode (PAUSE_MODE_*) of this Node.
</description>
</method>
<method name="get_physics_process_delta_time" qualifiers="const">
<return type="float">
</return>
<description>
Return the time elapsed since the last physics-bound frame (see [method _physics_process]). This is always a constant value in physics processing unless the frames per second is changed in [OS].
</description>
</method>
<method name="get_position_in_parent" qualifiers="const">
<return type="int">
</return>
@ -359,19 +359,6 @@
<description>
</description>
</method>
<method name="is_fixed_processing" qualifiers="const">
<return type="bool">
</return>
<description>
Return true if fixed processing is enabled (see [method set_fixed_process]).
</description>
</method>
<method name="is_fixed_processing_internal" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_greater_than" qualifiers="const">
<return type="bool">
</return>
@ -403,6 +390,19 @@
<description>
</description>
</method>
<method name="is_physics_processing" qualifiers="const">
<return type="bool">
</return>
<description>
Return true if physics processing is enabled (see [method set_physics_process]).
</description>
</method>
<method name="is_physics_processing_internal" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_processing" qualifiers="const">
<return type="bool">
</return>
@ -666,23 +666,6 @@
A node can contain a filename. This filename should not be changed by the user, unless writing editors and tools. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded.
</description>
</method>
<method name="set_fixed_process">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Enables or disables node fixed framerate processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS at a fixed (usually 60 fps, check [OS] to change that) interval (and the [method _fixed_process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_fixed_process_delta_time].
</description>
</method>
<method name="set_fixed_process_internal">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_name">
<return type="void">
</return>
@ -720,6 +703,23 @@
Set pause mode (PAUSE_MODE_*) of this Node.
</description>
</method>
<method name="set_physics_process">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Enables or disables the node's physics (alias fixed framerate) processing. When a node is being processed, it will receive a NOTIFICATION_PHYSICS_PROCESS at a fixed (usually 60 fps, check [OS] to change that) interval (and the [method _physics_process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_physics_process_delta_time].
</description>
</method>
<method name="set_physics_process_internal">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_process">
<return type="void">
</return>
@ -806,7 +806,8 @@
</constant>
<constant name="NOTIFICATION_READY" value="13" enum="">
</constant>
<constant name="NOTIFICATION_FIXED_PROCESS" value="16" enum="">
<constant name="NOTIFICATION_PHYSICS_PROCESS" value="16" enum="">
Notification received every frame when the physics process flag is set (see [method set_physics_process]).
</constant>
<constant name="NOTIFICATION_PROCESS" value="17" enum="">
Notification received every frame when the process flag is set (see [method set_process]).
@ -833,7 +834,7 @@
</constant>
<constant name="NOTIFICATION_INTERNAL_PROCESS" value="25" enum="">
</constant>
<constant name="NOTIFICATION_INTERNAL_FIXED_PROCESS" value="26" enum="">
<constant name="NOTIFICATION_INTERNAL_PHYSICS_PROCESS" value="26" enum="">
</constant>
<constant name="RPC_MODE_DISABLED" value="0">
</constant>

16
doc/classes/OS.xml
View file

@ -397,6 +397,12 @@
You can pass the output from [method get_datetime_from_unix_time] directly into this function. Daylight savings time (dst), if present, is ignored.
</description>
</method>
<method name="get_virtual_keyboard_height">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_window_position" qualifiers="const">
<return type="Vector2">
</return>
@ -420,6 +426,14 @@
Returns [code]true[/code] if an environment variable exists.
</description>
</method>
<method name="has_feature" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="tag_name" type="String">
</argument>
<description>
</description>
</method>
<method name="has_touchscreen_ui_hint" qualifiers="const">
<return type="bool">
</return>
@ -468,7 +482,7 @@
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the "Okay" button should appear on the left and "Cancel" on the right.
Returns [code]true[/code] if the "Okay" button should appear on the left and "Cancel" on the right.
</description>
</method>
<method name="is_scancode_unicode" qualifiers="const">

4
doc/classes/Performance.xml
View file

@ -77,6 +77,8 @@
<constant name="RENDER_DRAW_CALLS_IN_FRAME" value="16">
Draw calls per frame. 3D only.
</constant>
<constant name="RENDER_USAGE_VIDEO_MEM_TOTAL" value="20">
</constant>
<constant name="RENDER_VIDEO_MEM_USED" value="17">
Video memory used. Includes both texture and vertex memory.
</constant>
@ -86,8 +88,6 @@
<constant name="RENDER_VERTEX_MEM_USED" value="19">
Vertex memory used.
</constant>
<constant name="RENDER_USAGE_VIDEO_MEM_TOTAL" value="20">
</constant>
<constant name="PHYSICS_2D_ACTIVE_OBJECTS" value="21">
Number of active [RigidBody2D] nodes in the game.
</constant>

8
doc/classes/Physics2DServer.xml
View file

@ -372,6 +372,14 @@
Return the continuous collision detection mode.
</description>
</method>
<method name="body_get_direct_state">
<return type="Physics2DDirectBodyState">
</return>
<argument index="0" name="body" type="RID">
</argument>
<description>
</description>
</method>
<method name="body_get_max_contacts_reported" qualifiers="const">
<return type="int">
</return>

8
doc/classes/PhysicsServer.xml
View file

@ -337,6 +337,14 @@
<description>
</description>
</method>
<method name="body_get_direct_state">
<return type="PhysicsDirectBodyState">
</return>
<argument index="0" name="body" type="RID">
</argument>
<description>
</description>
</method>
<method name="body_get_max_contacts_reported" qualifiers="const">
<return type="int">
</return>

20
doc/classes/ProjectSettings.xml
View file

@ -51,6 +51,14 @@
Return the order of a configuration value (influences when saved to the config file).
</description>
</method>
<method name="get_setting" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="get_singleton" qualifiers="const">
<return type="Object">
</return>
@ -68,7 +76,7 @@
Convert a localized path (res://) to a full native OS path.
</description>
</method>
<method name="has" qualifiers="const">
<method name="has_setting" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
@ -153,6 +161,16 @@
Set the order of a configuration value (influences when saved to the config file).
</description>
</method>
<method name="set_setting">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="value" type="Variant">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>

7
doc/classes/RayCast.xml
View file

@ -5,12 +5,9 @@
</brief_description>
<description>
A RayCast represents a line from its origin to its destination position, [code]cast_to[/code]. It is used to query the 3D space in order to find the closest object along the path of the ray.
RayCast can ignore some objects by adding them to the exception list via [code]add_exception[/code], by setting proper filtering with collision layers, or by filtering object types with type masks.
Only enabled raycasts will be able to query the space and report collisions.
RayCast calculates intersection every fixed frame (see [Node]), and the result is cached so it can be used later until the next frame. If multiple queries are required between fixed frames (or during the same frame) use [method force_raycast_update] after adjusting the raycast.
RayCast calculates intersection every physics frame (see [Node]), and the result is cached so it can be used later until the next frame. If multiple queries are required between physics frames (or during the same frame) use [method force_raycast_update] after adjusting the raycast.
</description>
<tutorials>
</tutorials>
@ -47,7 +44,7 @@
</return>
<description>
Updates the collision information for the ray.
Use this method to update the collision information immediately instead of waiting for the next [code]_fixed_process[/code] call, for example if the ray or its parent has changed state. Note: [code]enabled == true[/code] is not required for this to work.
Use this method to update the collision information immediately instead of waiting for the next [code]_physics_process[/code] call, for example if the ray or its parent has changed state. Note: [code]enabled == true[/code] is not required for this to work.
</description>
</method>
<method name="get_cast_to" qualifiers="const">

4
doc/classes/RayCast2D.xml
View file

@ -7,7 +7,7 @@
A RayCast represents a line from its origin to its destination position, [code]cast_to[/code]. It is used to query the 2D space in order to find the closest object along the path of the ray.
RayCast2D can ignore some objects by adding them to the exception list via [code]add_exception[/code], by setting proper filtering with collision layers, or by filtering object types with type masks.
Only enabled raycasts will be able to query the space and report collisions.
RayCast2D calculates intersection every fixed frame (see [Node]), and the result is cached so it can be used later until the next frame. If multiple queries are required between fixed frames (or during the same frame) use [method force_raycast_update] after adjusting the raycast.
RayCast2D calculates intersection every physics frame (see [Node]), and the result is cached so it can be used later until the next frame. If multiple queries are required between physics frames (or during the same frame) use [method force_raycast_update] after adjusting the raycast.
</description>
<tutorials>
</tutorials>
@ -43,7 +43,7 @@
<return type="void">
</return>
<description>
Updates the collision information for the ray. Use this method to update the collision information immediately instead of waiting for the next [code]_fixed_process[/code] call, for example if the ray or its parent has changed state. Note: [code]enabled == true[/code] is not required for this to work.
Updates the collision information for the ray. Use this method to update the collision information immediately instead of waiting for the next [code]_physics_process[/code] call, for example if the ray or its parent has changed state. Note: [code]enabled == true[/code] is not required for this to work.
</description>
</method>
<method name="get_cast_to" qualifiers="const">

10
doc/classes/SceneTree.xml
View file

@ -336,10 +336,6 @@
<description>
</description>
</signal>
<signal name="fixed_frame">
<description>
</description>
</signal>
<signal name="idle_frame">
<description>
</description>
@ -368,6 +364,10 @@
<description>
</description>
</signal>
<signal name="physics_frame">
<description>
</description>
</signal>
<signal name="screen_resized">
<description>
</description>
@ -404,5 +404,7 @@
</constant>
<constant name="STRETCH_ASPECT_KEEP_HEIGHT" value="3">
</constant>
<constant name="STRETCH_ASPECT_EXPAND" value="4">
</constant>
</constants>
</class>

24
doc/classes/SpatialMaterial.xml
View file

@ -27,6 +27,12 @@
<description>
</description>
</method>
<method name="get_ao_light_affect" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_ao_texture_channel" qualifiers="const">
<return type="int" enum="SpatialMaterial.TextureChannel">
</return>
@ -357,6 +363,14 @@
<description>
</description>
</method>
<method name="set_ao_light_affect">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
<method name="set_ao_texture_channel">
<return type="void">
</return>
@ -777,6 +791,8 @@
</member>
<member name="ao_enabled" type="bool" setter="set_feature" getter="get_feature">
</member>
<member name="ao_light_affect" type="float" setter="set_ao_light_affect" getter="get_ao_light_affect">
</member>
<member name="ao_on_uv2" type="bool" setter="set_flag" getter="get_flag">
</member>
<member name="ao_texture" type="Texture" setter="set_texture" getter="get_texture">
@ -1059,13 +1075,13 @@
</constant>
<constant name="FLAG_MAX" value="12">
</constant>
<constant name="DIFFUSE_LAMBERT" value="0">
<constant name="DIFFUSE_BURLEY" value="0">
</constant>
<constant name="DIFFUSE_LAMBERT_WRAP" value="1">
<constant name="DIFFUSE_LAMBERT" value="1">
</constant>
<constant name="DIFFUSE_OREN_NAYAR" value="2">
<constant name="DIFFUSE_LAMBERT_WRAP" value="2">
</constant>
<constant name="DIFFUSE_BURLEY" value="3">
<constant name="DIFFUSE_OREN_NAYAR" value="3">
</constant>
<constant name="DIFFUSE_TOON" value="4">
</constant>

4
doc/classes/SpatialVelocityTracker.xml
View file

@ -15,7 +15,7 @@
<description>
</description>
</method>
<method name="is_tracking_fixed_step" qualifiers="const">
<method name="is_tracking_physics_step" qualifiers="const">
<return type="bool">
</return>
<description>
@ -29,7 +29,7 @@
<description>
</description>
</method>
<method name="set_track_fixed_step">
<method name="set_track_physics_step">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">

2
doc/classes/SpriteBase3D.xml
View file

@ -210,7 +210,7 @@
If set, texture can be seen from the back as well, if not, it is invisible when looking at it from behind.
</constant>
<constant name="FLAG_MAX" value="3">
Used internally to mark the end of the Flags section.
Used internally to mark the end of the Flags section.
</constant>
<constant name="ALPHA_CUT_DISABLED" value="0">
</constant>

4
doc/classes/Timer.xml
View file

@ -141,8 +141,8 @@
</signal>
</signals>
<constants>
<constant name="TIMER_PROCESS_FIXED" value="0">
Update the Timer at fixed intervals (framerate processing).
<constant name="TIMER_PROCESS_PHYSICS" value="0">
Update the Timer during the physics step at each frame (fixed framerate processing).
</constant>
<constant name="TIMER_PROCESS_IDLE" value="1">
Update the Timer during the idle time at each frame.

2
doc/classes/TreeItem.xml
View file

@ -25,7 +25,7 @@
<argument index="4" name="tooltip" type="String" default="&quot;&quot;">
</argument>
<description>
Adds a button with [Texture] [code]button[/code] at column [code]column[/code]. The [code]button_idx[/code] index is used to identify the button when calling other methods. If not specified, the next available index is used, which may be retrieved by calling [code]get_buton_count()[/code] immediately after this method. Optionally, the button can be [code]disabled[/code] and have a [code]tooltip[/code].
Adds a button with [Texture] [code]button[/code] at column [code]column[/code]. The [code]button_idx[/code] index is used to identify the button when calling other methods. If not specified, the next available index is used, which may be retrieved by calling [code]get_buton_count()[/code] immediately after this method. Optionally, the button can be [code]disabled[/code] and have a [code]tooltip[/code].
</description>
</method>
<method name="clear_custom_bg_color">

6
doc/classes/Tween.xml
View file

@ -296,7 +296,7 @@
<argument index="0" name="mode" type="int" enum="Tween.TweenProcessMode">
</argument>
<description>
Set whether the Tween uses [code]_process[/code] or [code]_fixed_process[/code] (accepts TWEEN_PROCESS_IDLE and TWEEN_PROCESS_FIXED constants, respectively).
Set whether the Tween uses [code]_process[/code] or [code]_physics_process[/code] (accepts TWEEN_PROCESS_IDLE and TWEEN_PROCESS_PHYSICS constants, respectively).
</description>
</method>
<method name="start">
@ -422,8 +422,8 @@
</signal>
</signals>
<constants>
<constant name="TWEEN_PROCESS_FIXED" value="0">
The [Tween] should use [code]_fixed_process[/code] for timekeeping when this is enabled.
<constant name="TWEEN_PROCESS_PHYSICS" value="0">
The [Tween] should use [code]_physics_process[/code] for timekeeping when this is enabled.
</constant>
<constant name="TWEEN_PROCESS_IDLE" value="1">
The [Tween] should use [code]_process[/code] for timekeeping when this is enabled (default).

2
doc/classes/VSlider.xml
View file

@ -19,6 +19,8 @@
</theme_item>
<theme_item name="grabber" type="Texture">
</theme_item>
<theme_item name="grabber_area" type="StyleBox">
</theme_item>
<theme_item name="grabber_disabled" type="Texture">
</theme_item>
<theme_item name="grabber_disabled" type="StyleBox">

6
doc/classes/VehicleWheel.xml
View file

@ -39,6 +39,12 @@
<description>
</description>
</method>
<method name="get_skidinfo" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_suspension_max_force" qualifiers="const">
<return type="float">
</return>

8
doc/classes/VisibilityEnabler2D.xml
View file

@ -33,8 +33,6 @@
</method>
</methods>
<members>
<member name="fixed_process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled">
</member>
<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled">
</member>
<member name="pause_animated_sprites" type="bool" setter="set_enabler" getter="is_enabler_enabled">
@ -43,6 +41,8 @@
</member>
<member name="pause_particles" type="bool" setter="set_enabler" getter="is_enabler_enabled">
</member>
<member name="physics_process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled">
</member>
<member name="process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled">
</member>
</members>
@ -61,8 +61,8 @@
<constant name="ENABLER_PARENT_PROCESS" value="3">
This enabler will stop the parent's _process function.
</constant>
<constant name="ENABLER_PARENT_FIXED_PROCESS" value="4">
This enabler will stop the parent's _fixed_process function.
<constant name="ENABLER_PARENT_PHYSICS_PROCESS" value="4">
This enabler will stop the parent's _physics_process function.
</constant>
<constant name="ENABLER_MAX" value="6">
</constant>

2
doc/classes/VisualScriptYield.xml
View file

@ -47,7 +47,7 @@
<constants>
<constant name="YIELD_FRAME" value="1">
</constant>
<constant name="YIELD_FIXED_FRAME" value="2">
<constant name="YIELD_PHYSICS_FRAME" value="2">
</constant>
<constant name="YIELD_WAIT" value="3">
</constant>

6
doc/classes/VisualServer.xml
View file

@ -18,6 +18,12 @@
<description>
</description>
</method>
<method name="force_sync">
<return type="void">
</return>
<description>
</description>
</method>
<method name="texture_create">
<return type="RID">
</return>

6
modules/gridmap/doc_classes/GridMap.xml
View file

@ -81,6 +81,12 @@
<description>
</description>
</method>
<method name="get_used_cells" qualifiers="const">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="resource_changed">
<return type="void">
</return>