Skip to content

Commit 14416c4

Browse files
BromeonBromeon
committed
Update XML docs to Godot 3.4
Sourced from downloadable documentation; godot --doctool yields different ones
1 parent 1e4ab8b commit 14416c4

File tree

560 files changed

+13136
-21353
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

560 files changed

+13136
-21353
lines changed

‎gdnative-bindings/docs/@GlobalScope.xml

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
2-
<class name="@GlobalScope" version="3.3">
2+
<class name="@GlobalScope" version="3.4">
33
<brief_description>
44
Global scope constants and variables.
55
</brief_description>
@@ -883,7 +883,7 @@
883883
<constant name="KEY_MASK_CTRL" value="268435456" enum="KeyModifierMask">
884884
Ctrl key mask.
885885
</constant>
886-
<constant name="KEY_MASK_CMD" value="268435456" enum="KeyModifierMask">
886+
<constant name="KEY_MASK_CMD" value="platform-dependent" enum="KeyModifierMask">
887887
Command key mask. On macOS, this is equivalent to [constant KEY_MASK_META]. On other platforms, this is equivalent to [constant KEY_MASK_CTRL]. This mask should be preferred to [constant KEY_MASK_META] or [constant KEY_MASK_CTRL] for system shortcuts as it handles all platforms correctly.
888888
</constant>
889889
<constant name="KEY_MASK_KPAD" value="536870912" enum="KeyModifierMask">
@@ -1003,7 +1003,10 @@
10031003
<constant name="JOY_BUTTON_21" value="21" enum="JoystickList">
10041004
Gamepad button 21.
10051005
</constant>
1006-
<constant name="JOY_BUTTON_MAX" value="22" enum="JoystickList">
1006+
<constant name="JOY_BUTTON_22" value="22" enum="JoystickList">
1007+
Gamepad button 22.
1008+
</constant>
1009+
<constant name="JOY_BUTTON_MAX" value="23" enum="JoystickList">
10071010
Represents the maximum number of joystick buttons supported.
10081011
</constant>
10091012
<constant name="JOY_SONY_CIRCLE" value="1" enum="JoystickList">
@@ -1081,22 +1084,25 @@
10811084
<constant name="JOY_DPAD_RIGHT" value="15" enum="JoystickList">
10821085
Gamepad DPad right.
10831086
</constant>
1084-
<constant name="JOY_MISC1" value="16" enum="JoystickList">
1087+
<constant name="JOY_GUIDE" value="16" enum="JoystickList">
1088+
Gamepad SDL guide button.
1089+
</constant>
1090+
<constant name="JOY_MISC1" value="17" enum="JoystickList">
10851091
Gamepad SDL miscellaneous button.
10861092
</constant>
1087-
<constant name="JOY_PADDLE1" value="17" enum="JoystickList">
1093+
<constant name="JOY_PADDLE1" value="18" enum="JoystickList">
10881094
Gamepad SDL paddle 1 button.
10891095
</constant>
1090-
<constant name="JOY_PADDLE2" value="18" enum="JoystickList">
1096+
<constant name="JOY_PADDLE2" value="19" enum="JoystickList">
10911097
Gamepad SDL paddle 2 button.
10921098
</constant>
1093-
<constant name="JOY_PADDLE3" value="19" enum="JoystickList">
1099+
<constant name="JOY_PADDLE3" value="20" enum="JoystickList">
10941100
Gamepad SDL paddle 3 button.
10951101
</constant>
1096-
<constant name="JOY_PADDLE4" value="20" enum="JoystickList">
1102+
<constant name="JOY_PADDLE4" value="21" enum="JoystickList">
10971103
Gamepad SDL paddle 4 button.
10981104
</constant>
1099-
<constant name="JOY_TOUCHPAD" value="21" enum="JoystickList">
1105+
<constant name="JOY_TOUCHPAD" value="22" enum="JoystickList">
11001106
Gamepad SDL touchpad button.
11011107
</constant>
11021108
<constant name="JOY_L" value="4" enum="JoystickList">
@@ -1364,7 +1370,7 @@
13641370
Hints that an integer or float property should be within a range specified via the hint string [code]"min,max"[/code] or [code]"min,max,step"[/code]. The hint string can optionally include [code]"or_greater"[/code] and/or [code]"or_lesser"[/code] to allow manual input going respectively above the max or below the min values. Example: [code]"-360,360,1,or_greater,or_lesser"[/code].
13651371
</constant>
13661372
<constant name="PROPERTY_HINT_EXP_RANGE" value="2" enum="PropertyHint">
1367-
Hints that an integer or float property should be within an exponential range specified via the hint string [code]"min,max"[/code] or [code]"min,max,step"[/code]. The hint string can optionally include [code]"or_greater"[/code] and/or [code]"or_lesser"[/code] to allow manual input going respectively above the max or below the min values. Example: [code]"0.01,100,0.01,or_greater"[/code].
1373+
Hints that a float property should be within an exponential range specified via the hint string [code]"min,max"[/code] or [code]"min,max,step"[/code]. The hint string can optionally include [code]"or_greater"[/code] and/or [code]"or_lesser"[/code] to allow manual input going respectively above the max or below the min values. Example: [code]"0.01,100,0.01,or_greater"[/code].
13681374
</constant>
13691375
<constant name="PROPERTY_HINT_ENUM" value="3" enum="PropertyHint">
13701376
Hints that an integer, float or string property is an enumerated value to pick in a list specified via a hint string such as [code]"Hello,Something,Else"[/code].

‎gdnative-bindings/docs/AABB.xml

Lines changed: 42 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
2-
<class name="AABB" version="3.3">
2+
<class name="AABB" version="3.4">
33
<brief_description>
44
Axis-Aligned Bounding Box.
55
</brief_description>
@@ -9,198 +9,160 @@
99
[b]Note:[/b] Unlike [Rect2], [AABB] does not have a variant that uses integer coordinates.
1010
</description>
1111
<tutorials>
12-
<link title="Math tutorial index">https://docs.godotengine.org/en/3.3/tutorials/math/index.html</link>
13-
<link title="Vector math">https://docs.godotengine.org/en/3.3/tutorials/math/vector_math.html</link>
14-
<link title="Advanced vector math">https://docs.godotengine.org/en/3.3/tutorials/math/vectors_advanced.html</link>
12+
<link title="Math tutorial index">https://docs.godotengine.org/en/3.4/tutorials/math/index.html</link>
13+
<link title="Vector math">https://docs.godotengine.org/en/3.4/tutorials/math/vector_math.html</link>
14+
<link title="Advanced vector math">https://docs.godotengine.org/en/3.4/tutorials/math/vectors_advanced.html</link>
1515
</tutorials>
1616
<methods>
1717
<method name="AABB">
18-
<return type="AABB">
19-
</return>
20-
<argument index="0" name="position" type="Vector3">
21-
</argument>
22-
<argument index="1" name="size" type="Vector3">
23-
</argument>
18+
<return type="AABB" />
19+
<argument index="0" name="position" type="Vector3" />
20+
<argument index="1" name="size" type="Vector3" />
2421
<description>
2522
Constructs an [AABB] from a position and size.
2623
</description>
2724
</method>
2825
<method name="abs">
29-
<return type="AABB">
30-
</return>
26+
<return type="AABB" />
3127
<description>
3228
Returns an AABB with equivalent position and size, modified so that the most-negative corner is the origin and the size is positive.
3329
</description>
3430
</method>
3531
<method name="encloses">
36-
<return type="bool">
37-
</return>
38-
<argument index="0" name="with" type="AABB">
39-
</argument>
32+
<return type="bool" />
33+
<argument index="0" name="with" type="AABB" />
4034
<description>
4135
Returns [code]true[/code] if this [AABB] completely encloses another one.
4236
</description>
4337
</method>
4438
<method name="expand">
45-
<return type="AABB">
46-
</return>
47-
<argument index="0" name="to_point" type="Vector3">
48-
</argument>
39+
<return type="AABB" />
40+
<argument index="0" name="to_point" type="Vector3" />
4941
<description>
5042
Returns this [AABB] expanded to include a given point.
5143
</description>
5244
</method>
5345
<method name="get_area">
54-
<return type="float">
55-
</return>
46+
<return type="float" />
5647
<description>
5748
Returns the volume of the [AABB].
5849
</description>
5950
</method>
6051
<method name="get_endpoint">
61-
<return type="Vector3">
62-
</return>
63-
<argument index="0" name="idx" type="int">
64-
</argument>
52+
<return type="Vector3" />
53+
<argument index="0" name="idx" type="int" />
6554
<description>
6655
Gets the position of the 8 endpoints of the [AABB] in space.
6756
</description>
6857
</method>
6958
<method name="get_longest_axis">
70-
<return type="Vector3">
71-
</return>
59+
<return type="Vector3" />
7260
<description>
7361
Returns the normalized longest axis of the [AABB].
7462
</description>
7563
</method>
7664
<method name="get_longest_axis_index">
77-
<return type="int">
78-
</return>
65+
<return type="int" />
7966
<description>
8067
Returns the index of the longest axis of the [AABB] (according to [Vector3]'s [code]AXIS_*[/code] constants).
8168
</description>
8269
</method>
8370
<method name="get_longest_axis_size">
84-
<return type="float">
85-
</return>
71+
<return type="float" />
8672
<description>
8773
Returns the scalar length of the longest axis of the [AABB].
8874
</description>
8975
</method>
9076
<method name="get_shortest_axis">
91-
<return type="Vector3">
92-
</return>
77+
<return type="Vector3" />
9378
<description>
9479
Returns the normalized shortest axis of the [AABB].
9580
</description>
9681
</method>
9782
<method name="get_shortest_axis_index">
98-
<return type="int">
99-
</return>
83+
<return type="int" />
10084
<description>
10185
Returns the index of the shortest axis of the [AABB] (according to [Vector3]::AXIS* enum).
10286
</description>
10387
</method>
10488
<method name="get_shortest_axis_size">
105-
<return type="float">
106-
</return>
89+
<return type="float" />
10790
<description>
10891
Returns the scalar length of the shortest axis of the [AABB].
10992
</description>
11093
</method>
11194
<method name="get_support">
112-
<return type="Vector3">
113-
</return>
114-
<argument index="0" name="dir" type="Vector3">
115-
</argument>
95+
<return type="Vector3" />
96+
<argument index="0" name="dir" type="Vector3" />
11697
<description>
11798
Returns the support point in a given direction. This is useful for collision detection algorithms.
11899
</description>
119100
</method>
120101
<method name="grow">
121-
<return type="AABB">
122-
</return>
123-
<argument index="0" name="by" type="float">
124-
</argument>
102+
<return type="AABB" />
103+
<argument index="0" name="by" type="float" />
125104
<description>
126105
Returns a copy of the [AABB] grown a given amount of units towards all the sides.
127106
</description>
128107
</method>
129108
<method name="has_no_area">
130-
<return type="bool">
131-
</return>
109+
<return type="bool" />
132110
<description>
133111
Returns [code]true[/code] if the [AABB] is flat or empty.
134112
</description>
135113
</method>
136114
<method name="has_no_surface">
137-
<return type="bool">
138-
</return>
115+
<return type="bool" />
139116
<description>
140117
Returns [code]true[/code] if the [AABB] is empty.
141118
</description>
142119
</method>
143120
<method name="has_point">
144-
<return type="bool">
145-
</return>
146-
<argument index="0" name="point" type="Vector3">
147-
</argument>
121+
<return type="bool" />
122+
<argument index="0" name="point" type="Vector3" />
148123
<description>
149124
Returns [code]true[/code] if the [AABB] contains a point.
150125
</description>
151126
</method>
152127
<method name="intersection">
153-
<return type="AABB">
154-
</return>
155-
<argument index="0" name="with" type="AABB">
156-
</argument>
128+
<return type="AABB" />
129+
<argument index="0" name="with" type="AABB" />
157130
<description>
158131
Returns the intersection between two [AABB]. An empty AABB (size 0,0,0) is returned on failure.
159132
</description>
160133
</method>
161134
<method name="intersects">
162-
<return type="bool">
163-
</return>
164-
<argument index="0" name="with" type="AABB">
165-
</argument>
135+
<return type="bool" />
136+
<argument index="0" name="with" type="AABB" />
166137
<description>
167138
Returns [code]true[/code] if the [AABB] overlaps with another.
168139
</description>
169140
</method>
170141
<method name="intersects_plane">
171-
<return type="bool">
172-
</return>
173-
<argument index="0" name="plane" type="Plane">
174-
</argument>
142+
<return type="bool" />
143+
<argument index="0" name="plane" type="Plane" />
175144
<description>
176145
Returns [code]true[/code] if the [AABB] is on both sides of a plane.
177146
</description>
178147
</method>
179148
<method name="intersects_segment">
180-
<return type="bool">
181-
</return>
182-
<argument index="0" name="from" type="Vector3">
183-
</argument>
184-
<argument index="1" name="to" type="Vector3">
185-
</argument>
149+
<return type="bool" />
150+
<argument index="0" name="from" type="Vector3" />
151+
<argument index="1" name="to" type="Vector3" />
186152
<description>
187153
Returns [code]true[/code] if the [AABB] intersects the line segment between [code]from[/code] and [code]to[/code].
188154
</description>
189155
</method>
190156
<method name="is_equal_approx">
191-
<return type="bool">
192-
</return>
193-
<argument index="0" name="aabb" type="AABB">
194-
</argument>
157+
<return type="bool" />
158+
<argument index="0" name="aabb" type="AABB" />
195159
<description>
196160
Returns [code]true[/code] if this [AABB] and [code]aabb[/code] are approximately equal, by calling [method @GDScript.is_equal_approx] on each component.
197161
</description>
198162
</method>
199163
<method name="merge">
200-
<return type="AABB">
201-
</return>
202-
<argument index="0" name="with" type="AABB">
203-
</argument>
164+
<return type="AABB" />
165+
<argument index="0" name="with" type="AABB" />
204166
<description>
205167
Returns a larger [AABB] that contains both this [AABB] and [code]with[/code].
206168
</description>

‎gdnative-bindings/docs/ARVRAnchor.xml

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
2-
<class name="ARVRAnchor" inherits="Spatial" version="3.3">
2+
<class name="ARVRAnchor" inherits="Spatial" version="3.4">
33
<brief_description>
44
An anchor point in AR space.
55
</brief_description>
@@ -12,36 +12,31 @@
1212
</tutorials>
1313
<methods>
1414
<method name="get_anchor_name" qualifiers="const">
15-
<return type="String">
16-
</return>
15+
<return type="String" />
1716
<description>
1817
Returns the name given to this anchor.
1918
</description>
2019
</method>
2120
<method name="get_is_active" qualifiers="const">
22-
<return type="bool">
23-
</return>
21+
<return type="bool" />
2422
<description>
2523
Returns [code]true[/code] if the anchor is being tracked and [code]false[/code] if no anchor with this ID is currently known.
2624
</description>
2725
</method>
2826
<method name="get_mesh" qualifiers="const">
29-
<return type="Mesh">
30-
</return>
27+
<return type="Mesh" />
3128
<description>
3229
If provided by the [ARVRInterface], this returns a mesh object for the anchor. For an anchor, this can be a shape related to the object being tracked or it can be a mesh that provides topology related to the anchor and can be used to create shadows/reflections on surfaces or for generating collision shapes.
3330
</description>
3431
</method>
3532
<method name="get_plane" qualifiers="const">
36-
<return type="Plane">
37-
</return>
33+
<return type="Plane" />
3834
<description>
3935
Returns a plane aligned with our anchor; handy for intersection testing.
4036
</description>
4137
</method>
4238
<method name="get_size" qualifiers="const">
43-
<return type="Vector3">
44-
</return>
39+
<return type="Vector3" />
4540
<description>
4641
Returns the estimated size of the plane that was detected. Say when the anchor relates to a table in the real world, this is the estimated size of the surface of that table.
4742
</description>
@@ -54,8 +49,7 @@
5449
</members>
5550
<signals>
5651
<signal name="mesh_updated">
57-
<argument index="0" name="mesh" type="Mesh">
58-
</argument>
52+
<argument index="0" name="mesh" type="Mesh" />
5953
<description>
6054
Emitted when the mesh associated with the anchor changes or when one becomes available. This is especially important for topology that is constantly being [code]mesh_updated[/code].
6155
</description>

‎gdnative-bindings/docs/ARVRCamera.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
2-
<class name="ARVRCamera" inherits="Camera" version="3.3">
2+
<class name="ARVRCamera" inherits="Camera" version="3.4">
33
<brief_description>
44
A camera node with a few overrules for AR/VR applied, such as location tracking.
55
</brief_description>
@@ -8,7 +8,7 @@
88
The position and orientation of this node is automatically updated by the ARVR Server to represent the location of the HMD if such tracking is available and can thus be used by game logic. Note that, in contrast to the ARVR Controller, the render thread has access to the most up-to-date tracking data of the HMD and the location of the ARVRCamera can lag a few milliseconds behind what is used for rendering as a result.
99
</description>
1010
<tutorials>
11-
<link>https://docs.godotengine.org/en/3.3/tutorials/vr/index.html</link>
11+
<link>https://docs.godotengine.org/en/3.4/tutorials/vr/index.html</link>
1212
</tutorials>
1313
<methods>
1414
</methods>

0 commit comments

Comments
 (0)