Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-10-23 05:31:54 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add an XML schema for documentation

Browse Source 
This makes it easier to spot syntax errors when editing the
class reference. The schema is referenced locally so validation
can still work offline.

Each class XML's schema conformance is also checked on GitHub Actions.
This commit is contained in:
Hugo Locurcio 2022-03-16 23:01:02 +01:00
parent 9ddeeb8b1a
commit b087538119
No known key found for this signature in database
GPG Key ID: 39E8F8BE30B0A49C
695 changed files with 857 additions and 694 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.github/workflows/static_checks.yml vendored
View File

@ -20,7 +20,7 @@ jobs:
- name: Install dependencies - name: Install dependencies
run: | run: |
sudo apt-get install -qq dos2unix recode clang-format-13 sudo apt-get install -qq dos2unix recode clang-format-13 libxml2-utils
sudo update-alternatives --remove-all clang-format sudo update-alternatives --remove-all clang-format
sudo update-alternatives --install /usr/bin/clang-format clang-format /usr/bin/clang-format-13 100 sudo update-alternatives --install /usr/bin/clang-format clang-format /usr/bin/clang-format-13 100
sudo pip3 install black==21.10b0 pygments sudo pip3 install black==21.10b0 pygments
@ -44,6 +44,10 @@ jobs:
npm run lint npm run lint
npm run docs -- -d dry-run npm run docs -- -d dry-run
- name: Class reference schema checks
run: |
xmllint --noout --schema doc/class.xsd doc/classes/*.xml modules/*/doc_classes/*.xml
- name: Documentation checks - name: Documentation checks
run: | run: |
doc/tools/make_rst.py --dry-run doc/classes modules doc/tools/make_rst.py --dry-run doc/classes modules

154
doc/class.xsd Normal file
View File

@ -0,0 +1,154 @@
<?xml version="1.0" encoding="UTF-8" ?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="class">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="brief_description" />
<xs:element type="xs:string" name="description" />
<xs:element name="tutorials">
<xs:complexType>
<xs:sequence>
<xs:element name="link" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute type="xs:string" name="title" use="optional" />
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="methods" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="method" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="return" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:sequence />
</xs:sequence>
<xs:attribute type="xs:string" name="type" />
<xs:attribute type="xs:string" name="enum" use="optional" />
</xs:complexType>
</xs:element>
<xs:element name="returns_error" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:sequence />
</xs:sequence>
<xs:attribute type="xs:byte" name="number" />
</xs:complexType>
</xs:element>
<xs:element name="argument" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:sequence />
</xs:sequence>
<xs:attribute type="xs:byte" name="index" />
<xs:attribute type="xs:string" name="name" />
<xs:attribute type="xs:string" name="type" />
<xs:attribute type="xs:string" name="enum" use="optional" />
<xs:attribute type="xs:string" name="default" use="optional" />
</xs:complexType>
</xs:element>
<xs:element type="xs:string" name="description" />
</xs:sequence>
<xs:attribute type="xs:string" name="name" use="optional" />
<xs:attribute type="xs:string" name="qualifiers" use="optional" />
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="members" minOccurs="0">
<xs:complexType>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element name="member">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute type="xs:string" name="name" />
<xs:attribute type="xs:string" name="type" />
<xs:attribute type="xs:string" name="setter" />
<xs:attribute type="xs:string" name="getter" />
<xs:attribute type="xs:string" name="overrides" use="optional" />
<xs:attribute type="xs:string" name="enum" use="optional" />
<xs:attribute type="xs:string" name="default" use="optional" />
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
<xs:element name="signals" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="signal" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="argument" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:sequence />
</xs:sequence>
<xs:attribute type="xs:byte" name="index" />
<xs:attribute type="xs:string" name="name" />
<xs:attribute type="xs:string" name="type" />
</xs:complexType>
</xs:element>
<xs:element type="xs:string" name="description" />
</xs:sequence>
<xs:attribute type="xs:string" name="name" use="optional" />
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="constants" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="constant" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute type="xs:string" name="name" />
<xs:attribute type="xs:string" name="value" />
<xs:attribute type="xs:string" name="enum" use="optional" />
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="theme_items" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="theme_item" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute type="xs:string" name="name" />
<xs:attribute type="xs:string" name="data_type" />
<xs:attribute type="xs:string" name="type" />
<xs:attribute type="xs:string" name="default" use="optional" />
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute type="xs:string" name="name" />
<xs:attribute type="xs:string" name="inherits" />
<xs:attribute type="xs:string" name="category" />
<xs:attribute type="xs:float" name="version" />
</xs:complexType>
</xs:element>
</xs:schema>

2
doc/classes/@GlobalScope.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="@GlobalScope" version="3.5"> <class name="@GlobalScope" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Global scope constants and variables. Global scope constants and variables.
</brief_description> </brief_description>

2
doc/classes/AABB.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AABB" version="3.5"> <class name="AABB" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Axis-Aligned Bounding Box. Axis-Aligned Bounding Box.
</brief_description> </brief_description>

2
doc/classes/AESContext.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AESContext" inherits="Reference" version="3.5"> <class name="AESContext" inherits="Reference" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Interface to low level AES encryption features. Interface to low level AES encryption features.
</brief_description> </brief_description>

2
doc/classes/ARVRAnchor.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="ARVRAnchor" inherits="Spatial" version="3.5"> <class name="ARVRAnchor" inherits="Spatial" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
An anchor point in AR space. An anchor point in AR space.
</brief_description> </brief_description>

2
doc/classes/ARVRCamera.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="ARVRCamera" inherits="Camera" version="3.5"> <class name="ARVRCamera" inherits="Camera" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
A camera node with a few overrules for AR/VR applied, such as location tracking. A camera node with a few overrules for AR/VR applied, such as location tracking.
</brief_description> </brief_description>

2
doc/classes/ARVRController.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="ARVRController" inherits="Spatial" version="3.5"> <class name="ARVRController" inherits="Spatial" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
A spatial node representing a spatially-tracked controller. A spatial node representing a spatially-tracked controller.
</brief_description> </brief_description>

2
doc/classes/ARVRInterface.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="ARVRInterface" inherits="Reference" version="3.5"> <class name="ARVRInterface" inherits="Reference" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Base class for an AR/VR interface implementation. Base class for an AR/VR interface implementation.
</brief_description> </brief_description>

2
doc/classes/ARVROrigin.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="ARVROrigin" inherits="Spatial" version="3.5"> <class name="ARVROrigin" inherits="Spatial" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
The origin point in AR/VR. The origin point in AR/VR.
</brief_description> </brief_description>

2
doc/classes/ARVRPositionalTracker.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="ARVRPositionalTracker" inherits="Reference" version="3.5"> <class name="ARVRPositionalTracker" inherits="Reference" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
A tracked object. A tracked object.
</brief_description> </brief_description>

2
doc/classes/ARVRServer.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="ARVRServer" inherits="Object" version="3.5"> <class name="ARVRServer" inherits="Object" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Server for AR and VR features. Server for AR and VR features.
</brief_description> </brief_description>

2
doc/classes/AStar.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AStar" inherits="Reference" version="3.5"> <class name="AStar" inherits="Reference" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
An implementation of A* to find the shortest paths among connected points in space. An implementation of A* to find the shortest paths among connected points in space.
</brief_description> </brief_description>

2
doc/classes/AStar2D.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AStar2D" inherits="Reference" version="3.5"> <class name="AStar2D" inherits="Reference" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
AStar class representation that uses 2D vectors as edges. AStar class representation that uses 2D vectors as edges.
</brief_description> </brief_description>

2
doc/classes/AcceptDialog.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AcceptDialog" inherits="WindowDialog" version="3.5"> <class name="AcceptDialog" inherits="WindowDialog" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Base dialog for user notification. Base dialog for user notification.
</brief_description> </brief_description>

2
doc/classes/AnimatedSprite.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimatedSprite" inherits="Node2D" version="3.5"> <class name="AnimatedSprite" inherits="Node2D" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Sprite node that can use multiple textures for animation. Sprite node that can use multiple textures for animation.
</brief_description> </brief_description>

2
doc/classes/AnimatedSprite3D.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimatedSprite3D" inherits="SpriteBase3D" version="3.5"> <class name="AnimatedSprite3D" inherits="SpriteBase3D" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
2D sprite node in 3D world, that can use multiple 2D textures for animation. 2D sprite node in 3D world, that can use multiple 2D textures for animation.
</brief_description> </brief_description>

2
doc/classes/AnimatedTexture.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimatedTexture" inherits="Texture" version="3.5"> <class name="AnimatedTexture" inherits="Texture" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Proxy texture for simple frame-based animations. Proxy texture for simple frame-based animations.
</brief_description> </brief_description>

2
doc/classes/Animation.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="Animation" inherits="Resource" version="3.5"> <class name="Animation" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Contains data used to animate everything in the engine. Contains data used to animate everything in the engine.
</brief_description> </brief_description>

2
doc/classes/AnimationNode.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNode" inherits="Resource" version="3.5"> <class name="AnimationNode" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Base resource for [AnimationTree] nodes. Base resource for [AnimationTree] nodes.
</brief_description> </brief_description>

2
doc/classes/AnimationNodeAdd2.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeAdd2" inherits="AnimationNode" version="3.5"> <class name="AnimationNodeAdd2" inherits="AnimationNode" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Blends two animations additively inside of an [AnimationNodeBlendTree]. Blends two animations additively inside of an [AnimationNodeBlendTree].
</brief_description> </brief_description>

2
doc/classes/AnimationNodeAdd3.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeAdd3" inherits="AnimationNode" version="3.5"> <class name="AnimationNodeAdd3" inherits="AnimationNode" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Blends two of three animations additively inside of an [AnimationNodeBlendTree]. Blends two of three animations additively inside of an [AnimationNodeBlendTree].
</brief_description> </brief_description>

2
doc/classes/AnimationNodeAnimation.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeAnimation" inherits="AnimationRootNode" version="3.5"> <class name="AnimationNodeAnimation" inherits="AnimationRootNode" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Input animation to use in an [AnimationNodeBlendTree]. Input animation to use in an [AnimationNodeBlendTree].
</brief_description> </brief_description>

2
doc/classes/AnimationNodeBlend2.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeBlend2" inherits="AnimationNode" version="3.5"> <class name="AnimationNodeBlend2" inherits="AnimationNode" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Blends two animations linearly inside of an [AnimationNodeBlendTree]. Blends two animations linearly inside of an [AnimationNodeBlendTree].
</brief_description> </brief_description>

2
doc/classes/AnimationNodeBlend3.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeBlend3" inherits="AnimationNode" version="3.5"> <class name="AnimationNodeBlend3" inherits="AnimationNode" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Blends two of three animations linearly inside of an [AnimationNodeBlendTree]. Blends two of three animations linearly inside of an [AnimationNodeBlendTree].
</brief_description> </brief_description>

2
doc/classes/AnimationNodeBlendSpace1D.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeBlendSpace1D" inherits="AnimationRootNode" version="3.5"> <class name="AnimationNodeBlendSpace1D" inherits="AnimationRootNode" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Blends linearly between two of any number of [AnimationNode] of any type placed on a virtual axis. Blends linearly between two of any number of [AnimationNode] of any type placed on a virtual axis.
</brief_description> </brief_description>

2
doc/classes/AnimationNodeBlendSpace2D.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeBlendSpace2D" inherits="AnimationRootNode" version="3.5"> <class name="AnimationNodeBlendSpace2D" inherits="AnimationRootNode" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Blends linearly between three [AnimationNode] of any type placed in a 2D space. Blends linearly between three [AnimationNode] of any type placed in a 2D space.
</brief_description> </brief_description>

2
doc/classes/AnimationNodeBlendTree.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeBlendTree" inherits="AnimationRootNode" version="3.5"> <class name="AnimationNodeBlendTree" inherits="AnimationRootNode" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
[AnimationTree] node resource that contains many blend type nodes. [AnimationTree] node resource that contains many blend type nodes.
</brief_description> </brief_description>

2
doc/classes/AnimationNodeOneShot.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeOneShot" inherits="AnimationNode" version="3.5"> <class name="AnimationNodeOneShot" inherits="AnimationNode" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Plays an animation once in [AnimationNodeBlendTree]. Plays an animation once in [AnimationNodeBlendTree].
</brief_description> </brief_description>

2
doc/classes/AnimationNodeOutput.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeOutput" inherits="AnimationNode" version="3.5"> <class name="AnimationNodeOutput" inherits="AnimationNode" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Generic output node to be added to [AnimationNodeBlendTree]. Generic output node to be added to [AnimationNodeBlendTree].
</brief_description> </brief_description>

2
doc/classes/AnimationNodeStateMachine.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeStateMachine" inherits="AnimationRootNode" version="3.5"> <class name="AnimationNodeStateMachine" inherits="AnimationRootNode" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
State machine for control of animations. State machine for control of animations.
</brief_description> </brief_description>

2
doc/classes/AnimationNodeStateMachinePlayback.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeStateMachinePlayback" inherits="Resource" version="3.5"> <class name="AnimationNodeStateMachinePlayback" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Playback control for [AnimationNodeStateMachine]. Playback control for [AnimationNodeStateMachine].
</brief_description> </brief_description>

2
doc/classes/AnimationNodeStateMachineTransition.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeStateMachineTransition" inherits="Resource" version="3.5"> <class name="AnimationNodeStateMachineTransition" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc/classes/AnimationNodeTimeScale.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeTimeScale" inherits="AnimationNode" version="3.5"> <class name="AnimationNodeTimeScale" inherits="AnimationNode" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
A time-scaling animation node to be used with [AnimationTree]. A time-scaling animation node to be used with [AnimationTree].
</brief_description> </brief_description>

2
doc/classes/AnimationNodeTimeSeek.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeTimeSeek" inherits="AnimationNode" version="3.5"> <class name="AnimationNodeTimeSeek" inherits="AnimationNode" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
A time-seeking animation node to be used with [AnimationTree]. A time-seeking animation node to be used with [AnimationTree].
</brief_description> </brief_description>

2
doc/classes/AnimationNodeTransition.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeTransition" inherits="AnimationNode" version="3.5"> <class name="AnimationNodeTransition" inherits="AnimationNode" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
A generic animation transition node for [AnimationTree]. A generic animation transition node for [AnimationTree].
</brief_description> </brief_description>

2
doc/classes/AnimationPlayer.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationPlayer" inherits="Node" version="3.5"> <class name="AnimationPlayer" inherits="Node" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Container and player of [Animation] resources. Container and player of [Animation] resources.
</brief_description> </brief_description>

2
doc/classes/AnimationRootNode.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationRootNode" inherits="AnimationNode" version="3.5"> <class name="AnimationRootNode" inherits="AnimationNode" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc/classes/AnimationTrackEditPlugin.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationTrackEditPlugin" inherits="Reference" version="3.5"> <class name="AnimationTrackEditPlugin" inherits="Reference" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc/classes/AnimationTree.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationTree" inherits="Node" version="3.5"> <class name="AnimationTree" inherits="Node" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
A node to be used for advanced animation transitions in an [AnimationPlayer]. A node to be used for advanced animation transitions in an [AnimationPlayer].
</brief_description> </brief_description>

2
doc/classes/AnimationTreePlayer.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationTreePlayer" inherits="Node" version="3.5"> <class name="AnimationTreePlayer" inherits="Node" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
[i]Deprecated.[/i] Animation player that uses a node graph for blending animations. Superseded by [AnimationTree]. [i]Deprecated.[/i] Animation player that uses a node graph for blending animations. Superseded by [AnimationTree].
</brief_description> </brief_description>

2
doc/classes/Area.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="Area" inherits="CollisionObject" version="3.5"> <class name="Area" inherits="CollisionObject" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
3D area for detection and physics and audio influence. 3D area for detection and physics and audio influence.
</brief_description> </brief_description>

2
doc/classes/Area2D.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="Area2D" inherits="CollisionObject2D" version="3.5"> <class name="Area2D" inherits="CollisionObject2D" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
2D area for detection and physics and audio influence. 2D area for detection and physics and audio influence.
</brief_description> </brief_description>

2
doc/classes/Array.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="Array" version="3.5"> <class name="Array" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
A generic array datatype. A generic array datatype.
</brief_description> </brief_description>

2
doc/classes/ArrayMesh.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="ArrayMesh" inherits="Mesh" version="3.5"> <class name="ArrayMesh" inherits="Mesh" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
[Mesh] type that provides utility for constructing a surface from arrays. [Mesh] type that provides utility for constructing a surface from arrays.
</brief_description> </brief_description>

2
doc/classes/AspectRatioContainer.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AspectRatioContainer" inherits="Container" version="3.5"> <class name="AspectRatioContainer" inherits="Container" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Container that preserves its child controls' aspect ratio. Container that preserves its child controls' aspect ratio.
</brief_description> </brief_description>

2
doc/classes/AtlasTexture.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AtlasTexture" inherits="Texture" version="3.5"> <class name="AtlasTexture" inherits="Texture" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Crops out one part of a texture, such as a texture from a texture atlas. Crops out one part of a texture, such as a texture from a texture atlas.
</brief_description> </brief_description>

2
doc/classes/AudioBusLayout.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioBusLayout" inherits="Resource" version="3.5"> <class name="AudioBusLayout" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Stores information about the audio buses. Stores information about the audio buses.
</brief_description> </brief_description>

2
doc/classes/AudioEffect.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffect" inherits="Resource" version="3.5"> <class name="AudioEffect" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Audio effect for audio. Audio effect for audio.
</brief_description> </brief_description>

2
doc/classes/AudioEffectAmplify.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectAmplify" inherits="AudioEffect" version="3.5"> <class name="AudioEffectAmplify" inherits="AudioEffect" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds an amplifying audio effect to an audio bus. Adds an amplifying audio effect to an audio bus.
Increases or decreases the volume of the selected audio bus. Increases or decreases the volume of the selected audio bus.

2
doc/classes/AudioEffectBandLimitFilter.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectBandLimitFilter" inherits="AudioEffectFilter" version="3.5"> <class name="AudioEffectBandLimitFilter" inherits="AudioEffectFilter" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a band limit filter to the audio bus. Adds a band limit filter to the audio bus.
</brief_description> </brief_description>

2
doc/classes/AudioEffectBandPassFilter.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectBandPassFilter" inherits="AudioEffectFilter" version="3.5"> <class name="AudioEffectBandPassFilter" inherits="AudioEffectFilter" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a band pass filter to the audio bus. Adds a band pass filter to the audio bus.
</brief_description> </brief_description>

2
doc/classes/AudioEffectCapture.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectCapture" inherits="AudioEffect" version="3.5"> <class name="AudioEffectCapture" inherits="AudioEffect" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Captures audio from an audio bus in real-time. Captures audio from an audio bus in real-time.
</brief_description> </brief_description>

2
doc/classes/AudioEffectChorus.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectChorus" inherits="AudioEffect" version="3.5"> <class name="AudioEffectChorus" inherits="AudioEffect" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a chorus audio effect. Adds a chorus audio effect.
</brief_description> </brief_description>

2
doc/classes/AudioEffectCompressor.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectCompressor" inherits="AudioEffect" version="3.5"> <class name="AudioEffectCompressor" inherits="AudioEffect" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a compressor audio effect to an audio bus. Adds a compressor audio effect to an audio bus.
Reduces sounds that exceed a certain threshold level, smooths out the dynamics and increases the overall volume. Reduces sounds that exceed a certain threshold level, smooths out the dynamics and increases the overall volume.

2
doc/classes/AudioEffectDelay.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectDelay" inherits="AudioEffect" version="3.5"> <class name="AudioEffectDelay" inherits="AudioEffect" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a delay audio effect to an audio bus. Plays input signal back after a period of time. Adds a delay audio effect to an audio bus. Plays input signal back after a period of time.
Two tap delay and feedback options. Two tap delay and feedback options.

2
doc/classes/AudioEffectDistortion.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectDistortion" inherits="AudioEffect" version="3.5"> <class name="AudioEffectDistortion" inherits="AudioEffect" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a distortion audio effect to an Audio bus. Adds a distortion audio effect to an Audio bus.
Modify the sound to make it distorted. Modify the sound to make it distorted.

2
doc/classes/AudioEffectEQ.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectEQ" inherits="AudioEffect" version="3.5"> <class name="AudioEffectEQ" inherits="AudioEffect" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Base class for audio equalizers. Gives you control over frequencies. Base class for audio equalizers. Gives you control over frequencies.
Use it to create a custom equalizer if [AudioEffectEQ6], [AudioEffectEQ10] or [AudioEffectEQ21] don't fit your needs. Use it to create a custom equalizer if [AudioEffectEQ6], [AudioEffectEQ10] or [AudioEffectEQ21] don't fit your needs.

2
doc/classes/AudioEffectEQ10.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectEQ10" inherits="AudioEffectEQ" version="3.5"> <class name="AudioEffectEQ10" inherits="AudioEffectEQ" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a 10-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 31 Hz to 16000 Hz. Adds a 10-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 31 Hz to 16000 Hz.
Each frequency can be modulated between -60/+24 dB. Each frequency can be modulated between -60/+24 dB.

2
doc/classes/AudioEffectEQ21.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectEQ21" inherits="AudioEffectEQ" version="3.5"> <class name="AudioEffectEQ21" inherits="AudioEffectEQ" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a 21-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 22 Hz to 22000 Hz. Adds a 21-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 22 Hz to 22000 Hz.
Each frequency can be modulated between -60/+24 dB. Each frequency can be modulated between -60/+24 dB.

2
doc/classes/AudioEffectEQ6.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectEQ6" inherits="AudioEffectEQ" version="3.5"> <class name="AudioEffectEQ6" inherits="AudioEffectEQ" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a 6-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 32 Hz to 10000 Hz. Adds a 6-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 32 Hz to 10000 Hz.
Each frequency can be modulated between -60/+24 dB. Each frequency can be modulated between -60/+24 dB.

2
doc/classes/AudioEffectFilter.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectFilter" inherits="AudioEffect" version="3.5"> <class name="AudioEffectFilter" inherits="AudioEffect" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a filter to the audio bus. Adds a filter to the audio bus.
</brief_description> </brief_description>

2
doc/classes/AudioEffectHighPassFilter.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectHighPassFilter" inherits="AudioEffectFilter" version="3.5"> <class name="AudioEffectHighPassFilter" inherits="AudioEffectFilter" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a high-pass filter to the Audio Bus. Adds a high-pass filter to the Audio Bus.
</brief_description> </brief_description>

2
doc/classes/AudioEffectHighShelfFilter.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectHighShelfFilter" inherits="AudioEffectFilter" version="3.5"> <class name="AudioEffectHighShelfFilter" inherits="AudioEffectFilter" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Reduces all frequencies above the [member AudioEffectFilter.cutoff_hz]. Reduces all frequencies above the [member AudioEffectFilter.cutoff_hz].
</brief_description> </brief_description>

2
doc/classes/AudioEffectInstance.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectInstance" inherits="Reference" version="3.5"> <class name="AudioEffectInstance" inherits="Reference" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc/classes/AudioEffectLimiter.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectLimiter" inherits="AudioEffect" version="3.5"> <class name="AudioEffectLimiter" inherits="AudioEffect" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a soft-clip limiter audio effect to an Audio bus. Adds a soft-clip limiter audio effect to an Audio bus.
</brief_description> </brief_description>

2
doc/classes/AudioEffectLowPassFilter.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectLowPassFilter" inherits="AudioEffectFilter" version="3.5"> <class name="AudioEffectLowPassFilter" inherits="AudioEffectFilter" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a low-pass filter to the Audio bus. Adds a low-pass filter to the Audio bus.
</brief_description> </brief_description>

2
doc/classes/AudioEffectLowShelfFilter.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectLowShelfFilter" inherits="AudioEffectFilter" version="3.5"> <class name="AudioEffectLowShelfFilter" inherits="AudioEffectFilter" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Reduces all frequencies below the [member AudioEffectFilter.cutoff_hz]. Reduces all frequencies below the [member AudioEffectFilter.cutoff_hz].
</brief_description> </brief_description>

2
doc/classes/AudioEffectNotchFilter.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectNotchFilter" inherits="AudioEffectFilter" version="3.5"> <class name="AudioEffectNotchFilter" inherits="AudioEffectFilter" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a notch filter to the Audio bus. Adds a notch filter to the Audio bus.
</brief_description> </brief_description>

2
doc/classes/AudioEffectPanner.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectPanner" inherits="AudioEffect" version="3.5"> <class name="AudioEffectPanner" inherits="AudioEffect" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a panner audio effect to an Audio bus. Pans sound left or right. Adds a panner audio effect to an Audio bus. Pans sound left or right.
</brief_description> </brief_description>

2
doc/classes/AudioEffectPhaser.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectPhaser" inherits="AudioEffect" version="3.5"> <class name="AudioEffectPhaser" inherits="AudioEffect" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a phaser audio effect to an Audio bus. Adds a phaser audio effect to an Audio bus.
Combines the original signal with a copy that is slightly out of phase with the original. Combines the original signal with a copy that is slightly out of phase with the original.

2
doc/classes/AudioEffectPitchShift.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectPitchShift" inherits="AudioEffect" version="3.5"> <class name="AudioEffectPitchShift" inherits="AudioEffect" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a pitch-shifting audio effect to an Audio bus. Adds a pitch-shifting audio effect to an Audio bus.
Raises or lowers the pitch of original sound. Raises or lowers the pitch of original sound.

2
doc/classes/AudioEffectRecord.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectRecord" inherits="AudioEffect" version="3.5"> <class name="AudioEffectRecord" inherits="AudioEffect" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Audio effect used for recording the sound from an audio bus. Audio effect used for recording the sound from an audio bus.
</brief_description> </brief_description>

2
doc/classes/AudioEffectReverb.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectReverb" inherits="AudioEffect" version="3.5"> <class name="AudioEffectReverb" inherits="AudioEffect" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Adds a reverberation audio effect to an Audio bus. Adds a reverberation audio effect to an Audio bus.
Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces. Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces.

2
doc/classes/AudioEffectSpectrumAnalyzer.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectSpectrumAnalyzer" inherits="AudioEffect" version="3.5"> <class name="AudioEffectSpectrumAnalyzer" inherits="AudioEffect" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Audio effect that can be used for real-time audio visualizations. Audio effect that can be used for real-time audio visualizations.
</brief_description> </brief_description>

2
doc/classes/AudioEffectSpectrumAnalyzerInstance.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectSpectrumAnalyzerInstance" inherits="AudioEffectInstance" version="3.5"> <class name="AudioEffectSpectrumAnalyzerInstance" inherits="AudioEffectInstance" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc/classes/AudioEffectStereoEnhance.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectStereoEnhance" inherits="AudioEffect" version="3.5"> <class name="AudioEffectStereoEnhance" inherits="AudioEffect" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc/classes/AudioServer.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioServer" inherits="Object" version="3.5"> <class name="AudioServer" inherits="Object" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Server interface for low-level audio access. Server interface for low-level audio access.
</brief_description> </brief_description>

2
doc/classes/AudioStream.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStream" inherits="Resource" version="3.5"> <class name="AudioStream" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Base class for audio streams. Base class for audio streams.
</brief_description> </brief_description>

2
doc/classes/AudioStreamGenerator.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamGenerator" inherits="AudioStream" version="3.5"> <class name="AudioStreamGenerator" inherits="AudioStream" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Audio stream that generates sounds procedurally. Audio stream that generates sounds procedurally.
</brief_description> </brief_description>

2
doc/classes/AudioStreamGeneratorPlayback.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamGeneratorPlayback" inherits="AudioStreamPlaybackResampled" version="3.5"> <class name="AudioStreamGeneratorPlayback" inherits="AudioStreamPlaybackResampled" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Plays back audio generated using [AudioStreamGenerator]. Plays back audio generated using [AudioStreamGenerator].
</brief_description> </brief_description>

2
doc/classes/AudioStreamMicrophone.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamMicrophone" inherits="AudioStream" version="3.5"> <class name="AudioStreamMicrophone" inherits="AudioStream" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc/classes/AudioStreamPlayback.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamPlayback" inherits="Reference" version="3.5"> <class name="AudioStreamPlayback" inherits="Reference" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Meta class for playing back audio. Meta class for playing back audio.
</brief_description> </brief_description>

2
doc/classes/AudioStreamPlaybackResampled.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamPlaybackResampled" inherits="AudioStreamPlayback" version="3.5"> <class name="AudioStreamPlaybackResampled" inherits="AudioStreamPlayback" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc/classes/AudioStreamPlayer.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamPlayer" inherits="Node" version="3.5"> <class name="AudioStreamPlayer" inherits="Node" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Plays back audio non-positionally. Plays back audio non-positionally.
</brief_description> </brief_description>

2
doc/classes/AudioStreamPlayer2D.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamPlayer2D" inherits="Node2D" version="3.5"> <class name="AudioStreamPlayer2D" inherits="Node2D" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Plays positional sound in 2D space. Plays positional sound in 2D space.
</brief_description> </brief_description>

2
doc/classes/AudioStreamPlayer3D.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamPlayer3D" inherits="Spatial" version="3.5"> <class name="AudioStreamPlayer3D" inherits="Spatial" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Plays positional sound in 3D space. Plays positional sound in 3D space.
</brief_description> </brief_description>

2
doc/classes/AudioStreamRandomPitch.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamRandomPitch" inherits="AudioStream" version="3.5"> <class name="AudioStreamRandomPitch" inherits="AudioStream" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Plays audio with random pitch shifting. Plays audio with random pitch shifting.
</brief_description> </brief_description>

2
doc/classes/AudioStreamSample.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamSample" inherits="AudioStream" version="3.5"> <class name="AudioStreamSample" inherits="AudioStream" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Stores audio data loaded from WAV files. Stores audio data loaded from WAV files.
</brief_description> </brief_description>

2
doc/classes/BackBufferCopy.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BackBufferCopy" inherits="Node2D" version="3.5"> <class name="BackBufferCopy" inherits="Node2D" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Copies a region of the screen (or the whole screen) to a buffer so it can be accessed in your shader scripts through the [code]texture(SCREEN_TEXTURE, ...)[/code] function. Copies a region of the screen (or the whole screen) to a buffer so it can be accessed in your shader scripts through the [code]texture(SCREEN_TEXTURE, ...)[/code] function.
</brief_description> </brief_description>

2
doc/classes/BakedLightmap.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BakedLightmap" inherits="VisualInstance" version="3.5"> <class name="BakedLightmap" inherits="VisualInstance" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Prerendered indirect light map for a scene. Prerendered indirect light map for a scene.
</brief_description> </brief_description>

2
doc/classes/BakedLightmapData.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BakedLightmapData" inherits="Resource" version="3.5"> <class name="BakedLightmapData" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc/classes/BaseButton.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BaseButton" inherits="Control" version="3.5"> <class name="BaseButton" inherits="Control" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Base class for different kinds of buttons. Base class for different kinds of buttons.
</brief_description> </brief_description>

2
doc/classes/Basis.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="Basis" version="3.5"> <class name="Basis" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
3×3 matrix datatype. 3×3 matrix datatype.
</brief_description> </brief_description>

2
doc/classes/BitMap.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BitMap" inherits="Resource" version="3.5"> <class name="BitMap" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Boolean matrix. Boolean matrix.
</brief_description> </brief_description>

2
doc/classes/BitmapFont.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BitmapFont" inherits="Font" version="3.5"> <class name="BitmapFont" inherits="Font" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Renders text using fonts under the [url=https://www.angelcode.com/products/bmfont/]BMFont[/url] format. Renders text using fonts under the [url=https://www.angelcode.com/products/bmfont/]BMFont[/url] format.
Handles files with the [code].fnt[/code] extension. Handles files with the [code].fnt[/code] extension.

2
doc/classes/Bone2D.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="Bone2D" inherits="Node2D" version="3.5"> <class name="Bone2D" inherits="Node2D" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Joint used with [Skeleton2D] to control and animate other nodes. Joint used with [Skeleton2D] to control and animate other nodes.
</brief_description> </brief_description>

2
doc/classes/BoneAttachment.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BoneAttachment" inherits="Spatial" version="3.5"> <class name="BoneAttachment" inherits="Spatial" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
A node that will attach to a bone. A node that will attach to a bone.
</brief_description> </brief_description>

2
doc/classes/BoxContainer.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BoxContainer" inherits="Container" version="3.5"> <class name="BoxContainer" inherits="Container" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Base class for box containers. Base class for box containers.
</brief_description> </brief_description>

2
doc/classes/BoxShape.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="BoxShape" inherits="Shape" version="3.5"> <class name="BoxShape" inherits="Shape" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
Box shape resource. Box shape resource.
</brief_description> </brief_description>

Some files were not shown because too many files have changed in this diff Show More