Skip to content

Commit 536d676

Browse files
BromeonBromeon
committed
Update api.json + XML docs
1 parent 5c2c4e6 commit 536d676

File tree

596 files changed

+8413
-2331
lines changed

Some content is hidden

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

596 files changed

+8413
-2331
lines changed

‎gdnative-bindings/api.json

Lines changed: 298 additions & 9 deletions
Large diffs are not rendered by default.

‎gdnative-bindings/docs/@GlobalScope.xml

Lines changed: 84 additions & 26 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.4">
2+
<class name="@GlobalScope" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
33
<brief_description>
44
Global scope constants and variables.
55
</brief_description>
@@ -53,8 +53,14 @@
5353
<member name="Marshalls" type="Marshalls" setter="" getter="">
5454
The [Marshalls] singleton.
5555
</member>
56-
<member name="NavigationMeshGenerator" type="EditorNavigationMeshGenerator" setter="" getter="">
57-
The [EditorNavigationMeshGenerator] singleton.
56+
<member name="Navigation2DServer" type="Navigation2DServer" setter="" getter="">
57+
The [Navigation2DServer] singleton.
58+
</member>
59+
<member name="NavigationMeshGenerator" type="NavigationMeshGenerator" setter="" getter="">
60+
The [NavigationMeshGenerator] singleton.
61+
</member>
62+
<member name="NavigationServer" type="NavigationServer" setter="" getter="">
63+
The [NavigationServer] singleton.
5864
</member>
5965
<member name="OS" type="OS" setter="" getter="">
6066
The [OS] singleton.
@@ -77,6 +83,9 @@
7783
<member name="ResourceSaver" type="ResourceSaver" setter="" getter="">
7884
The [ResourceSaver] singleton.
7985
</member>
86+
<member name="Time" type="Time" setter="" getter="">
87+
The [Time] singleton.
88+
</member>
8089
<member name="TranslationServer" type="TranslationServer" setter="" getter="">
8190
The [TranslationServer] singleton.
8291
</member>
@@ -1006,8 +1015,11 @@
10061015
<constant name="JOY_BUTTON_22" value="22" enum="JoystickList">
10071016
Gamepad button 22.
10081017
</constant>
1009-
<constant name="JOY_BUTTON_MAX" value="23" enum="JoystickList">
1010-
Represents the maximum number of joystick buttons supported.
1018+
<constant name="JOY_BUTTON_MAX" value="128" enum="JoystickList">
1019+
The maximum number of game controller buttons supported by the engine. The actual limit may be lower on specific platforms:
1020+
- Android: Up to 36 buttons.
1021+
- Linux: Up to 80 buttons.
1022+
- Windows and macOS: Up to 128 buttons.
10111023
</constant>
10121024
<constant name="JOY_SONY_CIRCLE" value="1" enum="JoystickList">
10131025
DualShock circle button.
@@ -1187,25 +1199,58 @@
11871199
OpenVR touchpad Y axis (Joystick axis on Oculus Touch and Windows MR controllers).
11881200
</constant>
11891201
<constant name="MIDI_MESSAGE_NOTE_OFF" value="8" enum="MidiMessageList">
1190-
MIDI note OFF message.
1202+
MIDI note OFF message. See the documentation of [InputEventMIDI] for information of how to use MIDI inputs.
11911203
</constant>
11921204
<constant name="MIDI_MESSAGE_NOTE_ON" value="9" enum="MidiMessageList">
1193-
MIDI note ON message.
1205+
MIDI note ON message. See the documentation of [InputEventMIDI] for information of how to use MIDI inputs.
11941206
</constant>
11951207
<constant name="MIDI_MESSAGE_AFTERTOUCH" value="10" enum="MidiMessageList">
1196-
MIDI aftertouch message.
1208+
MIDI aftertouch message. This message is most often sent by pressing down on the key after it "bottoms out".
11971209
</constant>
11981210
<constant name="MIDI_MESSAGE_CONTROL_CHANGE" value="11" enum="MidiMessageList">
1199-
MIDI control change message.
1211+
MIDI control change message. This message is sent when a controller value changes. Controllers include devices such as pedals and levers.
12001212
</constant>
12011213
<constant name="MIDI_MESSAGE_PROGRAM_CHANGE" value="12" enum="MidiMessageList">
1202-
MIDI program change message.
1214+
MIDI program change message. This message sent when the program patch number changes.
12031215
</constant>
12041216
<constant name="MIDI_MESSAGE_CHANNEL_PRESSURE" value="13" enum="MidiMessageList">
1205-
MIDI channel pressure message.
1217+
MIDI channel pressure message. This message is most often sent by pressing down on the key after it "bottoms out". This message is different from polyphonic after-touch as it indicates the highest pressure across all keys.
12061218
</constant>
12071219
<constant name="MIDI_MESSAGE_PITCH_BEND" value="14" enum="MidiMessageList">
1208-
MIDI pitch bend message.
1220+
MIDI pitch bend message. This message is sent to indicate a change in the pitch bender (wheel or lever, typically).
1221+
</constant>
1222+
<constant name="MIDI_MESSAGE_SYSTEM_EXCLUSIVE" value="240" enum="MidiMessageList">
1223+
MIDI system exclusive message. This has behavior exclusive to the device you're receiving input from. Getting this data is not implemented in Godot.
1224+
</constant>
1225+
<constant name="MIDI_MESSAGE_QUARTER_FRAME" value="241" enum="MidiMessageList">
1226+
MIDI quarter frame message. Contains timing information that is used to synchronize MIDI devices. Getting this data is not implemented in Godot.
1227+
</constant>
1228+
<constant name="MIDI_MESSAGE_SONG_POSITION_POINTER" value="242" enum="MidiMessageList">
1229+
MIDI song position pointer message. Gives the number of 16th notes since the start of the song. Getting this data is not implemented in Godot.
1230+
</constant>
1231+
<constant name="MIDI_MESSAGE_SONG_SELECT" value="243" enum="MidiMessageList">
1232+
MIDI song select message. Specifies which sequence or song is to be played. Getting this data is not implemented in Godot.
1233+
</constant>
1234+
<constant name="MIDI_MESSAGE_TUNE_REQUEST" value="246" enum="MidiMessageList">
1235+
MIDI tune request message. Upon receiving a tune request, all analog synthesizers should tune their oscillators.
1236+
</constant>
1237+
<constant name="MIDI_MESSAGE_TIMING_CLOCK" value="248" enum="MidiMessageList">
1238+
MIDI timing clock message. Sent 24 times per quarter note when synchronization is required.
1239+
</constant>
1240+
<constant name="MIDI_MESSAGE_START" value="250" enum="MidiMessageList">
1241+
MIDI start message. Start the current sequence playing. This message will be followed with Timing Clocks.
1242+
</constant>
1243+
<constant name="MIDI_MESSAGE_CONTINUE" value="251" enum="MidiMessageList">
1244+
MIDI continue message. Continue at the point the sequence was stopped.
1245+
</constant>
1246+
<constant name="MIDI_MESSAGE_STOP" value="252" enum="MidiMessageList">
1247+
MIDI stop message. Stop the current sequence.
1248+
</constant>
1249+
<constant name="MIDI_MESSAGE_ACTIVE_SENSING" value="254" enum="MidiMessageList">
1250+
MIDI active sensing message. This message is intended to be sent repeatedly to tell the receiver that a connection is alive.
1251+
</constant>
1252+
<constant name="MIDI_MESSAGE_SYSTEM_RESET" value="255" enum="MidiMessageList">
1253+
MIDI system reset message. Reset all receivers in the system to power-up status. It should not be sent on power-up itself.
12091254
</constant>
12101255
<constant name="OK" value="0" enum="Error">
12111256
Methods that return [enum Error] return [constant OK] when no error occurred. Note that many functions don't return an error code but will print error messages to standard output.
@@ -1373,7 +1418,12 @@
13731418
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].
13741419
</constant>
13751420
<constant name="PROPERTY_HINT_ENUM" value="3" enum="PropertyHint">
1376-
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].
1421+
Hints that an integer, float or string property is an enumerated value to pick in a list specified via a hint string.
1422+
The hint string is a comma separated list of names such as [code]"Hello,Something,Else"[/code]. For integer and float properties, the first name in the list has value 0, the next 1, and so on. Explicit values can also be specified by appending [code]:integer[/code] to the name, e.g. [code]"Zero,One,Three:3,Four,Six:6"[/code].
1423+
</constant>
1424+
<constant name="PROPERTY_HINT_ENUM_SUGGESTION" value="39" enum="PropertyHint">
1425+
Hints that a string property can be an enumerated value to pick in a list specified via a hint string such as [code]"Hello,Something,Else"[/code].
1426+
Unlike [constant PROPERTY_HINT_ENUM] a property with this hint still accepts arbitrary values and can be empty. The list of values serves to suggest possible values.
13771427
</constant>
13781428
<constant name="PROPERTY_HINT_EXP_EASING" value="4" enum="PropertyHint">
13791429
Hints that a float property should be edited via an exponential easing function. The hint string can include [code]"attenuation"[/code] to flip the curve horizontally and/or [code]"inout"[/code] to also include in/out easing.
@@ -1393,40 +1443,46 @@
13931443
<constant name="PROPERTY_HINT_LAYERS_2D_PHYSICS" value="10" enum="PropertyHint">
13941444
Hints that an integer property is a bitmask using the optionally named 2D physics layers.
13951445
</constant>
1396-
<constant name="PROPERTY_HINT_LAYERS_3D_RENDER" value="11" enum="PropertyHint">
1446+
<constant name="PROPERTY_HINT_LAYERS_2D_NAVIGATION" value="11" enum="PropertyHint">
1447+
Hints that an integer property is a bitmask using the optionally named 2D navigation layers.
1448+
</constant>
1449+
<constant name="PROPERTY_HINT_LAYERS_3D_RENDER" value="12" enum="PropertyHint">
13971450
Hints that an integer property is a bitmask using the optionally named 3D render layers.
13981451
</constant>
1399-
<constant name="PROPERTY_HINT_LAYERS_3D_PHYSICS" value="12" enum="PropertyHint">
1452+
<constant name="PROPERTY_HINT_LAYERS_3D_PHYSICS" value="13" enum="PropertyHint">
14001453
Hints that an integer property is a bitmask using the optionally named 3D physics layers.
14011454
</constant>
1402-
<constant name="PROPERTY_HINT_FILE" value="13" enum="PropertyHint">
1455+
<constant name="PROPERTY_HINT_LAYERS_3D_NAVIGATION" value="14" enum="PropertyHint">
1456+
Hints that an integer property is a bitmask using the optionally named 3D navigation layers.
1457+
</constant>
1458+
<constant name="PROPERTY_HINT_FILE" value="15" enum="PropertyHint">
14031459
Hints that a string property is a path to a file. Editing it will show a file dialog for picking the path. The hint string can be a set of filters with wildcards like [code]"*.png,*.jpg"[/code].
14041460
</constant>
1405-
<constant name="PROPERTY_HINT_DIR" value="14" enum="PropertyHint">
1461+
<constant name="PROPERTY_HINT_DIR" value="16" enum="PropertyHint">
14061462
Hints that a string property is a path to a directory. Editing it will show a file dialog for picking the path.
14071463
</constant>
1408-
<constant name="PROPERTY_HINT_GLOBAL_FILE" value="15" enum="PropertyHint">
1464+
<constant name="PROPERTY_HINT_GLOBAL_FILE" value="17" enum="PropertyHint">
14091465
Hints that a string property is an absolute path to a file outside the project folder. Editing it will show a file dialog for picking the path. The hint string can be a set of filters with wildcards like [code]"*.png,*.jpg"[/code].
14101466
</constant>
1411-
<constant name="PROPERTY_HINT_GLOBAL_DIR" value="16" enum="PropertyHint">
1467+
<constant name="PROPERTY_HINT_GLOBAL_DIR" value="18" enum="PropertyHint">
14121468
Hints that a string property is an absolute path to a directory outside the project folder. Editing it will show a file dialog for picking the path.
14131469
</constant>
1414-
<constant name="PROPERTY_HINT_RESOURCE_TYPE" value="17" enum="PropertyHint">
1470+
<constant name="PROPERTY_HINT_RESOURCE_TYPE" value="19" enum="PropertyHint">
14151471
Hints that a property is an instance of a [Resource]-derived type, optionally specified via the hint string (e.g. [code]"Texture"[/code]). Editing it will show a popup menu of valid resource types to instantiate.
14161472
</constant>
1417-
<constant name="PROPERTY_HINT_MULTILINE_TEXT" value="18" enum="PropertyHint">
1473+
<constant name="PROPERTY_HINT_MULTILINE_TEXT" value="20" enum="PropertyHint">
14181474
Hints that a string property is text with line breaks. Editing it will show a text input field where line breaks can be typed.
14191475
</constant>
1420-
<constant name="PROPERTY_HINT_PLACEHOLDER_TEXT" value="19" enum="PropertyHint">
1476+
<constant name="PROPERTY_HINT_PLACEHOLDER_TEXT" value="21" enum="PropertyHint">
14211477
Hints that a string property should have a placeholder text visible on its input field, whenever the property is empty. The hint string is the placeholder text to use.
14221478
</constant>
1423-
<constant name="PROPERTY_HINT_COLOR_NO_ALPHA" value="20" enum="PropertyHint">
1479+
<constant name="PROPERTY_HINT_COLOR_NO_ALPHA" value="22" enum="PropertyHint">
14241480
Hints that a color property should be edited without changing its alpha component, i.e. only R, G and B channels are edited.
14251481
</constant>
1426-
<constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSY" value="21" enum="PropertyHint">
1482+
<constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSY" value="23" enum="PropertyHint">
14271483
Hints that an image is compressed using lossy compression.
14281484
</constant>
1429-
<constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS" value="22" enum="PropertyHint">
1485+
<constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS" value="24" enum="PropertyHint">
14301486
Hints that an image is compressed using lossless compression.
14311487
</constant>
14321488
<constant name="PROPERTY_USAGE_STORAGE" value="1" enum="PropertyUsageFlags">
@@ -1451,7 +1507,7 @@
14511507
The property is a translatable string.
14521508
</constant>
14531509
<constant name="PROPERTY_USAGE_GROUP" value="128" enum="PropertyUsageFlags">
1454-
Used to group properties together in the editor.
1510+
Used to group properties together in the editor. See [EditorInspector].
14551511
</constant>
14561512
<constant name="PROPERTY_USAGE_CATEGORY" value="256" enum="PropertyUsageFlags">
14571513
Used to categorize properties together in the editor.
@@ -1495,6 +1551,8 @@
14951551
<constant name="METHOD_FLAG_FROM_SCRIPT" value="64" enum="MethodFlags">
14961552
Deprecated method flag, unused.
14971553
</constant>
1554+
<constant name="METHOD_FLAG_VARARG" value="128" enum="MethodFlags">
1555+
</constant>
14981556
<constant name="METHOD_FLAGS_DEFAULT" value="1" enum="MethodFlags">
14991557
Default method flags.
15001558
</constant>

‎gdnative-bindings/docs/AABB.xml

Lines changed: 18 additions & 5 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.4">
2+
<class name="AABB" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
33
<brief_description>
44
Axis-Aligned Bounding Box.
55
</brief_description>
@@ -9,9 +9,9 @@
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.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>
12+
<link title="Math tutorial index">https://docs.godotengine.org/en/3.5/tutorials/math/index.html</link>
13+
<link title="Vector math">https://docs.godotengine.org/en/3.5/tutorials/math/vector_math.html</link>
14+
<link title="Advanced vector math">https://docs.godotengine.org/en/3.5/tutorials/math/vectors_advanced.html</link>
1515
</tutorials>
1616
<methods>
1717
<method name="AABB">
@@ -39,7 +39,14 @@
3939
<return type="AABB" />
4040
<argument index="0" name="to_point" type="Vector3" />
4141
<description>
42-
Returns this [AABB] expanded to include a given point.
42+
Returns a copy of this [AABB] expanded to include a given point.
43+
[b]Example:[/b]
44+
[codeblock]
45+
# position (-3, 2, 0), size (1, 1, 1)
46+
var box = AABB(Vector3(-3, 2, 0), Vector3(1, 1, 1))
47+
# position (-3, -1, 0), size (3, 4, 2), so we fit both the original AABB and Vector3(0, -1, 2)
48+
var box2 = box.expand(Vector3(0, -1, 2))
49+
[/codeblock]
4350
</description>
4451
</method>
4552
<method name="get_area">
@@ -48,6 +55,12 @@
4855
Returns the volume of the [AABB].
4956
</description>
5057
</method>
58+
<method name="get_center">
59+
<return type="Vector3" />
60+
<description>
61+
Returns the center of the [AABB], which is equal to [member position] + ([member size] / 2).
62+
</description>
63+
</method>
5164
<method name="get_endpoint">
5265
<return type="Vector3" />
5366
<argument index="0" name="idx" type="int" />

‎gdnative-bindings/docs/AESContext.xml

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
<class name="AESContext" inherits="Reference" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
3+
<brief_description>
4+
Interface to low level AES encryption features.
5+
</brief_description>
6+
<description>
7+
This class provides access to AES encryption/decryption of raw data. Both AES-ECB and AES-CBC mode are supported.
8+
[codeblock]
9+
extends Node
10+
11+
var aes = AESContext.new()
12+
13+
func _ready():
14+
var key = "My secret key!!!" # Key must be either 16 or 32 bytes.
15+
var data = "My secret text!!" # Data size must be multiple of 16 bytes, apply padding if needed.
16+
# Encrypt ECB
17+
aes.start(AESContext.MODE_ECB_ENCRYPT, key.to_utf8())
18+
var encrypted = aes.update(data.to_utf8())
19+
aes.finish()
20+
# Decrypt ECB
21+
aes.start(AESContext.MODE_ECB_DECRYPT, key.to_utf8())
22+
var decrypted = aes.update(encrypted)
23+
aes.finish()
24+
# Check ECB
25+
assert(decrypted == data.to_utf8())
26+
27+
var iv = "My secret iv!!!!" # IV must be of exactly 16 bytes.
28+
# Encrypt CBC
29+
aes.start(AESContext.MODE_CBC_ENCRYPT, key.to_utf8(), iv.to_utf8())
30+
encrypted = aes.update(data.to_utf8())
31+
aes.finish()
32+
# Decrypt CBC
33+
aes.start(AESContext.MODE_CBC_DECRYPT, key.to_utf8(), iv.to_utf8())
34+
decrypted = aes.update(encrypted)
35+
aes.finish()
36+
# Check CBC
37+
assert(decrypted == data.to_utf8())
38+
[/codeblock]
39+
</description>
40+
<tutorials>
41+
</tutorials>
42+
<methods>
43+
<method name="finish">
44+
<return type="void" />
45+
<description>
46+
Close this AES context so it can be started again. See [method start].
47+
</description>
48+
</method>
49+
<method name="get_iv_state">
50+
<return type="PoolByteArray" />
51+
<description>
52+
Get the current IV state for this context (IV gets updated when calling [method update]). You normally don't need this function.
53+
[b]Note:[/b] This function only makes sense when the context is started with [constant MODE_CBC_ENCRYPT] or [constant MODE_CBC_DECRYPT].
54+
</description>
55+
</method>
56+
<method name="start">
57+
<return type="int" enum="Error" />
58+
<argument index="0" name="mode" type="int" enum="AESContext.Mode" />
59+
<argument index="1" name="key" type="PoolByteArray" />
60+
<argument index="2" name="iv" type="PoolByteArray" default="PoolByteArray( )" />
61+
<description>
62+
Start the AES context in the given [code]mode[/code]. A [code]key[/code] of either 16 or 32 bytes must always be provided, while an [code]iv[/code] (initialization vector) of exactly 16 bytes, is only needed when [code]mode[/code] is either [constant MODE_CBC_ENCRYPT] or [constant MODE_CBC_DECRYPT].
63+
</description>
64+
</method>
65+
<method name="update">
66+
<return type="PoolByteArray" />
67+
<argument index="0" name="src" type="PoolByteArray" />
68+
<description>
69+
Run the desired operation for this AES context. Will return a [PoolByteArray] containing the result of encrypting (or decrypting) the given [code]src[/code]. See [method start] for mode of operation.
70+
[b]Note:[/b] The size of [code]src[/code] must be a multiple of 16. Apply some padding if needed.
71+
</description>
72+
</method>
73+
</methods>
74+
<constants>
75+
<constant name="MODE_ECB_ENCRYPT" value="0" enum="Mode">
76+
AES electronic codebook encryption mode.
77+
</constant>
78+
<constant name="MODE_ECB_DECRYPT" value="1" enum="Mode">
79+
AES electronic codebook decryption mode.
80+
</constant>
81+
<constant name="MODE_CBC_ENCRYPT" value="2" enum="Mode">
82+
AES cipher blocker chaining encryption mode.
83+
</constant>
84+
<constant name="MODE_CBC_DECRYPT" value="3" enum="Mode">
85+
AES cipher blocker chaining decryption mode.
86+
</constant>
87+
<constant name="MODE_MAX" value="4" enum="Mode">
88+
Maximum value for the mode enum.
89+
</constant>
90+
</constants>
91+
</class>

‎gdnative-bindings/docs/ARVRAnchor.xml

Lines changed: 1 addition & 1 deletion
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.4">
2+
<class name="ARVRAnchor" inherits="Spatial" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
33
<brief_description>
44
An anchor point in AR space.
55
</brief_description>

0 commit comments

Comments
 (0)