From d5bb6faac77334154d2b16a3ff2d7ef6479b98be Mon Sep 17 00:00:00 2001 From: Juan Linietsky Date: Mon, 11 Jun 2018 13:41:16 -0300 Subject: -Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings --- doc/classes/@GDScript.xml | 2 +- doc/classes/@GlobalScope.xml | 3 - doc/classes/Animation.xml | 226 +++++++++++++++++ doc/classes/FileDialog.xml | 6 + doc/classes/Image.xml | 6 + doc/classes/Object.xml | 2 +- doc/classes/PopupMenu.xml | 18 ++ doc/classes/ProjectSettings.xml | 528 ++++++++++++++++++++++++++++++++++++++++ doc/classes/ScrollContainer.xml | 12 + doc/classes/Tween.xml | 6 + 10 files changed, 804 insertions(+), 5 deletions(-) (limited to 'doc/classes') diff --git a/doc/classes/@GDScript.xml b/doc/classes/@GDScript.xml index cddc59ab71..4a42cca836 100644 --- a/doc/classes/@GDScript.xml +++ b/doc/classes/@GDScript.xml @@ -1160,7 +1160,7 @@ A positive infinity. (For negative infinity, use -INF). - + Macro constant that expands to an expression of type float that represents a NaN. The NaN values are used to identify undefined or non-representable values for floating-point elements, such as the square root of negative numbers or the result of 0/0. diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 840d884a8c..7f94676e93 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -29,9 +29,6 @@ [Geometry] singleton - - [GodotSharp] singleton - [IP] singleton diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index ea503f8aa9..236cf06ca0 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -24,6 +24,214 @@ Add a track to the Animation. The track type must be specified as any of the values in the TYPE_* enumeration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -347,6 +555,16 @@ Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". Example: "character/skeleton:ankle" or "character/mesh:transform/local" + + + + + + + + + + @@ -430,6 +648,12 @@ Method tracks call functions with given arguments per key. + + + + + + No interpolation (nearest value). @@ -448,5 +672,7 @@ Update at the keyframes. + + diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index b165d8fb8c..247228d265 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -33,6 +33,12 @@ + + + + + + diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index 760b0c6bdc..9fc7672a80 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -393,6 +393,12 @@ Resizes the image to the nearest power of 2 for the width and height. If [code]square[/code] is [code]true[/code] then set width and height to be the same. + + + + + + diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index 0717836366..ab49bc468c 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -16,7 +16,7 @@ - + diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 166a4be2b0..89d8c43c00 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -303,6 +303,14 @@ Return whether the item is a separator. If it is, it would be displayed as a line. + + + + + + + + @@ -433,6 +441,16 @@ + + + + + + + + + + diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 44bba8bd20..77b61f29ac 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -156,6 +156,534 @@ + + + Scale the boot splash image to the full window length when engine starts (will leave it as default pixel size otherwise). + + + Path to an image used for boot splash. + + + This directory is used for storing persistent data (user:// filesystem). If a custom name is set, then system paths will be used to store this on Desktop (AppData on Windows, user ~/.config on Unixes, etc), else the Godot config folder is used. This name needs to be unique, and it's recommended to set it to something before publishing. + the "use_custom_user_dir" setting must be enabled for this to take effect. + + + Icon used for the project, set when project loads. Exporters will use this icon when possible to. + + + Name of the project. It is used from both project manager and by the exporters. Overriding this as name.locale allows setting it in multiple languages. + + + Allow the project to save to it's own custom user dir (in AppData on windows or ~/.config on unixes). This setting only works for desktop exporters. A name must be set in the "custom_user_dir_name" setting for this to take effect. + + + Disable printing to stderr on exported build. + + + Disable printing to stdout on exported build. + + + Force a delay between frames in the main loop. This may be useful if you plan to disable vsync. + + + Turn on low processor mode. This setting only works on desktops. The screen is not redrawn if nothing changes visually. This is meant for writing applications and editors, but is pretty useless (and can hurt performance) on games. + + + Amount of sleeping between frames when the low_processor_mode is enabled. This effectively reduces CPU usage when this mode is enabled. + + + Path to the main scene file that will be loaded when the project runs. + + + Audio buses will disable automatically when sound goes below a given DB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. + + + Audio buses will disable automatically when sound goes below a given DB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. + + + + + Mix rate used for audio. In general, it's better to not touch this and leave it to the host operating system. + + + Setting to harcode audio delay when playing video. Best to leave this untouched unless you know what you are doing. + + + Default compression level for gzip. Affects compressed scenes and resources. + + + Default compression level for zlib. Affects compressed scenes and resources. + + + Default compression level for zstd. Affects compressed scenes and resources. + + + Enable long distance matching in zstd. + + + + + + + + + Maximum call stack allowed for debugging GDScript. + + + Maximum amount of functions per frame allowed when profiling. + + + Print frames per second to stdout. Not very useful in general. + + + Print more information to stdout when running. It shows info such as memory leaks, which scenes and resources are being loaded, etc. + + + Maximum call stack in visual scripting, to avoid infinite recursion. + + + Custom image for the mouse cursor. + + + Hotspot for the custom mouse cursor image. + + + Allow per pixel transparency in a Desktop window. This affects performance if not needed, so leave it off. + + + Allow HiDPI display on Windows and OSX. On Desktop Linux, this can't be enabled or disabled. + + + Force keep the screen on, so the screensaver does not take over. Works on Desktop and Mobile. + + + Default orientation for cell phone or tablet. + + + + + + + Force the window to be always on top. + + + Force the window to be borderless. + + + Set the window to full screen when it starts. + + + Set the main window height. On desktop, this is the default window size. Stretch mode settings use this also as a reference when enabled. + + + Allow the window to be resizable by default. + + + Test a different height for the window. The main use for this is to test with stretch modes. + + + Test a different width for the window. The main use for this is to test with stretch modes. + + + Set the main window width. On desktop, this is the default window size. Stretch mode settings use this also as a reference when enabled. + + + Use VSync. Don't be stupid, don't turn this off. + + + Internal editor setting, don't touch. + + + + + Enable swap OK and Cancel buttons on dialogs. This is because Windows/MacOS/Desktop Linux may use them in different order, so the GUI swaps them depending on the host OS. Disable this behavior by turning this setting off. + + + Use a custom theme resource, set a path to it here. + + + USe a custom default font resource, set a path to it here. + + + Make sure the theme used works with hidpi. + + + Timer setting for incremental search in Tree, IntemList, etc. controls. + + + Timer for detecting idle in the editor. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Log all output to a file. + + + Path to logs withint he project. Using an user:// based path is recommended. + + + Amount of log files (used for rotation)/ + + + Godot uses a message queue to defer some function calls. If you run out of space on it (you will see an error), you can increase the size here. + + + This is used by servers when used in multi threading mode (servers and visual). RIDs are preallocated to avoid stalling the server requesting them on threads. If servers get stalled too often when loading resources in a thread, increase this number. + + + Maximum amount of characters allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. + + + Maximum amount of errors allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. + + + Maximum amount of messages allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. + + + Default size of packet peer stream for deserializing godot data. Over this size, data is dropped. + + + Maximum amount of pages used for remote filesystem (used by debugging). + + + Amount of read ahead used by remote filesystem. Improves latency. + + + Page size used by remote filesystem. + + + If your game or application uses HTTPS, a certificates file is needed. It must be set here. + + + When creating nodes names automatically, set the type of casing in this project. This is mostly an editor setting. + + + What to use to separate node name from number. This is mostly an editor setting. + + + + + Set whether physics is run on the main thread or a separate one. Running the server on a thread increases performance, but restricts API Access to only physics process. + + + + + Frames per second used in the physics. Physics always needs a fixed amount of frames per second. + + + Fix to improve physics jitter, specially on monitors where refresh rate is different than physics FPS. + + + Default background clear color. + + + Max buffer size for blend shapes. Any blend shape bigger than this will not work. + + + Max buffer size for drawing polygons. Any polygon bigger than this will not work. + + + Max index buffer size for drawing polygons. Any polygon bigger than this will not work. + + + Max buffer size for drawing immediate objects (ImmediateGeometry nodes). Nodes using more than this size will not work. + + + Max amount of elements renderable in a frame. If more than this are visible per frame, they will be dropped. Keep in mind elements refer to mesh surfaces and not mesh themselves. + + + Shaders have a time variable that constantly increases. At some point it needs to be rolled back to zero to avoid numerical errors on shader animations. This setting specifies when. + + + Force snapping of polygons to pixels in 2D rendering. May help in some pixel art styles. + + + Disable depth pre-pass for some GPU vendors (usually mobile), as their architecture already does this. + + + Do a previous depth pass before rendering materials. This increases performance in scenes with high overdraw, when complex materials and lighting are used. + + + Size in pixels of the directional shadow. + + + + + + + Maximum Anisotropic filter level used for textures when anisotropy enabled. + + + Force to use nearest mipmap filtering when using mipmaps. This may increase performance in mobile as less memory bandwidth is used. + + + Strategy used for framebuffer allocation. The simpler it is, the less memory it uses (but the least features it supports). + + + + + + + For reflection probes and panorama backgrounds (sky), use a high amount of samples to create ggx blurred versions (used for roughness). + + + + + For reflection probes and panorama backgrounds (sky), use a texure array instead of mipmaps. This reduces jitter noise on reflections, but costs more performance and memory. + + + + + Force vertex shading for all rendering. This can increase performance a lot, but also reduces quality inmensely. Can work to optimize on very low end mobile. + + + + + Subdivision quadrant size for shadow mapping. See shadow mapping documentation. + + + Subdivision quadrant size for shadow mapping. See shadow mapping documentation. + + + Subdivision quadrant size for shadow mapping. See shadow mapping documentation. + + + Subdivision quadrant size for shadow mapping. See shadow mapping documentation. + + + Size for shadow atlas (used for point and omni lights). See documentation. + + + + + Shadow filter mode. The more complex the filter, the more memory bandwidth required. + + + + + Improves quality of subsurface scattering, but cost significantly increases. + + + Quality setting for subsurface scaterring (samples taken). + + + + + Weight subsurface scattering samples. Helps to avoid reading samples from unrelated parts of the screen. + + + Use high quality voxel cone tracing (looks better, but requires a higher end GPU). + + + Thread model for rendering. Rendering on a thread can vastly improve performance, but syncinc to the main thread can cause a bit more jitter. + + + If the project uses this compression (usually low end mobile), texture importer will import these. + + + If the project uses this compression (usually high end mobile), texture importer will import these. + + + If the project uses this compression (usually iOS), texture importer will import these. + + + If the project uses this compression (usually Desktop and Consoles), texture importer will import these. + + + + diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index 3a99a203ae..02f58a88cb 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -11,6 +11,18 @@ + + + + + + + + + + + + diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index 2332c1a7aa..d82694d328 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -181,6 +181,12 @@ Returns [code]true[/code] if any tweens are currently running. Note that this method doesn't consider tweens that have ended. + + + + + + -- cgit v1.2.3