From 2a0991dde6448ab2567bb01819105a1dda1b96c4 Mon Sep 17 00:00:00 2001 From: Chris Bradfield Date: Sat, 18 Aug 2018 21:29:12 -0700 Subject: [PATCH] [DOCS] Many class ref updates --- doc/classes/BakedLightmap.xml | 15 +++++++++ doc/classes/DirectionalLight.xml | 18 +++++++++-- doc/classes/InputEventKey.xml | 1 + doc/classes/InputMap.xml | 5 +-- doc/classes/KinematicBody2D.xml | 3 ++ doc/classes/Light.xml | 15 +++++++++ doc/classes/OmniLight.xml | 8 +++-- doc/classes/ProgressBar.xml | 1 + doc/classes/Range.xml | 16 +++++----- doc/classes/TileSet.xml | 54 +++++++++++++++++--------------- doc/classes/Viewport.xml | 34 ++++++++++---------- 11 files changed, 115 insertions(+), 55 deletions(-) diff --git a/doc/classes/BakedLightmap.xml b/doc/classes/BakedLightmap.xml index 77895249e5f..966b6dd7c41 100644 --- a/doc/classes/BakedLightmap.xml +++ b/doc/classes/BakedLightmap.xml @@ -1,8 +1,10 @@ + Prerendered indirect light map for a scene. + Baked lightmaps are an alternative workflow for adding indirect (or baked) lighting to a scene. Unlike the [GIProbe] approach, baked lightmaps work fine on low-end PCs and mobile devices as they consume almost no resources in run-time. http://docs.godotengine.org/en/3.0/tutorials/3d/baked_lightmaps.html @@ -29,36 +31,49 @@ + Grid subdivision size for lightmapper calculation. Default value of [code]0.25[/code] will work for most cases. Increase for better lighting on small details or if your scene is very large. + Size of affected area. + If [code]true[/code] lightmap can capture light values greater than [code]1.0[/code]. Turning this off will result in a smaller lightmap. Default value:[code]false[/code]. + Lightmapping mode. See [enum BakeMode]. + Three quality modes are available. Higher quality requires more rendering time. See [enum BakeQuality]. + Grid size used for real-time capture information on dynamic objects. Cannot be larger than [member bake_cell_size]. + Location where lightmaps will be saved. + The calculated light data. + Lowest bake quality mode. Fastest to calculate. + Default bake quality mode. + Highest bake quality mode. Takes longer to calculate. + Less precise but faster bake mode. + More precise bake mode but can take considerably longer to bake. diff --git a/doc/classes/DirectionalLight.xml b/doc/classes/DirectionalLight.xml index ef751828116..2dc522083d1 100644 --- a/doc/classes/DirectionalLight.xml +++ b/doc/classes/DirectionalLight.xml @@ -1,10 +1,10 @@ - Directional Light, such as the Sun or the Moon. + Directional light from a distance, as from the Sun. - A DirectionalLight is a type of [Light] node that emits light constantly in one direction (the negative z axis of the node). It is used lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored, only the basis is used do determine light direction. + A directional light is a type of [Light] node that models an infinite number of parallel rays covering the entire scene. It is used for lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored. Only the basis is used do determine light direction. http://docs.godotengine.org/en/3.0/tutorials/3d/lights_and_shadows.html @@ -15,34 +15,48 @@ + Amount of extra bias for shadow splits that are far away. If self shadowing occurs only on the splits far away, this value can fix them. + If [code]true[/code] shadow detail is sacrificed in exchange for smoother transitions between splits. Default value:[code]false[/code]. + Optimizes shadow rendering for detail versus movement. See [enum ShadowDepthRange]. + The maximum distance for shadow splits. + The light's shadow rendering algorithm. See [enum ShadowMode]. + Can be used to fix special cases of self shadowing when objects are perpendicular to the light. + The distance from camera to shadow split 1. Relative to [member directional_shadow_max_distance]. Only used in [enum directional_shadow_mode] SHADOW_PARALLEL_*_SPLITS. + The distance from shadow split 1 to split 2. Relative to [member directional_shadow_max_distance]. Only used in [enum directional_shadow_mode] SHADOW_PARALLEL_*_SPLITS. + The distance from shadow split 2 to split 3. Relative to [member directional_shadow_max_distance]. Only used in [enum directional_shadow_mode] SHADOW_PARALLEL_4_SPLITS. + Renders the entire scene's shadow map from an orthogonal point of view. May result in blockier shadows on close objects. + Splits the view frustum in 2 areas, each with its own shadow map. + Splits the view frustum in 4 areas, each with its own shadow map. + Keeps the shadow stable when the camera moves, at the cost of lower effective shadow resolution. Default value. + Tries to achieve maximum shadow resolution. May result in saw effect on shadow edges. diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml index 7503e531882..a013ee62661 100644 --- a/doc/classes/InputEventKey.xml +++ b/doc/classes/InputEventKey.xml @@ -16,6 +16,7 @@ + Returns the scancode combined with modifier keys such as [code]Shift[/code] or [code]Alt[/code]. See also [InputEventWithModifiers]. diff --git a/doc/classes/InputMap.xml b/doc/classes/InputMap.xml index 2f5fb49dba6..cbcff1dd751 100644 --- a/doc/classes/InputMap.xml +++ b/doc/classes/InputMap.xml @@ -40,6 +40,7 @@ + Removes all events from an action. @@ -50,7 +51,7 @@ - Returns [true] if an action has an [InputEvent] associated with it. + Returns [code]true[/code] if the action has the given [InputEvent] associated with it. @@ -71,7 +72,7 @@ - Adds an (empty) action to the [code]InputMap[/code], with a configurable [code]deadzone[/code]. + Adds an empty action to the [code]InputMap[/code] with a configurable [code]deadzone[/code]. An [InputEvent] can then be added to this action with [method action_add_event]. diff --git a/doc/classes/KinematicBody2D.xml b/doc/classes/KinematicBody2D.xml index fdc974630f4..cdb1b0aa680 100644 --- a/doc/classes/KinematicBody2D.xml +++ b/doc/classes/KinematicBody2D.xml @@ -115,6 +115,8 @@ + Moves the body while keeping it attached to slopes. Similar to [me + As long as the [code]snap[/code] vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting[code]snap[/code] to[code](0, 0)[/code] or by using [method move_and_slide] instead. @@ -136,6 +138,7 @@ If the body is at least this close to another body, this body will consider them to be colliding. + If [code]true[/code] the body's movement will be synchronized to the physics frame. This is useful when animating movement via [AnimationPlayer], for example on moving platforms. diff --git a/doc/classes/Light.xml b/doc/classes/Light.xml index e9b36c2f9d8..04191136a8c 100644 --- a/doc/classes/Light.xml +++ b/doc/classes/Light.xml @@ -15,28 +15,40 @@ + If [code]true[/code] the light only appears in the editor and will not be visible at runtime. Default value:[code]false[/code]. + The light's bake mode. See [enum BakeMode]. + The light's color. + The light will affect objects in the selected layers. + The light's strength multiplier. + Secondary multiplier used with indirect light (light bounces). This works in baked light or GIProbe. + If [code]true[/code] the light's effect is reversed, darkening areas and casting bright shadows. Default value: [code]false[/code]. + The intensity of the specular blob in objects affected by the light. At [code]0[/code] the light becomes a pure diffuse light. + Used to adjust shadow appearance. Too small a value results in self shadowing, while too large a value causes shadows to separate from casters. Adjust as needed. + The color of shadows cast by this light. + Attempts to reduce [member shadow_bias] gap. + If [code]true[/code] the light will cast shadows. Default value: [code]false[/code]. @@ -75,10 +87,13 @@ + Light is ignored when baking. Note: hiding a light does [i]not[/i] affect baking. + Only indirect lighting will be baked. Default value. + Both direct and indirect light will be baked. Note: you should hide the light if you don't want it to appear twice (dynamic and baked). diff --git a/doc/classes/OmniLight.xml b/doc/classes/OmniLight.xml index ff2e77ffbed..5ed058bb062 100644 --- a/doc/classes/OmniLight.xml +++ b/doc/classes/OmniLight.xml @@ -1,10 +1,10 @@ - OmniDirectional Light, such as a light bulb or a candle. + Omnidirectional light, such as a light bulb or a candle. - An OmniDirectional light is a type of [Light] node that emits lights in all directions. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light]. + An Omnidirectional light is a type of [Light] that emits light in all directions. The light is attenuated by distance and this attenuation can be configured by changing its energy, radius, and attenuation parameters. http://docs.godotengine.org/en/3.0/tutorials/3d/lights_and_shadows.html @@ -15,12 +15,16 @@ + The light's attenuation (drop-off) curve. A number of presets are available in the Inspector. + Maximum distance the light affects. + See [enum ShadowDetail]. + See [enum ShadowMode]. diff --git a/doc/classes/ProgressBar.xml b/doc/classes/ProgressBar.xml index 919ecd7c862..0f03b7b80a3 100644 --- a/doc/classes/ProgressBar.xml +++ b/doc/classes/ProgressBar.xml @@ -14,6 +14,7 @@ + If [code]true[/code] the fill percentage is displayed on the bar. Default value: [code]true[/code]. diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml index fa7e20eff66..46a6132b940 100644 --- a/doc/classes/Range.xml +++ b/doc/classes/Range.xml @@ -17,30 +17,32 @@ - Binds two Ranges together along with any Ranges previously grouped with either of them. When any of Range's member variables change, it will share the new value with all other Ranges in its group. + Binds two ranges together along with any ranges previously grouped with either of them. When any of range's member variables change, it will share the new value with all other ranges in its group. - Stop Range from sharing its member variables with any other Range. + Stop range from sharing its member variables with any other. + If [code]true[/code] [member value] may be greater than [member max_value]. Default value: [code]false[/code]. + If [code]true[/code] [member value] may be less than [member min_value]. Default value: [code]false[/code]. If [code]true[/code] and [code]min_value[/code] is greater than 0, [code]value[/code] will be represented exponentially rather than linearly. - Maximum value. Range is clamped if [code]value[/code] is greater than [code]max_value[/code]. Default value: 100. + Maximum value. Range is clamped if [code]value[/code] is greater than [code]max_value[/code]. Default value: [code]100[/code]. - Minimum value. Range is clamped if [code]value[/code] is less than [code]min_value[/code]. Default value: 0. + Minimum value. Range is clamped if [code]value[/code] is less than [code]min_value[/code]. Default value: [code]0[/code]. Page size. Used mainly for [ScrollBar]. ScrollBar's length is its size multiplied by [code]page[/code] over the difference between [code]min_value[/code] and [code]max_value[/code]. @@ -49,7 +51,7 @@ The value mapped between 0 and 1. - If [code]true[/code], [code]value[/code] will always be rounded to the nearest integer. + If [code]true[/code] [code]value[/code] will always be rounded to the nearest integer. Default value: [code]false[/code]. If greater than 0, [code]value[/code] will always be rounded to a multiple of [code]step[/code]. If [code]rounded[/code] is also [code]true[/code], [code]value[/code] will first be rounded to a multiple of [code]step[/code] then rounded to the nearest integer. @@ -61,14 +63,14 @@ - This signal is emitted when min, max, range or step change. + Emitted when [member min_value], [member max_value], [member page], or [member step] change. - This signal is emitted when value changes. + Emitted when [member value] changes. diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index 7121bc8b9c5..dadc7c5ffa3 100644 --- a/doc/classes/TileSet.xml +++ b/doc/classes/TileSet.xml @@ -58,7 +58,7 @@ - Clear all tiles. + Clears all tiles. @@ -67,7 +67,7 @@ - Create a new tile which will be referenced by the given ID. + Creates a new tile which will be referenced by the given ID. @@ -76,21 +76,21 @@ - Find the first tile matching the given name. + Returns the first tile matching the given name. - Return the ID following the last currently used ID, useful when creating a new tile. + Returns the ID following the last currently used ID, useful when creating a new tile. - Return an array of all currently used tile IDs. + Returns an array of all currently used tile IDs. @@ -99,7 +99,7 @@ - Remove the tile referenced by the given ID. + Removes the tile referenced by the given ID. @@ -124,7 +124,7 @@ - Return the light occluder of the tile. + Returns the light occluder of the tile. @@ -133,7 +133,7 @@ - Return the material of the tile. + Returns the material of the tile. @@ -150,7 +150,7 @@ - Return the name of the tile. + Returns the name of the tile. @@ -159,7 +159,7 @@ - Return the navigation polygon of the tile. + Returns the navigation polygon of the tile. @@ -168,7 +168,7 @@ - Return the offset of the tile's navigation polygon. + Returns the offset of the tile's navigation polygon. @@ -185,7 +185,7 @@ - Return the offset of the tile's light occluder. + Returns the offset of the tile's light occluder. @@ -194,7 +194,7 @@ - Return the tile sub-region in the texture. + Returns the tile sub-region in the texture. @@ -241,7 +241,7 @@ - Return the array of shapes of the tile. + Returns the array of shapes of the tile. @@ -250,7 +250,7 @@ - Return the texture of the tile. + Returns the texture of the tile. @@ -259,7 +259,7 @@ - Return the texture offset of the tile. + Returns the texture offset of the tile. @@ -286,7 +286,7 @@ - Set a light occluder for the tile. + Sets a light occluder for the tile. @@ -297,7 +297,7 @@ - Set the material of the tile. + Sets the tile's material. @@ -308,6 +308,7 @@ + Sets the tile's modulation color. @@ -318,7 +319,7 @@ - Set the name of the tile, for descriptive purposes. + Sets the tile's name. @@ -329,7 +330,7 @@ - Set a navigation polygon for the tile. + Sets the tile's navigation polygon. @@ -340,7 +341,7 @@ - Set an offset for the tile's navigation polygon. + Sets an offset for the tile's navigation polygon. @@ -351,6 +352,7 @@ + Sets the tile's normal map texture. @@ -372,7 +374,7 @@ - Set the tile sub-region in the texture. This is common in texture atlases. + Set the tile's sub-region in the texture. This is common in texture atlases. @@ -419,7 +421,7 @@ - Set an array of shapes for the tile, enabling physics to collide with it. + Sets an array of shapes for the tile, enabling collision. @@ -430,7 +432,7 @@ - Set the texture of the tile. + Sets the tile's texture. @@ -441,7 +443,7 @@ - Set the texture offset of the tile. + Sets the tile's texture offset. @@ -452,6 +454,7 @@ + Sets the tile's [enum TileMode]. @@ -462,6 +465,7 @@ + Sets the tile's drawing index. diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index af0712d3570..05649193a6c 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -22,35 +22,35 @@ - Return the 3D world of the viewport, or if no such present, the one of the parent viewport. + Returns the 3D world of the viewport, or if none the world of the parent viewport. - Return the 2D world of the viewport. + Returns the 2D world of the viewport. - Return the active 3D camera. + Returns the active 3D camera. - Get the total transform of the viewport. + Returns the total transform of the viewport. - Get the mouse position, relative to the viewport. + Returns the mouse position relative to the viewport. @@ -59,35 +59,35 @@ - Get the specific information about the viewport from rendering pipeline. + Returns information about the viewport from the rendering pipeline. - Get the size override set with [method set_size_override]. + Returns the size override set with [method set_size_override]. - Get the viewport's texture, for use with various objects that you want to texture with the viewport. + Returns the viewport's texture. - Get the viewport RID from the [VisualServer]. + Returns the viewport's RID from the [VisualServer]. - Return the final, visible rect in global screen coordinates. + Returns the visible rectangle in global screen coordinates. @@ -101,7 +101,7 @@ - Returns whether there are shown modals on-screen. + Returns [code]true[/code] if there are visible modals on-screen. @@ -116,14 +116,14 @@ - Get the enabled status of the size override set with [method set_size_override]. + Returns [code]true[/code] if the size override is enabled. See [method set_size_override]. - Get the enabled status of the size stretch override set with [method set_size_override_stretch]. + Returns [code]true[/code] if the size stretch override is enabled. See [method set_size_override_stretch]. @@ -144,7 +144,7 @@ - Set the size override of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to [code](-1, -1)[/code], it won't update the size. + Sets the size override of the viewport. If the [code]enable[/code] parameter is [code]true[/code] the override is used, otherwise it uses the default size. If the size parameter is [code](-1, -1)[/code], it won't update the size. @@ -153,7 +153,7 @@ - Set whether the size override affects stretch as well. + If [code]true[/code] the size override affects stretch as well. @@ -168,7 +168,7 @@ - Force update of the 2D and 3D worlds. + Forces update of the 2D and 3D worlds. @@ -177,7 +177,7 @@ - Warp the mouse to a position, relative to the viewport. + Warps the mouse to a position relative to the viewport.