浏览代码

Go under 3000 Doc errors \o/

sebastien 7 年之前
父节点
当前提交
87f0ef533c
共有 1 个文件被更改,包括 25 次插入0 次删除
  1. 25 0
      src/Audio/babylon.sound.ts

+ 25 - 0
src/Audio/babylon.sound.ts

@@ -1,10 +1,35 @@
 module BABYLON {
 module BABYLON {
+    /**
+     * Defines a sound that can be played in the application.
+     * The sound can either be an ambient track or a simple sound played in reaction to a user action.
+     * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
+     */
     export class Sound {
     export class Sound {
+        /**
+         * The name of the sound in the scene.
+         */
         public name: string;
         public name: string;
+        /**
+         * Does the sound autoplay once loaded.
+         */
         public autoplay: boolean = false;
         public autoplay: boolean = false;
+        /**
+         * Does the sound loop after it finishes playing once.
+         */
         public loop: boolean = false;
         public loop: boolean = false;
+        /**
+         * Does the sound use a custom attenuation curve to simulate the falloff
+         * happening when the source gets further away from the camera.
+         * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
+         */
         public useCustomAttenuation: boolean = false;
         public useCustomAttenuation: boolean = false;
+        /**
+         * The sound track id this sound belongs to.
+         */
         public soundTrackId: number;
         public soundTrackId: number;
+        /**
+         * Does this sound enables spatial sound.
+         */
         public spatialSound: boolean = false;
         public spatialSound: boolean = false;
         public refDistance: number = 1;
         public refDistance: number = 1;
         public rolloffFactor: number = 1;
         public rolloffFactor: number = 1;