setWaterLevel

Define o nível da água — de um elemento específico ou do mundo inteiro.

Sintaxe

bool setWaterLevel ( water agua, number nivel )
bool setWaterLevel ( number nivel [, bool aguaDoMundo = true, bool todosOsElementos = true, bool mar = true, bool foraDoMapa = false ] )

-- só no cliente
bool setWaterLevel ( number x, number y, number z, number nivel )

Parâmetros da primeira forma

Nome	Tipo	Padrão	Descrição
agua	water	—	Elemento de água a mover.
nivel	number	—	Nova altura. Todos os vértices do elemento passam a ficar nessa altura.

Parâmetros da segunda forma

Nome	Tipo	Padrão	Descrição
nivel	number	—	Nova altura da água.
aguaDoMundo	bool	true	Move rios, lagos e piscinas do mapa original.
todosOsElementos	bool	true	Move também todas as águas criadas por script.
mar	bool	true	Move o mar.
foraDoMapa	bool	false	Estende a água para fora dos limites do mapa.

Parâmetros da terceira forma (só no cliente)

Nome	Tipo	Padrão	Descrição
x, y, z	number	—	Um ponto sobre a água a mover.
nivel	number	—	Nova altura do polígono de água sob esse ponto.

Retorno

true. Na primeira forma devolve false se o elemento não for uma água ou se o segundo argumento não for um número. A terceira forma devolve false quando não há água naquele ponto.

No servidor, o mar, o resto da água do mapa e a água fora do mapa guardam cada um o próprio nível, então um jogador que entrar depois recebe cada um exatamente como foi definido por último. No cliente, as mudanças de nível de água feitas por um resource são desfeitas quando esse resource para.

Exemplo

-- inunda a cidade
setWaterLevel(20)

-- só o mar, sem mexer nas águas criadas por script
setWaterLevel(5, false, false, true)

-- levanta uma piscina específica
setWaterLevel(piscina, 12)

Veja também

• getWaveHeight — Devolve a altura das ondas.
• setWaveHeight — Define a altura das ondas.
• createWater — Cria uma superfície de água.
• getWaterVertexPosition — Devolve a posição de um vértice de uma água.
• setWaterVertexPosition — Move um vértice de uma água.
• resetWaterLevel — Devolve toda a água à altura original do mapa.
• getWaterColor — Devolve a cor da água.
• setWaterColor — Define a cor da água.