class_spatialplayer.rst 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_SpatialPlayer:
  4. SpatialPlayer
  5. =============
  6. **Inherits:** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  7. **Inherited By:** :ref:`SpatialStreamPlayer<class_spatialstreamplayer>`, :ref:`SpatialSamplePlayer<class_spatialsampleplayer>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Member Functions
  12. ----------------
  13. +----------------------------+----------------------------------------------------------------------------------------------------------------------------+
  14. | :ref:`float<class_float>` | :ref:`get_param<class_SpatialPlayer_get_param>` **(** :ref:`int<class_int>` param **)** const |
  15. +----------------------------+----------------------------------------------------------------------------------------------------------------------------+
  16. | void | :ref:`set_param<class_SpatialPlayer_set_param>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
  17. +----------------------------+----------------------------------------------------------------------------------------------------------------------------+
  18. Numeric Constants
  19. -----------------
  20. - **PARAM_VOLUME_DB** = **0**
  21. - **PARAM_PITCH_SCALE** = **1**
  22. - **PARAM_ATTENUATION_MIN_DISTANCE** = **2**
  23. - **PARAM_ATTENUATION_MAX_DISTANCE** = **3**
  24. - **PARAM_ATTENUATION_DISTANCE_EXP** = **4**
  25. - **PARAM_EMISSION_CONE_DEGREES** = **5**
  26. - **PARAM_EMISSION_CONE_ATTENUATION_DB** = **6**
  27. - **PARAM_MAX** = **7**
  28. Member Function Description
  29. ---------------------------
  30. .. _class_SpatialPlayer_get_param:
  31. - :ref:`float<class_float>` **get_param** **(** :ref:`int<class_int>` param **)** const
  32. .. _class_SpatialPlayer_set_param:
  33. - void **set_param** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**