Skip to main content

SoundRef

Represents a sound instance

Functions​

stop​

</>
SoundRef:stop() → ()

Stops a sound if it is playing

fade​

</>
SoundRef:fade(
time: number--

duration

) → ()

Fades a sound to zero volume over the given time

Show raw api
{
    "functions": [
        {
            "name": "stop",
            "desc": "Stops a sound if it is playing",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 11,
                "path": "../../res/data/script/lib/system/sound_ref.lua"
            }
        },
        {
            "name": "fade",
            "desc": "Fades a sound to zero volume over the given time",
            "params": [
                {
                    "name": "time",
                    "desc": "duration",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 18,
                "path": "../../res/data/script/lib/system/sound_ref.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SoundRef",
    "desc": "Represents a sound instance",
    "source": {
        "line": 5,
        "path": "../../res/data/script/lib/system/sound_ref.lua"
    }
}