Noise Lua API: Difference between revisions
Jump to navigation
Jump to search
(Created Noise API page.) |
mNo edit summary |
||
Line 41: | Line 41: | ||
'''Docs last hacked together on''': 10/11/2017 11:07 | '''Docs last hacked together on''': 10/11/2017 11:07 | ||
[[ | [[Category:Modding]][[Category:LuaAPI]] |
Revision as of 12:27, 10 November 2017
Noise
Description
The Noise system provides a method of producing sounds that the AI can be aware of and respond to.
Functions
Emit
Noise.Emit(deviceName, noiseTable)
Expected parameter types
Name | Type |
---|---|
deviceName | string |
noiseTable | Lua Table |
Description: Emits a noise from deviceName with attributes in noiseTable
Returns: Nothing
Notes: Attraction value is required, volume is optional (default 1.0), as is duration (defaults to 0, which loops the sound).
Silence
Noise.Silence(deviceName, noiseTable)
Expected parameter types
Name | Type |
---|---|
deviceName | string |
noiseTable | Lua Table |
Description: Silences the noise
Returns: Nothing
Notes: Silences the noise, principally from an AI perspective. Will attempt to stop the audio if this noise was set up with an end event.
This file is auto generated, please don't edit manually!
Docs last hacked together on: 10/11/2017 11:07