Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2025-01-24 18:17:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

Re-extracted class docs.

Browse Source
This commit is contained in:
Relintai 2024-07-16 23:22:41 +02:00
parent f9507dc475
commit 05dbe60f9b
23 changed files with 652 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/classes/ArrayMesh.xml
View File

@ -75,6 +75,13 @@
Returns the name of the blend shape at this index.
</description>
</method>
<method name="lightmap_unwrap">
<return type="int" enum="Error" />
<argument index="0" name="transform" type="Transform" />
<argument index="1" name="texel_size" type="float" />
<description>
</description>
</method>
<method name="regen_normalmaps">
<return type="void" />
<description>

2
doc/classes/BakedLightmap.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BakedLightmap" inherits="VisualInstance" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<class name="BakedLightmap" inherits="VisualInstance" version="4.4">
<brief_description>
Prerendered indirect light map for a scene.
</brief_description>

2
doc/classes/BakedLightmapData.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BakedLightmapData" inherits="Resource" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<class name="BakedLightmapData" inherits="Resource" version="4.4">
<brief_description>
</brief_description>
<description>

6
doc/classes/CPUParticles.xml
View File

@ -11,6 +11,12 @@
<tutorials>
</tutorials>
<methods>
<method name="convert_from_particles">
<return type="void" />
<argument index="0" name="particles" type="Node" />
<description>
</description>
</method>
<method name="get_param" qualifiers="const">
<return type="float" />
<argument index="0" name="param" type="int" enum="CPUParticles.Parameter" />

6
doc/classes/CPUParticles2D.xml
View File

@ -12,6 +12,12 @@
<link>$DOCS_URL/tutorials/2d/particle_systems_2d.md</link>
</tutorials>
<methods>
<method name="convert_from_particles">
<return type="void" />
<argument index="0" name="particles" type="Node" />
<description>
</description>
</method>
<method name="get_param" qualifiers="const">
<return type="float" />
<argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter" />

2
doc/classes/EditorSettings.xml
View File

@ -281,6 +281,8 @@
<member name="editors/3d/grid_yz_plane" type="bool" setter="" getter="">
If [code]true[/code], render the grid on an YZ plane. This can be useful for 3D side-scrolling games.
</member>
<member name="editors/3d/lightmap_baking_number_of_cpu_threads" type="int" setter="" getter="">
</member>
<member name="editors/3d/navigation/emulate_3_button_mouse" type="bool" setter="" getter="">
If [code]true[/code], enables 3-button mouse emulation mode. This is useful on laptops when using a trackpad.
When 3-button mouse emulation mode is enabled, the pan, zoom and orbit modifiers can always be used in the 3D editor viewport, even when not holding down any mouse button.

2
doc/classes/GIProbe.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GIProbe" inherits="VisualInstance" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<class name="GIProbe" inherits="VisualInstance" version="4.4">
<brief_description>
Real-time global illumination (GI) probe.
</brief_description>

16
doc/classes/GIProbeData.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GIProbeData" inherits="Resource" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<class name="GIProbeData" inherits="Resource" version="4.4">
<brief_description>
</brief_description>
<description>
@ -10,25 +10,25 @@
<methods>
</methods>
<members>
<member name="bias" type="float" setter="set_bias" getter="get_bias" default="0.4">
<member name="bias" type="float" setter="set_bias" getter="get_bias" default="0.0">
</member>
<member name="bounds" type="AABB" setter="set_bounds" getter="get_bounds" default="AABB( 0, 0, 0, 1, 1, 1 )">
<member name="bounds" type="AABB" setter="set_bounds" getter="get_bounds" default="AABB( 0, 0, 0, 0, 0, 0 )">
</member>
<member name="cell_size" type="float" setter="set_cell_size" getter="get_cell_size" default="1.0">
<member name="cell_size" type="float" setter="set_cell_size" getter="get_cell_size" default="0.0">
</member>
<member name="compress" type="bool" setter="set_compress" getter="is_compressed" default="false">
</member>
<member name="dynamic_data" type="PoolIntArray" setter="set_dynamic_data" getter="get_dynamic_data" default="PoolIntArray( )">
</member>
<member name="dynamic_range" type="int" setter="set_dynamic_range" getter="get_dynamic_range" default="1">
<member name="dynamic_range" type="int" setter="set_dynamic_range" getter="get_dynamic_range" default="0">
</member>
<member name="energy" type="float" setter="set_energy" getter="get_energy" default="1.0">
<member name="energy" type="float" setter="set_energy" getter="get_energy" default="0.0">
</member>
<member name="interior" type="bool" setter="set_interior" getter="is_interior" default="false">
</member>
<member name="normal_bias" type="float" setter="set_normal_bias" getter="get_normal_bias" default="0.4">
<member name="normal_bias" type="float" setter="set_normal_bias" getter="get_normal_bias" default="0.0">
</member>
<member name="propagation" type="float" setter="set_propagation" getter="get_propagation" default="1.0">
<member name="propagation" type="float" setter="set_propagation" getter="get_propagation" default="0.0">
</member>
<member name="to_cell_xform" type="Transform" setter="set_to_cell_xform" getter="get_to_cell_xform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
</member>

2
doc/classes/GPUParticles.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GPUParticles" inherits="GeometryInstance" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<class name="GPUParticles" inherits="GeometryInstance" version="4.4">
<brief_description>
GPU-based 3D particle emitter.
</brief_description>

2
doc/classes/GPUParticles2D.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GPUParticles2D" inherits="Node2D" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<class name="GPUParticles2D" inherits="Node2D" version="4.4">
<brief_description>
GPU-based 2D particle emitter.
</brief_description>

22
doc/classes/GeometryInstance.xml
View File

@ -39,6 +39,10 @@
<member name="extra_cull_margin" type="float" setter="set_extra_cull_margin" getter="get_extra_cull_margin" default="0.0">
The extra distance added to the GeometryInstance's bounding box ([AABB]) to increase its cull box.
</member>
<member name="generate_lightmap" type="bool" setter="set_generate_lightmap" getter="get_generate_lightmap" default="true">
</member>
<member name="lightmap_scale" type="int" setter="set_lightmap_scale" getter="get_lightmap_scale" enum="GeometryInstance.LightmapScale" default="0">
</member>
<member name="material_overlay" type="Material" setter="set_material_overlay" getter="get_material_overlay">
The material overlay for the whole geometry.
If a material is assigned to this property, it will be rendered on top of any other active material for all the surfaces.
@ -47,8 +51,20 @@
The material override for the whole geometry.
If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh.
</member>
<member name="use_in_baked_light" type="bool" setter="set_flag" getter="get_flag" default="false">
</member>
</members>
<constants>
<constant name="LIGHTMAP_SCALE_1X" value="0" enum="LightmapScale">
</constant>
<constant name="LIGHTMAP_SCALE_2X" value="1" enum="LightmapScale">
</constant>
<constant name="LIGHTMAP_SCALE_4X" value="2" enum="LightmapScale">
</constant>
<constant name="LIGHTMAP_SCALE_8X" value="3" enum="LightmapScale">
</constant>
<constant name="LIGHTMAP_SCALE_MAX" value="4" enum="LightmapScale">
</constant>
<constant name="SHADOW_CASTING_SETTING_OFF" value="0" enum="ShadowCastingSetting">
Will not cast any shadows.
</constant>
@ -64,9 +80,9 @@
Will only show the shadows casted from this object.
In other words, the actual mesh will not be visible, only the shadows casted from the mesh will be.
</constant>
<constant name="FLAG_USE_BAKED_LIGHT" value="0" enum="Flags">
Will allow the GeometryInstance to be used when baking lights using a [GIProbe] or [BakedLightmap].
</constant>
<constant name="FLAG_USE_BAKED_LIGHT" value="0" enum="Flags">
Will allow the GeometryInstance to be used when baking lights using a [GIProbe] or [BakedLightmap].
</constant>
<constant name="FLAG_DRAW_NEXT_FRAME_IF_VISIBLE" value="1" enum="Flags">
Unused in this class, exposed for consistency with [enum RenderingServer.InstanceFlags].
</constant>

10
doc/classes/Light.xml
View File

@ -31,6 +31,8 @@
<member name="editor_only" type="bool" setter="set_editor_only" getter="is_editor_only" default="false">
If [code]true[/code], the light only appears in the editor and will not be visible at runtime.
</member>
<member name="light_bake_mode" type="int" setter="set_bake_mode" getter="get_bake_mode" enum="Light.BakeMode" default="1">
</member>
<member name="light_color" type="Color" setter="set_color" getter="get_color" default="Color( 1, 1, 1, 1 )">
The light's color. An [i]overbright[/i] color can be used to achieve a result equivalent to increasing the light's [member light_energy].
</member>
@ -119,8 +121,14 @@
<constant name="PARAM_SHADOW_BIAS_SPLIT_SCALE" value="15" enum="Param">
Constant for accessing [member DirectionalLight.directional_shadow_bias_split_scale].
</constant>
<constant name="PARAM_MAX" value="16" enum="Param">
<constant name="PARAM_MAX" value="17" enum="Param">
Represents the size of the [enum Param] enum.
</constant>
<constant name="BAKE_DISABLED" value="0" enum="BakeMode">
</constant>
<constant name="BAKE_INDIRECT" value="1" enum="BakeMode">
</constant>
<constant name="BAKE_ALL" value="2" enum="BakeMode">
</constant>
</constants>
</class>

4
doc/classes/Mesh.xml
View File

@ -92,6 +92,10 @@
</description>
</method>
</methods>
<members>
<member name="lightmap_size_hint" type="Vector2i" setter="set_lightmap_size_hint" getter="get_lightmap_size_hint" default="Vector2i( 0, 0 )">
</member>
</members>
<constants>
<constant name="PRIMITIVE_POINTS" value="0" enum="PrimitiveType">
Render array as points (one vertex equals one point).

6
doc/classes/Node2D.xml
View File

@ -121,6 +121,9 @@
The node's scale. Unscaled value: [code](1, 1)[/code].
[b]Note:[/b] Negative X scales in 2D are not decomposable from the transformation matrix. Due to the way scale is represented with transformation matrices in Godot, negative scales on the X axis will be changed to negative scales on the Y axis and a rotation of 180 degrees when decomposed.
</member>
<member name="sort_enabled" type="bool" setter="set_sort_enabled" getter="is_sort_enabled" default="false">
If [code]true[/code], child nodes are sorted, otherwise sorting is disabled.
</member>
<member name="toplevel" type="bool" setter="set_as_toplevel" getter="is_set_as_toplevel" default="false">
</member>
<member name="transform" type="Transform2D" setter="set_transform" getter="get_transform">
@ -132,9 +135,6 @@
<member name="z_index" type="int" setter="set_z_index" getter="get_z_index" default="0">
Z index. Controls the order in which the nodes render. A node with a higher Z index will display in front of others. Must be between [constant RenderingServer.CANVAS_ITEM_Z_MIN] and [constant RenderingServer.CANVAS_ITEM_Z_MAX] (inclusive).
</member>
<member name="sort_enabled" type="bool" setter="set_sort_enabled" getter="is_sort_enabled" default="true">
If [code]true[/code], child nodes are sorted, otherwise sorting is disabled.
</member>
</members>
<constants>
</constants>

2
doc/classes/OS.xml
View File

@ -1200,6 +1200,8 @@
<constant name="VIDEO_DRIVER_GLES2" value="0" enum="VideoDriver">
The GLES2 rendering backend. It uses OpenGL ES 2.0 on mobile devices, OpenGL 2.1 on desktop platforms and WebGL 1.0 on the web.
</constant>
<constant name="VIDEO_DRIVER_GLES3" value="1" enum="VideoDriver">
</constant>
<constant name="DAY_SUNDAY" value="0" enum="Weekday">
Sunday.
</constant>

14
doc/classes/ProjectSettings.xml
View File

@ -489,7 +489,7 @@
<member name="debug/shapes/avoidance/obstacles_static_edge_pushout_color" type="Color" setter="" getter="" default="Color( 1, 1, 0, 1 )">
Color of the static avoidance obstacles edges when their vertices are winded in order to push agents out, visible when "Visible Avoidance" is enabled in the Debug menu.
</member>
<member name="debug/shapes/avoidance/obstacles_static_face_pushin_color" type="Color" setter="" getter="" default="Color( 1, 0, 0, 0 )">
<member name="debug/shapes/avoidance/obstacles_static_face_pushin_color" type="Color" setter="" getter="" default="Color( 1, 0, 0, 0.5 )">
Color of the static avoidance obstacles faces when their vertices are winded in order to push agents in, visible when "Visible Avoidance" is enabled in the Debug menu.
</member>
<member name="debug/shapes/avoidance/obstacles_static_face_pushout_color" type="Color" setter="" getter="" default="Color( 1, 1, 0, 0.5 )">
@ -1812,6 +1812,14 @@
The amount of UV contraction. This figure is divided by 1000000, and is a proportion of the total texture dimensions, where the width and height are both ranged from 0.0 to 1.0.
Use the default unless correcting for a problem on particular hardware.
</member>
<member name="rendering/cpu_lightmapper/quality/high_quality_ray_count" type="int" setter="" getter="" default="512">
</member>
<member name="rendering/cpu_lightmapper/quality/low_quality_ray_count" type="int" setter="" getter="" default="64">
</member>
<member name="rendering/cpu_lightmapper/quality/medium_quality_ray_count" type="int" setter="" getter="" default="256">
</member>
<member name="rendering/cpu_lightmapper/quality/ultra_quality_ray_count" type="int" setter="" getter="" default="1024">
</member>
<member name="rendering/environment/default_clear_color" type="Color" setter="" getter="" default="Color( 0.3, 0.3, 0.3, 1 )">
Default background clear color. Overridable per [Viewport] using its [Environment3D]. See [member Environment3D.background_mode] and [member Environment3D.background_color] in particular. To change this default color programmatically, use [method RenderingServer.set_default_clear_color].
</member>
@ -1983,6 +1991,10 @@
<member name="rendering/quality/intended_usage/framebuffer_allocation.mobile" type="int" setter="" getter="" default="3">
Lower-end override for [member rendering/quality/intended_usage/framebuffer_allocation] on mobile devices, due to performance concerns or driver support.
</member>
<member name="rendering/quality/lightmapping/use_bicubic_sampling" type="bool" setter="" getter="" default="true">
</member>
<member name="rendering/quality/lightmapping/use_bicubic_sampling.mobile" type="bool" setter="" getter="" default="false">
</member>
<member name="rendering/quality/reflections/atlas_size" type="int" setter="" getter="" default="2048">
Size of the atlas used by reflection probes. A larger size can result in higher visual quality, while a smaller size will be faster and take up less memory.
</member>

448
doc/classes/RenderingServer.xml
View File

@ -185,6 +185,15 @@
See [NinePatchRect] for more explanation.
</description>
</method>
<method name="canvas_item_add_particles">
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="particles" type="RID" />
<argument index="2" name="texture" type="RID" />
<argument index="3" name="normal_map" type="RID" />
<description>
</description>
</method>
<method name="canvas_item_add_polygon">
<return type="void" />
<argument index="0" name="item" type="RID" />
@ -1113,6 +1122,154 @@
Returns the id of a white texture. Creates one if none exists.
</description>
</method>
<method name="gi_probe_create">
<return type="RID" />
<description>
</description>
</method>
<method name="gi_probe_get_bias" qualifiers="const">
<return type="float" />
<argument index="0" name="probe" type="RID" />
<description>
</description>
</method>
<method name="gi_probe_get_bounds" qualifiers="const">
<return type="AABB" />
<argument index="0" name="probe" type="RID" />
<description>
</description>
</method>
<method name="gi_probe_get_cell_size" qualifiers="const">
<return type="float" />
<argument index="0" name="probe" type="RID" />
<description>
</description>
</method>
<method name="gi_probe_get_dynamic_data" qualifiers="const">
<return type="PoolIntArray" />
<argument index="0" name="probe" type="RID" />
<description>
</description>
</method>
<method name="gi_probe_get_dynamic_range" qualifiers="const">
<return type="int" />
<argument index="0" name="probe" type="RID" />
<description>
</description>
</method>
<method name="gi_probe_get_energy" qualifiers="const">
<return type="float" />
<argument index="0" name="probe" type="RID" />
<description>
</description>
</method>
<method name="gi_probe_get_normal_bias" qualifiers="const">
<return type="float" />
<argument index="0" name="probe" type="RID" />
<description>
</description>
</method>
<method name="gi_probe_get_propagation" qualifiers="const">
<return type="float" />
<argument index="0" name="probe" type="RID" />
<description>
</description>
</method>
<method name="gi_probe_get_to_cell_xform" qualifiers="const">
<return type="Transform" />
<argument index="0" name="probe" type="RID" />
<description>
</description>
</method>
<method name="gi_probe_is_compressed" qualifiers="const">
<return type="bool" />
<argument index="0" name="probe" type="RID" />
<description>
</description>
</method>
<method name="gi_probe_is_interior" qualifiers="const">
<return type="bool" />
<argument index="0" name="probe" type="RID" />
<description>
</description>
</method>
<method name="gi_probe_set_bias">
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="bias" type="float" />
<description>
</description>
</method>
<method name="gi_probe_set_bounds">
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="bounds" type="AABB" />
<description>
</description>
</method>
<method name="gi_probe_set_cell_size">
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="range" type="float" />
<description>
</description>
</method>
<method name="gi_probe_set_compress">
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="enable" type="bool" />
<description>
</description>
</method>
<method name="gi_probe_set_dynamic_data">
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="data" type="PoolIntArray" />
<description>
</description>
</method>
<method name="gi_probe_set_dynamic_range">
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="range" type="int" />
<description>
</description>
</method>
<method name="gi_probe_set_energy">
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="energy" type="float" />
<description>
</description>
</method>
<method name="gi_probe_set_interior">
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="enable" type="bool" />
<description>
</description>
</method>
<method name="gi_probe_set_normal_bias">
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="bias" type="float" />
<description>
</description>
</method>
<method name="gi_probe_set_propagation">
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="propagation" type="float" />
<description>
</description>
</method>
<method name="gi_probe_set_to_cell_xform">
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="xform" type="Transform" />
<description>
</description>
</method>
<method name="has_changed" qualifiers="const">
<return type="bool" />
<argument index="0" name="queried_priority" type="int" enum="RenderingServer.ChangedPriority" default="0" />
@ -1400,6 +1557,16 @@
Sets the world space transform of the instance. Equivalent to [member Spatial.transform].
</description>
</method>
<method name="instance_set_use_lightmap">
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="lightmap_instance" type="RID" />
<argument index="2" name="lightmap" type="RID" />
<argument index="3" name="lightmap_slice" type="int" default="-1" />
<argument index="4" name="lightmap_uv_rect" type="Rect2" default="Rect2( 0, 0, 1, 1 )" />
<description>
</description>
</method>
<method name="instance_set_visible">
<return type="void" />
<argument index="0" name="instance" type="RID" />
@ -1476,6 +1643,13 @@
Sets whether to use a dual paraboloid or a cubemap for the shadow map. Dual paraboloid is faster but may suffer from artifacts. Equivalent to [member OmniLight.omni_shadow_mode].
</description>
</method>
<method name="light_set_bake_mode">
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="bake_mode" type="int" enum="RenderingServer.LightBakeMode" />
<description>
</description>
</method>
<method name="light_set_color">
<return type="void" />
<argument index="0" name="light" type="RID" />
@ -1541,6 +1715,89 @@
Sets the color of the shadow cast by the light. Equivalent to [member Light.shadow_color].
</description>
</method>
<method name="lightmap_capture_create">
<return type="RID" />
<description>
</description>
</method>
<method name="lightmap_capture_get_bounds" qualifiers="const">
<return type="AABB" />
<argument index="0" name="capture" type="RID" />
<description>
</description>
</method>
<method name="lightmap_capture_get_energy" qualifiers="const">
<return type="float" />
<argument index="0" name="capture" type="RID" />
<description>
</description>
</method>
<method name="lightmap_capture_get_octree" qualifiers="const">
<return type="PoolByteArray" />
<argument index="0" name="capture" type="RID" />
<description>
</description>
</method>
<method name="lightmap_capture_get_octree_cell_subdiv" qualifiers="const">
<return type="int" />
<argument index="0" name="capture" type="RID" />
<description>
</description>
</method>
<method name="lightmap_capture_get_octree_cell_transform" qualifiers="const">
<return type="Transform" />
<argument index="0" name="capture" type="RID" />
<description>
</description>
</method>
<method name="lightmap_capture_is_interior" qualifiers="const">
<return type="bool" />
<argument index="0" name="capture" type="RID" />
<description>
</description>
</method>
<method name="lightmap_capture_set_bounds">
<return type="void" />
<argument index="0" name="capture" type="RID" />
<argument index="1" name="bounds" type="AABB" />
<description>
</description>
</method>
<method name="lightmap_capture_set_energy">
<return type="void" />
<argument index="0" name="capture" type="RID" />
<argument index="1" name="energy" type="float" />
<description>
</description>
</method>
<method name="lightmap_capture_set_interior">
<return type="void" />
<argument index="0" name="capture" type="RID" />
<argument index="1" name="interior" type="bool" />
<description>
</description>
</method>
<method name="lightmap_capture_set_octree">
<return type="void" />
<argument index="0" name="capture" type="RID" />
<argument index="1" name="octree" type="PoolByteArray" />
<description>
</description>
</method>
<method name="lightmap_capture_set_octree_cell_subdiv">
<return type="void" />
<argument index="0" name="capture" type="RID" />
<argument index="1" name="subdiv" type="int" />
<description>
</description>
</method>
<method name="lightmap_capture_set_octree_cell_transform">
<return type="void" />
<argument index="0" name="capture" type="RID" />
<argument index="1" name="xform" type="Transform" />
<description>
</description>
</method>
<method name="make_sphere_mesh">
<return type="RID" />
<argument index="0" name="latitudes" type="int" />
@ -2020,6 +2277,161 @@
To place in a scene, attach this omni light to an instance using [method instance_set_base] using the returned RID.
</description>
</method>
<method name="particles_create">
<return type="RID" />
<description>
</description>
</method>
<method name="particles_get_current_aabb">
<return type="AABB" />
<argument index="0" name="particles" type="RID" />
<description>
</description>
</method>
<method name="particles_get_emitting">
<return type="bool" />
<argument index="0" name="particles" type="RID" />
<description>
</description>
</method>
<method name="particles_is_inactive">
<return type="bool" />
<argument index="0" name="particles" type="RID" />
<description>
</description>
</method>
<method name="particles_request_process">
<return type="void" />
<argument index="0" name="particles" type="RID" />
<description>
</description>
</method>
<method name="particles_restart">
<return type="void" />
<argument index="0" name="particles" type="RID" />
<description>
</description>
</method>
<method name="particles_set_amount">
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="amount" type="int" />
<description>
</description>
</method>
<method name="particles_set_custom_aabb">
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="aabb" type="AABB" />
<description>
</description>
</method>
<method name="particles_set_draw_order">
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="order" type="int" enum="RenderingServer.ParticlesDrawOrder" />
<description>
</description>
</method>
<method name="particles_set_draw_pass_mesh">
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="pass" type="int" />
<argument index="2" name="mesh" type="RID" />
<description>
</description>
</method>
<method name="particles_set_draw_passes">
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="count" type="int" />
<description>
</description>
</method>
<method name="particles_set_emission_transform">
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="transform" type="Transform" />
<description>
</description>
</method>
<method name="particles_set_emitting">
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="emitting" type="bool" />
<description>
</description>
</method>
<method name="particles_set_explosiveness_ratio">
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="ratio" type="float" />
<description>
</description>
</method>
<method name="particles_set_fixed_fps">
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="fps" type="int" />
<description>
</description>
</method>
<method name="particles_set_fractional_delta">
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="enable" type="bool" />
<description>
</description>
</method>
<method name="particles_set_lifetime">
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="lifetime" type="float" />
<description>
</description>
</method>
<method name="particles_set_one_shot">
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="one_shot" type="bool" />
<description>
</description>
</method>
<method name="particles_set_pre_process_time">
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="time" type="float" />
<description>
</description>
</method>
<method name="particles_set_process_material">
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="material" type="RID" />
<description>
</description>
</method>
<method name="particles_set_randomness_ratio">
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="ratio" type="float" />
<description>
</description>
</method>
<method name="particles_set_speed_scale">
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="scale" type="float" />
<description>
</description>
</method>
<method name="particles_set_use_local_coordinates">
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="enable" type="bool" />
<description>
</description>
</method>
<method name="reflection_probe_create">
<return type="RID" />
<description>
@ -3130,9 +3542,15 @@
<constant name="LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE" value="15" enum="LightParam">
Increases bias on further splits to fix self-shadowing that only occurs far away from the camera.
</constant>
<constant name="LIGHT_PARAM_MAX" value="16" enum="LightParam">
<constant name="LIGHT_PARAM_MAX" value="17" enum="LightParam">
Represents the size of the [enum LightParam] enum.
</constant>
<constant name="LIGHT_BAKE_DISABLED" value="0" enum="LightBakeMode">
</constant>
<constant name="LIGHT_BAKE_INDIRECT" value="1" enum="LightBakeMode">
</constant>
<constant name="LIGHT_BAKE_ALL" value="2" enum="LightBakeMode">
</constant>
<constant name="LIGHT_OMNI_SHADOW_DUAL_PARABOLOID" value="0" enum="LightOmniShadowMode">
Use a dual paraboloid shadow map for omni lights.
</constant>
@ -3280,22 +3698,28 @@
<constant name="INSTANCE_IMMEDIATE" value="3" enum="InstanceType">
The instance is an immediate geometry.
</constant>
<constant name="INSTANCE_LIGHT" value="4" enum="InstanceType">
<constant name="INSTANCE_PARTICLES" value="4" enum="InstanceType">
</constant>
<constant name="INSTANCE_LIGHT" value="5" enum="InstanceType">
The instance is a light.
</constant>
<constant name="INSTANCE_REFLECTION_PROBE" value="5" enum="InstanceType">
<constant name="INSTANCE_REFLECTION_PROBE" value="6" enum="InstanceType">
The instance is a reflection probe.
</constant>
<constant name="INSTANCE_MAX" value="6" enum="InstanceType">
<constant name="INSTANCE_GI_PROBE" value="7" enum="InstanceType">
</constant>
<constant name="INSTANCE_LIGHTMAP_CAPTURE" value="8" enum="InstanceType">
</constant>
<constant name="INSTANCE_MAX" value="9" enum="InstanceType">
Represents the size of the [enum InstanceType] enum.
</constant>
<constant name="INSTANCE_GEOMETRY_MASK" value="14" enum="InstanceType">
<constant name="INSTANCE_GEOMETRY_MASK" value="30" enum="InstanceType">
A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
</constant>
<constant name="INSTANCE_FLAG_USE_BAKED_LIGHT" value="1" enum="InstanceFlags">
Allows the instance to be used in baked lighting.
</constant>
<constant name="INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE" value="2" enum="InstanceFlags">
<constant name="INSTANCE_FLAG_USE_BAKED_LIGHT" value="0" enum="InstanceFlags">
Allows the instance to be used in baked lighting.
</constant>
<constant name="INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE" value="1" enum="InstanceFlags">
When set, manually requests to draw geometry on next frame.
</constant>
<constant name="INSTANCE_FLAG_MAX" value="2" enum="InstanceFlags">
@ -3445,6 +3869,12 @@
<constant name="REFLECTION_PROBE_UPDATE_ALWAYS" value="1" enum="ReflectionProbeUpdateMode">
Reflection probe will update each frame. This mode is necessary to capture moving objects.
</constant>
<constant name="PARTICLES_DRAW_ORDER_INDEX" value="0" enum="ParticlesDrawOrder">
</constant>
<constant name="PARTICLES_DRAW_ORDER_LIFETIME" value="1" enum="ParticlesDrawOrder">
</constant>
<constant name="PARTICLES_DRAW_ORDER_VIEW_DEPTH" value="2" enum="ParticlesDrawOrder">
</constant>
<constant name="ENV_BG_CLEAR_COLOR" value="0" enum="Environment3DBG">
Use the clear color as background.
</constant>

1
doc/classes/YSort.xml
View File

@ -12,6 +12,7 @@
<methods>
</methods>
<members>
<member name="sort_enabled" type="bool" setter="set_sort_enabled" getter="is_sort_enabled" overrides="Node2D" default="true" />
</members>
<constants>
</constants>

14
modules/database/doc_classes/PreparedStatement.xml
View File

@ -19,12 +19,12 @@
ps.sql = "INSERT INTO 'data_table' VALUES(?, ?, ?, ?);"
ps.prepare()
print("Inserting 10 values!")
for i in range(10):
ps.reset()
ps.bind_text(1, "vc" + str(randi()))
ps.bind_text(2, "text" + str(randi()))
ps.bind_int(3, randi())
@ -37,15 +37,15 @@
qb.insert("data_table", "data_varchar,data_text,data_int,data_double").values()
qb.valph().valph().valph().valph().cvalues()
qb.end_command()
var ps : PreparedStatement = qb.create_prepared_statement()
ps.prepare()
print("Inserting 10 values!")
for i in range(10):
ps.reset()
ps.bind_text(1, "vc" + str(randi()))
ps.bind_text(2, "text" + str(randi()))
ps.bind_int(3, randi())

2
modules/entity_spell_system/doc_classes/CharacterSkeleton2D.xml
View File

@ -188,7 +188,7 @@
</member>
<member name="model_index" type="int" setter="set_model_index" getter="get_model_index" default="0">
</member>
<member name="sort_enabled" type="bool" setter="set_sort_enabled" getter="is_sort_enabled" overrides="YSort" default="false" />
<member name="sort_enabled" type="bool" setter="set_sort_enabled" getter="is_sort_enabled" overrides="Node2D" default="false" />
</members>
<constants>
</constants>

63
modules/layered_tile_map/doc_classes/LayeredTileData.xml
View File

@ -16,6 +16,24 @@
Adds a collision polygon to the tile on the given LayeredTileSet physics layer.
</description>
</method>
<method name="get_avoidance_polygon_points" qualifiers="const">
<return type="PoolVector2Array" />
<argument index="0" name="layer_id" type="int" />
<description>
</description>
</method>
<method name="get_avoidance_position" qualifiers="const">
<return type="Vector2i" />
<argument index="0" name="layer_id" type="int" />
<description>
</description>
</method>
<method name="get_avoidance_radius" qualifiers="const">
<return type="float" />
<argument index="0" name="layer_id" type="int" />
<description>
</description>
</method>
<method name="get_collision_polygon_one_way_margin" qualifiers="const">
<return type="float" />
<argument index="0" name="layer_id" type="int" />
@ -112,6 +130,27 @@
Removes the polygon at index [param polygon_index] for LayeredTileSet physics layer with index [param layer_id].
</description>
</method>
<method name="set_avoidance_polygon_points">
<return type="void" />
<argument index="0" name="layer_id" type="int" />
<argument index="1" name="polygon" type="PoolVector2Array" />
<description>
</description>
</method>
<method name="set_avoidance_position">
<return type="void" />
<argument index="0" name="layer_id" type="int" />
<argument index="1" name="position" type="Vector2i" />
<description>
</description>
</method>
<method name="set_avoidance_radius">
<return type="void" />
<argument index="0" name="layer_id" type="int" />
<argument index="1" name="radius" type="float" />
<description>
</description>
</method>
<method name="set_collision_polygon_one_way">
<return type="void" />
<argument index="0" name="layer_id" type="int" />
@ -232,6 +271,24 @@
<member name="transpose" type="bool" setter="set_transpose" getter="get_transpose" default="false">
If [code]true[/code], the tile will display transposed, i.e. with horizontal and vertical texture UVs swapped.
</member>
<member name="vertex_light_attenuation" type="float" setter="set_vertex_light_attenuation" getter="get_vertex_light_attenuation" default="1.0">
</member>
<member name="vertex_light_color" type="Color" setter="set_vertex_light_color" getter="get_vertex_light_color" default="Color( 1, 1, 1, 1 )">
</member>
<member name="vertex_light_enabled" type="bool" setter="set_vertex_light_enabled" getter="get_vertex_light_is_enabled" default="false">
</member>
<member name="vertex_light_item_cull_mask" type="int" setter="set_vertex_light_item_cull_mask" getter="get_vertex_light_item_cull_mask" default="1">
</member>
<member name="vertex_light_layer_range" type="Vector2i" setter="set_vertex_light_layer_range" getter="get_vertex_light_layer_range" default="Vector2i( -512, 512 )">
</member>
<member name="vertex_light_mode" type="int" setter="set_vertex_light_mode" getter="get_vertex_light_mode" enum="LayeredTileData.VertexLight2DMode" default="0">
</member>
<member name="vertex_light_position" type="Vector2i" setter="set_vertex_light_position" getter="get_vertex_light_position" default="Vector2i( 0, 0 )">
</member>
<member name="vertex_light_range" type="Vector2i" setter="set_vertex_light_range" getter="get_vertex_light_range" default="Vector2i( 32, 32 )">
</member>
<member name="vertex_light_z_range" type="Vector2i" setter="set_vertex_light_z_range" getter="get_vertex_light_z_range" default="Vector2i( -1024, 1024 )">
</member>
<member name="y_sort_origin" type="int" setter="set_y_sort_origin" getter="get_y_sort_origin" default="0">
Vertical point of the tile used for determining y-sorted order.
</member>
@ -247,5 +304,11 @@
</signal>
</signals>
<constants>
<constant name="VERTEX_LIGHT_2D_MODE_ADD" value="0" enum="VertexLight2DMode">
</constant>
<constant name="VERTEX_LIGHT_2D_MODE_SUB" value="1" enum="VertexLight2DMode">
</constant>
<constant name="VERTEX_LIGHT_2D_MODE_MIX" value="2" enum="VertexLight2DMode">
</constant>
</constants>
</class>

52
modules/layered_tile_map/doc_classes/LayeredTileSet.xml
View File

@ -21,6 +21,12 @@
<link title="2D Kinematic Character Demo">https://godotengine.org/asset-library/asset/113</link>
</tutorials>
<methods>
<method name="add_avoidance_layer">
<return type="void" />
<argument index="0" name="to_position" type="int" default="-1" />
<description>
</description>
</method>
<method name="add_custom_data_layer">
<return type="void" />
<argument index="0" name="to_position" type="int" default="-1" />
@ -108,6 +114,24 @@
If the LayeredTileSet has no proxy for the given identifiers, returns an empty Array.
</description>
</method>
<method name="get_avoidance_layer_layer_value" qualifiers="const">
<return type="bool" />
<argument index="0" name="layer_index" type="int" />
<argument index="1" name="layer_number" type="int" />
<description>
</description>
</method>
<method name="get_avoidance_layer_layers" qualifiers="const">
<return type="int" />
<argument index="0" name="layer_index" type="int" />
<description>
</description>
</method>
<method name="get_avoidance_layers_count" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
<method name="get_coords_level_tile_proxy">
<return type="Array" />
<argument index="0" name="source_from" type="int" />
@ -337,6 +361,13 @@
If no proxy corresponding to provided identifiers are found, returns the same values the ones used as arguments.
</description>
</method>
<method name="move_avoidance_layer">
<return type="void" />
<argument index="0" name="layer_index" type="int" />
<argument index="1" name="to_position" type="int" />
<description>
</description>
</method>
<method name="move_custom_data_layer">
<return type="void" />
<argument index="0" name="layer_index" type="int" />
@ -395,6 +426,12 @@
Removes an alternative-level proxy for the given identifiers.
</description>
</method>
<method name="remove_avoidance_layer">
<return type="void" />
<argument index="0" name="layer_index" type="int" />
<description>
</description>
</method>
<method name="remove_coords_level_tile_proxy">
<return type="void" />
<argument index="0" name="source_from" type="int" />
@ -481,6 +518,21 @@
Proxied tiles can be automatically replaced in LayeredTileMap nodes using the editor.
</description>
</method>
<method name="set_avoidance_layer_layer_value">
<return type="void" />
<argument index="0" name="layer_index" type="int" />
<argument index="1" name="layer_number" type="int" />
<argument index="2" name="value" type="bool" />
<description>
</description>
</method>
<method name="set_avoidance_layer_layers">
<return type="void" />
<argument index="0" name="layer_index" type="int" />
<argument index="1" name="layers" type="int" />
<description>
</description>
</method>
<method name="set_coords_level_tile_proxy">
<return type="void" />
<argument index="0" name="p_source_from" type="int" />

5
modules/web/doc_classes/FolderServeWebPage.xml
View File

@ -21,6 +21,11 @@
<tutorials>
</tutorials>
<methods>
<method name="get_file_cache" qualifiers="const">
<return type="FileCache" />
<description>
</description>
</method>
<method name="load">
<return type="void" />
<description>