documenting some params on ISoundModule methods

integration
SignpostMarv 2012-10-16 14:30:33 +01:00 committed by Justin Clark-Casey (justincc)
parent dcac2a7f71
commit 2bb0419251
1 changed files with 16 additions and 7 deletions

View File

@ -100,18 +100,27 @@ namespace OpenSim.Region.Framework.Interfaces
/// <summary> /// <summary>
/// Trigger or play an attached sound in this part's inventory. /// Trigger or play an attached sound in this part's inventory.
/// </summary> /// </summary>
/// <param name="objectID"></param> /// <param name="objectID">Sound source ID</param>
/// <param name="sound"></param> /// <param name="sound">Sound asset ID</param>
/// <param name="volume"></param> /// <param name="volume">Sound volume</param>
/// <param name="triggered"></param> /// <param name="triggered">Triggered or not.</param>
/// <param name="flags"></param> /// <param name="flags"></param>
/// <param name="radius"></param> /// <param name="radius">Sound radius</param>
/// <param name="useMaster"></param> /// <param name="useMaster">Play using sound master</param>
/// <param name="isMaster"></param> /// <param name="isMaster">Play as sound master</param>
void SendSound(UUID objectID, UUID sound, double volume, void SendSound(UUID objectID, UUID sound, double volume,
bool triggered, byte flags, float radius, bool useMaster, bool triggered, byte flags, float radius, bool useMaster,
bool isMaster); bool isMaster);
/// <summary>
/// Trigger a sound to be played to all agents within an axis-aligned
/// bounding box.
/// </summary>
/// <param name="objectID">Sound source ID</param>
/// <param name="sound">Sound asset ID</param>
/// <param name="volume">Sound volume</param>
/// <param name="min">AABB bottom south-west corner</param>
/// <param name="max">AABB top north-east corner</param>
void TriggerSoundLimited(UUID objectID, UUID sound, double volume, void TriggerSoundLimited(UUID objectID, UUID sound, double volume,
Vector3 min, Vector3 max); Vector3 min, Vector3 max);
} }