[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [52492] trunk/blender/doc/python_api/rst/ bge.types.rst: BGE Docs: Documenting missing Sound Actuator attributes based on RNA UI strings.
Mitchell Stokes
mogurijin at gmail.com
Thu Nov 22 23:13:28 CET 2012
Revision: 52492
http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=52492
Author: moguri
Date: 2012-11-22 22:13:27 +0000 (Thu, 22 Nov 2012)
Log Message:
-----------
BGE Docs: Documenting missing Sound Actuator attributes based on RNA UI strings.
Modified Paths:
--------------
trunk/blender/doc/python_api/rst/bge.types.rst
Modified: trunk/blender/doc/python_api/rst/bge.types.rst
===================================================================
--- trunk/blender/doc/python_api/rst/bge.types.rst 2012-11-22 21:52:30 UTC (rev 52491)
+++ trunk/blender/doc/python_api/rst/bge.types.rst 2012-11-22 22:13:27 UTC (rev 52492)
@@ -3258,6 +3258,12 @@
:type: float
+ .. attribute:: time
+
+ The current position in the audio stream (in seconds).
+
+ :type: float
+
.. attribute:: pitch
The pitch of the sound.
@@ -3270,6 +3276,84 @@
:type: integer
+ .. attribute:: sound
+
+ The sound the actuator should play.
+
+ :type: Audaspace factory
+
+ .. attribute:: is3D
+
+ Whether or not the actuator should be using 3D sound. (read-only)
+
+ :type: boolean
+
+ .. attribute:: volume_maximum
+
+ The maximum gain of the sound, no matter how near it is.
+
+ :type: float
+
+ .. attribute:: volume_minimum
+
+ The minimum gain of the sound, no matter how far it is away.
+
+ :type: float
+
+ .. attribute:: distance_reference
+
+ The distance where the sound has a gain of 1.0.
+
+ :type: float
+
+ .. attribute:: distance_maximum
+
+ The maximum distance at which you can hear the sound.
+
+ :type: float
+
+ .. attribute:: attenuation
+
+ The influence factor on volume depending on distance.
+
+ :type: float
+
+ .. attribute:: cone_angle_inner
+
+ The angle of the inner cone.
+
+ :type: float
+
+ .. attribute:: cone_angle_outer
+
+ The angle of the outer cone.
+
+ :type: float
+
+ .. attribute:: cone_volume_outer
+
+ The gain outside the outer cone (the gain in the outer cone will be interpolated between this value and the normal gain in the inner cone).
+
+ :type: float
+
+ .. method:: startSound()
+
+ Starts the sound.
+
+ :return: None
+
+ .. method:: pauseSound()
+
+ Pauses the sound.
+
+ :return: None
+
+ .. method:: stopSound()
+
+ Stops the sound.
+
+ :return: None
+
.. class:: KX_StateActuator(SCA_IActuator)
State actuator changes the state mask of parent object.
More information about the Bf-blender-cvs
mailing list