class_physicsserver3dmanager.rst 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/PhysicsServer3DManager.xml.
  6. .. _class_PhysicsServer3DManager:
  7. PhysicsServer3DManager
  8. ======================
  9. **Inherits:** :ref:`Object<class_Object>`
  10. Manager for 3D physics server implementations.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. **PhysicsServer3DManager** is the API for registering :ref:`PhysicsServer3D<class_PhysicsServer3D>` implementations, and for setting the default implementation.
  15. \ **Note:** 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.
  16. .. rst-class:: classref-reftable-group
  17. Methods
  18. -------
  19. .. table::
  20. :widths: auto
  21. +------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`register_server<class_PhysicsServer3DManager_method_register_server>` **(** :ref:`String<class_String>` name, :ref:`Callable<class_Callable>` create_callback **)** |
  23. +------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`set_default_server<class_PhysicsServer3DManager_method_set_default_server>` **(** :ref:`String<class_String>` name, :ref:`int<class_int>` priority **)** |
  25. +------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. .. rst-class:: classref-section-separator
  27. ----
  28. .. rst-class:: classref-descriptions-group
  29. Method Descriptions
  30. -------------------
  31. .. _class_PhysicsServer3DManager_method_register_server:
  32. .. rst-class:: classref-method
  33. void **register_server** **(** :ref:`String<class_String>` name, :ref:`Callable<class_Callable>` create_callback **)**
  34. Register a :ref:`PhysicsServer3D<class_PhysicsServer3D>` implementation by passing a ``name`` and a :ref:`Callable<class_Callable>` that returns a :ref:`PhysicsServer3D<class_PhysicsServer3D>` object.
  35. .. rst-class:: classref-item-separator
  36. ----
  37. .. _class_PhysicsServer3DManager_method_set_default_server:
  38. .. rst-class:: classref-method
  39. void **set_default_server** **(** :ref:`String<class_String>` name, :ref:`int<class_int>` priority **)**
  40. Set the default :ref:`PhysicsServer3D<class_PhysicsServer3D>` implementation to the one identified by ``name``, if ``priority`` is greater than the priority of the current default implementation.
  41. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  42. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  43. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  44. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  45. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  46. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`