Yamyam: 1版をインポートしました

2018-06-28T20:51:26Z

1版をインポートしました

wiki>AnOrdinaryKitten: /* Sound Actuator */

2013-02-14T14:38:28Z

‎Sound Actuator

新規ページ

=Sound Actuator=
The {{Literal|Sound}} actuator allows you to play sound files in the game engine.[[File:BGE_Actuator_Sound.png|thumb|right|271 px|The Sound Actuator]]
See [[Doc:2.6/Manual/Game Engine/Logic/Actuators/Common_Options|Actuator Common Options]] for common options.
{{clr}}

==Actuator Settings==
;'''Sound File'''
:Load a new sound file or select one from the list.
;'''Play Mode'''
:How the sound effect is played.

:'''Play Stop'''
:The sound effect is played when activated. Stops instantly when deactivated.
:'''Play End'''
:The sound effect is played when activated. When deactivated, stops after finishing playing the sound. The sound is not replayed if activated while still playing.
:'''Loop Stop'''
:The sound is played as infinite loop when activated. Stops instantly when deactivated.
:'''Loop End'''
:The sound is played as infinite loop when activated. When deactivated, stops after finishing playing the sound.
:'''Loop Bidirectional'''
:The sound is played as infinite ping-pong loop. When deactivated, stops after finishing playing the sound.
:'''Loop Bidirectional Stop'''
:The sound is played as infinite ping-pong loop. Stops instantly when deactivated.

;'''Volume'''
:The volume at which the sound effect is played.
;'''Pitch'''
:The pitch at which the sound effect is played. 0 is default, 12 is one octave.
;'''3D Sound'''
:If enabled, the sound is affected by distance, speed of the emitting object and various other things. The options below are only available if {{Literal|3d Sound}} is enabled.

;'''Minimum Gain'''
:The minimum gain of the sound, no matter how far it is away.
;'''Maximum Gain'''
:The maximum gain of the sound, no matter how near it is.
;'''Reference Distance'''[[File:BGE_Sound_Cone_Explanation.jpg|thumb|right|200 px| The cones point in the direction of the objects negative Z axis.]]
:The distance at which the sound has a gain of 1.0.
;'''Maximum Distance'''
:The maximum distance at which the sound can be heard.
;'''Rolloff'''
:The influence factor on volume depending on distance. The higher, the more the sound will fade with distance.
;'''Cone Outer Gain'''
:The gain outside the outer cone. The gain inside the outer cone will be interpolated between this value and the normal gain inside the inner cone ({{Literal|Volume}}). Note that the cones always point in the direction of the objects local -Z axis (Figure right).
;'''Cone Outer Angle'''
:The angle of the outer cone.
;'''Cone Inner Angle'''
:The angle of the inner cone.

{{NiceTip|Sound options|3d sound is influenced by the {{Literal|Sound}} options in {{Literal|Render}}. A brief description of the different distance models can be found [http://connect.creativelabs.com/openal/Documentation/OpenAL%201.1%20Specification.htm#_Toc199835864 here].}}
{{clr}}

==Python Access==
All settings of the {{Literal|Sound}} actuator can be retrieved and manipulated via {{Literal|Python}}.

<source lang="python">
# Import GameLogic module so we can access controller and its owner.
import GameLogic
controller = GameLogic.getCurrentController()
owner = controller.owner

# Accessing the sound actuator with the name "Sound".
owner.actuators["Sound"].startSound()
</source>

<source lang="python">
owner.actuators["Sound"].startSound()
</source>
Plays the sound. It has no effect if the sound is already being played.
All settings but {{Literal|Volume}}, {{Literal|Pitch}} and {{Literal|Play Mode}} are ignored.

<source lang="python">
owner.actuators["Sound"].stopSound()
</source>
Instantly stops the sound that is currently being played. Does not work if the sound actuator has been activated via the controller. The play mode has no effect on this.

<source lang="python">
controller.activate(owner.actuators["Sound"])
</source>
The controller activates the actuator.

<source lang="python">
controller.deactivate(owner.actuators["Sound"])
</source>
The controller deactivates the actuator.

<source lang="python">
owner.actuators["Sound"].volume
</source>
Float, gets/sets the actuators {{Literal|Volume}}.
Using negative values does not produce errors but have no effect (Sound is played with default volume).

<source lang="python">
owner.actuators["Sound"].pitch
</source>
Float, gets/sets the actuators {{Literal|Pitch}}. Here the pitch is handled in a different way from the {{Literal|Pitch}} setting in the actuator itself. The default value is 1.0 which is equal to 0.0 in the {{Literal|Pitch}} setting. 2.0 here is equal to 12.0 in {{Literal|Pitch}}, 0.5 is equal to -12.0 in {{Literal|Pitch}} and so on.
Using negative values does not produce errors but have no effect (Sound is played with default pitch).

<source lang="python">
owner.actuators["Sound"].mode
</source>
Integer, gets/sets the actuators {{Literal|Play Mode}}.
:1 = {{Literal|Play Stop}}
:2 = {{Literal|Play End}}
:3 = {{Literal|Loop Stop}}
:4 = {{Literal|Loop End}}
:5 = {{Literal|Loop Bidirectional}}
:6 = {{Literal|Loop Bidirectional Stop}}
Other values are not accepted and cause errors.

<source lang="python">
owner.actuators["Sound"].is3D
</source>
Boolean, gets/sets the actuators {{Literal|3D Sound}}.

<source lang="python">
owner.actuators["Sound"].volume_minimum
</source>
Float, gets/sets the actuators {{Literal|Minimum Gain}}.

<source lang="python">
owner.actuators["Sound"].volume_maximum
</source>
Float, gets/sets the actuators {{Literal|Maximum Gain}}.

<source lang="python">
owner.actuators["Sound"].distance_reference
</source>
Float, gets/sets the actuators {{Literal|Reference Distance}}.

<source lang="python">
owner.actuators["Sound"].distance_maximum
</source>
Float, gets/sets the actuators {{Literal|Maximum Distance}}.

<source lang="python">
owner.actuators["Sound"].cone_volume_outer
</source>
Float, gets/sets the actuators {{Literal|Cone Outer Gain}}.

<source lang="python">
owner.actuators["Sound"].cone_angle_outer
</source>
Float, gets/sets the actuators {{Literal|Cone Outer Angle}}.

<source lang="python">
owner.actuators["Sound"].cone_angle_inner
</source>
Float, gets/sets the actuators {{Literal|Cone Inner Angle}}.

<source lang="python">
owner.actuators["Sound"].time
</source>
Returns unidentified value.

<source lang="python">
owner.actuators["Sound"].sound
</source>
Returns a pointer to the sound file in aud.Factory.

<source lang="python">
owner.actuators["Sound"].attenuation
</source>
Returns unidentified value.
{{clr}}

[[Category:Game_engine]]

← 古い版	2018年6月28日 (木) 20:51時点における版
(相違点なし)

利用者:AnOrdinaryKitten/Doc:2.6/Manual/Game Engine/Logic/Actuators/Sound/ - 版の履歴

Yamyam: 1版 をインポートしました

wiki>AnOrdinaryKitten: /* Sound Actuator */

Yamyam: 1版をインポートしました