Skip to content

Commit 771d541

Browse files
committed
Update class reference to include some keywords
More should be added in future PRs, wherever there is demand.
1 parent 5f095e7 commit 771d541

12 files changed

Lines changed: 13 additions & 13 deletions

doc/classes/@GlobalScope.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1080,7 +1080,7 @@
10801080
[b]Note:[/b] This function is called automatically when the project is run. If you need to fix the seed to have consistent, reproducible results, use [method seed] to initialize the random number generator.
10811081
</description>
10821082
</method>
1083-
<method name="remap">
1083+
<method name="remap" keywords="range, lerp">
10841084
<return type="float" />
10851085
<param index="0" name="value" type="float" />
10861086
<param index="1" name="istart" type="float" />

doc/classes/Area2D.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="Area2D" inherits="CollisionObject2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
2+
<class name="Area2D" inherits="CollisionObject2D" keywords="trigger" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
33
<brief_description>
44
A region of 2D space that detects other [CollisionObject2D]s entering or exiting it.
55
</brief_description>

doc/classes/Area3D.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="Area3D" inherits="CollisionObject3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
2+
<class name="Area3D" inherits="CollisionObject3D" keywords="trigger" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
33
<brief_description>
44
A region of 3D space that detects other [CollisionObject3D]s entering or exiting it.
55
</brief_description>

doc/classes/Array.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@
332332
Returns the script associated with a typed array tied to a class name.
333333
</description>
334334
</method>
335-
<method name="has" qualifiers="const">
335+
<method name="has" qualifiers="const" keywords="includes, contains">
336336
<return type="bool" />
337337
<param index="0" name="value" type="Variant" />
338338
<description>

doc/classes/DirAccess.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="DirAccess" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
2+
<class name="DirAccess" inherits="RefCounted" keywords="directory, path, folder" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
33
<brief_description>
44
Provides methods for managing directories and their content.
55
</brief_description>

doc/classes/InputEventMouseButton.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="InputEventMouseButton" inherits="InputEventMouse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
2+
<class name="InputEventMouseButton" inherits="InputEventMouse" keywords="click, press" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
33
<brief_description>
44
Represents a mouse button being pressed or released.
55
</brief_description>

doc/classes/Node.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -722,7 +722,7 @@
722722
Calls [method Object.notification] with [param what] on this node and all of its children, recursively.
723723
</description>
724724
</method>
725-
<method name="queue_free">
725+
<method name="queue_free" keywords="delete, remove, kill, die">
726726
<return type="void" />
727727
<description>
728728
Queues this node to be deleted at the end of the current frame. When deleted, all of its children are deleted as well, and all references to the node and its children become invalid.

doc/classes/Object.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -623,7 +623,7 @@
623623
[b]Note:[/b] In C#, [param signal] must be in snake_case when referring to built-in Godot signals. Prefer using the names exposed in the [code]SignalName[/code] class to avoid allocating a new [StringName] on each call.
624624
</description>
625625
</method>
626-
<method name="free">
626+
<method name="free" keywords="delete, remove, kill, die">
627627
<return type="void" />
628628
<description>
629629
Deletes the object from memory. Pre-existing references to the object become invalid, and any attempt to access them will result in a run-time error. Checking the references with [method @GlobalScope.is_instance_valid] will return [code]false[/code].

doc/classes/PackedScene.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
Returns the [SceneState] representing the scene file contents.
8989
</description>
9090
</method>
91-
<method name="instantiate" qualifiers="const">
91+
<method name="instantiate" qualifiers="const" keywords="create, make, spawn, new">
9292
<return type="Node" />
9393
<param index="0" name="edit_state" type="int" enum="PackedScene.GenEditState" default="0" />
9494
<description>

doc/classes/PhysicalBone2D.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="PhysicalBone2D" inherits="RigidBody2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
2+
<class name="PhysicalBone2D" inherits="RigidBody2D" keywords="ragdoll" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
33
<brief_description>
44
A [RigidBody2D]-derived node used to make [Bone2D]s in a [Skeleton2D] react to physics.
55
</brief_description>

0 commit comments

Comments
 (0)