Difference between revisions of "PlaySound"
Jump to navigation
Jump to search
imported>Geckbot m (Robot: Automated text replacement (-Link to TES4 Construction Set Wiki +{{Incomplete}}\n\nLink to TES4 Construction Set Wiki)) |
imported>HunterZ (add previously undocumented parameter, fix example) |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{Function | ||
|CSWikiPage = PlaySound | |||
|origin = GECK1 | |||
|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 = | |||
|arguments = {{FunctionArgument | |||
|Name = SoundName | |||
|Type = EditorID | |||
}}{{FunctionArgument | |||
|Name = SystemSound | |||
|Type = int | |||
|Optional = optional | |||
}} | |||
|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. | |||
=='''See Also'''== | =='''See Also'''== | ||
| Line 8: | Line 28: | ||
[[Category:Functions]] | [[Category:Functions]] | ||
[[Category:Functions (GECK 1.1)]] | |||
[[Category:Miscellaneous Functions]] | [[Category:Miscellaneous Functions]] | ||
[[Category:Miscellaneous Functions (GECK 1.1)]] | |||
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.