diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/AStar.xml | 23 | ||||
| -rw-r--r-- | doc/classes/AStar2D.xml | 23 | ||||
| -rw-r--r-- | doc/classes/AudioStreamGenerator.xml | 1 | ||||
| -rw-r--r-- | doc/classes/AudioStreamGeneratorPlayback.xml | 1 | ||||
| -rw-r--r-- | doc/classes/AudioStreamSample.xml | 1 | ||||
| -rw-r--r-- | doc/classes/Button.xml | 5 | ||||
| -rw-r--r-- | doc/classes/Control.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Environment.xml | 7 | ||||
| -rw-r--r-- | doc/classes/Geometry.xml | 25 | ||||
| -rw-r--r-- | doc/classes/GraphNode.xml | 2 | ||||
| -rw-r--r-- | doc/classes/JSONRPC.xml | 95 | ||||
| -rw-r--r-- | doc/classes/MainLoop.xml | 10 | ||||
| -rw-r--r-- | doc/classes/OS.xml | 44 | ||||
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 5 | ||||
| -rw-r--r-- | doc/classes/SceneTree.xml | 9 | ||||
| -rw-r--r-- | doc/classes/SpriteBase3D.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Transform.xml | 4 | ||||
| -rw-r--r-- | doc/classes/Transform2D.xml | 4 | ||||
| -rw-r--r-- | doc/classes/TreeItem.xml | 20 | ||||
| -rw-r--r-- | doc/classes/Vector2.xml | 4 | ||||
| -rw-r--r-- | doc/classes/Vector3.xml | 6 | ||||
| -rw-r--r-- | doc/classes/VisualShaderNodeCustom.xml | 1 |
22 files changed, 268 insertions, 26 deletions
diff --git a/doc/classes/AStar.xml b/doc/classes/AStar.xml index 6d7adc9935..9ca09371dd 100644 --- a/doc/classes/AStar.xml +++ b/doc/classes/AStar.xml @@ -157,6 +157,13 @@ If you change the 2nd point's weight to 3, then the result will be [code][1, 4, 3][/code] instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2. </description> </method> + <method name="get_point_capacity" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the capacity of the structure backing the points, useful in conjunction with [code]reserve_space[/code]. + </description> + </method> <method name="get_point_connections"> <return type="PoolIntArray"> </return> @@ -178,6 +185,13 @@ [/codeblock] </description> </method> + <method name="get_point_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the number of points currently in the points pool. + </description> + </method> <method name="get_point_path"> <return type="PoolVector3Array"> </return> @@ -241,6 +255,15 @@ Removes the point associated with the given [code]id[/code] from the points pool. </description> </method> + <method name="reserve_space"> + <return type="void"> + </return> + <argument index="0" name="num_nodes" type="int"> + </argument> + <description> + Reserves space internally for [code]num_nodes[/code] points, useful if you're adding a known large number of points at once, for a grid for instance. New capacity must be greater or equals to old capacity. + </description> + </method> <method name="set_point_disabled"> <return type="void"> </return> diff --git a/doc/classes/AStar2D.xml b/doc/classes/AStar2D.xml index 9d51330139..0eff2bd560 100644 --- a/doc/classes/AStar2D.xml +++ b/doc/classes/AStar2D.xml @@ -134,6 +134,13 @@ If you change the 2nd point's weight to 3, then the result will be [code][1, 4, 3][/code] instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2. </description> </method> + <method name="get_point_capacity" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the capacity of the structure backing the points, useful in conjunction with [code]reserve_space[/code]. + </description> + </method> <method name="get_point_connections"> <return type="PoolIntArray"> </return> @@ -155,6 +162,13 @@ [/codeblock] </description> </method> + <method name="get_point_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the number of points currently in the points pool. + </description> + </method> <method name="get_point_path"> <return type="PoolVector2Array"> </return> @@ -218,6 +232,15 @@ Removes the point associated with the given [code]id[/code] from the points pool. </description> </method> + <method name="reserve_space"> + <return type="void"> + </return> + <argument index="0" name="num_nodes" type="int"> + </argument> + <description> + Reserves space internally for [code]num_nodes[/code] points, useful if you're adding a known large number of points at once, for a grid for instance. New capacity must be greater or equals to old capacity. + </description> + </method> <method name="set_point_disabled"> <return type="void"> </return> diff --git a/doc/classes/AudioStreamGenerator.xml b/doc/classes/AudioStreamGenerator.xml index 9d67b88c71..9a1e4432f1 100644 --- a/doc/classes/AudioStreamGenerator.xml +++ b/doc/classes/AudioStreamGenerator.xml @@ -5,6 +5,7 @@ <description> </description> <tutorials> + <link>https://github.com/godotengine/godot-demo-projects/tree/master/audio/generator</link> </tutorials> <methods> </methods> diff --git a/doc/classes/AudioStreamGeneratorPlayback.xml b/doc/classes/AudioStreamGeneratorPlayback.xml index 310b58c4e5..448284e670 100644 --- a/doc/classes/AudioStreamGeneratorPlayback.xml +++ b/doc/classes/AudioStreamGeneratorPlayback.xml @@ -5,6 +5,7 @@ <description> </description> <tutorials> + <link>https://github.com/godotengine/godot-demo-projects/tree/master/audio/generator</link> </tutorials> <methods> <method name="can_push_buffer" qualifiers="const"> diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml index 6d03301749..a496902ded 100644 --- a/doc/classes/AudioStreamSample.xml +++ b/doc/classes/AudioStreamSample.xml @@ -24,6 +24,7 @@ <members> <member name="data" type="PoolByteArray" setter="set_data" getter="get_data" default="PoolByteArray( )"> Contains the audio data in bytes. + [b]Note:[/b] This property expects signed PCM8 data. To convert unsigned PCM8 to signed PCM8, subtract 128 from each byte. </member> <member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format" default="0"> Audio format. See [code]FORMAT_*[/code] constants for values. diff --git a/doc/classes/Button.xml b/doc/classes/Button.xml index adf826c26b..305be8b58d 100644 --- a/doc/classes/Button.xml +++ b/doc/classes/Button.xml @@ -15,7 +15,10 @@ Text alignment policy for the button's text, use one of the [code]ALIGN_*[/code] constants. </member> <member name="clip_text" type="bool" setter="set_clip_text" getter="get_clip_text" default="false"> - When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. This property is disabled by default. + When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. + </member> + <member name="expand_icon" type="bool" setter="set_expand_icon" getter="is_expand_icon" default="false"> + When enabled, the button's icon will expand/shrink to fit the button's size while keeping its aspect. </member> <member name="flat" type="bool" setter="set_flat" getter="is_flat" default="false"> Flat buttons don't display decoration. diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index f263c12821..1eeef92ccc 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -260,7 +260,7 @@ </description> </method> <method name="get_drag_data" qualifiers="virtual"> - <return type="Object"> + <return type="Variant"> </return> <argument index="0" name="position" type="Vector2"> </argument> diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index 86c1002666..9a943aba51 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -146,10 +146,11 @@ <member name="fog_depth_enabled" type="bool" setter="set_fog_depth_enabled" getter="is_fog_depth_enabled" default="true"> Enables the fog depth. </member> - <member name="fog_depth_end" type="float" setter="set_fog_depth_end" getter="get_fog_depth_end" default="0.0"> + <member name="fog_depth_end" type="float" setter="set_fog_depth_end" getter="get_fog_depth_end" default="100.0"> + Fog's depth end distance from the camera. If this value is set to 0, it will be equal to the current camera's [member Camera.far] value. </member> <member name="fog_enabled" type="bool" setter="set_fog_enabled" getter="is_fog_enabled" default="false"> - Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog. + Enables the fog. Needs [member fog_height_enabled] and/or [member fog_depth_enabled] to actually display fog. </member> <member name="fog_height_curve" type="float" setter="set_fog_height_curve" getter="get_fog_height_curve" default="1.0"> Value defining the fog height intensity. @@ -305,7 +306,7 @@ Replace glow blending mode. Replaces all pixels' color by the glow value. </constant> <constant name="TONE_MAPPER_LINEAR" value="0" enum="ToneMapper"> - Linear tonemapper operator. Reads the linear data and performs an exposure adjustment. + Linear tonemapper operator. Reads the linear data and passes it on unmodified. </constant> <constant name="TONE_MAPPER_REINHARDT" value="1" enum="ToneMapper"> Reinhardt tonemapper operator. Performs a variation on rendered pixels' colors by this formula: [code]color = color / (1 + color)[/code]. diff --git a/doc/classes/Geometry.xml b/doc/classes/Geometry.xml index 3cbbe6da56..3824baa4dc 100644 --- a/doc/classes/Geometry.xml +++ b/doc/classes/Geometry.xml @@ -216,6 +216,19 @@ Intersects [code]polyline[/code] with [code]polygon[/code] and returns an array of intersected polylines. This performs [constant OPERATION_INTERSECTION] between the polyline and the polygon. This operation can be thought of as chopping a line with a closed shape. </description> </method> + <method name="is_point_in_circle"> + <return type="bool"> + </return> + <argument index="0" name="point" type="Vector2"> + </argument> + <argument index="1" name="circle_position" type="Vector2"> + </argument> + <argument index="2" name="circle_radius" type="float"> + </argument> + <description> + Returns [code]true[/code] if [code]point[/code] is inside the circle or if it's located exactly [i]on[/i] the circle's boundary, otherwise returns [code]false[/code]. + </description> + </method> <method name="is_point_in_polygon"> <return type="bool"> </return> @@ -428,18 +441,6 @@ Tests if the segment ([code]from[/code], [code]to[/code]) intersects the triangle [code]a[/code], [code]b[/code], [code]c[/code]. If yes, returns the point of intersection as [Vector3]. If no intersection takes place, an empty [Variant] is returned. </description> </method> - <method name="transform_points_2d"> - <return type="PoolVector2Array"> - </return> - <argument index="0" name="points" type="PoolVector2Array"> - </argument> - <argument index="1" name="transform" type="Transform2D"> - </argument> - <description> - Transforms an array of points by [code]transform[/code] and returns the result. - Can be useful in conjunction with performing polygon boolean operations in a CSG-like manner, see [method merge_polygons_2d], [method clip_polygons_2d], [method intersect_polygons_2d], [method exclude_polygons_2d]. - </description> - </method> <method name="triangulate_delaunay_2d"> <return type="PoolIntArray"> </return> diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml index df641883af..8470a346ff 100644 --- a/doc/classes/GraphNode.xml +++ b/doc/classes/GraphNode.xml @@ -258,6 +258,8 @@ </theme_item> <theme_item name="resizer" type="Texture"> </theme_item> + <theme_item name="resizer_color" type="Color" default="Color( 0, 0, 0, 1 )"> + </theme_item> <theme_item name="selectedframe" type="StyleBox"> </theme_item> <theme_item name="separation" type="int" default="1"> diff --git a/doc/classes/JSONRPC.xml b/doc/classes/JSONRPC.xml new file mode 100644 index 0000000000..921161afb4 --- /dev/null +++ b/doc/classes/JSONRPC.xml @@ -0,0 +1,95 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="JSONRPC" inherits="Object" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="make_notification"> + <return type="Dictionary"> + </return> + <argument index="0" name="method" type="String"> + </argument> + <argument index="1" name="params" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="make_request"> + <return type="Dictionary"> + </return> + <argument index="0" name="method" type="String"> + </argument> + <argument index="1" name="params" type="Variant"> + </argument> + <argument index="2" name="id" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="make_response"> + <return type="Dictionary"> + </return> + <argument index="0" name="result" type="Variant"> + </argument> + <argument index="1" name="id" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="make_response_error" qualifiers="const"> + <return type="Dictionary"> + </return> + <argument index="0" name="code" type="int"> + </argument> + <argument index="1" name="message" type="String"> + </argument> + <argument index="2" name="id" type="Variant" default="null"> + </argument> + <description> + </description> + </method> + <method name="process_action"> + <return type="Variant"> + </return> + <argument index="0" name="action" type="Variant"> + </argument> + <argument index="1" name="recurse" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="process_string"> + <return type="String"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_scope"> + <return type="void"> + </return> + <argument index="0" name="scope" type="String"> + </argument> + <argument index="1" name="target" type="Object"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="ParseError" value="-32700" enum="ErrorCode"> + </constant> + <constant name="InvalidRequest" value="-32600" enum="ErrorCode"> + </constant> + <constant name="MethodNotFound" value="-32601" enum="ErrorCode"> + </constant> + <constant name="InvalidParams" value="-32602" enum="ErrorCode"> + </constant> + <constant name="InternalError" value="-32603" enum="ErrorCode"> + </constant> + </constants> +</class> diff --git a/doc/classes/MainLoop.xml b/doc/classes/MainLoop.xml index fedf77bfd2..181a99590a 100644 --- a/doc/classes/MainLoop.xml +++ b/doc/classes/MainLoop.xml @@ -61,6 +61,16 @@ Called before the program exits. </description> </method> + <method name="_global_menu_action" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="id" type="Variant"> + </argument> + <argument index="1" name="meta" type="Variant"> + </argument> + <description> + </description> + </method> <method name="_idle" qualifiers="virtual"> <return type="bool"> </return> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index c770e78c7c..938777a36b 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -497,6 +497,50 @@ Returns unobscured area of the window where interactive controls should be rendered. </description> </method> + <method name="global_menu_add_item"> + <return type="void"> + </return> + <argument index="0" name="menu" type="String"> + </argument> + <argument index="1" name="label" type="String"> + </argument> + <argument index="2" name="id" type="Variant"> + </argument> + <argument index="3" name="meta" type="Variant"> + </argument> + <description> + Add a new item with text "label" to global menu. Use "_dock" menu to add item to the macOS dock icon menu. + </description> + </method> + <method name="global_menu_add_separator"> + <return type="void"> + </return> + <argument index="0" name="menu" type="String"> + </argument> + <description> + Add a separator between items. Separators also occupy an index. + </description> + </method> + <method name="global_menu_clear"> + <return type="void"> + </return> + <argument index="0" name="menu" type="String"> + </argument> + <description> + Clear the global menu, in effect removing all items. + </description> + </method> + <method name="global_menu_remove_item"> + <return type="void"> + </return> + <argument index="0" name="menu" type="String"> + </argument> + <argument index="1" name="idx" type="int"> + </argument> + <description> + Removes the item at index "idx" from the global menu. Note that the indexes of items after the removed item are going to be shifted by one. + </description> + </method> <method name="has_environment" qualifiers="const"> <return type="bool"> </return> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index bf1835594b..86b874d8ee 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -180,6 +180,9 @@ This user directory is used for storing persistent data ([code]user://[/code] filesystem). If left empty, [code]user://[/code] resolves to a project-specific folder in Godot's own configuration folder (see [method OS.get_user_data_dir]). If a custom directory name is defined, this name will be used instead and appended to the system-specific user data directory (same parent folder as the Godot configuration folder documented in [method OS.get_user_data_dir]). The [member application/config/use_custom_user_dir] setting must be enabled for this to take effect. </member> + <member name="application/config/description" type="String" setter="" getter="" default=""""> + The project's description, displayed as a tooltip in the Project Manager when hovering the project. + </member> <member name="application/config/icon" type="String" setter="" getter="" default=""""> Icon used for the project, set when project loads. Exporters will also use this icon when possible. </member> @@ -412,6 +415,8 @@ <member name="editor/active" type="bool" setter="" getter="" default="false"> Internal editor setting, don't touch. </member> + <member name="editor/script_templates_search_path" type="String" setter="" getter="" default=""res://script_templates""> + </member> <member name="editor/search_in_file_extensions" type="PoolStringArray" setter="" getter="" default="PoolStringArray( "gd", "shader" )"> </member> <member name="gui/common/default_scroll_deadzone" type="int" setter="" getter="" default="0"> diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index 1302c1e6bf..ed43f83f05 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -324,6 +324,15 @@ Emitted when files are dragged from the OS file manager and dropped in the game window. The arguments are a list of file paths and the identifier of the screen where the drag originated. </description> </signal> + <signal name="global_menu_action"> + <argument index="0" name="id" type="Nil"> + </argument> + <argument index="1" name="meta" type="Nil"> + </argument> + <description> + Emitted whenever global menu item is clicked. + </description> + </signal> <signal name="idle_frame"> <description> Emitted immediately before [method Node._process] is called on every node in the [SceneTree]. diff --git a/doc/classes/SpriteBase3D.xml b/doc/classes/SpriteBase3D.xml index 5529da909d..15d5d7beb4 100644 --- a/doc/classes/SpriteBase3D.xml +++ b/doc/classes/SpriteBase3D.xml @@ -46,6 +46,8 @@ <member name="axis" type="int" setter="set_axis" getter="get_axis" enum="Vector3.Axis" default="2"> The direction in which the front of the texture faces. </member> + <member name="billboard" type="int" setter="set_billboard_mode" getter="get_billboard_mode" enum="SpatialMaterial.BillboardMode" default="0"> + </member> <member name="centered" type="bool" setter="set_centered" getter="is_centered" default="true"> If [code]true[/code], texture will be centered. </member> diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml index 9916d25af5..6ebc389ed7 100644 --- a/doc/classes/Transform.xml +++ b/doc/classes/Transform.xml @@ -144,7 +144,7 @@ <argument index="0" name="v" type="Variant"> </argument> <description> - Transforms the given [Vector3], [Plane], or [AABB] by this transform. + Transforms the given [Vector3], [Plane], [AABB], or [PoolVector3Array] by this transform. </description> </method> <method name="xform_inv"> @@ -153,7 +153,7 @@ <argument index="0" name="v" type="Variant"> </argument> <description> - Inverse-transforms the given [Vector3], [Plane], or [AABB] by this transform. + Inverse-transforms the given [Vector3], [Plane], [AABB], or [PoolVector3Array] by this transform. </description> </method> </methods> diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index f6fce1aaa1..580da080b3 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -146,7 +146,7 @@ <argument index="0" name="v" type="Variant"> </argument> <description> - Transforms the given [Vector2] or [Rect2] by this transform. + Transforms the given [Vector2], [Rect2], or [PoolVector2Array] by this transform. </description> </method> <method name="xform_inv"> @@ -155,7 +155,7 @@ <argument index="0" name="v" type="Variant"> </argument> <description> - Inverse-transforms the given [Vector2] or [Rect2] by this transform. + Inverse-transforms the given [Vector2], [Rect2], or [PoolVector2Array] by this transform. </description> </method> </methods> diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index 56b4b21525..04deae6bf5 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -136,6 +136,15 @@ Returns the column's icon's maximum width. </description> </method> + <method name="get_icon_modulate" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + Returns the [Color] modulating the column's icon. + </description> + </method> <method name="get_icon_region" qualifiers="const"> <return type="Rect2"> </return> @@ -464,6 +473,17 @@ Sets the given column's icon's maximum width. </description> </method> + <method name="set_icon_modulate"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="modulate" type="Color"> + </argument> + <description> + Modulates the given column's icon with [code]modulate[/code]. + </description> + </method> <method name="set_icon_region"> <return type="void"> </return> diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 66c4849358..987ed9867b 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -215,7 +215,7 @@ <method name="posmodv"> <return type="Vector2"> </return> - <argument index="0" name="mod" type="float"> + <argument index="0" name="modv" type="Vector2"> </argument> <description> Returns a vector composed of the [code]fposmod[/code] of this vector's components and [code]modv[/code]'s components. @@ -310,7 +310,7 @@ </members> <constants> <constant name="AXIS_X" value="0"> - Enumerated value for the X axis. Returned by [method max_axis] and [method min_axis]. + Enumerated value for the X axis. </constant> <constant name="AXIS_Y" value="1"> Enumerated value for the Y axis. diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 4631eb7300..05ce6c43ae 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -214,7 +214,7 @@ <method name="posmodv"> <return type="Vector3"> </return> - <argument index="0" name="mod" type="float"> + <argument index="0" name="modv" type="Vector3"> </argument> <description> Returns a vector composed of the [code]fposmod[/code] of this vector's components and [code]modv[/code]'s components. @@ -317,10 +317,10 @@ Enumerated value for the X axis. Returned by [method max_axis] and [method min_axis]. </constant> <constant name="AXIS_Y" value="1"> - Enumerated value for the Y axis. + Enumerated value for the Y axis. Returned by [method max_axis] and [method min_axis]. </constant> <constant name="AXIS_Z" value="2"> - Enumerated value for the Z axis. + Enumerated value for the Z axis. Returned by [method max_axis] and [method min_axis]. </constant> <constant name="ZERO" value="Vector3( 0, 0, 0 )"> Zero vector. diff --git a/doc/classes/VisualShaderNodeCustom.xml b/doc/classes/VisualShaderNodeCustom.xml index 9067097f0b..9e58abae97 100644 --- a/doc/classes/VisualShaderNodeCustom.xml +++ b/doc/classes/VisualShaderNodeCustom.xml @@ -13,6 +13,7 @@ [/codeblock] </description> <tutorials> + <link>http://docs.godotengine.org/en/latest/tutorials/plugins/editor/visual_shader_plugins.html</link> </tutorials> <methods> <method name="_get_category" qualifiers="virtual"> |