Difference between revisions of "GetSoundPlaying"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Scruggs
imported>Scruggs
(page was missing the asterisk wildcard)
 
Line 1: Line 1:
{{Function
{{Function
  | origin = OBSE
  | origin = OBSE
  | summary = If no parameters are passed, then it dumps a list of the currently playing sounds and actors making sound to obse.log (this may change). If a string is passed, then it returns the number of times the specified sound is playing. The string may contain wildcards: * matches several characters, and ? matches one character. If a reference is passed in, then the search is restricted to that reference, returning  the number of times it is playing that sound. Some sounds are not associated with objects, so if you pass in a "fuzzy check radius" parameter, it returns the number of times the sound is playing within the specified radius around the reference.
  | summary = If no parameters are passed, then it dumps a list of the currently playing sounds and actors making sound to obse.log (this may change). If a string is passed, then it returns the number of times the specified sound is playing. The string may contain wildcards: * (asterisk) matches several characters, and ? (question mark) matches one character. If a reference is passed in, then the search is restricted to that reference, returning  the number of times it is playing that sound. Some sounds are not associated with objects, so if you pass in a "fuzzy check radius" parameter, it returns the number of times the sound is playing within the specified radius around the reference.
  | name = GetSoundPlaying
  | name = GetSoundPlaying
  | returnVal = playingCount
  | returnVal = playingCount

Latest revision as of 23:58, 18 December 2010

< [[::Category:Functions|Category:Functions]]

A function added by the Oblivion Script Extender.

Syntax:

(playingCount:long) reference.GetSoundPlaying soundName:string fuzzyCheckRadius:float

If no parameters are passed, then it dumps a list of the currently playing sounds and actors making sound to obse.log (this may change). If a string is passed, then it returns the number of times the specified sound is playing. The string may contain wildcards: * (asterisk) matches several characters, and ? (question mark) matches one character. If a reference is passed in, then the search is restricted to that reference, returning the number of times it is playing that sound. Some sounds are not associated with objects, so if you pass in a "fuzzy check radius" parameter, it returns the number of times the sound is playing within the specified radius around the reference.