forked from bartvdbraak/blender
BGE Docs: Documenting missing Sound Actuator attributes based on RNA UI strings.
This commit is contained in:
parent
f90298bc0a
commit
ff94827965
@ -3258,6 +3258,12 @@ Types
|
||||
|
||||
: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 @@ Types
|
||||
|
||||
: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.
|
||||
|
Loading…
Reference in New Issue
Block a user