Browse Source

classref: Sync with current source

[ci skip]
Rémi Verschelde 7 years ago
parent
commit
552ed07cfd

+ 67 - 67
doc/classes/@Global Scope.xml

@@ -863,199 +863,199 @@
 		<constant name="KEY_MASK_GROUP_SWITCH" value="1073741824">
 			Group Switch Key Mask
 		</constant>
-		<constant name="BUTTON_LEFT" value="1" enum="">
+		<constant name="BUTTON_LEFT" value="1">
 			Left Mouse Button
 		</constant>
-		<constant name="BUTTON_RIGHT" value="2" enum="">
+		<constant name="BUTTON_RIGHT" value="2">
 			Right Mouse Button
 		</constant>
-		<constant name="BUTTON_MIDDLE" value="3" enum="">
+		<constant name="BUTTON_MIDDLE" value="3">
 			Middle Mouse Button
 		</constant>
-		<constant name="BUTTON_WHEEL_UP" value="4" enum="">
+		<constant name="BUTTON_WHEEL_UP" value="4">
 			Mouse wheel up
 		</constant>
-		<constant name="BUTTON_WHEEL_DOWN" value="5" enum="">
+		<constant name="BUTTON_WHEEL_DOWN" value="5">
 			Mouse wheel down
 		</constant>
-		<constant name="BUTTON_WHEEL_LEFT" value="6" enum="">
+		<constant name="BUTTON_WHEEL_LEFT" value="6">
 			Mouse wheel left button
 		</constant>
-		<constant name="BUTTON_WHEEL_RIGHT" value="7" enum="">
+		<constant name="BUTTON_WHEEL_RIGHT" value="7">
 			Mouse wheel right button
 		</constant>
-		<constant name="BUTTON_MASK_LEFT" value="1" enum="">
+		<constant name="BUTTON_MASK_LEFT" value="1">
 			Left Mouse Button Mask
 		</constant>
-		<constant name="BUTTON_MASK_RIGHT" value="2" enum="">
+		<constant name="BUTTON_MASK_RIGHT" value="2">
 			Right Mouse Button Mask
 		</constant>
-		<constant name="BUTTON_MASK_MIDDLE" value="4" enum="">
+		<constant name="BUTTON_MASK_MIDDLE" value="4">
 			Middle Mouse Button Mask
 		</constant>
-		<constant name="JOY_BUTTON_0" value="0" enum="">
+		<constant name="JOY_BUTTON_0" value="0">
 			Joypad Button 0
 		</constant>
-		<constant name="JOY_BUTTON_1" value="1" enum="">
+		<constant name="JOY_BUTTON_1" value="1">
 			Joypad Button 1
 		</constant>
-		<constant name="JOY_BUTTON_2" value="2" enum="">
+		<constant name="JOY_BUTTON_2" value="2">
 			Joypad Button 2
 		</constant>
-		<constant name="JOY_BUTTON_3" value="3" enum="">
+		<constant name="JOY_BUTTON_3" value="3">
 			Joypad Button 3
 		</constant>
-		<constant name="JOY_BUTTON_4" value="4" enum="">
+		<constant name="JOY_BUTTON_4" value="4">
 			Joypad Button 4
 		</constant>
-		<constant name="JOY_BUTTON_5" value="5" enum="">
+		<constant name="JOY_BUTTON_5" value="5">
 			Joypad Button 5
 		</constant>
-		<constant name="JOY_BUTTON_6" value="6" enum="">
+		<constant name="JOY_BUTTON_6" value="6">
 			Joypad Button 6
 		</constant>
-		<constant name="JOY_BUTTON_7" value="7" enum="">
+		<constant name="JOY_BUTTON_7" value="7">
 			Joypad Button 7
 		</constant>
-		<constant name="JOY_BUTTON_8" value="8" enum="">
+		<constant name="JOY_BUTTON_8" value="8">
 			Joypad Button 8
 		</constant>
-		<constant name="JOY_BUTTON_9" value="9" enum="">
+		<constant name="JOY_BUTTON_9" value="9">
 			Joypad Button 9
 		</constant>
-		<constant name="JOY_BUTTON_10" value="10" enum="">
+		<constant name="JOY_BUTTON_10" value="10">
 			Joypad Button 10
 		</constant>
-		<constant name="JOY_BUTTON_11" value="11" enum="">
+		<constant name="JOY_BUTTON_11" value="11">
 			Joypad Button 11
 		</constant>
-		<constant name="JOY_BUTTON_12" value="12" enum="">
+		<constant name="JOY_BUTTON_12" value="12">
 			Joypad Button 12
 		</constant>
-		<constant name="JOY_BUTTON_13" value="13" enum="">
+		<constant name="JOY_BUTTON_13" value="13">
 			Joypad Button 13
 		</constant>
-		<constant name="JOY_BUTTON_14" value="14" enum="">
+		<constant name="JOY_BUTTON_14" value="14">
 			Joypad Button 14
 		</constant>
-		<constant name="JOY_BUTTON_15" value="15" enum="">
+		<constant name="JOY_BUTTON_15" value="15">
 			Joypad Button 15
 		</constant>
-		<constant name="JOY_BUTTON_MAX" value="16" enum="">
+		<constant name="JOY_BUTTON_MAX" value="16">
 			Joypad Button 16
 		</constant>
-		<constant name="JOY_SONY_CIRCLE" value="1" enum="">
+		<constant name="JOY_SONY_CIRCLE" value="1">
 			DUALSHOCK circle button
 		</constant>
-		<constant name="JOY_SONY_X" value="0" enum="">
+		<constant name="JOY_SONY_X" value="0">
 			DUALSHOCK X button
 		</constant>
-		<constant name="JOY_SONY_SQUARE" value="2" enum="">
+		<constant name="JOY_SONY_SQUARE" value="2">
 			DUALSHOCK square button
 		</constant>
-		<constant name="JOY_SONY_TRIANGLE" value="3" enum="">
+		<constant name="JOY_SONY_TRIANGLE" value="3">
 			DUALSHOCK triangle button
 		</constant>
-		<constant name="JOY_XBOX_B" value="1" enum="">
+		<constant name="JOY_XBOX_B" value="1">
 			XBOX controller B button
 		</constant>
-		<constant name="JOY_XBOX_A" value="0" enum="">
+		<constant name="JOY_XBOX_A" value="0">
 			XBOX controller A button
 		</constant>
-		<constant name="JOY_XBOX_X" value="2" enum="">
+		<constant name="JOY_XBOX_X" value="2">
 			XBOX controller X button
 		</constant>
-		<constant name="JOY_XBOX_Y" value="3" enum="">
+		<constant name="JOY_XBOX_Y" value="3">
 			XBOX controller Y button
 		</constant>
-		<constant name="JOY_DS_A" value="1" enum="">
+		<constant name="JOY_DS_A" value="1">
 			DualShock controller A button
 		</constant>
-		<constant name="JOY_DS_B" value="0" enum="">
+		<constant name="JOY_DS_B" value="0">
 			DualShock controller B button
 		</constant>
-		<constant name="JOY_DS_X" value="3" enum="">
+		<constant name="JOY_DS_X" value="3">
 			DualShock controller X button
 		</constant>
-		<constant name="JOY_DS_Y" value="2" enum="">
+		<constant name="JOY_DS_Y" value="2">
 			DualShock controller Y button
 		</constant>
-		<constant name="JOY_SELECT" value="10" enum="">
+		<constant name="JOY_SELECT" value="10">
 			Joypad Button Select
 		</constant>
-		<constant name="JOY_START" value="11" enum="">
+		<constant name="JOY_START" value="11">
 			Joypad Button Start
 		</constant>
-		<constant name="JOY_DPAD_UP" value="12" enum="">
+		<constant name="JOY_DPAD_UP" value="12">
 			Joypad DPad Up
 		</constant>
-		<constant name="JOY_DPAD_DOWN" value="13" enum="">
+		<constant name="JOY_DPAD_DOWN" value="13">
 			Joypad DPad Down
 		</constant>
-		<constant name="JOY_DPAD_LEFT" value="14" enum="">
+		<constant name="JOY_DPAD_LEFT" value="14">
 			Joypad DPad Left
 		</constant>
-		<constant name="JOY_DPAD_RIGHT" value="15" enum="">
+		<constant name="JOY_DPAD_RIGHT" value="15">
 			Joypad DPad Right
 		</constant>
-		<constant name="JOY_L" value="4" enum="">
+		<constant name="JOY_L" value="4">
 			Joypad Left Shoulder Button
 		</constant>
-		<constant name="JOY_L2" value="6" enum="">
+		<constant name="JOY_L2" value="6">
 			Joypad Left Trigger
 		</constant>
-		<constant name="JOY_L3" value="8" enum="">
+		<constant name="JOY_L3" value="8">
 			Joypad Left Stick Click
 		</constant>
-		<constant name="JOY_R" value="5" enum="">
+		<constant name="JOY_R" value="5">
 			Joypad Right Shoulder Button
 		</constant>
-		<constant name="JOY_R2" value="7" enum="">
+		<constant name="JOY_R2" value="7">
 			Joypad Right Trigger
 		</constant>
-		<constant name="JOY_R3" value="9" enum="">
+		<constant name="JOY_R3" value="9">
 			Joypad Right Stick Click
 		</constant>
-		<constant name="JOY_AXIS_0" value="0" enum="">
+		<constant name="JOY_AXIS_0" value="0">
 			Joypad Left Stick Horizontal Axis
 		</constant>
-		<constant name="JOY_AXIS_1" value="1" enum="">
+		<constant name="JOY_AXIS_1" value="1">
 			Joypad Left Stick Vertical Axis
 		</constant>
-		<constant name="JOY_AXIS_2" value="2" enum="">
+		<constant name="JOY_AXIS_2" value="2">
 			Joypad Right Stick Horizontal Axis
 		</constant>
-		<constant name="JOY_AXIS_3" value="3" enum="">
+		<constant name="JOY_AXIS_3" value="3">
 			Joypad Right Stick Vertical Axis
 		</constant>
-		<constant name="JOY_AXIS_4" value="4" enum="">
+		<constant name="JOY_AXIS_4" value="4">
 		</constant>
-		<constant name="JOY_AXIS_5" value="5" enum="">
+		<constant name="JOY_AXIS_5" value="5">
 		</constant>
-		<constant name="JOY_AXIS_6" value="6" enum="">
+		<constant name="JOY_AXIS_6" value="6">
 			Joypad Left Trigger Analog Axis
 		</constant>
-		<constant name="JOY_AXIS_7" value="7" enum="">
+		<constant name="JOY_AXIS_7" value="7">
 			Joypad Right Trigger Analog Axis
 		</constant>
-		<constant name="JOY_AXIS_MAX" value="8" enum="">
+		<constant name="JOY_AXIS_MAX" value="8">
 		</constant>
-		<constant name="JOY_ANALOG_LX" value="0" enum="">
+		<constant name="JOY_ANALOG_LX" value="0">
 			Joypad Left Stick Horizontal Axis
 		</constant>
-		<constant name="JOY_ANALOG_LY" value="1" enum="">
+		<constant name="JOY_ANALOG_LY" value="1">
 			Joypad Left Stick Vertical Axis
 		</constant>
-		<constant name="JOY_ANALOG_RX" value="2" enum="">
+		<constant name="JOY_ANALOG_RX" value="2">
 			Joypad Right Stick Horizontal Axis
 		</constant>
-		<constant name="JOY_ANALOG_RY" value="3" enum="">
+		<constant name="JOY_ANALOG_RY" value="3">
 			Joypad Right Stick Vertical Axis
 		</constant>
-		<constant name="JOY_ANALOG_L2" value="6" enum="">
+		<constant name="JOY_ANALOG_L2" value="6">
 			Joypad Left Analog Trigger
 		</constant>
-		<constant name="JOY_ANALOG_R2" value="7" enum="">
+		<constant name="JOY_ANALOG_R2" value="7">
 			Joypad Right Analog Trigger
 		</constant>
 		<constant name="OK" value="0">
@@ -1377,7 +1377,7 @@
 			Variable is of type [PoolColorArray].
 		</constant>
 		<constant name="TYPE_MAX" value="27">
-		</constant>
 			Marker for end of type constants.
+		</constant>
 	</constants>
 </class>

+ 54 - 8
doc/classes/Environment.xml

@@ -238,6 +238,12 @@
 			<description>
 			</description>
 		</method>
+		<method name="get_ssao_blur" qualifiers="const">
+			<return type="int" enum="Environment.SSAOBlur">
+			</return>
+			<description>
+			</description>
+		</method>
 		<method name="get_ssao_color" qualifiers="const">
 			<return type="Color">
 			</return>
@@ -250,6 +256,12 @@
 			<description>
 			</description>
 		</method>
+		<method name="get_ssao_edge_sharpness" qualifiers="const">
+			<return type="float">
+			</return>
+			<description>
+			</description>
+		</method>
 		<method name="get_ssao_intensity" qualifiers="const">
 			<return type="float">
 			</return>
@@ -262,6 +274,12 @@
 			<description>
 			</description>
 		</method>
+		<method name="get_ssao_quality" qualifiers="const">
+			<return type="int" enum="Environment.SSAOQuality">
+			</return>
+			<description>
+			</description>
+		</method>
 		<method name="get_ssao_radius" qualifiers="const">
 			<return type="float">
 			</return>
@@ -408,12 +426,6 @@
 			<description>
 			</description>
 		</method>
-		<method name="is_ssao_blur_enabled" qualifiers="const">
-			<return type="bool">
-			</return>
-			<description>
-			</description>
-		</method>
 		<method name="is_ssao_enabled" qualifiers="const">
 			<return type="bool">
 			</return>
@@ -813,7 +825,7 @@
 		<method name="set_ssao_blur">
 			<return type="void">
 			</return>
-			<argument index="0" name="enabled" type="bool">
+			<argument index="0" name="mode" type="int" enum="Environment.SSAOBlur">
 			</argument>
 			<description>
 			</description>
@@ -834,6 +846,14 @@
 			<description>
 			</description>
 		</method>
+		<method name="set_ssao_edge_sharpness">
+			<return type="void">
+			</return>
+			<argument index="0" name="edge_sharpness" type="float">
+			</argument>
+			<description>
+			</description>
+		</method>
 		<method name="set_ssao_enabled">
 			<return type="void">
 			</return>
@@ -858,6 +878,14 @@
 			<description>
 			</description>
 		</method>
+		<method name="set_ssao_quality">
+			<return type="void">
+			</return>
+			<argument index="0" name="quality" type="int" enum="Environment.SSAOQuality">
+			</argument>
+			<description>
+			</description>
+		</method>
 		<method name="set_ssao_radius">
 			<return type="void">
 			</return>
@@ -1172,10 +1200,12 @@
 		</member>
 		<member name="ssao_bias" type="float" setter="set_ssao_bias" getter="get_ssao_bias">
 		</member>
-		<member name="ssao_blur" type="bool" setter="set_ssao_blur" getter="is_ssao_blur_enabled">
+		<member name="ssao_blur" type="int" setter="set_ssao_blur" getter="is_ssao_blur_enabled" enum="Environment.SSAOBlur">
 		</member>
 		<member name="ssao_color" type="Color" setter="set_ssao_color" getter="get_ssao_color">
 		</member>
+		<member name="ssao_edge_sharpness" type="float" setter="set_ssao_edge_sharpness" getter="get_ssao_edge_sharpness">
+		</member>
 		<member name="ssao_enabled" type="bool" setter="set_ssao_enabled" getter="is_ssao_enabled">
 		</member>
 		<member name="ssao_intensity" type="float" setter="set_ssao_intensity" getter="get_ssao_intensity">
@@ -1184,6 +1214,8 @@
 		</member>
 		<member name="ssao_light_affect" type="float" setter="set_ssao_direct_light_affect" getter="get_ssao_direct_light_affect">
 		</member>
+		<member name="ssao_quality" type="int" setter="set_ssao_quality" getter="get_ssao_quality" enum="Environment.SSAOQuality">
+		</member>
 		<member name="ssao_radius" type="float" setter="set_ssao_radius" getter="get_ssao_radius">
 		</member>
 		<member name="ssao_radius2" type="float" setter="set_ssao_radius2" getter="get_ssao_radius2">
@@ -1253,5 +1285,19 @@
 		<constant name="DOF_BLUR_QUALITY_HIGH" value="2">
 			High depth-of-field blur quality.
 		</constant>
+		<constant name="SSAO_BLUR_DISABLED" value="0">
+		</constant>
+		<constant name="SSAO_BLUR_1x1" value="1">
+		</constant>
+		<constant name="SSAO_BLUR_2x2" value="2">
+		</constant>
+		<constant name="SSAO_BLUR_3x3" value="3">
+		</constant>
+		<constant name="SSAO_QUALITY_LOW" value="0">
+		</constant>
+		<constant name="SSAO_QUALITY_MEDIUM" value="1">
+		</constant>
+		<constant name="SSAO_QUALITY_HIGH" value="2">
+		</constant>
 	</constants>
 </class>

+ 1 - 1
doc/classes/ParallaxLayer.xml

@@ -64,7 +64,7 @@
 			The ParallaxLayer's [Texture] mirroring. Useful for creating an infinite scrolling background. If an axis is set to [code]0[/code] the [Texture] will not be mirrored. Default value: [code](0, 0)[/code].
 		</member>
 		<member name="motion_offset" type="Vector2" setter="set_motion_offset" getter="get_motion_offset">
-			 The ParallaxLayer's offset relative to the parent ParallaxBackground's [member ParallaxBackground.scroll_offset].
+			The ParallaxLayer's offset relative to the parent ParallaxBackground's [member ParallaxBackground.scroll_offset].
 		</member>
 		<member name="motion_scale" type="Vector2" setter="set_motion_scale" getter="get_motion_scale">
 			Multiplies the ParallaxLayer's motion. If an axis is set to [code]0[/code] it will not scroll.

+ 1 - 1
doc/classes/Quat.xml

@@ -127,7 +127,7 @@
 			<argument index="1" name="t" type="float">
 			</argument>
 			<description>
-				Performs a spherical-linear interpolation with another quaterion without checking if the rotation path is not bigger than 90°. 
+				Performs a spherical-linear interpolation with another quaterion without checking if the rotation path is not bigger than 90°.
 			</description>
 		</method>
 		<method name="xform">

+ 18 - 0
doc/classes/RayCast.xml

@@ -85,6 +85,14 @@
 				Returns the collision mask for this ray.
 			</description>
 		</method>
+		<method name="get_collision_mask_bit" qualifiers="const">
+			<return type="bool">
+			</return>
+			<argument index="0" name="bit" type="int">
+			</argument>
+			<description>
+			</description>
+		</method>
 		<method name="get_collision_normal" qualifiers="const">
 			<return type="Vector3">
 			</return>
@@ -156,6 +164,16 @@
 				Set the mask to filter objects. Only objects in at least one collision layer enabled in the mask will be detected.
 			</description>
 		</method>
+		<method name="set_collision_mask_bit">
+			<return type="void">
+			</return>
+			<argument index="0" name="bit" type="int">
+			</argument>
+			<argument index="1" name="value" type="bool">
+			</argument>
+			<description>
+			</description>
+		</method>
 		<method name="set_enabled">
 			<return type="void">
 			</return>

+ 18 - 0
doc/classes/RayCast2D.xml

@@ -84,6 +84,14 @@
 				Returns the collision mask for this ray.
 			</description>
 		</method>
+		<method name="get_collision_mask_bit" qualifiers="const">
+			<return type="bool">
+			</return>
+			<argument index="0" name="bit" type="int">
+			</argument>
+			<description>
+			</description>
+		</method>
 		<method name="get_collision_normal" qualifiers="const">
 			<return type="Vector2">
 			</return>
@@ -162,6 +170,16 @@
 				Set the mask to filter objects. Only objects in at least one collision layer enabled in the mask will be detected.
 			</description>
 		</method>
+		<method name="set_collision_mask_bit">
+			<return type="void">
+			</return>
+			<argument index="0" name="bit" type="int">
+			</argument>
+			<argument index="1" name="value" type="bool">
+			</argument>
+			<description>
+			</description>
+		</method>
 		<method name="set_enabled">
 			<return type="void">
 			</return>

+ 16 - 0
doc/classes/TextEdit.xml

@@ -239,6 +239,12 @@
 				Returns true if highlight all occurrences is enabled.
 			</description>
 		</method>
+		<method name="is_highlight_current_line_enabled" qualifiers="const">
+			<return type="bool">
+			</return>
+			<description>
+			</description>
+		</method>
 		<method name="is_overriding_selected_font_color" qualifiers="const">
 			<return type="bool">
 			</return>
@@ -340,6 +346,14 @@
 				Set to enable highlighting all occurrences of the current selection.
 			</description>
 		</method>
+		<method name="set_highlight_current_line">
+			<return type="void">
+			</return>
+			<argument index="0" name="enabled" type="bool">
+			</argument>
+			<description>
+			</description>
+		</method>
 		<method name="set_max_chars">
 			<return type="void">
 			</return>
@@ -435,6 +449,8 @@
 		</member>
 		<member name="highlight_all_occurrences" type="bool" setter="set_highlight_all_occurrences" getter="is_highlight_all_occurrences_enabled">
 		</member>
+		<member name="highlight_current_line" type="bool" setter="set_highlight_current_line" getter="is_highlight_current_line_enabled">
+		</member>
 		<member name="override_selected_font_color" type="bool" setter="set_override_selected_font_color" getter="is_overriding_selected_font_color">
 		</member>
 		<member name="show_line_numbers" type="bool" setter="set_show_line_numbers" getter="is_show_line_numbers_enabled">