Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-22 12:12:28 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

doc: Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde 2017-11-24 09:16:27 +01:00
parent 679b64fe48
commit 15ada56d73
31 changed files with 406 additions and 298 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/classes/@GlobalScope.xml
View File

@ -73,6 +73,9 @@
<member name="TranslationServer" type="TranslationServer" setter="" getter="">
[TranslationServer] singleton
</member>
<member name="VisualScriptEditor" type="VisualScriptEditor" setter="" getter="">
[VisualScriptEditor] singleton
</member>
<member name="VisualServer" type="VisualServer" setter="" getter="">
[VisualServer] singleton
</member>

52
doc/classes/Array.xml
View File

@ -88,6 +88,32 @@
Returns the last element of the array if the array is not empty (size&gt;0).
</description>
</method>
<method name="bsearch">
<return type="int">
</return>
<argument index="0" name="value" type="var">
</argument>
<argument index="1" name="before" type="bool" default="True">
</argument>
<description>
Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. Note that calling bsearch on an unsorted array results in unexpected behavior.
</description>
</method>
<method name="bsearch_custom">
<return type="int">
</return>
<argument index="0" name="value" type="var">
</argument>
<argument index="1" name="obj" type="Object">
</argument>
<argument index="2" name="func" type="String">
</argument>
<argument index="3" name="before" type="bool" default="True">
</argument>
<description>
Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return true if the first argument is less than the second, and return false otherwise. Note that calling bsearch on an unsorted array results in unexpected behavior.
</description>
</method>
<method name="clear">
<description>
Clear the array (resize to 0).
@ -260,32 +286,6 @@
Sort the array using a custom method and return reference to the array. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior.
</description>
</method>
<method name="bsearch">
<return type="int">
</return>
<argument index="0" name="value" type="var">
</argument>
<argument index="1" name="before" type="bool" default="true">
</argument>
<description>
Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. Note that calling bsearch on an unsorted array results in unexpected behavior.
</description>
</method>
<method name="bsearch_custom">
<return type="int">
</return>
<argument index="0" name="value" type="var">
</argument>
<argument index="1" name="obj" type="Object">
</argument>
<argument index="2" name="func" type="String">
</argument>
<argument index="3" name="before" type="bool" default="true">
</argument>
<description>
Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return true if the first argument is less than the second, and return false otherwise. Note that calling bsearch on an unsorted array results in unexpected behavior.
</description>
</method>
</methods>
<constants>
</constants>

2
doc/classes/Basis.xml
View File

@ -24,7 +24,7 @@
<method name="Basis">
<return type="Basis">
</return>
<argument index="0" name="euler" type="Vector3">
<argument index="0" name="from" type="Vector3">
</argument>
<description>
Create a rotation matrix (in the YXZ convention: first Z, then X, and Y last) from the specified Euler angles, given in the vector format as (X-angle, Y-angle, Z-angle).

47
doc/classes/CanvasItem.xml
View File

@ -271,39 +271,6 @@
Draw a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.
</description>
</method>
<method name="edit_get_state" qualifiers="const">
<return type="Variant">
</return>
<description>
Used for editing, returns an opaque value representing the transform state.
</description>
</method>
<method name="edit_rotate">
<return type="void">
</return>
<argument index="0" name="degrees" type="float">
</argument>
<description>
Used for editing, handle rotation.
</description>
</method>
<method name="edit_set_rect">
<return type="void">
</return>
<argument index="0" name="rect" type="Rect2">
</argument>
<description>
</description>
</method>
<method name="edit_set_state">
<return type="void">
</return>
<argument index="0" name="state" type="Variant">
</argument>
<description>
Set the transform state of this CanvasItem. For [Node2D], this is an [Array] with (in order) a [Vector2] for position, a float for rotation (radians) and another [Vector2] for scale. For [Control] this is a [Rect2] with the position and size.
</description>
</method>
<method name="get_canvas" qualifiers="const">
<return type="RID">
</return>
@ -346,20 +313,6 @@
Get the global transform matrix of this item in relation to the canvas.
</description>
</method>
<method name="edit_get_item_and_children_rect" qualifiers="const">
<return type="Rect2">
</return>
<description>
Get a [Rect2] with the boundaries of this item and its children.
</description>
</method>
<method name="edit_get_rect" qualifiers="const">
<return type="Rect2">
</return>
<description>
Return a rect containing the editable boundaries of the item.
</description>
</method>
<method name="get_light_mask" qualifiers="const">
<return type="int">
</return>

26
doc/classes/Color.xml
View File

@ -103,6 +103,19 @@
[/codeblock]
</description>
</method>
<method name="darkened">
<return type="Color">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
Returns a new color resulting from making this color darker by the specified percentage (0-1).
[codeblock]
var green = Color(0.0, 1.0, 0.0)
var darkgreen = green.darkened(0.2) # 20% darker than regular green
[/codeblock]
</description>
</method>
<method name="gray">
<return type="float">
</return>
@ -139,19 +152,6 @@
[/codeblock]
</description>
</method>
<method name="darkened">
<return type="Color">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
Returns a new color resulting from making this color darker by the specified percentage (0-1).
[codeblock]
var green = Color(0.0, 1.0, 0.0)
var darkgreen = green.darkened(0.2) # 20% darker than regular green
[/codeblock]
</description>
</method>
<method name="linear_interpolate">
<return type="Color">
</return>

4
doc/classes/Control.xml
View File

@ -909,6 +909,10 @@
<member name="focus_neighbour_top" type="NodePath" setter="set_focus_neighbour" getter="get_focus_neighbour">
Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab, the top arrow on the keyboard or top on a gamepad. The node must be a [code]Control[/code]. If this property is not set, Godot will give focus to the closest [code]Control[/code] to the bottom of this one.
</member>
<member name="focus_next" type="NodePath" setter="set_focus_next" getter="get_focus_next">
</member>
<member name="focus_previous" type="NodePath" setter="set_focus_previous" getter="get_focus_previous">
</member>
<member name="grow_horizontal" type="int" setter="set_h_grow_direction" getter="get_h_grow_direction" enum="Control.GrowDirection">
</member>
<member name="grow_vertical" type="int" setter="set_v_grow_direction" getter="get_v_grow_direction" enum="Control.GrowDirection">

48
doc/classes/EditorExportPlugin.xml
View File

@ -14,6 +14,12 @@
</return>
<argument index="0" name="features" type="PoolStringArray">
</argument>
<argument index="1" name="is_debug" type="bool">
</argument>
<argument index="2" name="path" type="String">
</argument>
<argument index="3" name="flags" type="int">
</argument>
<description>
</description>
</method>
@ -41,11 +47,53 @@
<description>
</description>
</method>
<method name="add_ios_bundle_file">
<return type="void">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
</description>
</method>
<method name="add_ios_cpp_code">
<return type="void">
</return>
<argument index="0" name="code" type="String">
</argument>
<description>
</description>
</method>
<method name="add_ios_framework">
<return type="void">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
</description>
</method>
<method name="add_ios_linker_flags">
<return type="void">
</return>
<argument index="0" name="flags" type="String">
</argument>
<description>
</description>
</method>
<method name="add_ios_plist_content">
<return type="void">
</return>
<argument index="0" name="plist_content" type="String">
</argument>
<description>
</description>
</method>
<method name="add_shared_object">
<return type="void">
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="tags" type="PoolStringArray">
</argument>
<description>
</description>
</method>

23
doc/classes/EditorScenePostImport.xml Normal file
View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorScenePostImport" inherits="Reference" category="Core" version="3.0-alpha">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="post_import" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="scene" type="Object">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>

6
doc/classes/ItemList.xml
View File

@ -514,6 +514,12 @@
Fired when a multiple selection is altered on a list allowing multiple selection.
</description>
</signal>
<signal name="rmb_clicked">
<argument index="0" name="at_position" type="Vector2">
</argument>
<description>
</description>
</signal>
</signals>
<constants>
<constant name="ICON_MODE_TOP" value="0">

32
doc/classes/Light.xml
View File

@ -137,6 +137,8 @@
</member>
<member name="light_energy" type="float" setter="set_param" getter="get_param">
</member>
<member name="light_indirect_energy" type="float" setter="set_param" getter="get_param">
</member>
<member name="light_negative" type="bool" setter="set_negative" getter="is_negative">
</member>
<member name="light_specular" type="float" setter="set_param" getter="get_param">
@ -155,33 +157,35 @@
<constants>
<constant name="PARAM_ENERGY" value="0">
</constant>
<constant name="PARAM_SPECULAR" value="1">
<constant name="PARAM_INDIRECT_ENERGY" value="1">
</constant>
<constant name="PARAM_RANGE" value="2">
<constant name="PARAM_SPECULAR" value="2">
</constant>
<constant name="PARAM_ATTENUATION" value="3">
<constant name="PARAM_RANGE" value="3">
</constant>
<constant name="PARAM_SPOT_ANGLE" value="4">
<constant name="PARAM_ATTENUATION" value="4">
</constant>
<constant name="PARAM_SPOT_ATTENUATION" value="5">
<constant name="PARAM_SPOT_ANGLE" value="5">
</constant>
<constant name="PARAM_CONTACT_SHADOW_SIZE" value="6">
<constant name="PARAM_SPOT_ATTENUATION" value="6">
</constant>
<constant name="PARAM_SHADOW_MAX_DISTANCE" value="7">
<constant name="PARAM_CONTACT_SHADOW_SIZE" value="7">
</constant>
<constant name="PARAM_SHADOW_SPLIT_1_OFFSET" value="8">
<constant name="PARAM_SHADOW_MAX_DISTANCE" value="8">
</constant>
<constant name="PARAM_SHADOW_SPLIT_2_OFFSET" value="9">
<constant name="PARAM_SHADOW_SPLIT_1_OFFSET" value="9">
</constant>
<constant name="PARAM_SHADOW_SPLIT_3_OFFSET" value="10">
<constant name="PARAM_SHADOW_SPLIT_2_OFFSET" value="10">
</constant>
<constant name="PARAM_SHADOW_NORMAL_BIAS" value="11">
<constant name="PARAM_SHADOW_SPLIT_3_OFFSET" value="11">
</constant>
<constant name="PARAM_SHADOW_BIAS" value="12">
<constant name="PARAM_SHADOW_NORMAL_BIAS" value="12">
</constant>
<constant name="PARAM_SHADOW_BIAS_SPLIT_SCALE" value="13">
<constant name="PARAM_SHADOW_BIAS" value="13">
</constant>
<constant name="PARAM_MAX" value="14">
<constant name="PARAM_SHADOW_BIAS_SPLIT_SCALE" value="14">
</constant>
<constant name="PARAM_MAX" value="15">
</constant>
</constants>
</class>

2
doc/classes/LineEdit.xml
View File

@ -274,7 +274,7 @@
<member name="editable" type="bool" setter="set_editable" getter="is_editable">
If [code]false[/code] existing text cannot be modified and new text cannot be added.
</member>
<member name="expand_to_len" type="bool" setter="set_expand_to_text_length" getter="get_expand_to_text_length">
<member name="expand_to_text_length" type="bool" setter="set_expand_to_text_length" getter="get_expand_to_text_length">
If [code]true[/code] the [LineEdit] width will increase to stay longer than the [member text]. It will [b]not[/b] compress if the [member text] is shortened.
</member>
<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" enum="Control.FocusMode">

9
doc/classes/Node2D.xml
View File

@ -20,15 +20,6 @@
Multiplies the current scale by the 'ratio' vector.
</description>
</method>
<method name="edit_set_pivot">
<return type="void">
</return>
<argument index="0" name="pivot" type="Vector2">
</argument>
<description>
Sets the node's pivot position.
</description>
</method>
<method name="get_angle_to" qualifiers="const">
<return type="float">
</return>

19
doc/classes/NodePath.xml
View File

@ -22,6 +22,18 @@
Create a NodePath from a string, e.g. "Path2D/PathFollow2D/Sprite:texture:size". A path is absolute if it starts with a slash. Absolute paths are only valid in the global scene tree, not within individual scenes. In a relative path, [code]"."[/code] and [code]".."[/code] indicate the current node and its parent.
</description>
</method>
<method name="get_as_property_path">
<return type="NodePath">
</return>
<description>
</description>
</method>
<method name="get_concatenated_subnames">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_name">
<return type="String">
</return>
@ -38,13 +50,6 @@
Get the number of node names which make up the path.
</description>
</method>
<method name="get_property">
<return type="String">
</return>
<description>
Get the path's property name, or an empty string if the path doesn't have a property.
</description>
</method>
<method name="get_subname">
<return type="String">
</return>

14
doc/classes/OS.xml
View File

@ -127,13 +127,6 @@
Returns the current screen index (0 padded).
</description>
</method>
<method name="get_user_data_dir" qualifiers="const">
<return type="String">
</return>
<description>
Returns the absolute directory path where user data is written ([code]user://[/code]).
</description>
</method>
<method name="get_date" qualifiers="const">
<return type="Dictionary">
</return>
@ -397,6 +390,13 @@
You can pass the output from [method get_datetime_from_unix_time] directly into this function. Daylight savings time (dst), if present, is ignored.
</description>
</method>
<method name="get_user_data_dir" qualifiers="const">
<return type="String">
</return>
<description>
Returns the absolute directory path where user data is written ([code]user://[/code]).
</description>
</method>
<method name="get_virtual_keyboard_height">
<return type="int">
</return>

18
doc/classes/Object.xml
View File

@ -178,6 +178,14 @@
- "method_name" is a name of method to which signal is connected.
</description>
</method>
<method name="get_indexed" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="property" type="NodePath">
</argument>
<description>
</description>
</method>
<method name="get_instance_id" qualifiers="const">
<return type="int">
</return>
@ -338,6 +346,16 @@
If set to true, signal emission is blocked.
</description>
</method>
<method name="set_indexed">
<return type="void">
</return>
<argument index="0" name="property" type="NodePath">
</argument>
<argument index="1" name="value" type="Variant">
</argument>
<description>
</description>
</method>
<method name="set_message_translation">
<return type="void">
</return>

28
doc/classes/Physics2DDirectSpaceState.xml
View File

@ -18,7 +18,7 @@
</argument>
<description>
Check whether the shape can travel to a point. If it can, the method will return an array with two floats: The first is the distance the shape can move in that direction without colliding, and the second is the distance at which it will collide.
If the shape can not move, the array will be empty.
If the shape can not move, the array will be empty.
</description>
</method>
<method name="collide_shape">
@ -61,8 +61,6 @@
</argument>
<argument index="3" name="collision_layer" type="int" default="2147483647">
</argument>
<argument index="4" name="type_mask" type="int" default="15">
</argument>
<description>
Check whether a point is inside any shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields:
shape: Shape index within the object the point is in.
@ -70,7 +68,7 @@
collider_id: Id of the object the point is in.
collider: Object the point is inside of.
rid: [RID] of the object the point is in.
Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK_* constants).
Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, or a bitmask representing the physics layers to check in.
</description>
</method>
<method name="intersect_ray">
@ -84,8 +82,6 @@
</argument>
<argument index="3" name="collision_layer" type="int" default="2147483647">
</argument>
<argument index="4" name="type_mask" type="int" default="15">
</argument>
<description>
Intersect a ray in a given space. The returned object is a dictionary with the following fields:
position: Place where ray is stopped.
@ -96,7 +92,7 @@
collider: Object against which the ray was stopped.
rid: [RID] of the object against which the ray was stopped.
If the ray did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead.
Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK_* constants).
Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, or a bitmask representing the physics layers to check in.
</description>
</method>
<method name="intersect_shape">
@ -118,23 +114,5 @@
</method>
</methods>
<constants>
<constant name="TYPE_MASK_STATIC_BODY" value="1">
Check for collisions with static bodies.
</constant>
<constant name="TYPE_MASK_KINEMATIC_BODY" value="2">
Check for collisions with kinematic bodies.
</constant>
<constant name="TYPE_MASK_RIGID_BODY" value="4">
Check for collisions with rigid bodies.
</constant>
<constant name="TYPE_MASK_CHARACTER_BODY" value="8">
Check for collisions with rigid bodies in character mode.
</constant>
<constant name="TYPE_MASK_COLLISION" value="15">
Check for collisions with any kind of bodies (but not areas).
</constant>
<constant name="TYPE_MASK_AREA" value="16">
Check for collisions with areas.
</constant>
</constants>
</class>

16
doc/classes/Physics2DShapeQueryParameters.xml
View File

@ -39,13 +39,6 @@
Return the current movement speed of the shape.
</description>
</method>
<method name="get_object_type_mask" qualifiers="const">
<return type="int">
</return>
<description>
Return the type of object the shape belongs to.
</description>
</method>
<method name="get_shape_rid" qualifiers="const">
<return type="RID">
</return>
@ -96,15 +89,6 @@
Set the current movement speed of the shape.
</description>
</method>
<method name="set_object_type_mask">
<return type="void">
</return>
<argument index="0" name="object_type_mask" type="int">
</argument>
<description>
Set the type of object the shape belongs to (see Physics2DDirectSpaceState.TYPE_MASK_*).
</description>
</method>
<method name="set_shape">
<return type="void">
</return>

14
doc/classes/PhysicsDirectSpaceState.xml
View File

@ -48,8 +48,6 @@
</argument>
<argument index="3" name="collision_layer" type="int" default="2147483647">
</argument>
<argument index="4" name="type_mask" type="int" default="15">
</argument>
<description>
</description>
</method>
@ -65,17 +63,5 @@
</method>
</methods>
<constants>
<constant name="TYPE_MASK_STATIC_BODY" value="1">
</constant>
<constant name="TYPE_MASK_KINEMATIC_BODY" value="2">
</constant>
<constant name="TYPE_MASK_RIGID_BODY" value="4">
</constant>
<constant name="TYPE_MASK_CHARACTER_BODY" value="8">
</constant>
<constant name="TYPE_MASK_COLLISION" value="15">
</constant>
<constant name="TYPE_MASK_AREA" value="16">
</constant>
</constants>
</class>

20
doc/classes/PhysicsShapeQueryParameters.xml
View File

@ -9,7 +9,7 @@
<demos>
</demos>
<methods>
<method name="get_collision_layer" qualifiers="const">
<method name="get_collision_mask" qualifiers="const">
<return type="int">
</return>
<description>
@ -27,12 +27,6 @@
<description>
</description>
</method>
<method name="get_object_type_mask" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_shape_rid" qualifiers="const">
<return type="RID">
</return>
@ -45,10 +39,10 @@
<description>
</description>
</method>
<method name="set_collision_layer">
<method name="set_collision_mask">
<return type="void">
</return>
<argument index="0" name="collision_layer" type="int">
<argument index="0" name="collision_mask" type="int">
</argument>
<description>
</description>
@ -69,14 +63,6 @@
<description>
</description>
</method>
<method name="set_object_type_mask">
<return type="void">
</return>
<argument index="0" name="object_type_mask" type="int">
</argument>
<description>
</description>
</method>
<method name="set_shape">
<return type="void">
</return>

23
doc/classes/RayCast.xml
View File

@ -107,13 +107,6 @@
Returns the collision point at which the ray intersects the closest object. Note: this point is in the [b]global[/b] coordinate system.
</description>
</method>
<method name="get_type_mask" qualifiers="const">
<return type="int">
</return>
<description>
Returns the type mask (types of objects to detect) for this ray. The value is a sum (bitwise OR'd) of constants available for [PhysicsDirectSpaceState].
</description>
</method>
<method name="is_colliding" qualifiers="const">
<return type="bool">
</return>
@ -183,15 +176,6 @@
Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions.
</description>
</method>
<method name="set_type_mask">
<return type="void">
</return>
<argument index="0" name="mask" type="int">
</argument>
<description>
Set the types of objects to detect. For [code]mask[/code] use a logic sum (OR operation) of constants defined in [PhysicsDirectSpaceState], eg. [code]PhysicsDirectSpaceState.TYPE_MASK_STATIC_BODY | PhysicsDirectSpaceState.TYPE_MASK_KINEMATIC_BODY[/code] to detect only those two types.
</description>
</method>
</methods>
<members>
<member name="cast_to" type="Vector3" setter="set_cast_to" getter="get_cast_to">
@ -203,13 +187,6 @@
<member name="enabled" type="bool" setter="set_enabled" getter="is_enabled">
If [code]true[/code], collisions will be reported. Default value: [code]false[/code].
</member>
<member name="type_mask" type="int" setter="set_type_mask" getter="get_type_mask">
Object types to detect using a logical sum (OR operation) of type constants defined in [Physics2DDirectSpaceState].
Example:
[codeblock]
RayCast.type_mask = Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY
[/codeblock]
</member>
</members>
<constants>
</constants>

23
doc/classes/RayCast2D.xml
View File

@ -113,13 +113,6 @@
Returns whether this ray should hit your parent node, if it's a body.
</description>
</method>
<method name="get_type_mask" qualifiers="const">
<return type="int">
</return>
<description>
Returns the type mask (types of objects to detect) for this ray. The value is a sum (bitwise OR'd) of constants available for [Physics2DDirectSpaceState].
</description>
</method>
<method name="is_colliding" qualifiers="const">
<return type="bool">
</return>
@ -198,15 +191,6 @@
Toggle whether this ray should hit your parent node, if it's a body.
</description>
</method>
<method name="set_type_mask">
<return type="void">
</return>
<argument index="0" name="mask" type="int">
</argument>
<description>
Set the types of objects to detect. For [code]mask[/code] use a logic sum (OR operation) of constants defined in [Physics2DDirectSpaceState], eg. [code]Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY[/code] to detect only those two types.
</description>
</method>
</methods>
<members>
<member name="cast_to" type="Vector2" setter="set_cast_to" getter="get_cast_to">
@ -221,13 +205,6 @@
<member name="exclude_parent" type="bool" setter="set_exclude_parent_body" getter="get_exclude_parent_body">
If [code]true[/code], the parent node will be excluded from collision detection. Default value: [code]true[/code].
</member>
<member name="type_mask" type="int" setter="set_type_mask" getter="get_type_mask">
Object types to detect using a logical sum (OR operation) of type constants defined in [Physics2DDirectSpaceState].
Example:
[codeblock]
RayCast.type_mask = Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY
[/codeblock]
</member>
</members>
<constants>
</constants>

16
doc/classes/RichTextLabel.xml
View File

@ -403,18 +403,18 @@
Triggered when the user clicks on content between [url] tags. If the meta is defined in text, e.g. [code][url={"data"="hi"}]hi[/url][/code], then the parameter for this signal will be a [String] type. If a particular type or an object is desired, the [method push_meta] method must be used to manually insert the data into the tag stack.
</description>
</signal>
<signal name="meta_hover_started">
<argument index="0" name="meta" type="Nil">
</argument>
<description>
Triggers when the mouse enters a meta tag.
</description>
</signal>
<signal name="meta_hover_ended">
<argument index="0" name="meta" type="Nil">
</argument>
<description>
Triggers when the mouse exits a meta tag.
Triggers when the mouse exits a meta tag.
</description>
</signal>
<signal name="meta_hover_started">
<argument index="0" name="meta" type="Nil">
</argument>
<description>
Triggers when the mouse enters a meta tag.
</description>
</signal>
</signals>

28
doc/classes/Tabs.xml
View File

@ -35,6 +35,18 @@
<description>
</description>
</method>
<method name="get_offset_buttons_visible" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="get_scrolling_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="get_tab_align" qualifiers="const">
<return type="int" enum="Tabs.TabAlign">
</return>
@ -69,6 +81,12 @@
<description>
</description>
</method>
<method name="get_tab_offset" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_tab_rect" qualifiers="const">
<return type="Rect2">
</return>
@ -113,6 +131,14 @@
<description>
</description>
</method>
<method name="set_scrolling_enabled">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_tab_align">
<return type="void">
</return>
@ -163,6 +189,8 @@
<members>
<member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab">
</member>
<member name="scrolling_enabled" type="bool" setter="set_scrolling_enabled" getter="get_scrolling_enabled">
</member>
<member name="tab_close_display_policy" type="int" setter="set_tab_close_display_policy" getter="get_tab_close_display_policy" enum="Tabs.CloseButtonDisplayPolicy">
</member>
</members>

80
doc/classes/TextEdit.xml
View File

@ -37,6 +37,14 @@
Add a keyword and its color.
</description>
</method>
<method name="can_fold" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="line" type="int">
</argument>
<description>
</description>
</method>
<method name="clear_colors">
<return type="void">
</return>
@ -137,6 +145,8 @@
</argument>
<argument index="1" name="adjust_viewport" type="bool" default="true">
</argument>
<argument index="2" name="can_be_hidden" type="bool" default="true">
</argument>
<description>
</description>
</method>
@ -147,6 +157,20 @@
Cut the current selection.
</description>
</method>
<method name="fold_all_lines">
<return type="void">
</return>
<description>
</description>
</method>
<method name="fold_line">
<return type="void">
</return>
<argument index="0" name="line" type="int">
</argument>
<description>
</description>
</method>
<method name="get_line" qualifiers="const">
<return type="String">
</return>
@ -239,6 +263,20 @@
Returns true if the context menu is enabled.
</description>
</method>
<method name="is_folded" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="line" type="int">
</argument>
<description>
</description>
</method>
<method name="is_hiding_enabled" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="is_highlight_all_occurrences_enabled" qualifiers="const">
<return type="bool">
</return>
@ -252,6 +290,14 @@
<description>
</description>
</method>
<method name="is_line_hidden" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="arg0" type="int">
</argument>
<description>
</description>
</method>
<method name="is_overriding_selected_font_color" qualifiers="const">
<return type="bool">
</return>
@ -360,6 +406,14 @@
Set the status of the context menu. When enabled, the context menu will appear when the [code]TextEdit[/code] is right clicked.
</description>
</method>
<method name="set_hiding_enabled">
<return type="void">
</return>
<argument index="0" name="enable" type="int">
</argument>
<description>
</description>
</method>
<method name="set_highlight_all_occurrences">
<return type="void">
</return>
@ -377,6 +431,16 @@
<description>
</description>
</method>
<method name="set_line_as_hidden">
<return type="void">
</return>
<argument index="0" name="line" type="int">
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_max_chars">
<return type="void">
</return>
@ -462,6 +526,20 @@
Perform undo operation.
</description>
</method>
<method name="unfold_line">
<return type="void">
</return>
<argument index="0" name="line" type="int">
</argument>
<description>
</description>
</method>
<method name="unhide_all_lines">
<return type="void">
</return>
<description>
</description>
</method>
</methods>
<members>
<member name="caret_blink" type="bool" setter="cursor_set_blink_enabled" getter="cursor_get_blink_enabled">
@ -472,6 +550,8 @@
</member>
<member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled">
</member>
<member name="hiding_enabled" type="int" setter="set_hiding_enabled" getter="is_hiding_enabled">
</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">

7
doc/classes/TileMap.xml
View File

@ -252,10 +252,12 @@
</argument>
<argument index="5" name="transpose" type="bool" default="false">
</argument>
<argument index="6" name="autotile_coord" type="Vector2" default="Vector2( 0, 0 )">
</argument>
<description>
Set the tile index for the cell referenced by its grid-based X and Y coordinates.
A tile index of -1 clears the cell.
Optionally, the tile can also be flipped over the X and Y coordinates or transposed.
Optionally, the tile can also be flipped over the X and Y coordinates, transposed, or be given autotile coordinates.
</description>
</method>
<method name="set_cell_size">
@ -505,9 +507,6 @@
<member name="occluder_light_mask" type="int" setter="set_occluder_light_mask" getter="get_occluder_light_mask">
The light mask assigned to all light occluders in the TileMap. The TileSet's light occluders will cast shadows only from Light2D(s) that have the same light mask(s).
</member>
<member name="tile_data" type="PoolIntArray" setter="_set_tile_data" getter="_get_tile_data">
A [PoolIntArray] containing
</member>
<member name="tile_set" type="TileSet" setter="set_tileset" getter="get_tileset">
The assigned [TileSet].
</member>

64
doc/classes/TileSet.xml
View File

@ -12,6 +12,48 @@
<demos>
</demos>
<methods>
<method name="_forward_subtile_selection" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="autotile_id" type="int">
</argument>
<argument index="1" name="bitmask" type="int">
</argument>
<argument index="2" name="tilemap" type="Object">
</argument>
<argument index="3" name="tile_location" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="_is_tile_bound" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="drawn_id" type="int">
</argument>
<argument index="1" name="neighbor_id" type="int">
</argument>
<description>
</description>
</method>
<method name="autotile_get_bitmask_mode" qualifiers="const">
<return type="int" enum="TileSet.BitmaskMode">
</return>
<argument index="0" name="arg0" type="int">
</argument>
<description>
</description>
</method>
<method name="autotile_set_bitmask_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int">
</argument>
<argument index="1" name="arg1" type="int" enum="TileSet.BitmaskMode">
</argument>
<description>
</description>
</method>
<method name="clear">
<return type="void">
</return>
@ -71,6 +113,8 @@
</argument>
<argument index="3" name="one_way" type="bool" default="false">
</argument>
<argument index="4" name="autotile_coord" type="Vector2" default="Vector2( 0, 0 )">
</argument>
<description>
</description>
</method>
@ -368,5 +412,25 @@
</method>
</methods>
<constants>
<constant name="BITMASK_2X2" value="0">
</constant>
<constant name="BITMASK_3X3" value="1">
</constant>
<constant name="BIND_TOPLEFT" value="1">
</constant>
<constant name="BIND_TOP" value="2">
</constant>
<constant name="BIND_TOPRIGHT" value="4">
</constant>
<constant name="BIND_LEFT" value="8">
</constant>
<constant name="BIND_RIGHT" value="32">
</constant>
<constant name="BIND_BOTTOMLEFT" value="64">
</constant>
<constant name="BIND_BOTTOM" value="128">
</constant>
<constant name="BIND_BOTTOMRIGHT" value="256">
</constant>
</constants>
</class>

10
doc/classes/Tween.xml
View File

@ -50,13 +50,13 @@
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="property" type="String">
<argument index="1" name="property" type="NodePath">
</argument>
<argument index="2" name="initial_val" type="Variant">
</argument>
<argument index="3" name="target" type="Object">
</argument>
<argument index="4" name="target_property" type="String">
<argument index="4" name="target_property" type="NodePath">
</argument>
<argument index="5" name="duration" type="float">
</argument>
@ -167,7 +167,7 @@
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="property" type="String">
<argument index="1" name="property" type="NodePath">
</argument>
<argument index="2" name="initial_val" type="Variant">
</argument>
@ -355,11 +355,11 @@
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="property" type="String">
<argument index="1" name="property" type="NodePath">
</argument>
<argument index="2" name="initial" type="Object">
</argument>
<argument index="3" name="initial_val" type="String">
<argument index="3" name="initial_val" type="NodePath">
</argument>
<argument index="4" name="final_val" type="Variant">
</argument>

28
doc/classes/VisualServer.xml
View File

@ -1942,33 +1942,33 @@
</constant>
<constant name="LIGHT_PARAM_ENERGY" value="0">
</constant>
<constant name="LIGHT_PARAM_SPECULAR" value="1">
<constant name="LIGHT_PARAM_SPECULAR" value="2">
</constant>
<constant name="LIGHT_PARAM_RANGE" value="2">
<constant name="LIGHT_PARAM_RANGE" value="3">
</constant>
<constant name="LIGHT_PARAM_ATTENUATION" value="3">
<constant name="LIGHT_PARAM_ATTENUATION" value="4">
</constant>
<constant name="LIGHT_PARAM_SPOT_ANGLE" value="4">
<constant name="LIGHT_PARAM_SPOT_ANGLE" value="5">
</constant>
<constant name="LIGHT_PARAM_SPOT_ATTENUATION" value="5">
<constant name="LIGHT_PARAM_SPOT_ATTENUATION" value="6">
</constant>
<constant name="LIGHT_PARAM_CONTACT_SHADOW_SIZE" value="6">
<constant name="LIGHT_PARAM_CONTACT_SHADOW_SIZE" value="7">
</constant>
<constant name="LIGHT_PARAM_SHADOW_MAX_DISTANCE" value="7">
<constant name="LIGHT_PARAM_SHADOW_MAX_DISTANCE" value="8">
</constant>
<constant name="LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET" value="8">
<constant name="LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET" value="9">
</constant>
<constant name="LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET" value="9">
<constant name="LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET" value="10">
</constant>
<constant name="LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET" value="10">
<constant name="LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET" value="11">
</constant>
<constant name="LIGHT_PARAM_SHADOW_NORMAL_BIAS" value="11">
<constant name="LIGHT_PARAM_SHADOW_NORMAL_BIAS" value="12">
</constant>
<constant name="LIGHT_PARAM_SHADOW_BIAS" value="12">
<constant name="LIGHT_PARAM_SHADOW_BIAS" value="13">
</constant>
<constant name="LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE" value="13">
<constant name="LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE" value="14">
</constant>
<constant name="LIGHT_PARAM_MAX" value="14">
<constant name="LIGHT_PARAM_MAX" value="15">
</constant>
<constant name="VIEWPORT_UPDATE_DISABLED" value="0">
</constant>

6
modules/gdnative/doc_classes/GDNativeLibrary.xml
View File

@ -33,12 +33,6 @@
<description>
</description>
</method>
<method name="is_current_library_statically_linked" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_singleton" qualifiers="const">
<return type="bool">
</return>

34
modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml
View File

@ -170,55 +170,55 @@
<constant name="LOGIC_CLAMP" value="46">
Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to `min(max(input, range_low), range_high)`
</constant>
<constant name="LOGIC_NEAREST_PO2" value="46">
<constant name="LOGIC_NEAREST_PO2" value="47">
Return the nearest power of 2 to the input.
</constant>
<constant name="OBJ_WEAKREF" value="47">
<constant name="OBJ_WEAKREF" value="48">
Create a [WeakRef] from the input.
</constant>
<constant name="FUNC_FUNCREF" value="48">
<constant name="FUNC_FUNCREF" value="49">
Create a [FuncRef] from the input.
</constant>
<constant name="TYPE_CONVERT" value="49">
<constant name="TYPE_CONVERT" value="50">
Convert between types.
</constant>
<constant name="TYPE_OF" value="50">
<constant name="TYPE_OF" value="51">
Return the type of the input as an integer. Check [enum Variant.Type] for the integers that might be returned.
</constant>
<constant name="TYPE_EXISTS" value="51">
<constant name="TYPE_EXISTS" value="52">
Checks if a type is registered in the [ClassDB].
</constant>
<constant name="TEXT_CHAR" value="52">
<constant name="TEXT_CHAR" value="53">
Return a character with the given ascii value.
</constant>
<constant name="TEXT_STR" value="53">
<constant name="TEXT_STR" value="54">
Convert the input to a string.
</constant>
<constant name="TEXT_PRINT" value="54">
<constant name="TEXT_PRINT" value="55">
Print the given string to the output window.
</constant>
<constant name="TEXT_PRINTERR" value="55">
<constant name="TEXT_PRINTERR" value="56">
Print the given string to the standard error output.
</constant>
<constant name="TEXT_PRINTRAW" value="56">
<constant name="TEXT_PRINTRAW" value="57">
Print the given string to the standard output, without adding a newline.
</constant>
<constant name="VAR_TO_STR" value="57">
<constant name="VAR_TO_STR" value="58">
Serialize a [Variant] to a string.
</constant>
<constant name="STR_TO_VAR" value="58">
<constant name="STR_TO_VAR" value="59">
Deserialize a [Variant] from a string serialized using [VAR_TO_STR].
</constant>
<constant name="VAR_TO_BYTES" value="59">
<constant name="VAR_TO_BYTES" value="60">
Serialize a [Variant] to a [PoolByteArray].
</constant>
<constant name="BYTES_TO_VAR" value="60">
<constant name="BYTES_TO_VAR" value="61">
Deserialize a [Variant] from a [PoolByteArray] serialized using [VAR_TO_BYTES].
</constant>
<constant name="COLORN" value="61">
<constant name="COLORN" value="62">
Return the [Color] with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc.
</constant>
<constant name="FUNC_MAX" value="62">
<constant name="FUNC_MAX" value="63">
The maximum value the [member function] property can have.
</constant>
</constants>

2
modules/visual_script/doc_classes/VisualScriptEditor.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptEditor" inherits="Object" category="Core" version="3.0.alpha.custom_build">
<class name="VisualScriptEditor" inherits="Object" category="Core" version="3.0-alpha">
<brief_description>
</brief_description>
<description>