Difference between revisions of "PlaySound"
Jump to navigation
Jump to search
imported>Geckbot m (Robot: Automated text replacement (-\[\[Category:(.*?)\(GECK 1.0\)\]\] +Category:\1(GECK 1.1))) |
imported>HunterZ (add previously undocumented parameter, fix example) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 3: | Line 3: | ||
|origin = GECK1 | |origin = GECK1 | ||
|summary = [[PlaySound]] plays the specified sound, non-locational. | |summary = [[PlaySound]] plays the specified sound, non-locational. | ||
If the ''SystemSound'' flag is set to a non-zero value, the sound will play even in [[MenuMode]]. Otherwise, the sound may be queued and not played until returning to [[GameMode]]. | |||
|referenceType = | |referenceType = | ||
|arguments = {{FunctionArgument | |arguments = {{FunctionArgument | ||
|Name = SoundName | |Name = SoundName | ||
|Type = EditorID | |Type = EditorID | ||
}}{{FunctionArgument | |||
|Name = SystemSound | |||
|Type = int | |||
|Optional = optional | |||
}} | }} | ||
| | |example = PlaySound AMBCeilingCrumble | ||
The game will play the AMBCeilingCrumble sound | The game will play the AMBCeilingCrumble sound; if in MenuMode, it may not play until return to GameMode. | ||
PlaySound UIItemTakeAll 1 | |||
The UIItemTakeAll sound will be played even in MenuMode. | |||
}} | }} | ||
==Bugs== | |||
This function will not work when called on an ambient sound that consists of one or more .ogg files. | |||
=='''See Also'''== | =='''See Also'''== | ||
[[PlaySound3D]]<br> | [[PlaySound3D]]<br> | ||
Latest revision as of 09:25, 13 March 2012
< [[::Category:Functions|Category:Functions]]
Link to TES4 Construction Set Wiki: PlaySound.
A function included in the GECK version 1.1.0.36.
Description
PlaySound plays the specified sound, non-locational.
If the SystemSound flag is set to a non-zero value, the sound will play even in MenuMode. Otherwise, the sound may be queued and not played until returning to GameMode.
Syntax
PlaySound SoundName:EditorID SystemSound:int
Example
PlaySound AMBCeilingCrumble
The game will play the AMBCeilingCrumble sound; if in MenuMode, it may not play until return to GameMode.
PlaySound UIItemTakeAll 1
The UIItemTakeAll sound will be played even in MenuMode.
Bugs
This function will not work when called on an ambient sound that consists of one or more .ogg files.