summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2017-12-16 20:34:16 +0100
committerRémi Verschelde <rverschelde@gmail.com>2017-12-16 21:08:31 +0100
commitd03f35f1bc0ecf09d436ebb44356f8add5b95a3e (patch)
treee6f9cd25ec25e9fe0dbbd2618491208be47423c4 /doc
parentdb22aec51a86a562d167eeaadcd8b57bc89c9a88 (diff)
Bind TextEdit.deselect and update documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/Animation.xml2
-rw-r--r--doc/classes/BakedLightmap.xml77
-rw-r--r--doc/classes/BakedLightmapData.xml113
-rw-r--r--doc/classes/Curve.xml2
-rw-r--r--doc/classes/HTTPClient.xml3
-rw-r--r--doc/classes/Light.xml8
-rw-r--r--doc/classes/PacketPeer.xml4
-rw-r--r--doc/classes/SceneState.xml8
-rw-r--r--doc/classes/ScriptEditor.xml10
-rw-r--r--doc/classes/SpatialMaterial.xml10
-rw-r--r--doc/classes/TextEdit.xml7
-rw-r--r--doc/classes/TileMap.xml18
-rw-r--r--doc/classes/VisualServer.xml4
13 files changed, 257 insertions, 9 deletions
diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml
index dd248d18f7..f78b39eadb 100644
--- a/doc/classes/Animation.xml
+++ b/doc/classes/Animation.xml
@@ -321,7 +321,7 @@
<argument index="1" name="enabled" type="bool">
</argument>
<description>
- Enables/disables the given track. Tracks are enabled by default.
+ Enables/disables the given track. Tracks are enabled by default.
</description>
</method>
<method name="track_set_imported">
diff --git a/doc/classes/BakedLightmap.xml b/doc/classes/BakedLightmap.xml
new file mode 100644
index 0000000000..8084af3817
--- /dev/null
+++ b/doc/classes/BakedLightmap.xml
@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="BakedLightmap" inherits="VisualInstance" category="Core" version="3.0-beta">
+ <brief_description>
+ </brief_description>
+ <description>
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="bake">
+ <return type="int" enum="BakedLightmap.BakeError">
+ </return>
+ <argument index="0" name="from_node" type="Node" default="null">
+ </argument>
+ <argument index="1" name="create_visual_debug" type="bool" default="false">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="debug_bake">
+ <return type="void">
+ </return>
+ <description>
+ </description>
+ </method>
+ </methods>
+ <members>
+ <member name="bake_mode" type="int" setter="set_bake_mode" getter="get_bake_mode" enum="BakedLightmap.BakeMode">
+ </member>
+ <member name="bake_quality" type="int" setter="set_bake_quality" getter="get_bake_quality" enum="BakedLightmap.BakeQuality">
+ </member>
+ <member name="bake_subdiv" type="int" setter="set_bake_subdiv" getter="get_bake_subdiv" enum="BakedLightmap.Subdiv">
+ </member>
+ <member name="capture_subdiv" type="int" setter="set_capture_subdiv" getter="get_capture_subdiv" enum="BakedLightmap.Subdiv">
+ </member>
+ <member name="energy" type="float" setter="set_energy" getter="get_energy">
+ </member>
+ <member name="extents" type="Vector3" setter="set_extents" getter="get_extents">
+ </member>
+ <member name="hdr" type="bool" setter="set_hdr" getter="is_hdr">
+ </member>
+ <member name="image_path" type="String" setter="set_image_path" getter="get_image_path">
+ </member>
+ <member name="light_data" type="BakedLightmapData" setter="set_light_data" getter="get_light_data">
+ </member>
+ <member name="propagation" type="float" setter="set_propagation" getter="get_propagation">
+ </member>
+ </members>
+ <constants>
+ <constant name="SUBDIV_128" value="0" enum="Subdiv">
+ </constant>
+ <constant name="SUBDIV_256" value="1" enum="Subdiv">
+ </constant>
+ <constant name="SUBDIV_512" value="2" enum="Subdiv">
+ </constant>
+ <constant name="SUBDIV_1024" value="3" enum="Subdiv">
+ </constant>
+ <constant name="SUBDIV_2048" value="4" enum="Subdiv">
+ </constant>
+ <constant name="SUBDIV_4096" value="5" enum="Subdiv">
+ </constant>
+ <constant name="SUBDIV_MAX" value="6" enum="Subdiv">
+ </constant>
+ <constant name="BAKE_QUALITY_LOW" value="0" enum="BakeQuality">
+ </constant>
+ <constant name="BAKE_QUALITY_MEDIUM" value="1" enum="BakeQuality">
+ </constant>
+ <constant name="BAKE_QUALITY_HIGH" value="2" enum="BakeQuality">
+ </constant>
+ <constant name="BAKE_MODE_CONE_TRACE" value="0" enum="BakeMode">
+ </constant>
+ <constant name="BAKE_MODE_RAY_TRACE" value="1" enum="BakeMode">
+ </constant>
+ </constants>
+</class>
diff --git a/doc/classes/BakedLightmapData.xml b/doc/classes/BakedLightmapData.xml
new file mode 100644
index 0000000000..6997dcb0b2
--- /dev/null
+++ b/doc/classes/BakedLightmapData.xml
@@ -0,0 +1,113 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="BakedLightmapData" inherits="Resource" category="Core" version="3.0-beta">
+ <brief_description>
+ </brief_description>
+ <description>
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="add_user">
+ <return type="void">
+ </return>
+ <argument index="0" name="path" type="NodePath">
+ </argument>
+ <argument index="1" name="lightmap" type="Texture">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="clear_users">
+ <return type="void">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_bounds" qualifiers="const">
+ <return type="AABB">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_cell_space_transform" qualifiers="const">
+ <return type="Transform">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_cell_subdiv" qualifiers="const">
+ <return type="int">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_octree" qualifiers="const">
+ <return type="PoolByteArray">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_user_count" qualifiers="const">
+ <return type="int">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_user_lightmap" qualifiers="const">
+ <return type="Texture">
+ </return>
+ <argument index="0" name="user_idx" type="int">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="get_user_path" qualifiers="const">
+ <return type="NodePath">
+ </return>
+ <argument index="0" name="user_idx" type="int">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_bounds">
+ <return type="void">
+ </return>
+ <argument index="0" name="bounds" type="AABB">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_cell_space_transform">
+ <return type="void">
+ </return>
+ <argument index="0" name="xform" type="Transform">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_cell_subdiv">
+ <return type="void">
+ </return>
+ <argument index="0" name="cell_subdiv" type="int">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_octree">
+ <return type="void">
+ </return>
+ <argument index="0" name="octree" type="PoolByteArray">
+ </argument>
+ <description>
+ </description>
+ </method>
+ </methods>
+ <members>
+ <member name="energy" type="float" setter="set_energy" getter="get_energy">
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>
diff --git a/doc/classes/Curve.xml b/doc/classes/Curve.xml
index f7ef9a182c..8a007cc5cc 100644
--- a/doc/classes/Curve.xml
+++ b/doc/classes/Curve.xml
@@ -107,9 +107,9 @@
<return type="float">
</return>
<argument index="0" name="offset" type="float">
- Returns the y value for the point that would exist at x-position [code]offset[/code] along the curve using the baked cache. Bakes the curve's points if not already baked.
</argument>
<description>
+ Returns the y value for the point that would exist at x-position [code]offset[/code] along the curve using the baked cache. Bakes the curve's points if not already baked.
</description>
</method>
<method name="remove_point">
diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml
index 9d4b45a8d7..80f6966e12 100644
--- a/doc/classes/HTTPClient.xml
+++ b/doc/classes/HTTPClient.xml
@@ -26,7 +26,7 @@
</return>
<argument index="0" name="host" type="String">
</argument>
- <argument index="1" name="port" type="int">
+ <argument index="1" name="port" type="int" default="-1">
</argument>
<argument index="2" name="use_ssl" type="bool" default="false">
</argument>
@@ -35,6 +35,7 @@
<description>
Connect to a host. This needs to be done before any requests are sent.
The host should not have http:// prepended but will strip the protocol identifier if provided.
+ If no [code]port[/code] is specified (or [code]-1[/code] is used), it is automatically set to 80 for HTTP and 443 for HTTPS (if [code]use_ssl[/code] is enabled).
[code]verify_host[/code] will check the SSL identity of the host if set to [code]true[/code].
</description>
</method>
diff --git a/doc/classes/Light.xml b/doc/classes/Light.xml
index e4f92cc9b3..4aa39ffff6 100644
--- a/doc/classes/Light.xml
+++ b/doc/classes/Light.xml
@@ -15,6 +15,8 @@
<members>
<member name="editor_only" type="bool" setter="set_editor_only" getter="is_editor_only">
</member>
+ <member name="light_bake_mode" type="int" setter="set_bake_mode" getter="get_bake_mode" enum="Light.BakeMode">
+ </member>
<member name="light_color" type="Color" setter="set_color" getter="get_color">
</member>
<member name="light_cull_mask" type="int" setter="set_cull_mask" getter="get_cull_mask">
@@ -71,5 +73,11 @@
</constant>
<constant name="PARAM_MAX" value="15" enum="Param">
</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>
diff --git a/doc/classes/PacketPeer.xml b/doc/classes/PacketPeer.xml
index 891f0c9ffc..57d88d7ff8 100644
--- a/doc/classes/PacketPeer.xml
+++ b/doc/classes/PacketPeer.xml
@@ -18,7 +18,7 @@
Return the number of packets currently available in the ring-buffer.
</description>
</method>
- <method name="get_packet" qualifiers="const">
+ <method name="get_packet">
<return type="PoolByteArray">
</return>
<description>
@@ -32,7 +32,7 @@
Return the error state of the last packet received (via [method get_packet] and [method get_var]).
</description>
</method>
- <method name="get_var" qualifiers="const">
+ <method name="get_var">
<return type="Variant">
</return>
<description>
diff --git a/doc/classes/SceneState.xml b/doc/classes/SceneState.xml
index 4fcaaa23dc..f5cf2dbee4 100644
--- a/doc/classes/SceneState.xml
+++ b/doc/classes/SceneState.xml
@@ -88,6 +88,14 @@
Returns the list of group names associated with the node at [code]idx[/code].
</description>
</method>
+ <method name="get_node_index" qualifiers="const">
+ <return type="int">
+ </return>
+ <argument index="0" name="idx" type="int">
+ </argument>
+ <description>
+ </description>
+ </method>
<method name="get_node_instance" qualifiers="const">
<return type="PackedScene">
</return>
diff --git a/doc/classes/ScriptEditor.xml b/doc/classes/ScriptEditor.xml
index 0b035f90d2..81b0b3d0c3 100644
--- a/doc/classes/ScriptEditor.xml
+++ b/doc/classes/ScriptEditor.xml
@@ -57,6 +57,16 @@
Returns an array with all [Script] objects which are currently open in editor.
</description>
</method>
+ <method name="open_script_create_dialog">
+ <return type="void">
+ </return>
+ <argument index="0" name="base_name" type="String">
+ </argument>
+ <argument index="1" name="base_path" type="String">
+ </argument>
+ <description>
+ </description>
+ </method>
</methods>
<signals>
<signal name="editor_script_changed">
diff --git a/doc/classes/SpatialMaterial.xml b/doc/classes/SpatialMaterial.xml
index cf08b0daae..403a6dc930 100644
--- a/doc/classes/SpatialMaterial.xml
+++ b/doc/classes/SpatialMaterial.xml
@@ -75,6 +75,8 @@
</member>
<member name="emission_energy" type="float" setter="set_emission_energy" getter="get_emission_energy">
</member>
+ <member name="emission_on_uv2" type="bool" setter="set_flag" getter="get_flag">
+ </member>
<member name="emission_operator" type="int" setter="set_emission_operator" getter="get_emission_operator" enum="SpatialMaterial.EmissionOperator">
</member>
<member name="emission_texture" type="Texture" setter="set_texture" getter="get_texture">
@@ -305,13 +307,15 @@
</constant>
<constant name="FLAG_AO_ON_UV2" value="10" enum="Flags">
</constant>
- <constant name="FLAG_USE_ALPHA_SCISSOR" value="11" enum="Flags">
+ <constant name="FLAG_EMISSION_ON_UV2" value="11" enum="Flags">
+ </constant>
+ <constant name="FLAG_USE_ALPHA_SCISSOR" value="12" enum="Flags">
</constant>
<constant name="FLAG_TRIPLANAR_USE_WORLD" value="9" enum="Flags">
</constant>
- <constant name="FLAG_ALBEDO_TEXTURE_FORCE_SRGB" value="12" enum="Flags">
+ <constant name="FLAG_ALBEDO_TEXTURE_FORCE_SRGB" value="13" enum="Flags">
</constant>
- <constant name="FLAG_MAX" value="13" enum="Flags">
+ <constant name="FLAG_MAX" value="14" enum="Flags">
</constant>
<constant name="DIFFUSE_BURLEY" value="0" enum="DiffuseMode">
</constant>
diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml
index da30c4c7bd..85cbeaaa03 100644
--- a/doc/classes/TextEdit.xml
+++ b/doc/classes/TextEdit.xml
@@ -109,6 +109,13 @@
Cut the current selection.
</description>
</method>
+ <method name="deselect">
+ <return type="void">
+ </return>
+ <description>
+ Clears the current selection.
+ </description>
+ </method>
<method name="fold_all_lines">
<return type="void">
</return>
diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml
index 72cd56dc55..510a215fbc 100644
--- a/doc/classes/TileMap.xml
+++ b/doc/classes/TileMap.xml
@@ -182,6 +182,24 @@
<description>
</description>
</method>
+ <method name="update_bitmask_area">
+ <return type="void">
+ </return>
+ <argument index="0" name="arg0" type="Vector2">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="update_bitmask_region">
+ <return type="void">
+ </return>
+ <argument index="0" name="start" type="Vector2" default="Vector2( 0, 0 )">
+ </argument>
+ <argument index="1" name="end" type="Vector2" default="Vector2( 0, 0 )">
+ </argument>
+ <description>
+ </description>
+ </method>
<method name="world_to_map" qualifiers="const">
<return type="Vector2">
</return>
diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml
index 1a9dc3a669..0cba132de8 100644
--- a/doc/classes/VisualServer.xml
+++ b/doc/classes/VisualServer.xml
@@ -2315,7 +2315,9 @@
</constant>
<constant name="INSTANCE_GI_PROBE" value="7" enum="InstanceType">
</constant>
- <constant name="INSTANCE_MAX" value="8" enum="InstanceType">
+ <constant name="INSTANCE_LIGHTMAP_CAPTURE" value="8" enum="InstanceType">
+ </constant>
+ <constant name="INSTANCE_MAX" value="9" enum="InstanceType">
The max value for INSTANCE_* constants, used internally.
</constant>
<constant name="INSTANCE_GEOMETRY_MASK" value="30" enum="InstanceType">