$vol » History » Version 4
Per Amundsen, 02/23/2023 07:56 PM
| 1 | 1 | Per Amundsen | _Added in 1.9.0_ |
|---|---|---|---|
| 2 | |||
| 3 | *$vol(wave|midi|song|mp3|master)* |
||
| 4 | |||
| 5 | Gets the current volume for the specified sound setting. |
||
| 6 | |||
| 7 | *Parameters* |
||
| 8 | |||
| 9 | 4 | Per Amundsen | table(ktable). |
| 10 | |*Parameter*|*Description*| |
||
| 11 | | wave<notextile>|</notextile>midi<notextile>|</notextile>song<notextile>|</notextile>master | The sound setting to get status from. | |
||
| 12 | 1 | Per Amundsen | |
| 13 | *Properties* |
||
| 14 | |||
| 15 | 4 | Per Amundsen | table(ktable). |
| 16 | |*Property*|*Description*| |
||
| 17 | | .mute | Returns [[$true]] if the player is muted, otherwise [[$false]]. | |
||
| 18 | 1 | Per Amundsen | |
| 19 | *Example* |
||
| 20 | |||
| 21 | <pre> |
||
| 22 | ; Print volume for 'song' |
||
| 23 | //echo -ag Volume for song is $vol(song) |
||
| 24 | </pre> |