Mundo

Estas funções mexem no mundo do ponto de vista de um único jogador: traçar raios contra a geometria, converter coordenadas de mundo em coordenadas de tela, consultar garagens, ligar e desligar efeitos de pós-processamento, ajustar distâncias de LOD e silenciar sons do cenário.

Nada aqui é sincronizado. Cada chamada muda apenas a máquina em que o script está rodando; os outros jogadores continuam vendo e ouvindo o mundo do jeito que estava.

Estas 57 funções existem somente no cliente. Chamá-las de um script de servidor resulta em erro de valor nulo.

Veja também as funções de Mundo compartilhadas, que valem nos dois lados.

Nota

Quando um argumento é inválido, a maioria destas funções não interrompe o script: elas devolvem false (ou nil, onde indicado) e escrevem um aviso no console de debug. Vale a pena conferir o retorno antes de seguir usando o resultado. Algumas delas conferem os argumentos de forma estrita e geram um erro de Lua em vez disso — as páginas delas avisam.

Onde uma função daqui recebe x, y, z, um único Vector3 também funciona — exceto getWorldPropsWithinRange, que recebe apenas números soltos.

Raycasts e colisão

processLineOfSight Traça uma linha entre dois pontos e descreve o primeiro obstáculo encontrado.

isLineOfSightClear Responde apenas se existe caminho livre entre dois pontos, sem descrever o obstáculo.

processLineAgainstMesh Traça uma linha contra a malha de um elemento específico e devolve o ponto exato do triângulo atingido.

testSphereAgainstWorld Testa uma esfera contra o mundo e descreve o que ela encostou.

getGroundPosition Devolve a altura do chão logo abaixo de um ponto.

getRoofPosition Devolve a altura do teto logo acima de um ponto.

Mundo e tela

getScreenFromWorldPosition Converte uma posição do mundo na posição correspondente na tela.

getWorldFromScreenPosition Converte uma posição da tela numa posição do mundo, a uma profundidade escolhida.

Garagens

As garagens são identificadas por um número de 0 a 49. Um ID fora dessa faixa devolve false sem aviso; só um argumento que não seja número registra um.

getGaragePosition Devolve a posição de uma garagem.

getGarageSize Devolve as dimensões de uma garagem.

getGarageBoundingBox Devolve a caixa que delimita a garagem no plano horizontal.

Cenário

removeGameWorld Tira do jogo todo o cenário original: prédios, ruas e objetos fixos.

restoreGameWorld Devolve o cenário original removido por removeGameWorld.

createSWATRope Cria uma corda de descida no ponto indicado, como as usadas em invasões.

getWorldPropsWithinRange Lista os objetos de cenário do próprio jogo próximos de um ponto.

Propriedades de renderização

Estas três funções mexem nos valores que o motor usa para montar a iluminação, o céu e o clima do quadro. O nome da propriedade é exato e sensível a maiúsculas — escreva exatamente como está na tabela. Um nome desconhecido gera um erro de Lua.

Algumas propriedades são cores e usam três números; as demais são escalares e usam um. Passar a quantidade errada devolve false sem aviso.

Propriedade	Valores
AmbientColor	3
AmbientObjColor	3
DirectionalColor	3
LowCloudsColor	3
BottomCloudsColor	3
SpriteSize	1
SpriteBrightness	1
PoleShadowStrength	1
ShadowStrength	1
ShadowsOffset	1
LightsOnGround	1
CloudsAlpha	1
Illumination	1
WetRoads	1
Foggyness	1
Fog	1
RainFog	1
WaterFog	1
Sandstorm	1
Rainbow	1

setWorldProperty Define uma propriedade de renderização.

getWorldProperty Lê uma propriedade de renderização.

resetWorldProperty Devolve uma propriedade de renderização ao valor original.

Pós-processamento

setColorFilter Aplica um filtro de cor sobre a imagem final, em dois passes.

getColorFilter Lê o filtro de cor em vigor.

resetColorFilter Remove o filtro de cor e devolve o controle ao jogo.

setGrainLevel Define a intensidade do granulado sobre a imagem.

setGrainMultiplier Multiplica a intensidade de um dos tipos de granulado.

setBlurLevel Define a intensidade do borrão de movimento.

getBlurLevel Lê a intensidade atual do borrão de movimento.

resetBlurLevel Devolve o borrão de movimento ao controle do jogo.

Efeitos visuais

setVolumetricShadowsEnabled Liga ou desliga as sombras volumétricas.

isVolumetricShadowsEnabled Diz se as sombras volumétricas estão ligadas.

resetVolumetricShadows Devolve as sombras volumétricas ao estado definido pelas configurações do jogador.

setDynamicPedShadowsEnabled Liga ou desliga as sombras dinâmicas dos peds.

isDynamicPedShadowsEnabled Diz se as sombras dinâmicas dos peds estão ligadas.

resetDynamicPedShadows Devolve as sombras dinâmicas dos peds ao estado definido pelas configurações do jogador.

setCoronaReflectionsEnabled Controla o reflexo das luzes no chão.

getCoronaReflectionsEnabled Lê o modo de reflexo das luzes.

resetCoronaReflectionsEnabled Devolve o reflexo das luzes ao padrão.

setBirdsEnabled Liga ou desliga os pássaros que sobrevoam o mapa.

getBirdsEnabled Diz se os pássaros estão ligados.

setInteriorFurnitureEnabled Liga ou desliga a mobília gerada automaticamente em um tipo de cômodo.

getInteriorFurnitureEnabled Diz se a mobília de um tipo de cômodo está ligada.

Corte e LOD

setNearClipDistance Define a que distância da câmera o mundo começa a ser desenhado.

getNearClipDistance Lê a distância mínima de desenho.

resetNearClipDistance Devolve a distância mínima de desenho ao padrão.

setPedsLODDistance Define a partir de que distância os peds passam a ser desenhados em baixa qualidade.

getPedsLODDistance Lê a distância de LOD dos peds.

resetPedsLODDistance Devolve a distância de LOD dos peds ao padrão.

setVehiclesLODDistance Define as distâncias de LOD dos veículos.

getVehiclesLODDistance Lê as distâncias de LOD dos veículos.

resetVehiclesLODDistance Devolve as distâncias de LOD dos veículos ao padrão.

Relógio local

setTimeFrozen Congela ou destrava o avanço do relógio neste cliente.

isTimeFrozen Diz se o relógio está congelado.

resetTimeFrozen Destrava o relógio, equivalente a setTimeFrozen(false).

Sons do mundo

setAmbientSoundEnabled Liga ou desliga um tipo de som ambiente.

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.