godot/doc/classes/PhysicsServer2DManager.xml
Rémi Verschelde 81064cc239
Doctool: Remove version attribute from XML header
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 10:08:21 +02:00

30 lines
1.4 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PhysicsServer2DManager" inherits="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
A singleton for managing [PhysicsServer2D] implementations.
</brief_description>
<description>
[PhysicsServer2DManager] is the API for registering [PhysicsServer2D] implementations and for setting the default implementation.
[b]Note:[/b] It is not possible to switch physics servers at runtime. This class is only used on startup at the server initialization level, by Godot itself and possibly by GDExtensions.
</description>
<tutorials>
</tutorials>
<methods>
<method name="register_server">
<return type="void" />
<param index="0" name="name" type="String" />
<param index="1" name="create_callback" type="Callable" />
<description>
Register a [PhysicsServer2D] implementation by passing a [param name] and a [Callable] that returns a [PhysicsServer2D] object.
</description>
</method>
<method name="set_default_server">
<return type="void" />
<param index="0" name="name" type="String" />
<param index="1" name="priority" type="int" />
<description>
Set the default [PhysicsServer2D] implementation to the one identified by [param name], if [param priority] is greater than the priority of the current default implementation.
</description>
</method>
</methods>
</class>