diff options
Diffstat (limited to 'doc')
29 files changed, 103 insertions, 84 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 9af81ae299..8b3e6345ec 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -1077,7 +1077,7 @@ Joypad Right Analog Trigger </constant> <constant name="OK" value="0" enum="Error"> - Functions that return Error return OK when no error occured. Most functions don't return errors and/or just print errors to STDOUT. + Functions that return Error return OK when no error occurred. Most functions don't return errors and/or just print errors to STDOUT. </constant> <constant name="FAILED" value="1" enum="Error"> Generic error. diff --git a/doc/classes/ARVRInterface.xml b/doc/classes/ARVRInterface.xml index c941b126a4..50f49ae66c 100644 --- a/doc/classes/ARVRInterface.xml +++ b/doc/classes/ARVRInterface.xml @@ -91,7 +91,7 @@ This interface support AR (video background and real world tracking). </constant> <constant name="ARVR_EXTERNAL" value="8" enum="Capabilities"> - This interface outputs to an external device, if the main viewport is used the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of get_render_targetsize. Using a seperate viewport node frees up the main viewport for other purposes. + This interface outputs to an external device, if the main viewport is used the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of get_render_targetsize. Using a separate viewport node frees up the main viewport for other purposes. </constant> <constant name="EYE_MONO" value="0" enum="Eyes"> Mono output, this is mostly used internally when retrieving positioning information for our camera node or when stereo scopic rendering is not supported. diff --git a/doc/classes/ARVRServer.xml b/doc/classes/ARVRServer.xml index 0b1db11a4d..1eec98a40d 100644 --- a/doc/classes/ARVRServer.xml +++ b/doc/classes/ARVRServer.xml @@ -49,7 +49,7 @@ <return type="int"> </return> <description> - Get the number of interfaces currently registered with the AR/VR server. If you're game supports multiple AR/VR platforms you can look throught the available interface and either present the user with a selection or simply try an initialize each interface and use the first one that returns true. + Get the number of interfaces currently registered with the AR/VR server. If you're game supports multiple AR/VR platforms you can look through the available interface and either present the user with a selection or simply try an initialize each interface and use the first one that returns true. </description> </method> <method name="get_interfaces" qualifiers="const"> diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index ed53bc85be..0ec8da976c 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -415,7 +415,7 @@ <return type="bool"> </return> <description> - Returns [code]true[/code] if the node is in the [SceneTree] and is visible on-screen. + Returns [code]true[/code] if the node is present in the [SceneTree], its [member visible] property is [code]true[/code] and its inherited visibility is also [code]true[/code]. </description> </method> <method name="make_canvas_position_local" qualifiers="const"> diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 3ce0457755..9f3263528d 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -8,7 +8,7 @@ For more information on Godot's UI system, anchors, margins, and containers, see the related tutorials in the manual. To build flexible UIs, you'll need a mix of UI elements that inherit from [code]Control[/code] and [Container] nodes. [b]User Interface nodes and input[/b] Godot sends input events to the scene's root node first, by calling [method Node._input]. [method Node._input] forwards the event down the node tree to the nodes under the mouse cursor, or on keyboard focus. To do so, it calls [method MainLoop._input_event]. Call [method accept_event] so no other node receives the event. Once you accepted an input, it becomes handled so [method Node._unhandled_input] will not process it. - Only one [code]Control[/code] node can be in keyboard focus. Only the node in focus will receive keyboard events. To get the foucs, call [method set_focus_mode]. [code]Control[/code] nodes lose focus when another node grabs it, or if you hide the node in focus. + Only one [code]Control[/code] node can be in keyboard focus. Only the node in focus will receive keyboard events. To get the focus, call [method set_focus_mode]. [code]Control[/code] nodes lose focus when another node grabs it, or if you hide the node in focus. Call [method set_ignore_mouse] to tell a [code]Control[/code] node to ignore mouse or touch events. You'll need it if you place an icon on top of a button. [Theme] resources change the Control's appearance. If you change the [Theme] on a [code]Control[/code] node, it affects all of its children. To override some of the theme's parameters, call one of the [code]add_*_override[/code] methods, like [method add_font_override]. You can override the theme with the inspector. </description> diff --git a/doc/classes/Generic6DOFJoint.xml b/doc/classes/Generic6DOFJoint.xml index f5b3df714b..01009edf9a 100644 --- a/doc/classes/Generic6DOFJoint.xml +++ b/doc/classes/Generic6DOFJoint.xml @@ -24,10 +24,10 @@ When rotating across x-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. </member> <member name="angular_limit_x/force_limit" type="float" setter="set_param_x" getter="get_param_x"> - The maximum amount of force that can occur, when rotating arround x-axis. + The maximum amount of force that can occur, when rotating around x-axis. </member> <member name="angular_limit_x/lower_angle" type="float" setter="_set_angular_lo_limit_x" getter="_get_angular_lo_limit_x"> - The minimum rotation in negative direction to break loose and rotate arround the x-axis. + The minimum rotation in negative direction to break loose and rotate around the x-axis. </member> <member name="angular_limit_x/restitution" type="float" setter="set_param_x" getter="get_param_x"> The amount of rotational restitution across the x-axis. The lower, the more restitution occurs. @@ -36,7 +36,7 @@ The speed of all rotations across the x-axis. </member> <member name="angular_limit_x/upper_angle" type="float" setter="_set_angular_hi_limit_x" getter="_get_angular_hi_limit_x"> - The minimum rotation in positive direction to break loose and rotate arround the x-axis. + The minimum rotation in positive direction to break loose and rotate around the x-axis. </member> <member name="angular_limit_y/damping" type="float" setter="set_param_y" getter="get_param_y"> The amount of rotational damping across the y-axis. The lower, the more dampening occurs. @@ -48,10 +48,10 @@ When rotating across y-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. </member> <member name="angular_limit_y/force_limit" type="float" setter="set_param_y" getter="get_param_y"> - The maximum amount of force that can occur, when rotating arround y-axis. + The maximum amount of force that can occur, when rotating around y-axis. </member> <member name="angular_limit_y/lower_angle" type="float" setter="_set_angular_lo_limit_y" getter="_get_angular_lo_limit_y"> - The minimum rotation in negative direction to break loose and rotate arround the y-axis. + The minimum rotation in negative direction to break loose and rotate around the y-axis. </member> <member name="angular_limit_y/restitution" type="float" setter="set_param_y" getter="get_param_y"> The amount of rotational restitution across the y-axis. The lower, the more restitution occurs. @@ -60,7 +60,7 @@ The speed of all rotations across the y-axis. </member> <member name="angular_limit_y/upper_angle" type="float" setter="_set_angular_hi_limit_y" getter="_get_angular_hi_limit_y"> - The minimum rotation in positive direction to break loose and rotate arround the y-axis. + The minimum rotation in positive direction to break loose and rotate around the y-axis. </member> <member name="angular_limit_z/damping" type="float" setter="set_param_z" getter="get_param_z"> The amount of rotational damping across the z-axis. The lower, the more dampening occurs. @@ -72,10 +72,10 @@ When rotating across z-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. </member> <member name="angular_limit_z/force_limit" type="float" setter="set_param_z" getter="get_param_z"> - The maximum amount of force that can occur, when rotating arround z-axis. + The maximum amount of force that can occur, when rotating around z-axis. </member> <member name="angular_limit_z/lower_angle" type="float" setter="_set_angular_lo_limit_z" getter="_get_angular_lo_limit_z"> - The minimum rotation in negative direction to break loose and rotate arround the z-axis. + The minimum rotation in negative direction to break loose and rotate around the z-axis. </member> <member name="angular_limit_z/restitution" type="float" setter="set_param_z" getter="get_param_z"> The amount of rotational restitution across the z-axis. The lower, the more restitution occurs. @@ -84,7 +84,7 @@ The speed of all rotations across the z-axis. </member> <member name="angular_limit_z/upper_angle" type="float" setter="_set_angular_hi_limit_z" getter="_get_angular_hi_limit_z"> - The minimum rotation in positive direction to break loose and rotate arround the z-axis. + The minimum rotation in positive direction to break loose and rotate around the z-axis. </member> <member name="angular_motor_x/enabled" type="bool" setter="set_flag_x" getter="get_flag_x"> If [code]true[/code] a rotating motor at the x-axis is enabled. @@ -185,10 +185,10 @@ The amount of damping that happens at the linear motion across the axes. </constant> <constant name="PARAM_ANGULAR_LOWER_LIMIT" value="5" enum="Param"> - The minimum rotation in negative direction to break loose and rotate arround the axes. + The minimum rotation in negative direction to break loose and rotate around the axes. </constant> <constant name="PARAM_ANGULAR_UPPER_LIMIT" value="6" enum="Param"> - The minimum rotation in positive direction to break loose and rotate arround the axes. + The minimum rotation in positive direction to break loose and rotate around the axes. </constant> <constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="7" enum="Param"> The speed of all rotations across the axes. @@ -200,7 +200,7 @@ The amount of rotational restitution across the axes. The lower, the more restitution occurs. </constant> <constant name="PARAM_ANGULAR_FORCE_LIMIT" value="10" enum="Param"> - The maximum amount of force that can occur, when rotating arround the axes. + The maximum amount of force that can occur, when rotating around the axes. </constant> <constant name="PARAM_ANGULAR_ERP" value="11" enum="Param"> When rotating across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. diff --git a/doc/classes/HingeJoint.xml b/doc/classes/HingeJoint.xml index dab7f4127c..b6e2f6f9a2 100644 --- a/doc/classes/HingeJoint.xml +++ b/doc/classes/HingeJoint.xml @@ -4,7 +4,7 @@ A hinge between two 3D bodies. </brief_description> <description> - Normaly uses the z-axis of body A as the hinge axis, another axis can be specified when adding it manually though. + Normally uses the z-axis of body A as the hinge axis, another axis can be specified when adding it manually though. </description> <tutorials> </tutorials> @@ -40,12 +40,12 @@ Target speed for the motor. </member> <member name="params/bias" type="float" setter="set_param" getter="get_param"> - The speed with wich the two bodies get pulled together when they move in different directions. + The speed with which the two bodies get pulled together when they move in different directions. </member> </members> <constants> <constant name="PARAM_BIAS" value="0" enum="Param"> - The speed with wich the two bodies get pulled together when they move in different directions. + The speed with which the two bodies get pulled together when they move in different directions. </constant> <constant name="PARAM_LIMIT_UPPER" value="1" enum="Param"> The maximum rotation. only active if [member angular_limit/enable] is [code]true[/code]. diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 30fc80dae9..5b0b63abec 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -17,7 +17,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - This will simulate pressing the specificed action. + This will simulate pressing the specified action. </description> </method> <method name="action_release"> diff --git a/doc/classes/InputEventMouse.xml b/doc/classes/InputEventMouse.xml index 7d5a60ff0d..5d9cda8605 100644 --- a/doc/classes/InputEventMouse.xml +++ b/doc/classes/InputEventMouse.xml @@ -4,7 +4,7 @@ Base input event type for mouse events. </brief_description> <description> - Stores general mouse events informations. + Stores general mouse events information. </description> <tutorials> http://docs.godotengine.org/en/3.0/learning/features/inputs/inputevent.html @@ -21,7 +21,7 @@ Mouse position relative to the current [Viewport] when used in [method Control._gui_input], otherwise is at 0,0. </member> <member name="position" type="Vector2" setter="set_position" getter="get_position"> - Mouse local position relative to the [Viewport]. If used in [method Control._gui_input] the position is relative to the current [Control] wich is under the mouse. + Mouse local position relative to the [Viewport]. If used in [method Control._gui_input] the position is relative to the current [Control] which is under the mouse. </member> </members> <constants> diff --git a/doc/classes/InputEventMouseButton.xml b/doc/classes/InputEventMouseButton.xml index 6b93fbfa67..1f7aa19386 100644 --- a/doc/classes/InputEventMouseButton.xml +++ b/doc/classes/InputEventMouseButton.xml @@ -4,7 +4,7 @@ Input event type for mouse button events. </brief_description> <description> - Contains mouse click informations. See [method Node._input]. + Contains mouse click information. See [method Node._input]. </description> <tutorials> http://docs.godotengine.org/en/3.0/learning/features/inputs/mouse_and_input_coordinates.html diff --git a/doc/classes/InputEventMouseMotion.xml b/doc/classes/InputEventMouseMotion.xml index 4b3126dc72..1183d1c16c 100644 --- a/doc/classes/InputEventMouseMotion.xml +++ b/doc/classes/InputEventMouseMotion.xml @@ -4,7 +4,7 @@ Input event type for mouse motion events. </brief_description> <description> - Contains mouse motion informations. Supports relative, absolute positions and speed. See [method Node._input]. + Contains mouse motion information. Supports relative, absolute positions and speed. See [method Node._input]. </description> <tutorials> http://docs.godotengine.org/en/3.0/learning/features/inputs/mouse_and_input_coordinates.html diff --git a/doc/classes/InputEventScreenDrag.xml b/doc/classes/InputEventScreenDrag.xml index bbf1411189..950f79018e 100644 --- a/doc/classes/InputEventScreenDrag.xml +++ b/doc/classes/InputEventScreenDrag.xml @@ -5,7 +5,7 @@ (only available on mobile devices) </brief_description> <description> - Contains screen drag informations. See [method Node._input]. + Contains screen drag information. See [method Node._input]. </description> <tutorials> http://docs.godotengine.org/en/3.0/learning/features/inputs/inputevent.html diff --git a/doc/classes/InputEventWithModifiers.xml b/doc/classes/InputEventWithModifiers.xml index 68a5540402..3dc102aa61 100644 --- a/doc/classes/InputEventWithModifiers.xml +++ b/doc/classes/InputEventWithModifiers.xml @@ -4,7 +4,7 @@ Base class for keys events with modifiers. </brief_description> <description> - Contains keys events informations with modifiers support like [code]SHIFT[/code] or [code]ALT[/code]. See [method Node._input]. + Contains keys events information with modifiers support like [code]SHIFT[/code] or [code]ALT[/code]. See [method Node._input]. </description> <tutorials> http://docs.godotengine.org/en/3.0/learning/features/inputs/inputevent.html diff --git a/doc/classes/Joint.xml b/doc/classes/Joint.xml index c26bbdb218..7b1497e99a 100644 --- a/doc/classes/Joint.xml +++ b/doc/classes/Joint.xml @@ -23,7 +23,7 @@ The [Node], the second side of the Joint attaches to. </member> <member name="solver/priority" type="int" setter="set_solver_priority" getter="get_solver_priority"> - The order in wich the solver is executed compared to the other [Joints], the lower, the earlier. + The order in which the solver is executed compared to the other [Joints], the lower, the earlier. </member> </members> <constants> diff --git a/doc/classes/KinematicBody.xml b/doc/classes/KinematicBody.xml index 747c46cced..a782a55504 100644 --- a/doc/classes/KinematicBody.xml +++ b/doc/classes/KinematicBody.xml @@ -27,7 +27,7 @@ <argument index="0" name="slide_idx" type="int"> </argument> <description> - Returns a [KinematicCollision], which contains information about a collision that occured during the last [method move_and_slide] call. Since the body can collide several times in a single call to [method move_and_slide], you must specify the index of the collision in the range 0 to ([method get_slide_count] - 1). + Returns a [KinematicCollision], which contains information about a collision that occurred during the last [method move_and_slide] call. Since the body can collide several times in a single call to [method move_and_slide], you must specify the index of the collision in the range 0 to ([method get_slide_count] - 1). </description> </method> <method name="get_slide_count" qualifiers="const"> @@ -87,7 +87,7 @@ If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below [code]slope_stop_min_velocity[/code], the body will stop completely. This prevents the body from sliding down slopes when you include gravity in [code]linear_velocity[/code]. When set to lower values, the body will not be able to stand still on steep slopes. If the body collides, it will change direction a maximum of [code]max_bounces[/code] times before it stops. [code]floor_max_angle[/code] is the maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall. The default value equals 45 degrees. - Returns the movement that remained when the body stopped. To get more detailed information about collisions that occured, use [method get_slide_collision]. + Returns the movement that remained when the body stopped. To get more detailed information about collisions that occurred, use [method get_slide_collision]. </description> </method> <method name="test_move"> diff --git a/doc/classes/KinematicBody2D.xml b/doc/classes/KinematicBody2D.xml index 5c12a0c8c0..d00a887e42 100644 --- a/doc/classes/KinematicBody2D.xml +++ b/doc/classes/KinematicBody2D.xml @@ -26,7 +26,7 @@ <argument index="0" name="slide_idx" type="int"> </argument> <description> - Returns a [KinematicCollision2D], which contains information about a collision that occured during the last [method move_and_slide] call. Since the body can collide several times in a single call to [method move_and_slide], you must specify the index of the collision in the range 0 to ([method get_slide_count] - 1). + Returns a [KinematicCollision2D], which contains information about a collision that occurred during the last [method move_and_slide] call. Since the body can collide several times in a single call to [method move_and_slide], you must specify the index of the collision in the range 0 to ([method get_slide_count] - 1). </description> </method> <method name="get_slide_count" qualifiers="const"> @@ -86,7 +86,7 @@ If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below [code]slope_stop_min_velocity[/code], the body will stop completely. This prevents the body from sliding down slopes when you include gravity in [code]linear_velocity[/code]. When set to lower values, the body will not be able to stand still on steep slopes. If the body collides, it will change direction a maximum of [code]max_bounces[/code] times before it stops. [code]floor_max_angle[/code] is the maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall. The default value equals 45 degrees. - Returns the movement that remained when the body stopped. To get more detailed information about collisions that occured, use [method get_slide_collision]. + Returns the movement that remained when the body stopped. To get more detailed information about collisions that occurred, use [method get_slide_collision]. </description> </method> <method name="test_move"> diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml index 4ad0d7575f..2898a84491 100644 --- a/doc/classes/Line2D.xml +++ b/doc/classes/Line2D.xml @@ -71,7 +71,7 @@ The gradient is drawn through the whole line from start to finish. The default color will not be used if a gradient is set. </member> <member name="joint_mode" type="int" setter="set_joint_mode" getter="get_joint_mode" enum="Line2D.LineJointMode"> - The style for the points inbetween the start and the end. + The style for the points between the start and the end. </member> <member name="points" type="PoolVector2Array" setter="set_points" getter="get_points"> The points that form the lines. The line is drawn between every point set in this array. diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 3a3fda72cc..c8798b8ee4 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -86,7 +86,7 @@ Duration (in seconds) of a caret's blinking cycle. </member> <member name="caret_position" type="int" setter="set_cursor_position" getter="get_cursor_position"> - The cursor's position inside the [code]LineEdit[/code]. When set, the text may scroll to accomodate it. + The cursor's position inside the [code]LineEdit[/code]. When set, the text may scroll to accommodate it. </member> <member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled"> If [code]true[/code] the context menu will appear when right clicked. diff --git a/doc/classes/MultiMeshInstance.xml b/doc/classes/MultiMeshInstance.xml index e09327e2c9..2896f514aa 100644 --- a/doc/classes/MultiMeshInstance.xml +++ b/doc/classes/MultiMeshInstance.xml @@ -4,7 +4,8 @@ Node that instances a [MultiMesh]. </brief_description> <description> - MultiMeshInstance is a [Node] that takes a [MultiMesh] resource and adds it to the current scenario by creating an instance of it (yes, this is an instance of instances). + [code]MultiMeshInstance[/code] is a specialized node to instance [GeometryInstance]s based on a [MultiMesh] resource. + This is useful to optimize the rendering of a high amount of instances of a given mesh (for example tree in a forest or grass strands). </description> <tutorials> </tutorials> @@ -14,6 +15,7 @@ </methods> <members> <member name="multimesh" type="MultiMesh" setter="set_multimesh" getter="get_multimesh"> + The [MultiMesh] resource that will be used and shared among all instances of the [code]MultiMeshInstance[/code]. </member> </members> <constants> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index e7627e11c5..6f64c865cd 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -44,7 +44,7 @@ </argument> <description> Called when there is an input event. The input event propagates through the node tree until a node consumes it. - It is only called if input processing is enabled, which is done automatically if this method is overriden, and can be toggled with [method set_process_input]. + It is only called if input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_input]. </description> </method> <method name="_physics_process" qualifiers="virtual"> @@ -54,7 +54,7 @@ </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 is enabled, which is done automatically if this method is overriden, and can be toggled with [method set_physics_process]. + It is only called if physics processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_physics_process]. Corresponds to the NOTIFICATION_PHYSICS_PROCESS notification in [method Object._notification]. </description> </method> @@ -65,7 +65,7 @@ </argument> <description> Called during the processing step of the main loop. Processing happens at every frame and as fast as possible, so the [code]delta[/code] time since the previous frame is not constant. - It is only called if processing is enabled, which is done automatically if this method is overriden, and can be toggled with [method set_process]. + It is only called if processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process]. Corresponds to the NOTIFICATION_PROCESS notification in [method Object._notification]. </description> </method> @@ -84,7 +84,7 @@ </argument> <description> Propagated to all nodes when the previous InputEvent is not consumed by any nodes. - It is only called if unhandled input processing is enabled, which is done automatically if this method is overriden, and can be toggled with [method set_process_unhandled_input]. + It is only called if unhandled input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_unhandled_input]. </description> </method> <method name="_unhandled_key_input" qualifiers="virtual"> @@ -656,7 +656,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Enables or disables physics (i.e. fixed framerate) processing. When a node is being processed, it will receive a NOTIFICATION_PHYSICS_PROCESS at a fixed (usually 60 fps, see [OS] to change) interval (and the [method _physics_process] callback will be called if exists). Enabled automatically if [method _physics_process] is overriden. Any calls to this before [method _ready] will be ignored. + Enables or disables physics (i.e. fixed framerate) processing. When a node is being processed, it will receive a NOTIFICATION_PHYSICS_PROCESS at a fixed (usually 60 fps, see [OS] to change) interval (and the [method _physics_process] callback will be called if exists). Enabled automatically if [method _physics_process] is overridden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_physics_process_internal"> @@ -673,7 +673,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Enables or disables processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the [method _process] callback will be called if exists). Enabled automatically if [method _process] is overriden. Any calls to this before [method _ready] will be ignored. + Enables or disables processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the [method _process] callback will be called if exists). Enabled automatically if [method _process] is overridden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_process_input"> @@ -682,7 +682,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Enables or disables input processing. This is not required for GUI controls! Enabled automatically if [method _input] is overriden. Any calls to this before [method _ready] will be ignored. + Enables or disables input processing. This is not required for GUI controls! Enabled automatically if [method _input] is overridden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_process_internal"> @@ -699,7 +699,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Enables unhandled input processing. This is not required for GUI controls! It enables the node to receive all input that was not previously handled (usually by a [Control]). Enabled automatically if [method _unhandled_input] is overriden. Any calls to this before [method _ready] will be ignored. + Enables unhandled input processing. This is not required for GUI controls! It enables the node to receive all input that was not previously handled (usually by a [Control]). Enabled automatically if [method _unhandled_input] is overridden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_process_unhandled_key_input"> @@ -708,7 +708,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Enables unhandled key input processing. Enabled automatically if [method _unhandled_key_input] is overriden. Any calls to this before [method _ready] will be ignored. + Enables unhandled key input processing. Enabled automatically if [method _unhandled_key_input] is overridden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_scene_instance_load_placeholder"> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 522a00385a..89b33b3c1c 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -87,7 +87,18 @@ <argument index="3" name="output" type="Array" default="[ ]"> </argument> <description> - Execute the binary file in given path, optionally blocking until it returns. A process ID is returned. + Execute the file at the given path, optionally blocking until it returns. + Platform path resolution will take place. The resolved file must exist and be executable. + Returns a process id. + For example: + [codeblock] + var output = [] + var pid = OS.execute('ls', [], true, output) + [/codeblock] + If you wish to access a shell built-in or perform a composite command, a platform specific shell can be invoked. For example: + [codeblock] + var pid = OS.execute('CMD.exe', ['/C', 'cd %TEMP% && dir'], true, output) + [/codeblock] </description> </method> <method name="find_scancode_from_string" qualifiers="const"> diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index 2edf2f5e72..f822867666 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -1199,7 +1199,7 @@ If above 0, this value is the maximum value for an impulse that this Joint puts on it's ends. </constant> <constant name="HINGE_JOINT_BIAS" value="0" enum="HingeJointParam"> - The speed with wich the two bodies get pulled together when they move in different directions. + The speed with which the two bodies get pulled together when they move in different directions. </constant> <constant name="HINGE_JOINT_LIMIT_UPPER" value="1" enum="HingeJointParam"> The maximum rotation across the Hinge. @@ -1234,7 +1234,7 @@ The minimum difference between the pivot points on their x-axis before damping happens. </constant> <constant name="SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS" value="2" enum="SliderJointParam"> - A factor applied to the movement accross the slider axis once the limits get surpassed. The lower, the slower the movement. + A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. </constant> <constant name="SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION" value="3" enum="SliderJointParam"> The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost. @@ -1243,7 +1243,7 @@ The amount of damping once the slider limits are surpassed. </constant> <constant name="SLIDER_JOINT_LINEAR_MOTION_SOFTNESS" value="5" enum="SliderJointParam"> - A factor applied to the movement accross the slider axis as long as the slider is in the limits. The lower, the slower the movement. + A factor applied to the movement across the slider axis as long as the slider is in the limits. The lower, the slower the movement. </constant> <constant name="SLIDER_JOINT_LINEAR_MOTION_RESTITUTION" value="6" enum="SliderJointParam"> The amount of restitution inside the slider limits. @@ -1252,13 +1252,13 @@ The amount of damping inside the slider limits. </constant> <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS" value="8" enum="SliderJointParam"> - A factor applied to the movement accross axes orthogonal to the slider. + A factor applied to the movement across axes orthogonal to the slider. </constant> <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION" value="9" enum="SliderJointParam"> - The amount of restitution when movement is accross axes orthogonal to the slider. + The amount of restitution when movement is across axes orthogonal to the slider. </constant> <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING" value="10" enum="SliderJointParam"> - The amount of damping when movement is accross axes orthogonal to the slider. + The amount of damping when movement is across axes orthogonal to the slider. </constant> <constant name="SLIDER_JOINT_ANGULAR_LIMIT_UPPER" value="11" enum="SliderJointParam"> The upper limit of rotation in the slider. @@ -1323,7 +1323,7 @@ The maximum difference between the pivot points' axes. </constant> <constant name="G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS" value="2" enum="G6DOFJointAxisParam"> - A factor that gets applied to the movement accross the axes. The lower, the slower the movement. + A factor that gets applied to the movement across the axes. The lower, the slower the movement. </constant> <constant name="G6DOF_JOINT_LINEAR_RESTITUTION" value="3" enum="G6DOFJointAxisParam"> The amount of restitution on the axes movement. The lower, the more velocity-energy gets lost. @@ -1332,25 +1332,25 @@ The amount of damping that happens at the linear motion across the axes. </constant> <constant name="G6DOF_JOINT_ANGULAR_LOWER_LIMIT" value="5" enum="G6DOFJointAxisParam"> - The minimum rotation in negative direction to break loose and rotate arround the axes. + The minimum rotation in negative direction to break loose and rotate around the axes. </constant> <constant name="G6DOF_JOINT_ANGULAR_UPPER_LIMIT" value="6" enum="G6DOFJointAxisParam"> - The minimum rotation in positive direction to break loose and rotate arround the axes. + The minimum rotation in positive direction to break loose and rotate around the axes. </constant> <constant name="G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS" value="7" enum="G6DOFJointAxisParam"> - A factor that gets multiplied onto all rotations accross the axes. + A factor that gets multiplied onto all rotations across the axes. </constant> <constant name="G6DOF_JOINT_ANGULAR_DAMPING" value="8" enum="G6DOFJointAxisParam"> - The amount of rotational damping accross the axes. The lower, the more dampening occurs. + The amount of rotational damping across the axes. The lower, the more dampening occurs. </constant> <constant name="G6DOF_JOINT_ANGULAR_RESTITUTION" value="9" enum="G6DOFJointAxisParam"> - The amount of rotational restitution accross the axes. The lower, the more restitution occurs. + The amount of rotational restitution across the axes. The lower, the more restitution occurs. </constant> <constant name="G6DOF_JOINT_ANGULAR_FORCE_LIMIT" value="10" enum="G6DOFJointAxisParam"> - The maximum amount of force that can occur, when rotating arround the axes. + The maximum amount of force that can occur, when rotating around the axes. </constant> <constant name="G6DOF_JOINT_ANGULAR_ERP" value="11" enum="G6DOFJointAxisParam"> - When correcting the crossing of limits in rotation accross the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. + When correcting the crossing of limits in rotation across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. </constant> <constant name="G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY" value="12" enum="G6DOFJointAxisParam"> Target speed for the motor at the axes. diff --git a/doc/classes/PinJoint.xml b/doc/classes/PinJoint.xml index f1e9d8dfe6..eeea1d5565 100644 --- a/doc/classes/PinJoint.xml +++ b/doc/classes/PinJoint.xml @@ -14,11 +14,11 @@ </methods> <members> <member name="params/bias" type="float" setter="set_param" getter="get_param"> - The force with wich the pinned objects stay in positional relation to each other. + The force with which the pinned objects stay in positional relation to each other. The higher, the stronger. </member> <member name="params/damping" type="float" setter="set_param" getter="get_param"> - The force with wich the pinned objects stay in velocity relation to each other. + The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger. </member> <member name="params/impulse_clamp" type="float" setter="set_param" getter="get_param"> @@ -27,11 +27,11 @@ </members> <constants> <constant name="PARAM_BIAS" value="0" enum="Param"> - The force with wich the pinned objects stay in positional relation to each other. + The force with which the pinned objects stay in positional relation to each other. The higher, the stronger. </constant> <constant name="PARAM_DAMPING" value="1" enum="Param"> - The force with wich the pinned objects stay in velocity relation to each other. + The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger. </constant> <constant name="PARAM_IMPULSE_CLAMP" value="2" enum="Param"> diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 1a68a13907..da73abbabb 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -266,7 +266,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return whether the item is a seperator. If it is, it would be displayed as a line. + Return whether the item is a separator. If it is, it would be displayed as a line. </description> </method> <method name="remove_item"> @@ -308,7 +308,7 @@ <argument index="1" name="enable" type="bool"> </argument> <description> - Mark the item at index "idx" as a seperator, which means that it would be displayed as a mere line. + Mark the item at index "idx" as a separator, which means that it would be displayed as a mere line. </description> </method> <method name="set_item_checked"> diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index 7575f11e05..2d53206663 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -76,6 +76,7 @@ <argument index="0" name="bit" type="int"> </argument> <description> + Return an individual bit on the collision mask. </description> </method> <method name="get_collision_normal" qualifiers="const"> @@ -125,6 +126,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. </description> </method> </methods> diff --git a/doc/classes/SliderJoint.xml b/doc/classes/SliderJoint.xml index 89441094e6..81ab064b8a 100644 --- a/doc/classes/SliderJoint.xml +++ b/doc/classes/SliderJoint.xml @@ -59,7 +59,7 @@ The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost. </member> <member name="linear_limit/softness" type="float" setter="set_param" getter="get_param"> - A factor applied to the movement accross the slider axis once the limits get surpassed. The lower, the slower the movement. + A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. </member> <member name="linear_limit/upper_distance" type="float" setter="set_param" getter="get_param"> The maximum difference between the pivot points on their x-axis before damping happens. @@ -71,16 +71,16 @@ The amount of restitution inside the slider limits. </member> <member name="linear_motion/softness" type="float" setter="set_param" getter="get_param"> - A factor applied to the movement accross the slider axis as long as the slider is in the limits. The lower, the slower the movement. + A factor applied to the movement across the slider axis as long as the slider is in the limits. The lower, the slower the movement. </member> <member name="linear_ortho/damping" type="float" setter="set_param" getter="get_param"> - The amount of damping when movement is accross axes orthogonal to the slider. + The amount of damping when movement is across axes orthogonal to the slider. </member> <member name="linear_ortho/restitution" type="float" setter="set_param" getter="get_param"> - The amount of restitution when movement is accross axes orthogonal to the slider. + The amount of restitution when movement is across axes orthogonal to the slider. </member> <member name="linear_ortho/softness" type="float" setter="set_param" getter="get_param"> - A factor applied to the movement accross axes orthogonal to the slider. + A factor applied to the movement across axes orthogonal to the slider. </member> </members> <constants> @@ -91,7 +91,7 @@ The minimum difference between the pivot points on their x-axis before damping happens. </constant> <constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2" enum="Param"> - A factor applied to the movement accross the slider axis once the limits get surpassed. The lower, the slower the movement. + A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. </constant> <constant name="PARAM_LINEAR_LIMIT_RESTITUTION" value="3" enum="Param"> The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost. @@ -100,7 +100,7 @@ The amount of damping once the slider limits are surpassed. </constant> <constant name="PARAM_LINEAR_MOTION_SOFTNESS" value="5" enum="Param"> - A factor applied to the movement accross the slider axis as long as the slider is in the limits. The lower, the slower the movement. + A factor applied to the movement across the slider axis as long as the slider is in the limits. The lower, the slower the movement. </constant> <constant name="PARAM_LINEAR_MOTION_RESTITUTION" value="6" enum="Param"> The amount of restitution inside the slider limits. @@ -109,13 +109,13 @@ The amount of damping inside the slider limits. </constant> <constant name="PARAM_LINEAR_ORTHOGONAL_SOFTNESS" value="8" enum="Param"> - A factor applied to the movement accross axes orthogonal to the slider. + A factor applied to the movement across axes orthogonal to the slider. </constant> <constant name="PARAM_LINEAR_ORTHOGONAL_RESTITUTION" value="9" enum="Param"> - The amount of restitution when movement is accross axes orthogonal to the slider. + The amount of restitution when movement is across axes orthogonal to the slider. </constant> <constant name="PARAM_LINEAR_ORTHOGONAL_DAMPING" value="10" enum="Param"> - The amount of damping when movement is accross axes orthogonal to the slider. + The amount of damping when movement is across axes orthogonal to the slider. </constant> <constant name="PARAM_ANGULAR_LIMIT_UPPER" value="11" enum="Param"> The upper limit of rotation in the slider. diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 5ae1c6608b..a0605ec78e 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -277,6 +277,7 @@ <return type="String"> </return> <description> + Removes indentation from string. </description> </method> <method name="empty"> @@ -321,7 +322,7 @@ <argument index="0" name="what" type="String"> </argument> <description> - Finds the last occurrence of a substring. Returns the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + Finds the last occurrence of a substring. Returns the starting position of the substring or -1 if not found. </description> </method> <method name="findn"> @@ -343,7 +344,7 @@ <argument index="1" name="placeholder" type="String" default="{_}"> </argument> <description> - Formats the string by replacing all occurences of [code]placeholder[/code] with [code]values[/code]. + Formats the string by replacing all occurrences of [code]placeholder[/code] with [code]values[/code]. </description> </method> <method name="get_base_dir"> diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 3823b7e5e9..ed987f7047 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -204,7 +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. + Adds a polyline, which is a line from multiple points with a width, to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_primitive"> @@ -669,7 +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. + The shadow mask. binary about which layers this canvas light affects which canvas item's shadows. See [LightOccluder2D] for more information on light masks. </description> </method> <method name="canvas_light_set_layer_range"> @@ -1506,7 +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. + Returns a copy of a texture's image unless it's a CubeMap, in which case it returns the [RID] of the image at one of the cubes sides. </description> </method> <method name="texture_get_flags" qualifiers="const"> @@ -2155,10 +2155,10 @@ 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). + Primitive to draw consists of a triangle strip (the last 3 vertices 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). + Primitive to draw consists of a triangle strip (the last 2 vertices 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. diff --git a/doc/classes/WorldEnvironment.xml b/doc/classes/WorldEnvironment.xml index 06a24c98d9..3969a8c502 100644 --- a/doc/classes/WorldEnvironment.xml +++ b/doc/classes/WorldEnvironment.xml @@ -1,10 +1,12 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="WorldEnvironment" inherits="Node" category="Core" version="3.0-rc1"> <brief_description> - Sets environment properties for the entire scene + Default environment properties for the entire scene (post-processing effects, lightning and background settings). </brief_description> <description> - The [code]WorldEnvironment[/code] node can be added to a scene in order to set default [Environment] variables for the scene. The [code]WorldEnvironment[/code] can be overridden by an [Environment] node set on the current [Camera]. Additionally, only one [code]WorldEnvironment[/code] may be instanced in a given scene at a time. The [code]WorldEnvironment[/code] allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). + The [code]WorldEnvironment[/code] node is used to configure the default [Environment] for the scene. + The parameters defined in the [code]WorldEnvironment[/code] can be overridden by an [Environment] node set on the current [Camera]. Additionally, only one [code]WorldEnvironment[/code] may be instanced in a given scene at a time. + The [code]WorldEnvironment[/code] allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). Usually, these are added in order to improve the realism/color balance of the scene. </description> <tutorials> http://docs.godotengine.org/en/3.0/learning/features/3d/environment_and_post_processing.html @@ -15,6 +17,7 @@ </methods> <members> <member name="environment" type="Environment" setter="set_environment" getter="get_environment"> + The [Environment] resource used by this [code]WorldEnvironment[/code], defining the default properties. </member> </members> <constants> |