diff options
author | SignpostMarv | 2012-10-16 14:30:33 +0100 |
---|---|---|
committer | Justin Clark-Casey (justincc) | 2012-10-29 23:39:01 +0000 |
commit | 2bb041925160922be669d7e185fb5da6df0efd29 (patch) | |
tree | f9c664b87489455d83f47a3e0e03f2f3f5bb3721 /OpenSim/Region/Framework/Interfaces/ISoundModule.cs | |
parent | refactoring llCollisionSound to use new KeyOrName method (diff) | |
download | opensim-SC_OLD-2bb041925160922be669d7e185fb5da6df0efd29.zip opensim-SC_OLD-2bb041925160922be669d7e185fb5da6df0efd29.tar.gz opensim-SC_OLD-2bb041925160922be669d7e185fb5da6df0efd29.tar.bz2 opensim-SC_OLD-2bb041925160922be669d7e185fb5da6df0efd29.tar.xz |
documenting some params on ISoundModule methods
Diffstat (limited to 'OpenSim/Region/Framework/Interfaces/ISoundModule.cs')
-rw-r--r-- | OpenSim/Region/Framework/Interfaces/ISoundModule.cs | 23 |
1 files changed, 16 insertions, 7 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/ISoundModule.cs b/OpenSim/Region/Framework/Interfaces/ISoundModule.cs index 2e53b16..68af492 100644 --- a/OpenSim/Region/Framework/Interfaces/ISoundModule.cs +++ b/OpenSim/Region/Framework/Interfaces/ISoundModule.cs | |||
@@ -100,18 +100,27 @@ namespace OpenSim.Region.Framework.Interfaces | |||
100 | /// <summary> | 100 | /// <summary> |
101 | /// Trigger or play an attached sound in this part's inventory. | 101 | /// Trigger or play an attached sound in this part's inventory. |
102 | /// </summary> | 102 | /// </summary> |
103 | /// <param name="objectID"></param> | 103 | /// <param name="objectID">Sound source ID</param> |
104 | /// <param name="sound"></param> | 104 | /// <param name="sound">Sound asset ID</param> |
105 | /// <param name="volume"></param> | 105 | /// <param name="volume">Sound volume</param> |
106 | /// <param name="triggered"></param> | 106 | /// <param name="triggered">Triggered or not.</param> |
107 | /// <param name="flags"></param> | 107 | /// <param name="flags"></param> |
108 | /// <param name="radius"></param> | 108 | /// <param name="radius">Sound radius</param> |
109 | /// <param name="useMaster"></param> | 109 | /// <param name="useMaster">Play using sound master</param> |
110 | /// <param name="isMaster"></param> | 110 | /// <param name="isMaster">Play as sound master</param> |
111 | void SendSound(UUID objectID, UUID sound, double volume, | 111 | void SendSound(UUID objectID, UUID sound, double volume, |
112 | bool triggered, byte flags, float radius, bool useMaster, | 112 | bool triggered, byte flags, float radius, bool useMaster, |
113 | bool isMaster); | 113 | bool isMaster); |
114 | 114 | ||
115 | /// <summary> | ||
116 | /// Trigger a sound to be played to all agents within an axis-aligned | ||
117 | /// bounding box. | ||
118 | /// </summary> | ||
119 | /// <param name="objectID">Sound source ID</param> | ||
120 | /// <param name="sound">Sound asset ID</param> | ||
121 | /// <param name="volume">Sound volume</param> | ||
122 | /// <param name="min">AABB bottom south-west corner</param> | ||
123 | /// <param name="max">AABB top north-east corner</param> | ||
115 | void TriggerSoundLimited(UUID objectID, UUID sound, double volume, | 124 | void TriggerSoundLimited(UUID objectID, UUID sound, double volume, |
116 | Vector3 min, Vector3 max); | 125 | Vector3 min, Vector3 max); |
117 | } | 126 | } |