setAmbientSoundEnabled
Liga ou desliga um tipo de som ambiente.
Sintaxe
Seção intitulada “Sintaxe”bool setAmbientSoundEnabled ( string tipo, bool ativado )Parâmetros
Seção intitulada “Parâmetros”| Nome | Tipo | Padrão | Descrição |
|---|---|---|---|
tipo | string | "general" | "general" ou "gunfire". Maiúsculas e minúsculas são indiferentes. nil age sobre "general". |
ativado | bool | — | true liga, false silencia. |
Os dois argumentos são posicionais: o tipo pode ser nil, mas não pode ser pulado. setAmbientSoundEnabled(false) é recusada — o booleano cai na posição do tipo — e devolve false com um aviso. Um ativado ausente ou que não seja booleano tem o mesmo efeito.
| Tipo | O que cobre |
|---|---|
"general" | Sons de ambiente do cenário. |
"gunfire" | Tiroteios ao fundo. |
Retorno
Seção intitulada “Retorno”true se a mudança foi aplicada. Um tipo desconhecido devolve false e registra um aviso.
Exemplo
Seção intitulada “Exemplo”setAmbientSoundEnabled("general", false) -- silencia o ambiente geralsetAmbientSoundEnabled("gunfire", false) -- sem tiroteio ao fundoVeja também
Seção intitulada “Veja também”isAmbientSoundEnabled— Diz se um tipo de som ambiente está ligado.resetAmbientSounds— Religa todos os tipos de som ambiente.setWorldSoundEnabled— Liga ou desliga um som do mundo, ou um grupo inteiro deles.isWorldSoundEnabled— Diz se um som do mundo está liberado.resetWorldSounds— Libera de volta todos os sons do mundo que tinham sido silenciados.