M MY Multiplayer: Wiki
Lado
Tipo

Referência de scripting

Catálogo completo das funções e eventos Lua do MY Multiplayer (MYMP) por categoria, indicando o lado de execução (cliente, servidor ou compartilhado).

Elementos

NomeLadoDescrição
addElementDataSubscriberServidorInscreve um jogador num dado de elemento definido com o modo de sincronização "subscribe". O jogador recebe o valor atual na hora e cada mudança depois disso.
createElementCompartilhadoCria um elemento de um tipo inventado pelo script, sem nada no mundo. Ele fica sob a raiz dinâmica do recurso.
destroyElementCompartilhadoDestrói um elemento e todos os seus filhos. Antes de sumir, cada um dispara onElementDestroy no servidor ou onClientElementDestroy no cliente.
getAllElementDataCompartilhadoLê todos os dados de um elemento de uma vez.
getElementAlphaCompartilhadoLê a transparência de um elemento, de 0 (invisível) a 255 (opaco).
getElementAngularVelocityCompartilhadoLê a velocidade de giro de um elemento em cada eixo, por passo da simulação.
getElementBoundingBoxClienteLê a caixa de colisão do modelo de um elemento, relativa à origem do modelo.
getElementByIDCompartilhadoProcura o primeiro elemento com um ID, a partir de um elemento e descendo pelos seus filhos.
getElementCastShadowClienteDiz se um elemento projeta sombra.
getElementChildrenCompartilhadoLista os filhos diretos de um elemento, opcionalmente só os de um tipo.
getElementChildrenCountCompartilhadoConta os filhos diretos de um elemento.
getElementDataCompartilhadoLê um dado guardado num elemento.
getElementDimensionCompartilhadoLê a dimensão de um elemento, de 0 a 65535.
getElementDistanceFromCentreOfMassToBaseOfModelClienteLê a distância entre o centro de massa de um elemento e a base do seu modelo.
getElementHealthCompartilhadoLê a vida de um jogador, ped, veículo ou objeto.
getElementIDCompartilhadoLê o ID de um elemento, o nome que getElementByID procura.
getElementInteriorCompartilhadoLê o interior em que um elemento está. O interior 0 é o mundo aberto.
getElementMatrixCompartilhadoLê a matriz 4x4 de um elemento, feita da sua posição e rotação.
getElementModelCompartilhadoLê o nome do modelo de um elemento.
getElementParentCompartilhadoLê o pai de um elemento na árvore de elementos.
getElementPositionCompartilhadoLê a posição de um elemento no mundo.
getElementRadiusClienteLê o raio da esfera de colisão do modelo de um elemento.
getElementRotationCompartilhadoLê a rotação de um elemento em graus.
getElementsByTypeClienteLista todos os elementos de um tipo abaixo de um elemento da árvore neste cliente.
getElementsByTypeServidorLista todos os elementos de um tipo abaixo de um elemento da árvore no servidor.
getElementsInRangeCompartilhadoLista os elementos cuja posição está dentro de uma esfera.
getElementSyncerServidorDiz qual jogador sincroniza um elemento, isto é, qual cliente simula e envia o seu estado ao servidor.
getElementTypeCompartilhadoLê o tipo de um elemento, como "player", "vehicle" ou o tipo dado em createElement.
getElementVelocityCompartilhadoDevolve a velocidade de um elemento.
getRootElementCompartilhadoDevolve o elemento raiz, o topo da árvore de elementos. É o mesmo valor da variável global root.
hasElementDataSubscriberServidorDiz se um jogador está inscrito num dado de elemento.
isElementCompartilhadoDiz se um valor é um elemento que ainda existe.
isElementFrozenCompartilhadoDiz se um elemento está congelado.
isElementInWaterClienteDiz se um ped, jogador ou veículo está na água.
isElementLocalClienteDiz se um elemento foi criado por este cliente, e não pelo servidor.
isElementOnFireCompartilhadoDiz se um elemento está pegando fogo.
isElementOnScreenClienteDiz se um elemento aparece na tela.
isElementStreamableClienteDiz se um elemento entra e sai do streaming conforme a distância.
isElementStreamedInClienteDiz se um elemento está carregado no mundo deste cliente.
isElementSyncerClienteDiz se este cliente sincroniza um ped ou veículo para o servidor.
removeElementDataCompartilhadoApaga um dado guardado num elemento.
removeElementDataSubscriberServidorTira a inscrição de um jogador num dado de elemento. Ele deixa de receber as mudanças desse dado.
setElementAlphaCompartilhadoDefine a transparência de um elemento e de todos os seus filhos.
setElementAngularVelocityCompartilhadoDefine a velocidade de giro de um elemento.
setElementCastShadowClienteLiga ou desliga a sombra que um elemento projeta.
setElementDataClienteGuarda um dado num elemento, só neste cliente.
setElementDataServidorGuarda um dado num elemento e, conforme o sync, envia aos jogadores.
setElementDimensionCompartilhadoMuda a dimensão de um elemento e de todos os seus filhos.
setElementFrozenCompartilhadoCongela ou descongela um elemento e todos os seus filhos.
setElementHealthCompartilhadoDefine a vida de um ped, jogador, veículo ou objeto.
setElementIDCompartilhadoDá um id (nome) a um elemento, para encontrá-lo depois com getElementByID.
setElementInteriorCompartilhadoMuda o interior de um elemento.
setElementMatrixCompartilhadoPosiciona e gira um elemento a partir de uma matriz.
setElementModelServidorTroca o modelo de um ped ou jogador, e dos seus filhos.
setElementOnFireClientePõe fogo ou apaga um elemento neste cliente.
setElementOnFireServidorPõe fogo ou apaga um elemento e os seus filhos, para todos os jogadores.
setElementParentCompartilhadoPõe um elemento como filho de outro na árvore de elementos.
setElementPositionCompartilhadoMove um elemento para uma posição no mundo.
setElementRotationCompartilhadoDefine a rotação 3D de um elemento em graus.
setElementStreamableClienteEscolhe se um elemento entra e sai do streaming conforme a distância ou fica sempre carregado.
setElementSyncerServidorEscolhe qual jogador sincroniza um ped ou veículo.
setElementVelocityCompartilhadoDefine a velocidade de um elemento.
onClientElementDataChangeClienteDisparado quando um dado de um elemento muda ou é removido. Cancelar o evento não desfaz a mudança: o dado deste cliente fica com o novo valor.
onClientElementDestroyClienteDisparado quando um elemento vai ser destruído, enquanto ele ainda existe.
onClientElementDimensionChangeClienteDisparado depois que um elemento muda de dimensão. Não dispara se a dimensão continua a mesma.
onClientElementInteriorChangeClienteDisparado depois que um elemento muda de interior. Não dispara se o interior continua o mesmo.
onClientElementStreamInClienteDisparado quando um elemento entra no streaming deste cliente e passa a existir no mundo do jogo.
onClientElementStreamOutClienteDisparado quando um elemento sai do streaming deste cliente e deixa o mundo do jogo. O elemento continua existindo.
onElementDataChangeServidorDisparado quando um dado de um elemento muda ou é removido. Cancelar o evento devolve o valor anterior (ou apaga a chave, se ela não existia) e a mudança não é enviada aos jogadores.
onElementDestroyServidorDisparado quando um elemento vai ser destruído, enquanto ele ainda existe.
onElementDimensionChangeServidorDisparado depois que um elemento muda de dimensão. Não dispara se a dimensão continua a mesma.
onElementInteriorChangeServidorDisparado depois que um elemento muda de interior. Não dispara se o interior continua o mesmo.
onElementModelChangeServidorDisparado depois que setElementModel troca o modelo de um elemento. Cancelar o evento restaura o modelo anterior, e setElementModel devolve false.
onElementStartSyncServidorDisparado quando um jogador passa a sincronizar um ped ou veículo.
onElementStopSyncServidorDisparado quando um jogador deixa de sincronizar um ped ou veículo.

Anexos

NomeLadoDescrição
attachElementsCompartilhadoPendura um elemento em outro. A partir daí ele segue o alvo até ser solto.
detachElementsCompartilhadoSolta um elemento do elemento em que está anexado. Ele fica onde está.
getAttachedElementsCompartilhadoLista os elementos anexados diretamente a um elemento.
getElementAttachedOffsetsCompartilhadoLê o deslocamento, a rotação e o socket com que um elemento está anexado.
getElementAttachedToCompartilhadoDiz em qual elemento um elemento está anexado.
isElementAttachedCompartilhadoDiz se um elemento está anexado a outro.
setElementAttachedOffsetsCompartilhadoMuda o deslocamento, a rotação e, se pedido, o socket de um elemento anexado.
onClientElementAttachClienteDisparado quando um script do cliente chama attachElements, antes de o elemento ser anexado. Cancelar o evento impede o anexo e faz attachElements devolver false.
onClientElementDetachClienteDisparado antes de um elemento ser solto por um script do cliente, por detachElements ou por attachElements levando-o para outro alvo. Cancelar o evento mantém o elemento anexado.
onElementAttachServidorDisparado quando o servidor chama attachElements, antes de o elemento ser anexado. Cancelar o evento impede o anexo e faz attachElements devolver false.
onElementDetachServidorDisparado antes de um elemento ser solto no servidor, por detachElements ou por attachElements levando-o para outro alvo. Cancelar o evento mantém o elemento anexado.

Componentes e ossos

NomeLadoDescrição
getElementBoneMatrixClienteDevolve a matriz de um osso de um ped ou objeto no mundo.
getElementBonePositionClienteDevolve a posição de um osso de um ped ou objeto no mundo.
getElementBoneQuaternionClienteDevolve a orientação de um osso de um ped ou objeto em relação ao osso pai, como quatérnio.
getElementBoneRotationClienteDevolve a rotação de um osso de um ped ou objeto em relação ao osso pai, em graus.
getElementBoneScaleClienteDevolve a escala de um osso de um ped ou objeto.
getElementComponentPositionClienteDevolve a posição de um componente de um veículo ou objeto.
getElementComponentRotationClienteDevolve a rotação de um componente de um veículo ou objeto, em graus.
getElementComponentsClienteLista os componentes de um veículo ou objeto: os frames com nome do seu modelo.
getElementComponentVisibleClienteDiz se um componente de um veículo ou objeto está visível.
getPedBonePositionClienteDevolve a posição de um osso de um ped no mundo.
resetElementComponentPositionClienteDevolve um componente de um veículo ou objeto à posição original do modelo, desfazendo setElementComponentPosition.
resetElementComponentRotationClienteDevolve um componente de um veículo ou objeto à rotação original do modelo, desfazendo setElementComponentRotation.
setElementBoneMatrixClienteDefine a matriz de um osso de um ped ou objeto no mundo: posição, orientação e escala juntas. A mudança vale só neste cliente.
setElementBonePositionClienteMove um osso de um ped ou objeto para uma posição no mundo, mantendo a orientação. A mudança vale só neste cliente.
setElementBoneQuaternionClienteDefine a orientação de um osso de um ped ou objeto em relação ao osso pai, como quatérnio. A mudança vale só neste cliente.
setElementBoneRotationClienteGira um osso de um ped ou objeto em relação ao osso pai. A mudança vale só neste cliente.
setElementBoneScaleClienteMuda a escala de um osso de um ped ou objeto. A mudança vale só neste cliente.
setElementComponentPositionClienteMove um componente de um veículo ou objeto. A mudança vale só neste cliente.
setElementComponentRotationClienteGira um componente de um veículo ou objeto. A mudança vale só neste cliente.
setElementComponentVisibleClienteMostra ou esconde um componente de um veículo ou objeto. A mudança vale só neste cliente.

Eventos

NomeLadoDescrição
addEventCompartilhadoRegistra um evento novo com esse nome. Só depois disso é possível adicionar handlers a ele e dispará-lo.
addEventHandlerCompartilhadoFaz uma função ser chamada sempre que o evento acontece no elemento indicado ou, com propagate, em qualquer descendente dele.
cancelEventCompartilhadoMarca o evento que está rodando como cancelado. O que o cancelamento impede depende do evento.
cancelLatentEventClientePara o envio de um evento latente deste cliente ao servidor. O servidor descarta o que já tinha recebido e o evento não é disparado.
cancelLatentEventServidorPara o envio de um evento latente do servidor a um jogador. O cliente descarta o que já tinha recebido e o evento não é disparado lá.
getCancelReasonCompartilhadoDá o motivo passado a cancelEvent no último evento que terminou de rodar neste lado.
getEventHandlersCompartilhadoLista as funções que este recurso pôs num evento de um elemento com addEventHandler.
getLatentEventHandlesClienteLista os eventos latentes que este cliente ainda está enviando ao servidor.
getLatentEventHandlesServidorLista os eventos latentes que o servidor ainda está enviando a um jogador.
getLatentEventStatusClienteDiz como está o envio de um evento latente deste cliente ao servidor.
getLatentEventStatusServidorDiz como está o envio de um evento latente do servidor a um jogador.
removeEventHandlerCompartilhadoTira uma função de um evento de um elemento, onde ela foi posta com addEventHandler.
triggerClientEventServidorEnvia um evento aos clientes dos jogadores, que o disparam em source. A função retorna antes de os clientes receberem.
triggerEventCompartilhadoDispara um evento neste lado, em source. Os handlers do próprio elemento e os de seus ancestrais que propagam são chamados na hora, antes de a função retornar.
triggerLatentClientEventServidorEnvia um evento aos clientes dos jogadores aos poucos, em segundo plano, a no máximo bandwidth bytes por segundo para cada jogador. Serve para dados grandes que não podem segurar o resto do tráfego.
triggerLatentServerEventClienteEnvia um evento ao servidor aos poucos, em segundo plano, a no máximo bandwidth bytes por segundo. Serve para dados grandes que não podem segurar o resto do tráfego.
triggerServerEventClienteEnvia um evento ao servidor, que o dispara em source lá. A função retorna antes de o servidor receber.
wasEventCancelledCompartilhadoDiz se o último evento que terminou de rodar neste lado foi cancelado.
onPlayerTriggerEventThresholdServidorDisparado quando um jogador chama triggerServerEvent ou triggerLatentServerEvent vezes demais num intervalo. O servidor não faz mais nada: o que fazer fica com os scripts.

Teclado

NomeLadoDescrição
addCommandHandlerCompartilhadoRegistra uma função que roda quando o comando é digitado no console. Os argumentos chegam como textos separados por espaço.
bindKeyCompartilhadoLiga uma tecla a uma função ou a um comando. A função roda quando a tecla é apertada, solta ou os dois.
executeCommandHandlerClienteRoda os handlers que os scripts do cliente registraram para um comando, como se ele tivesse sido digitado.
executeCommandHandlerServidorRoda os handlers que os scripts do servidor registraram para um comando, como se o jogador o tivesse digitado.
getBoundKeysClienteLista as teclas ligadas a um comando neste cliente.
getCommandsBoundToKeyClienteLista os comandos ligados a uma tecla neste cliente.
getCursorPositionClienteLê onde o cursor está na tela e o ponto do mundo para onde ele aponta.
getFunctionsBoundToKeyCompartilhadoLista as funções que este recurso ligou a uma tecla.
getKeyBoundToCommandClienteDiz qual tecla roda um comando neste cliente.
getKeyBoundToFunctionCompartilhadoDiz a qual tecla este recurso ligou uma função.
getKeyStateClienteDiz se uma tecla está apertada agora.
isCursorShowingClienteDiz se o cursor do mouse está aparecendo.
isKeyBoundCompartilhadoDiz se este recurso ligou uma função a uma tecla.
removeCommandHandlerCompartilhadoRemove o handler que este recurso registrou para um comando.
setCursorAlphaClienteMuda a opacidade do cursor do mouse.
setCursorPositionClienteMove o cursor para um ponto da tela.
showCursorClienteMostra ou esconde o cursor do mouse para este recurso.
unbindKeyCompartilhadoDesfaz binds que este recurso criou numa tecla.
onClientClickClienteDisparado quando um botão do mouse é apertado ou solto com o cursor aparecendo.
onClientCursorMoveClienteDisparado quando o mouse se move.
onClientDoubleClickClienteDisparado quando um botão do mouse é apertado duas vezes seguidas com o cursor aparecendo.
onClientKeyClienteDisparado quando uma tecla ou botão do mouse é apertado ou solto. Cancelar o evento impede os binds dessa tecla e, no aperto, esconde a tecla do jogo enquanto ela fica apertada.
onPlayerCommandServidorDisparado quando um jogador manda um comando ao servidor, antes de ele rodar. Cancelar o evento impede o comando.

Recursos e módulos

NomeLadoDescrição
callCompartilhadoChama uma função que outro recurso exporta no seu meta.xml e devolve o que ela devolver.
deleteResourceServidorTira um recurso parado da lista de recursos e move a pasta ou o arquivo dele para a pasta trash do cache de recursos do servidor.
getResourceDynamicElementRootCompartilhadoDevolve o elemento sob o qual ficam os elementos que o recurso cria por script. Ele é filho do elemento do recurso e se chama dynamic.
getResourceExportedFunctionsCompartilhadoLista os nomes das funções que um recurso exporta no seu meta.xml, de qualquer lado.
getResourceFilesCompartilhadoLista os arquivos que um recurso declara com <file> no meta.xml, com os padrões já expandidos, em ordem alfabética.
getResourceFromNameCompartilhadoEncontra um recurso pelo nome.
getResourceInfoServidorLê um atributo da tag <info> do meta.xml de um recurso, como author ou version.
getResourceNameCompartilhadoDevolve o nome de um recurso.
getResourceRootElementCompartilhadoDevolve o elemento raiz de um recurso, o mesmo que a variável global resourceRoot desse recurso.
getResourcesCompartilhadoLista os recursos que estão rodando neste lado.
getResourceStateCompartilhadoDiz em que estado um recurso está.
getThisResourceCompartilhadoDevolve o recurso em que o script está rodando.
importCompartilhadoRoda um módulo de um recurso no estado Lua deste script, uma vez por estado, e dá o que ele devolveu. As globais que o módulo definiu passam a ser deste script.
refreshResourcesCompartilhadoLê de novo a pasta de recursos: acrescenta os recursos novos, tira os que sumiram (parando os que rodavam) e avisa no log quais recursos em execução mudaram no disco.
restartResourceCompartilhadoPede para parar e iniciar de novo um recurso que está rodando. Isso acontece no próximo ciclo dos recursos, não durante a chamada, e o recurso volta ao seu lugar na ordem de início.
startResourceCompartilhadoInicia um recurso na hora, depois de iniciar os recursos que ele inclui com <include> no meta.xml.
stopResourceCompartilhadoPede para parar um recurso que está rodando. Ele para no próximo ciclo dos recursos, não durante a chamada.
onClientResourceStartClienteDisparado quando um recurso termina de começar, depois que os seus scripts rodaram.
onClientResourceStopClienteDisparado quando um recurso vai parar, enquanto os seus scripts e elementos ainda existem.
onResourcePreStartServidorDisparado quando um recurso está começando, antes de rodar os seus scripts. Cancelar o evento impede o recurso de começar.
onResourceStartServidorDisparado quando um recurso termina de começar, depois que os seus scripts e mapas rodaram.
onResourceStopServidorDisparado quando um recurso vai parar, enquanto os seus scripts e elementos ainda existem.

Tempo e assíncrono

NomeLadoDescrição
async.allCompartilhadoRoda cada função da lista na sua própria thread, todas ao mesmo tempo, e faz a thread atual esperar até todas terminarem.
async.cancelCompartilhadoPara uma thread async deste recurso. Uma thread pausada é encerrada na hora; chamada na própria thread, ela para ali mesmo.
async.mapCompartilhadoChama handler(valor, chave) para cada entrada da tabela, na ordem de pairs, e junta numa lista os resultados que não são nil. O handler pode pausar com async.wait.
async.mutexCompartilhadoRoda uma função numa thread async nova, como async.thread, mas não começa enquanto outra thread iniciada pela mesma linha do código, com a mesma key, ainda está rodando.
async.promiseCompartilhadoRoda handler(resolve, reject) numa thread nova e faz a thread atual esperar até ele chamar resolve ou reject. Serve para esperar uma função que responde por callback.
async.statusCompartilhadoDiz em que estado está uma thread async deste recurso.
async.threadCompartilhadoRoda uma função numa thread async nova, na hora. A chamada retorna quando a função termina ou faz a primeira pausa, como async.wait.
async.waitCompartilhadoPausa a thread async atual por ms milissegundos. O resto do jogo continua rodando.
async.yieldCompartilhadoPausa a thread async atual até a próxima atualização dos scripts, para dividir um trabalho longo em pedaços.
getTimerDetailsCompartilhadoLê o estado de um timer: quanto falta, quantas repetições sobram e o intervalo.
getTimersCompartilhadoLista os timers ativos do recurso que chama.
isTimerCompartilhadoDiz se um timer ainda existe neste recurso.
killTimerCompartilhadoCancela um timer antes de ele terminar.
resetTimerCompartilhadoRecomeça a contagem de um timer do zero, com o mesmo intervalo. As repetições que faltam não mudam.
setTimerCompartilhadoChama uma função depois de um intervalo, uma vez ou repetidamente.
setTimerPausedCompartilhadoPausa ou retoma um timer. Pausado, ele guarda o tempo que faltava e não é chamado.

Convars

NomeLadoDescrição
getConvarCompartilhadoLê uma convar como texto. No cliente, uma convar que o servidor sincroniza vem antes da do próprio cliente.
getConvarIntCompartilhadoLê uma convar como número inteiro.
setConvarClienteDefine uma convar só neste cliente. Ela nunca é enviada ao servidor. Com persist, o valor fica guardado para este servidor e volta na próxima sessão.
setConvarServidorDefine uma convar no servidor, criando-a se não existir. Com synced, o valor vai para todos os clientes, inclusive os que entrarem depois, e o getConvar deles passa a ler este valor.

Arquivos

NomeLadoDescrição
fileCloseCompartilhadoFecha um arquivo, gravando o que falta, e destrói o elemento dele.
fileCopyCompartilhadoCopia um arquivo, que pode ser de outro recurso, para o recurso que chama. As pastas que faltam no destino são criadas.
fileCreateCompartilhadoCria um arquivo vazio e o abre para leitura e escrita. Um arquivo que já existe é apagado e recriado; as pastas que faltam são criadas.
fileDeleteCompartilhadoApaga um arquivo do recurso que chama.
fileExistsCompartilhadoDiz se um caminho é um arquivo. Faz o mesmo que pathIsFile.
fileFlushCompartilhadoGrava no disco o que foi escrito no arquivo e ainda está em memória.
fileGetContentsCompartilhadoLê um arquivo inteiro de uma vez, sem abri-lo.
fileGetPathCompartilhadoDevolve o caminho de um arquivo aberto.
fileGetPosCompartilhadoDevolve a posição atual de leitura e escrita de um arquivo.
fileGetSizeCompartilhadoDevolve o tamanho de um arquivo aberto.
fileIsEOFCompartilhadoDiz se a posição de um arquivo chegou ao fim.
fileOpenCompartilhadoAbre um arquivo que já existe, com a posição no começo.
fileReadCompartilhadoLê bytes de um arquivo a partir da posição atual e avança a posição.
fileRenameCompartilhadoRenomeia ou move um arquivo dentro do recurso que chama. As pastas que faltam no destino são criadas.
fileSetPosCompartilhadoMuda a posição de leitura e escrita de um arquivo.
fileWriteCompartilhadoEscreve um ou mais textos num arquivo, na posição atual.
pathIsDirectoryCompartilhadoDiz se um caminho é uma pasta.
pathIsFileCompartilhadoDiz se um caminho é um arquivo. Faz o mesmo que fileExists.
pathListDirCompartilhadoLista o que há numa pasta.

Dados e utilidades

NomeLadoDescrição
decodeStringCompartilhadoDecodifica ou decifra um texto produzido por encodeString.
encodeStringCompartilhadoCodifica ou cifra um texto com um algoritmo: TEA, AES-128, RSA, Base64, Base32 ou zlib.
fromJSONCompartilhadoConverte texto JSON num valor Lua. É a mesma função que json.decode.
getDistanceBetweenPoints2DCompartilhadoMede a distância entre dois pontos no plano horizontal, ignorando a altura.
getDistanceBetweenPoints3DCompartilhadoMede a distância em linha reta entre dois pontos no espaço.
getEasingValueCompartilhadoCalcula o valor de uma curva de easing num ponto do progresso.
getRealTimeCompartilhadoDevolve a data e a hora reais do computador, no fuso local.
getTickCountCompartilhadoDevolve quantos milissegundos se passaram desde que os scripts deste lado começaram a rodar.
getVersionCompartilhadoDevolve informações sobre a versão do jogo e do Lua.
hashCompartilhadoCalcula o hash de um texto: MD5, SHA-1, SHA-2 ou um HMAC.
interpolateBetweenCompartilhadoInterpola entre dois conjuntos de três números seguindo uma curva de easing.
isnanCompartilhadoDiz se um valor é o número especial NaN (não é um número).
json.decodeCompartilhadoConverte texto JSON num valor Lua. É a mesma função que fromJSON.
json.encodeCompartilhadoConverte um valor Lua em texto JSON. É a mesma função que toJSON.
rgbCompartilhadoJunta os componentes de uma cor num único número ARGB. É a mesma função que tocolor.
rgbaCompartilhadoJunta os componentes de uma cor num único número ARGB, com a opacidade de 0 a 1.
splitCompartilhadoDivide um texto em pedaços nos separadores.
tocolorCompartilhadoJunta os componentes de uma cor num único número ARGB. É a mesma função que rgb.
toJSONCompartilhadoConverte um valor Lua em texto JSON. É a mesma função que json.encode.

Saída e depuração

NomeLadoDescrição
createTrayNotificationClienteMostra uma notificação do sistema na bandeja do Windows, enquanto o jogo está sem foco.
outputDebugStringCompartilhadoEscreve uma linha no log de scripts deste lado, como erro, aviso ou mensagem.
outputServerLogCompartilhadoEscreve uma mensagem no log deste lado, com o nome do recurso na frente.
printCompartilhadoEscreve os valores dados no log de scripts como uma mensagem, separados por tabulação.
setClipboardClienteCopia um texto para a área de transferência do computador do jogador.
onClientDebugMessageClienteDisparado neste cliente para cada linha de script que vai para o log: erros, avisos e mensagens.
onDebugMessageServidorDisparado no servidor para cada linha de script que vai para o log: erros, avisos e mensagens.

Jogadores e contas

NomeLadoDescrição
getMaxPlayersServidorDevolve quantos jogadores o servidor aceita ao mesmo tempo.
getPlayerAccountServidorDevolve a conta MYMP com que o jogador entrou.
getPlayerCountServidorDevolve quantos jogadores estão no servidor.
getPlayerFromNameServidorEncontra um jogador pelo nome exato, diferenciando maiúsculas e minúsculas.
getPlayerIdentifierServidorDevolve um identificador do jogador de um tipo, como steam ou discord.
getPlayerIdentifiersServidorLista todos os identificadores do jogador, cada um como tipo:valor, por exemplo steam:110000112345678 e discord:80351110224678912.
getPlayerIPServidorDevolve o endereço IP de onde o jogador está conectado, sem a porta.
getPlayerNameServidorDevolve o nome do jogador. Num servidor com server_key, é o nome da conta MYMP no formato Nome#Tag.
getPlayerPingClienteDevolve o ping de um jogador. Para o jogador local, é o ping deste cliente com o servidor; para os outros, o que o servidor informou deles.
getPlayerPingServidorDevolve o ping do jogador com o servidor, medido pela conexão.
getPlayersServidorLista todos os jogadores do servidor.
getQueuePriorityServidorLê a prioridade de uma conta na fila do servidor cheio.
getRandomPlayerServidorEscolhe um jogador do servidor ao acaso.
isPlayerSpawnedServidorDiz se o jogador já foi colocado no mundo por spawnPlayer.
kickPlayerServidorDesconecta um jogador do servidor com um motivo.
playSoundFrontEndServidorToca um som de interface do jogo para um jogador, ou para todos os jogadores dentro de um elemento, como root.
setMaxPlayersServidorMuda quantos jogadores o servidor aceita ao mesmo tempo.
setQueuePriorityServidorDefine a prioridade de uma conta na fila do servidor cheio. Quem tem prioridade maior passa na frente.
spawnPlayerServidorColoca o jogador no mundo, com a vida em 100, sem colete, no interior 0 e sem armas.
onPlayerConnectServidorDisparado quando uma conexão vai ser aceita, antes de o jogador existir. Cancelar o evento recusa a entrada.
onPlayerJoinServidorDisparado quando um jogador terminou de entrar e já recebeu o estado inicial do servidor.
onPlayerQueueServidorDisparado quando uma conta vai entrar na fila de um servidor cheio. Cancelar o evento recusa a entrada.
onPlayerQuitServidorDisparado quando um jogador sai do servidor, antes de o seu elemento ser destruído.
onPlayerSpawnServidorDisparado depois que spawnPlayer faz um jogador nascer.

Peds

NomeLadoDescrição
canPedBeKnockedOffBikeClienteDiz se um ped pode cair da moto ou bicicleta ao bater.
createPedClienteCria um ped que existe só neste cliente.
createPedServidorCria um ped no servidor, visto por todos os jogadores.
getPedArmourServidorLê o colete de um ped ou jogador.
getPedBikeControlClienteLê a habilidade de um ped para pilotar motos e bicicletas.
getPedCyclePowerClienteLê a força com que um ped pedala uma bicicleta.
getPedJumpPowerClienteLê a força do pulo de um ped.
getPedMeleeStrengthClienteLê a força dos golpes corpo a corpo de um ped.
getPedMoveStateClienteDiz como um ped a pé está se movendo.
getPedOccupiedVehicleCompartilhadoLê o veículo em que um ped ou jogador está.
getPedOccupiedVehicleSeatCompartilhadoLê o assento que um ped ou jogador ocupa no veículo.
getPedSimplestTaskClienteLê a tarefa mais simples que o ped está executando agora.
getPedStrafePowerClienteLê como o ped acelera ao andar de lado enquanto luta ou mira uma arma.
getPedTaskClienteLê a tarefa que um ped executa num slot e todas as subtarefas dela.
getPedWeaponServidorLê a arma que um ped ou jogador está segurando.
giveWeaponServidorDá uma arma com munição a um ped ou jogador.
isPedDeadServidorDiz se um ped ou jogador está morto.
isPedDoingTaskClienteDiz se um ped está executando uma tarefa, em qualquer slot e em qualquer nível de subtarefa.
isPedDuckedCompartilhadoDiz se um ped ou jogador está agachado.
isPedInVehicleCompartilhadoDiz se um ped ou jogador está num veículo.
isPedInWaterCompartilhadoDiz se um ped ou jogador está na água.
isPedOnGroundCompartilhadoDiz se um ped ou jogador está no chão.
isPedUsingDoubleWeaponsClienteDiz se o ped segura uma cópia da arma também na mão esquerda.
killPedTaskClienteRemove a tarefa que um ped executa num slot.
removePedFromVehicleCompartilhadoTira um ped ou jogador do veículo na hora, sem animação.
setPedArmourServidorDefine o colete de um ped ou jogador e o envia aos clientes.
setPedBikeControlClienteDefine a habilidade de um ped para pilotar motos e bicicletas.
setPedCanBeKnockedOffBikeClienteDefine se um ped pode cair da moto ou bicicleta ao bater.
setPedCyclePowerClienteDefine a força com que um ped pedala uma bicicleta.
setPedDoubleWeaponsClienteDefine se o ped segura uma cópia da arma também na mão esquerda.
setPedEnterVehicleClienteFaz um ped ir até um veículo e entrar nele, como se o jogador apertasse para entrar.
setPedExitVehicleClienteFaz um ped sair do veículo em que está pela porta, com a animação de saída.
setPedJumpPowerClienteDefine a força do pulo de um ped.
setPedMeleeStrengthClienteDefine a força dos golpes corpo a corpo de um ped.
setPedStrafePowerClienteDefine como o ped acelera ao andar de lado enquanto luta ou mira uma arma.
warpPedIntoVehicleCompartilhadoColoca um ped ou jogador direto num assento de um veículo, sem animação.
onClientPedStepClienteDisparado a cada passo de um ped ou jogador, quando o pé toca o chão.
onClientPedsProcessedClienteDisparado a cada quadro depois que os peds e objetos foram animados, antes de serem apresentados e desenhados.

Controles

NomeLadoDescrição
getControlStateClienteDiz se um controle de um ped está pressionado, como forwards, fire ou accelerate.
getControlStateServidorDiz se um jogador está pressionando um controle, segundo as teclas que o cliente dele mandou por último.
getPedAnalogControlStateClienteDiz o quanto um controle de um ped está pressionado, de 0 a 1. Serve para os controles analógicos, como andar, virar e acelerar.
getPedCameraRotationClienteDiz para onde a câmera de um ped está virada, em graus. No jogador local, é a câmera do jogo; num jogador remoto, a que chegou pela rede; num ped, a que um script pôs.
getPedContactElementClienteDevolve o veículo ou objeto sobre o qual um ped está pisando.
getPedControlStateClienteDiz se um controle de um ped está pressionado, como forwards, fire ou accelerate.
isControlEnabledClienteDiz se um controle do jogador local está ligado.
isControlEnabledServidorDiz se um controle de um jogador está ligado, segundo o que o servidor mandou ao cliente dele.
setControlStateClientePressiona ou solta um controle de um ped como se fosse uma tecla, por exemplo para fazê-lo andar, pular ou atirar.
setControlStateServidorPressiona ou solta um controle de um jogador como se fosse uma tecla. A ordem vai para o cliente dele, que a aplica como setControlState no jogador local.
setPedAnalogControlStateClientePressiona um controle analógico de um ped só em parte, por exemplo para ele andar devagar ou virar de leve.
setPedCameraRotationClienteMuda para onde a câmera de um ped está virada. No jogador local, gira a câmera do jogo; num ped, é a direção em que ele olha e mira.
setPedControlStateClientePressiona ou solta um controle de um ped como se fosse uma tecla, por exemplo para fazê-lo andar, pular ou atirar.
toggleAllControlsClienteLiga ou desliga de uma vez todos os controles do jogador local.
toggleAllControlsServidorLiga ou desliga de uma vez todos os controles de um jogador. A ordem vai para o cliente dele.
toggleControlClienteLiga ou desliga um controle do jogador local. Um controle desligado não chega ao jogo, mesmo com a tecla pressionada.
toggleControlServidorLiga ou desliga um controle de um jogador. O cliente dele deixa de passar esse controle ao jogo, mesmo com a tecla pressionada.

Animações

NomeLadoDescrição
getPedAnimationClienteDiz qual animação de setPedAnimation um ped está tocando neste cliente.
getPedAnimationLengthClienteDiz a duração da animação que o ped toca, como a de setPedAnimation.
getPedAnimationProgressClienteDiz em que ponto está a animação que o ped toca, como a de setPedAnimation.
getPedAnimationSpeedClienteDiz a velocidade da animação que o ped toca, como a de setPedAnimation.
setPedAnimationClienteFaz um ped tocar uma animação de um bloco, ou para a animação que ele está tocando. A animação vale só neste cliente.
setPedAnimationProgressClientePula uma animação que o ped está tocando para um ponto dela. Sem anim, para a animação de setPedAnimation.
setPedAnimationSpeedClienteMuda a velocidade de uma animação que o ped está tocando.

Aparência

NomeLadoDescrição
addPedClothesCompartilhadoVeste uma peça de roupa num ped. A peça ocupa o seu encaixe e troca a que estava nele.
getClothesVariantCountCompartilhadoConta quantas texturas uma peça de roupa tem para o modelo de um ped.
getPedBodyShapeCompartilhadoDiz quanto de uma forma de corpo um ped tem.
getPedClothesCompartilhadoDiz que roupas um ped veste, todas ou a de um encaixe.
getPedHairColorCompartilhadoDiz a cor do cabelo de um ped e das mechas, se houver.
getPedHeadBlendCompartilhadoDiz como o rosto de um ped mistura os seus dois pais.
getPedHeadShapeCompartilhadoDiz quanto um traço do rosto de um ped foi ajustado.
getPedOverlayCompartilhadoDiz qual variante de uma sobreposição um ped usa no rosto.
getPedOverlayColorCompartilhadoDiz a cor de uma sobreposição que o ped usa no rosto.
removePedClothesCompartilhadoTira a peça de roupa que um ped veste num encaixe.
setPedBodyShapeCompartilhadoMuda o corpo de um ped por uma forma nomeada, que aumenta os ossos que ela declara.
setPedHairColorCompartilhadoTinge o cabelo de um ped e, se quiser, as mechas.
setPedHeadBlendCompartilhadoMonta o rosto de um ped misturando a cabeça e a pele de dois pais.
setPedHeadShapeCompartilhadoAjusta um traço do rosto de um ped, como o nariz ou o queixo.
setPedOverlayCompartilhadoPõe ou tira uma sobreposição no rosto de um ped, como barba, sobrancelha ou maquiagem.
setPedOverlayColorCompartilhadoTinge uma sobreposição que o ped usa no rosto, por uma linha da paleta ou por uma cor.

Ambiente do jogador

NomeLadoDescrição
getLocalizationClienteDevolve o idioma em que o jogador está jogando, o mesmo escolhido no launcher.
isStreamerModeClienteDiz se o modo streamer está ligado. Nele, o console esconde todo endereço IPv4 que mostra.
onClientStreamerModeChangeClienteDisparado quando o modo streamer liga ou desliga.

Veículos

NomeLadoDescrição
addVehicleUpgradeCompartilhadoInstala um upgrade de tuning em um veículo, trocando o que estiver no mesmo slot.
createVehicleClienteCria um veículo que existe só neste cliente.
createVehicleServidorCria um veículo no servidor, visto por todos os jogadores.
fixVehicleCompartilhadoConserta um veículo por completo: a vida volta a 1000 e as portas, rodas e luzes voltam ao estado inicial, sem amassados nem buracos de bala.
getVehicleCompatibleUpgradesCompartilhadoDevolve os upgrades de tuning que servem no modelo de um veículo.
getVehicleControllerCompartilhadoDevolve quem está dirigindo um veículo, ou seja, o ocupante do banco 0.
getVehicleDoorOpenRatioCompartilhadoDevolve quanto uma ou mais portas de um veículo estão abertas.
getVehicleDoorStateCompartilhadoDevolve o estado de uma ou mais portas de um veículo.
getVehicleEngineSoundClienteDevolve os sons de motor e de indução que setVehicleEngineSound pôs num veículo.
getVehicleEngineSoundsClienteLista os conjuntos de sons de motor que os pacotes montados trazem.
getVehicleEngineStateCompartilhadoDevolve se o motor de um veículo está ligado.
getVehicleHeadLightColorCompartilhadoDevolve a cor da luz dos faróis de um veículo.
getVehicleHydraulicsCompartilhadoDiz se um veículo tem hidráulica instalada por setVehicleHydraulics.
getVehicleHydraulicsControlCompartilhadoDevolve quanto setVehicleHydraulicsControl mandou levantar cada roda de um veículo.
getVehicleLightStateCompartilhadoDevolve se uma ou mais luzes de um veículo estão quebradas.
getVehicleMaxPassengersClienteDiz quantos passageiros cabem num veículo, sem contar o motorista.
getVehicleMaxPassengersServidorDiz quantos passageiros cabem num veículo, sem contar o motorista.
getVehicleOccupantCompartilhadoDevolve o ped ou jogador sentado em um banco de um veículo.
getVehicleOccupantsCompartilhadoDevolve todos os peds e jogadores dentro de um veículo.
getVehicleOverrideLightsCompartilhadoDevolve se os faróis de um veículo estão forçados a ficar ligados ou desligados.
getVehicleSuspensionHeightCompartilhadoDevolve a altura de suspensão que setVehicleSuspensionHeight deu a um veículo.
getVehicleTowedByVehicleCompartilhadoDevolve o reboque ou veículo que este veículo está puxando.
getVehicleTowingVehicleCompartilhadoDevolve o veículo que está puxando este veículo.
getVehicleUpgradeOnSlotCompartilhadoDevolve o upgrade instalado em um slot de um veículo.
getVehicleUpgradesCompartilhadoDevolve todos os upgrades de tuning instalados em um veículo.
getVehicleUpgradeSlotNameCompartilhadoDevolve o nome de um slot de upgrade, a partir do índice do slot ou de um upgrade que vai nele.
getVehicleUpgradeSlotsCompartilhadoDevolve os nomes de todos os slots de upgrade que os pacotes montados declaram.
getVehicleWheelCamberCompartilhadoDevolve a cambagem das rodas de um veículo.
getVehicleWheelFrictionStateClienteDiz como as rodas de um veículo estão aderindo ao chão.
getVehicleWheelOffsetCompartilhadoDevolve o deslocamento das rodas de um veículo.
getVehicleWheelScaleCompartilhadoDevolve o fator de raio dos pneus de um veículo.
getVehicleWheelStateCompartilhadoDevolve o estado de uma ou mais rodas de um veículo.
getVehicleWheelStatesCompartilhadoDevolve o estado das quatro rodas de um veículo.
getVehicleWheelWidthCompartilhadoDevolve o fator de largura dos pneus de um veículo.
isVehicleFullBeamCompartilhadoDevolve se o farol alto de um veículo está ligado.
isVehicleLockedCompartilhadoDevolve se as portas de um veículo estão trancadas.
isVehicleOnGroundCompartilhadoDevolve se um veículo está apoiado no chão.
isVehicleWheelOnGroundClienteDiz se as rodas de um veículo estão tocando alguma coisa.
removeVehicleUpgradeCompartilhadoTira um upgrade de tuning de um veículo.
setVehicleDoorOpenRatioCompartilhadoAbre ou fecha uma ou mais portas de um veículo até uma fração, de uma vez ou aos poucos.
setVehicleDoorStateCompartilhadoMuda o estado de uma ou mais portas de um veículo: fechada, aberta, amassada ou arrancada.
setVehicleEngineSoundClienteTroca o som do motor de um veículo neste cliente por um conjunto de sons dos pacotes montados.
setVehicleEngineStateCompartilhadoLiga ou desliga o motor de um veículo.
setVehicleFullBeamCompartilhadoLiga ou desliga o farol alto de um veículo.
setVehicleHeadLightColorCompartilhadoMuda a cor da luz dos faróis de um veículo.
setVehicleHydraulicsCompartilhadoInstala ou tira a hidráulica de um veículo.
setVehicleHydraulicsControlCompartilhadoLevanta cada roda de um veículo com a hidráulica, sem ninguém nos controles.
setVehicleLightStateCompartilhadoQuebra ou conserta uma ou mais luzes de um veículo.
setVehicleLockedCompartilhadoTranca ou destranca as portas de um veículo.
setVehicleOverrideLightsCompartilhadoForça os faróis de um veículo a ficarem ligados ou desligados, ou devolve a decisão ao jogo.
setVehicleSuspensionHeightCompartilhadoSobe ou rebaixa a suspensão de um veículo.
setVehicleWheelCamberCompartilhadoInclina as rodas de um veículo para dentro ou para fora (cambagem).
setVehicleWheelOffsetCompartilhadoDesloca as rodas de um veículo de onde o modelo as põe.
setVehicleWheelScaleCompartilhadoAumenta ou diminui o raio dos pneus de um veículo.
setVehicleWheelStateCompartilhadoMuda o estado de uma ou mais rodas de um veículo: cheia, furada, solta ou sem colisão.
setVehicleWheelStatesCompartilhadoMuda o estado das quatro rodas de um veículo de uma vez.
setVehicleWheelWidthCompartilhadoAlarga ou estreita os pneus de um veículo.
onClientPedVehicleEnterClienteDisparado no cliente quando um ped (que não é jogador) termina de entrar num veículo.
onClientPedVehicleExitClienteDisparado no cliente quando um ped (que não é jogador) sai de um veículo.
onClientPlayerVehicleEnterClienteDisparado no cliente quando um jogador termina de entrar num veículo.
onClientPlayerVehicleExitClienteDisparado no cliente quando um jogador sai de um veículo.
onClientTrailerAttachClienteDisparado no cliente quando um reboque é engatado num veículo.
onClientTrailerDetachClienteDisparado no cliente quando um reboque é solto do veículo que o puxava.
onClientVehicleEnterClienteDisparado no cliente quando um ped termina de entrar num veículo.
onClientVehicleExitClienteDisparado no cliente quando um ped sai de um veículo.
onClientVehicleStartEnterClienteDisparado no cliente quando um ped começa a entrar num veículo. Cancelar o evento impede a entrada.
onClientVehicleStartExitClienteDisparado no cliente quando um ped começa a sair de um veículo. Cancelar o evento impede a saída.
onPedVehicleEnterServidorDisparado no servidor quando um ped (que não é jogador) termina de entrar num veículo.
onPedVehicleExitServidorDisparado no servidor quando um ped (que não é jogador) sai de um veículo.
onPlayerVehicleEnterServidorDisparado no servidor quando um jogador termina de entrar num veículo.
onPlayerVehicleExitServidorDisparado no servidor quando um jogador sai de um veículo.
onTrailerAttachServidorDisparado no servidor quando um reboque é engatado num veículo. Cancelar o evento solta o reboque.
onTrailerDetachServidorDisparado no servidor quando um reboque é solto do veículo que o puxava.
onVehicleEnterServidorDisparado no servidor quando um ped termina de entrar num veículo.
onVehicleExitServidorDisparado no servidor quando um ped sai de um veículo.
onVehicleStartEnterServidorDisparado no servidor quando um ped começa a entrar num veículo. Cancelar o evento impede a entrada.
onVehicleStartExitServidorDisparado no servidor quando um ped começa a sair de um veículo ou vai ser puxado para fora. Cancelar o evento impede a saída.

Visual dos veículos

NomeLadoDescrição
areVehicleLightTrailsEnabledClienteDiz se um veículo deixa rastros de luz atrás das lanternas traseiras.
getVehicleDirtColorCompartilhadoDiz a cor da sujeira na pintura de um veículo.
getVehicleDirtLevelCompartilhadoDiz quanta sujeira aparece na pintura de um veículo.
getVehicleNeonColorCompartilhadoDiz a cor do neon de um veículo.
getVehicleNeonPowerCompartilhadoDiz o brilho do neon de um veículo.
getVehicleNeonStripsCompartilhadoLista as faixas de neon que o modelo de um veículo tem.
getVehicleWetnessLevelCompartilhadoDiz quão molhado um veículo foi fixado.
isVehicleBackfireEnabledClienteDiz se um veículo solta chamas sozinho pelo escapamento.
isVehicleNeonEnabledCompartilhadoDiz se faixas de neon de um veículo estão acesas.
resetVehicleDirtColorCompartilhadoVolta a sujeira de um veículo à cor padrão, 59, 57, 52.
resetVehicleWetnessLevelCompartilhadoFaz um veículo voltar a ficar molhado conforme a chuva, desfazendo setVehicleWetnessLevel.
setVehicleBackfireEnabledClienteLiga ou desliga as chamas que saem sozinhas do escapamento de um veículo ao tirar o pé do acelerador em alta rotação ou ao subir de marcha.
setVehicleDirtColorCompartilhadoMuda a cor da sujeira na pintura de um veículo, como lama ou areia.
setVehicleDirtLevelCompartilhadoMuda quanta sujeira aparece na pintura de um veículo.
setVehicleLightTrailsEnabledClienteLiga ou desliga rastros de luz vermelha atrás das lanternas traseiras acesas de um veículo, mais longos quanto mais rápido ele anda.
setVehicleNeonColorCompartilhadoMuda a cor do neon de um veículo. A cor vale para todas as faixas.
setVehicleNeonEnabledCompartilhadoAcende ou apaga faixas de neon sob um veículo.
setVehicleNeonPowerCompartilhadoMuda o brilho do neon de um veículo.
setVehicleWetnessLevelCompartilhadoFixa quão molhado um veículo aparece, em vez de seguir a chuva.
triggerVehicleBackfireClienteFaz sair uma pequena chama de cada escapamento de um veículo, uma vez.

Handling

NomeLadoDescrição
getModelHandlingServidorLê o handling de um modelo de veículo, com que os veículos novos desse modelo começam.
getOriginalHandlingClienteLê o handling original de um modelo de veículo, como o jogo o carregou, sem as mudanças dos scripts.
getOriginalHandlingServidorLê o handling original de um modelo de veículo, como os pacotes de conteúdo o declaram, sem as mudanças dos scripts.
getVehicleHandlingCompartilhadoLê o handling de um veículo: massa, motor, tração, suspensão e o resto do que define como ele anda.
setModelHandlingServidorMuda uma propriedade do handling de um modelo de veículo, com que os veículos novos desse modelo começam.
setVehicleHandlingClienteMuda o handling de um veículo só neste cliente.
setVehicleHandlingServidorMuda o handling de um veículo para todos os jogadores.

Mundo e clima

NomeLadoDescrição
createFireClienteAcende um fogo num ponto, só neste cliente. Ele queima por 5 segundos.
createLadderClienteCria uma escada em que peds podem subir, só neste cliente.
extinguishFireClienteApaga os fogos dentro de um raio de um ponto. Sem argumentos, apaga todos os fogos deste cliente.
getCloudsDensityClienteDevolve quanto do céu as nuvens cobrem: o valor de setCloudsDensity ou, sem ele, o atual das nuvens.
getFarClipDistanceClienteDevolve até que distância o mundo está sendo desenhado agora.
getFiresInRangeClienteLista os fogos acesos perto de um ponto. A distância é medida só no plano horizontal.
getFogDistanceClienteDevolve a que distância a neblina começa: o valor de setFogDistance ou, sem ele, o do ciclo de tempo.
getGroundPositionClienteProcura o chão logo abaixo de um ponto, até 1000 m para baixo. Só prédios e objetos contam.
getMinuteDurationClienteDevolve quanto tempo real dura um minuto do jogo neste cliente.
getMoonColorClienteDevolve a cor da lua que está sendo usada: a definida por setMoonColor ou, sem ela, a do ciclo de tempo.
getMoonSizeClienteDevolve o tamanho do disco da lua: o definido por setMoonSize ou, sem ele, o do ciclo de tempo.
getScreenFromWorldPositionClienteProjeta um ponto do mundo na tela, com a câmera do quadro atual.
getSkyColorClienteDevolve o degradê do céu definido por setSkyColor.
getSunColorClienteDevolve a cor do sol que está sendo usada: a definida por setSunColor ou, sem ela, a do ciclo de tempo.
getSunSizeClienteDevolve o tamanho do disco do sol: o definido por setSunSize ou, sem ele, o do ciclo de tempo.
getTimeClienteDevolve a hora do jogo neste cliente.
getWeatherClienteDevolve o clima atual deste cliente. Durante uma transição, é o clima de destino.
getWeatherNamesClienteLista os climas que os pacotes carregados declaram.
getWorldFromScreenPositionClienteConverte um ponto da tela, a uma profundidade, num ponto do mundo, com a câmera do quadro atual.
isLineOfSightClearClienteDiz se nada bloqueia o segmento entre dois pontos. Só prédios e objetos bloqueiam; veículos e peds não.
isTimeFrozenClienteDiz se o relógio do jogo está congelado neste cliente.
processLineOfSightClienteLança um raio entre dois pontos e devolve a primeira coisa que ele acerta.
resetCloudsDensityClienteDesfaz setCloudsDensity: a cobertura de nuvens volta a seguir o ciclo de tempo.
resetFarClipDistanceClienteDesfaz setFarClipDistance: a distância de desenho volta a seguir o ciclo de tempo.
resetFogDistanceClienteDesfaz setFogDistance: a neblina volta a seguir o ciclo de tempo.
resetMoonColorClienteDesfaz setMoonColor: a cor da lua volta a seguir o ciclo de tempo.
resetMoonSizeClienteDesfaz setMoonSize: o tamanho da lua volta a seguir o ciclo de tempo.
resetSkyColorClienteDesfaz setSkyColor: o céu volta a seguir o ciclo de tempo.
resetSunColorClienteDesfaz setSunColor: a cor do sol volta a seguir o ciclo de tempo.
resetSunSizeClienteDesfaz setSunSize: o tamanho do sol volta a seguir o ciclo de tempo.
setCloudsDensityClienteMuda quanto do céu as nuvens cobrem, por cima do ciclo de tempo, até ser restaurado com resetCloudsDensity.
setFarClipDistanceClienteMuda até que distância da câmera o mundo é desenhado, por cima do ciclo de tempo, até ser restaurada com resetFarClipDistance.
setFogDistanceClienteMuda a que distância da câmera a neblina começa, por cima do ciclo de tempo, até ser restaurada com resetFogDistance.
setMinuteDurationClienteDefine quanto tempo real dura um minuto do jogo neste cliente.
setMoonColorClienteMuda a cor da lua, por cima do ciclo de tempo, até ser restaurada com resetMoonColor.
setMoonSizeClienteMuda o tamanho do disco da lua no céu, por cima do ciclo de tempo, até ser restaurado com resetMoonSize.
setSkyColorClientePinta o céu com um degradê do topo ao horizonte, por cima do ciclo de tempo, até ser restaurado com resetSkyColor.
setSunColorClienteMuda a cor do sol, por cima do ciclo de tempo, até ser restaurada com resetSunColor.
setSunSizeClienteMuda o tamanho do disco do sol no céu, por cima do ciclo de tempo, até ser restaurado com resetSunSize.
setTimeClienteMuda a hora do jogo neste cliente. O relógio continua andando a partir dela.
setTimeFrozenClienteCongela ou descongela o relógio do jogo neste cliente. Congelado, a hora não avança, mas setTime ainda a muda.
setWeatherClienteMuda o clima deste cliente, de uma vez ou numa transição.

Objetos

NomeLadoDescrição
breakObjectCompartilhadoQuebra um objeto quebrável na hora.
createObjectClienteCria um objeto que existe só neste cliente.
createObjectServidorCria um objeto que todos os jogadores veem.
getObjectScaleCompartilhadoDevolve a escala de um objeto em cada eixo.
moveObjectCompartilhadoMove um objeto suavemente até uma posição, girando-o no caminho.
setObjectBreakableCompartilhadoDefine se um objeto quebrável pode ser quebrado. Um objeto que não pode fica imune a qualquer dano.
setObjectScaleCompartilhadoMuda o tamanho de um objeto, por igual ou em cada eixo.
stopObjectCompartilhadoPara o movimento de um objeto onde ele estiver.
onClientObjectMoveStartClienteDisparado neste cliente quando um objeto começa um movimento de moveObject, criado por este cliente ou vindo do servidor.
onClientObjectMoveStopClienteDisparado neste cliente quando o movimento de um objeto termina: ele chegou, stopObject o parou ou um novo moveObject tomou o lugar.

Áreas de colisão

NomeLadoDescrição
createColCircleCompartilhadoCria uma área de colisão circular, sem limite de altura.
createColCuboidCompartilhadoCria uma área de colisão em forma de caixa, alinhada aos eixos do mundo.
createColPolygonCompartilhadoCria uma área de colisão com a forma de um polígono no plano, sem limite de altura até setColPolygonHeight dar um.
createColRectangleCompartilhadoCria uma área de colisão retangular, alinhada aos eixos do mundo e sem limite de altura.
createColSphereCompartilhadoCria uma área de colisão esférica.
createColTubeCompartilhadoCria uma área de colisão em forma de cilindro vertical.
getColPolygonHeightCompartilhadoDevolve entre que alturas um polígono de colisão detecta elementos.
getColShapeTypeCompartilhadoDiz que forma uma área de colisão tem.
getElementsWithinColShapeCompartilhadoLista os elementos que estão dentro de uma área de colisão.
isElementWithinColShapeCompartilhadoDiz se um elemento está dentro de uma área de colisão.
setColPolygonHeightCompartilhadoLimita entre que alturas um polígono de colisão detecta elementos.
onClientColShapeHitClienteDisparado quando um jogador, ped, veículo ou objeto entra numa área de colisão neste cliente.
onClientColShapeLeaveClienteDisparado quando um jogador, ped, veículo ou objeto sai de uma área de colisão neste cliente.
onClientElementColShapeHitClienteDisparado num jogador, ped, veículo ou objeto quando ele entra numa área de colisão neste cliente.
onClientElementColShapeLeaveClienteDisparado num jogador, ped, veículo ou objeto quando ele sai de uma área de colisão neste cliente.
onColShapeHitServidorDisparado quando um jogador, ped, veículo ou objeto entra numa área de colisão.
onColShapeLeaveServidorDisparado quando um jogador, ped, veículo ou objeto sai de uma área de colisão.
onElementColShapeHitServidorDisparado num jogador, ped, veículo ou objeto quando ele entra numa área de colisão.
onElementColShapeLeaveServidorDisparado num jogador, ped, veículo ou objeto quando ele sai de uma área de colisão.

Ruas e caminhos

NomeLadoDescrição
arePathNodesLoadedClienteDiz se os nós de caminho de uma área já estão carregados.
calculatePathRouteClienteCalcula a rota mais curta pelos nós de caminho entre dois pontos, partindo do nó mais perto de cada um. Para carros, respeita as ruas de mão única.
getClosestPathNodeClienteAcha o nó de rua ou de calçada mais perto de um ponto.
getClosestStraightRoadClienteAcha o trecho de rua mais perto de um ponto: dois nós de carro ligados e a direção entre eles. Nós desligados ficam de fora.
getNthClosestPathNodeClienteAcha o n-ésimo nó de rua ou de calçada mais perto de um ponto.
getParkingNodeInAreaClienteAcha um nó de estacionamento dentro de uma caixa. Cada chamada devolve o próximo da caixa, voltando ao primeiro no fim.
getPathNodeInfoClienteDevolve o que se sabe de um nó de caminho.
getPathNodeNeighboursClienteLista os nós ligados a um nó de caminho e como é cada ligação.
getPathNodePositionClienteDevolve a posição de um nó de caminho.
getPathNodesInRadiusClienteLista os nós de rua ou de calçada dentro de um raio.
getRoadDensityClienteMede quanta rua há em volta de um ponto: as faixas vezes o comprimento das ligações de carro que saem a até 80 m dele, numa escala reduzida.
getSafePedSpawnPositionClienteSorteia um lugar numa calçada perto de um ponto onde um pedestre pode surgir, como o SA escolhe onde criar pedestres. O lugar fica no chão.
releasePathNodesClienteDesfaz o pedido de requestPathNodesInArea. As áreas longe do jogador podem ser descarregadas de novo.
requestPathNodesInAreaClientePede que os nós de caminho de uma área sejam carregados além dos que estão perto do jogador. A área fica carregada até releasePathNodes.

Câmera

NomeLadoDescrição
attachCameraToElementClientePrende a câmera a um elemento: ela acompanha a posição e a rotação dele até setCameraTarget devolvê-la a um ped.
fadeCameraClienteEscurece a tela até uma cor ou a clareia de volta.
getCameraMatrixClienteDevolve onde a câmera está e para onde olha.
getCameraTargetClienteDevolve o jogador ou ped que a câmera está seguindo.
setCameraMatrixClienteFixa a câmera num ponto, olhando para outro, até setCameraTarget devolvê-la a um ped.
setCameraTargetClientePõe a câmera para seguir um jogador ou ped, como no jogo normal. Também desfaz setCameraMatrix e attachCameraToElement.

Cinemáticas

NomeLadoDescrição
castCinematicActorClienteFaz um ator ser interpretado com a aparência e os dados de elemento de um ped, jogador ou veículo da sessão. Vale a partir da próxima reprodução.
createCinematicClienteCria um elemento cinematic, vazio ou a partir de uma cinemática salva. Ele pertence ao recurso que o criou e existe só neste cliente.
getCinematicActorClienteDevolve o elemento local (ped ou veículo) que faz um ator na reprodução atual.
getCinematicActorPoseClienteDevolve onde um ator está num tempo da cinemática. Não precisa de reprodução.
getCinematicActorsClienteLista os atores da cinemática: os gravados e os posicionados.
getCinematicAdjustmentsClienteDevolve os deslocamentos e as animações postos sobre a tomada de um ator.
getCinematicAudioClienteDevolve os sons da cinemática.
getCinematicCameraClienteDevolve os planos de câmera da cinemática.
getCinematicCaptionsClienteDevolve as legendas da cinemática.
getCinematicDataClienteDevolve a cinemática inteira como bytes .cine, que createCinematic lê de volta.
getCinematicDurationClienteDevolve quanto dura a cinemática.
getCinematicPositionClienteDevolve em que tempo da cinemática a reprodução está.
getCinematicShotViewClienteDevolve onde a câmera de um plano está e para onde olha num tempo da cinemática, com o tremor.
getCinematicWorldClienteDevolve as chaves de clima, hora e fade da cinemática.
isCinematicPausedClienteDiz se a reprodução da cinemática está pausada.
playCinematicClienteReproduz a cinemática: os atores com clones locais, e também a câmera, o clima, a hora, o fade, os sons e as legendas.
removeCinematicActorClienteTira um ator da cinemática, com a tomada dele.
setCinematicActorTimingClientePosiciona a tomada de um ator no tempo da cinemática, corta o trecho mostrado e define a velocidade. Fora desse trecho o ator sai de cena.
setCinematicAdjustmentsClientePõe deslocamentos e animações por cima da tomada de um ator. A tomada fica como foi gravada e se move junto. Substitui os ajustes anteriores do ator.
setCinematicAudioClienteDefine os sons que a cinemática toca durante a reprodução. Substitui os sons anteriores.
setCinematicCameraClienteDefine os planos de câmera que a cinemática dirige durante a reprodução. Substitui os planos anteriores.
setCinematicCameraEnabledClienteLiga ou desliga a câmera da cinemática. Desligada, a reprodução não move a câmera e os planos de setCinematicCamera são ignorados.
setCinematicCaptionsClienteDefine as legendas que a cinemática desenha na tela durante a reprodução. Substitui as legendas anteriores.
setCinematicDurationClienteFixa a duração da cinemática. A reprodução termina ao chegar nela.
setCinematicPausedClientePausa ou retoma a reprodução da cinemática. Pausada, os clones param nas suas animações, os veículos congelam e os sons pausam.
setCinematicPositionClientePula a reprodução para outro tempo da cinemática. Os clones continuam os mesmos; cada um volta para a sua amostra e entra ou sai do seu veículo conforme a tomada.
setCinematicPropClientePosiciona um veículo ou objeto parado numa parte da cinemática, ou muda um que já foi posicionado.
setCinematicWorldClienteDefine as chaves de clima, hora e fade da tela que a cinemática aplica durante a reprodução. Substitui as chaves anteriores.
startCinematicRecordingClienteComeça a gravar um ped, jogador ou veículo como ator da cinemática. Chamada de novo durante a gravação, acrescenta outro ator à mesma gravação.
stopCinematicClientePara a reprodução da cinemática. Os clones somem e o clima, a hora e o fade voltam ao que o mundo tinha.
stopCinematicRecordingClientePara a gravação da cinemática. Os outros atores que eram reproduzidos durante a gravação param também.
onClientCinematicFinishClienteDisparado quando a reprodução de uma cinemática chega ao fim sozinha.

Desenho na tela

NomeLadoDescrição
dxConvertPixelsClienteConverte uma imagem guardada numa string para outro formato, em segundo plano, e entrega o resultado a uma função.
dxCreateFontClienteCria uma fonte a partir de um arquivo de fonte do recurso, para usar nas funções de texto.
dxCreateRenderTargetClienteCria um render target: uma imagem em que as funções dx podem desenhar e que pode ser usada como qualquer outra imagem.
dxCreateScreenSourceClienteCria uma screen source: uma imagem que recebe uma cópia da tela do jogo a cada dxUpdateScreenSource.
dxDrawCircleClienteDesenha um círculo preenchido, ou um setor dele, na tela durante um quadro.
dxDrawImageClienteDesenha uma imagem na tela durante um quadro.
dxDrawImageSectionClienteDesenha uma parte de uma imagem na tela durante um quadro.
dxDrawLineClienteDesenha uma linha 2D na tela durante um quadro.
dxDrawLine3DClienteDesenha uma linha no mundo 3D durante um quadro. A linha fica virada para a câmera.
dxDrawMaterialLine3DClienteDesenha uma imagem esticada ao longo de uma linha no mundo 3D durante um quadro.
dxDrawMaterialPrimitiveClienteDesenha uma primitiva 2D com uma imagem na tela durante um quadro.
dxDrawMaterialPrimitive3DClienteDesenha uma primitiva com uma imagem no mundo 3D durante um quadro.
dxDrawMaterialSectionLine3DClienteDesenha uma parte de uma imagem esticada ao longo de uma linha no mundo 3D durante um quadro.
dxDrawPrimitiveClienteDesenha uma primitiva 2D (pontos, linhas ou triângulos) na tela durante um quadro.
dxDrawRectangleClienteDesenha um retângulo preenchido na tela durante um quadro.
dxDrawTextClienteDesenha um texto na tela durante um quadro, dentro de uma caixa.
dxGetBlendModeClienteDevolve o modo de mistura das funções dx 2D.
dxGetFontHeightClienteDevolve a altura de uma linha de texto de uma fonte.
dxGetMaterialSizeClienteDevolve o tamanho de uma imagem em pixels.
dxGetPixelColorClienteLê a cor de um pixel de uma imagem em plain.
dxGetPixelsFormatClienteDetecta o formato de uma imagem guardada numa string.
dxGetPixelsSizeClienteDevolve a largura e a altura de uma imagem guardada numa string (plain, png, jpeg ou dds).
dxGetStatusClienteDevolve informações sobre a placa de vídeo e a memória de vídeo usada pelos scripts.
dxGetTextSizeClienteMede a largura e a altura que um texto ocupa na tela.
dxGetTexturePixelsClienteLê os pixels de uma imagem e os entrega a uma função, alguns quadros depois.
dxGetTextWidthClienteMede a largura que um texto ocupa na tela, na linha mais larga.
dxSetBlendModeClienteEscolhe como as próximas funções dx 2D se misturam com o que já está desenhado.
dxSetPixelColorClienteMuda a cor de um pixel de uma imagem em plain, na própria string.
dxSetRenderTargetClienteEscolhe onde as próximas funções dx desenham: num render target ou, sem ele, na tela.
dxSetTextureEdgeClienteEscolhe o que uma imagem mostra quando é lida fora das suas bordas.
dxSetTexturePixelsClienteEscreve pixels numa textura criada por script ou num render target.
dxUpdateScreenSourceClienteCopia a tela do jogo para uma screen source.
getScreenSizeClienteDevolve o tamanho da tela do jogo em pixels.
onClientHUDRenderClienteDisparado a cada quadro, logo antes de onClientRender.
onClientPreRenderClienteDisparado a cada quadro, depois da simulação do mundo e antes de o mundo ser desenhado.
onClientRenderClienteDisparado a cada quadro, quando os desenhos dx daquele quadro devem ser feitos.

Interface web

NomeLadoDescrição
createDuiClienteAbre uma página web fora da tela, com fundo transparente, e a devolve como uma imagem que pode ser desenhada.
drawDuiClienteDesenha um dui na tela durante um quadro, em coordenadas relativas à tela.
isDuiReadyClienteDiz se a página de um dui terminou de carregar.
isNuiFocusedClienteDiz se alguma página de interface tem o foco.
registerNuiCallbackClienteRegistra uma função que a página de interface do recurso chama com um fetch para /nome no próprio endereço dela.
sendDuiMessageClienteManda uma mensagem para a página de um dui. A página a recebe no evento message do window.
sendDuiMouseButtonClienteAperta ou solta um botão do mouse sobre a página de um dui.
sendDuiMouseMoveClienteMove o ponteiro do mouse sobre a página de um dui.
sendDuiMouseWheelClienteRola a página de um dui com a roda do mouse.
sendNuiMessageClienteManda uma mensagem para a página de interface do recurso que chama. A página a recebe no evento message do window.
setDuiUrlClienteLeva um dui para outro endereço.
setNuiFocusClienteDá ou tira o foco da página de interface do recurso que chama. Com foco, a página recebe o mouse e o teclado.
setNuiKeepInputClienteEscolhe se o jogo continua recebendo o mouse e o teclado enquanto uma página de interface tem o foco.

Luzes

NomeLadoDescrição
createPointLightClienteCria uma luz que ilumina em todas as direções a partir de um ponto. A luz existe só neste cliente.
createRectLightClienteCria uma luz que sai de um retângulo, como um painel ou uma janela iluminada. A luz existe só neste cliente.
createSpotLightClienteCria uma luz que ilumina dentro de um cone, como um holofote. A luz existe só neste cliente.
dxDrawPointLightClienteAcende uma luz em todas as direções a partir de um ponto, por um único quadro, sem criar elemento.
dxDrawRectLightClienteAcende uma luz que sai de um retângulo por um único quadro, sem criar elemento.
dxDrawSpotLightClienteAcende uma luz dentro de um cone por um único quadro, sem criar elemento.
getLightBarnDoorClienteLê as abas de uma luz rect.
getLightCastShadowClienteDiz se uma luz projeta sombras.
getLightColorClienteLê a cor de uma luz.
getLightConeClienteLê a abertura e a dureza da borda do cone de uma luz spot.
getLightDirectionClienteLê para onde uma luz spot ou rect aponta.
getLightFalloffClienteLê o expoente de desvanecimento de uma luz.
getLightIntensityClienteLê o brilho de uma luz.
getLightRadiusClienteLê o alcance de uma luz.
getLightSizeClienteLê a largura e a altura de uma luz rect.
getLightSourceRadiusClienteLê o tamanho do bulbo de uma luz spot.
getLightTangentClienteLê para onde aponta a largura de uma luz rect.
getLightTypeClienteDiz o tipo de uma luz.
isLightEnabledClienteDiz se uma luz está ligada.
setLightBarnDoorClienteMuda as abas de uma luz rect, que limitam para onde a luz sai do retângulo.
setLightCastShadowClienteLiga ou desliga as sombras de uma luz.
setLightColorClienteMuda a cor de uma luz.
setLightConeClienteMuda a abertura e a dureza da borda do cone de uma luz spot.
setLightDirectionClienteMuda para onde uma luz spot ou rect aponta.
setLightEnabledClienteLiga ou desliga uma luz sem destruí-la.
setLightFalloffClienteMuda como a luz desvanece até o fim do alcance.
setLightIntensityClienteMuda o brilho de uma luz.
setLightRadiusClienteMuda o alcance de uma luz.
setLightSizeClienteMuda a largura e a altura de uma luz rect.
setLightSourceRadiusClienteMuda o tamanho do bulbo de uma luz spot. Um bulbo maior deixa o brilho e as sombras mais suaves.
setLightTangentClienteMuda para onde aponta a largura de uma luz rect, girando o retângulo em torno da normal.

Efeitos

NomeLadoDescrição
createEffectCompartilhadoCria um efeito de partículas no mundo. No servidor, todos os clientes o veem; num cliente, só esse cliente.
engineAddEffectsClienteRegistra os efeitos de partículas de um arquivo do recurso, para que createEffect os use por nome.
engineGetEffectsClienteLista os efeitos de partículas carregados neste cliente.
engineRemoveEffectsClienteRemove os efeitos que este recurso adicionou de um arquivo com engineAddEffects.
getEffectColorCompartilhadoLê a cor de um efeito.
getEffectEvolutionCompartilhadoLê o nível de uma evolução de um efeito.
getEffectScaleCompartilhadoLê o tamanho de um efeito.
setEffectColorCompartilhadoTinge um efeito com uma cor.
setEffectEvolutionCompartilhadoMuda o nível de uma evolução de um efeito, um parâmetro que o próprio efeito declara para variar a aparência.
setEffectScaleCompartilhadoMuda o tamanho de um efeito.
stopEffectCompartilhadoPara um efeito: ele deixa de emitir e as partículas que já existem terminam.

Texturas

NomeLadoDescrição
engineCreateTextureClienteCria uma textura a partir de um arquivo de imagem do recurso ou dos bytes de uma imagem na memória. A textura existe só neste cliente.
engineCreateTxdClienteCria um dicionário de texturas vazio com um nome. Preencha-o com engineSetTxdTexture. Ele existe só neste cliente.
engineGetModelTxdsClienteLista os txds de onde um modelo tira suas texturas, na ordem em que ele os procura.
engineGetTxdsClienteLista todos os dicionários de texturas que este cliente conhece, com a origem de cada um.
engineGetTxdTextureClienteDá um elemento texture que mostra o que um txd mostra sob um nome de textura, para desenhá-lo ou usá-lo como fonte.
engineGetTxdTexturesClienteLista os nomes das texturas que um txd dá, incluindo os links.
engineIsAssetLoadedClienteDiz se um asset criado por um script está pronto para uso.
engineLoadTxdClienteCarrega um dicionário de texturas (.ktd) de um arquivo do recurso com um nome. Ele existe só neste cliente.
engineRestoreElementTextureClienteRemove as trocas de textura que este recurso aplicou num elemento com engineSetElementTexture.
engineRestoreModelTextureClienteRemove as trocas de textura que este recurso aplicou num modelo com engineSetModelTexture.
engineRestoreModelTxdClienteTira os txds que este recurso colocou na frente de um modelo com engineSetModelTxd.
engineRestoreTxdTextureClienteRemove os links que este recurso criou num txd com engineSetTxdTexture, para que ele volte a dar suas próprias texturas.
engineRestoreTxdTextureSamplingClienteRemove a mudança de amostragem que este recurso aplicou na textura de um txd com engineSetTxdTextureSampling.
engineRestoreWorldTextureClienteRemove as trocas de textura do mundo que este recurso aplicou com engineSetWorldTexture.
engineSetElementTextureClienteTroca uma textura de um único veículo, ped, jogador ou objeto. As outras instâncias do mesmo modelo mantêm suas texturas.
engineSetModelTextureClienteTroca uma textura em todas as instâncias de um modelo. Só os materiais desse modelo mudam, não o txd de onde a textura vem.
engineSetModelTxdClienteColoca um txd na frente do txd do próprio modelo, para que o modelo procure suas texturas nele primeiro e use o seu para o resto.
engineSetTxdTextureClienteColoca uma imagem num txd sob um nome de textura, substituindo a textura com esse nome ou acrescentando uma nova. Tudo que lê o txd acompanha: modelos, peds, landscapes, ruas, partículas, água e céu.
engineSetTxdTextureSamplingClienteMuda como o mundo amostra a textura de um txd: o que acontece além das bordas e como ela é filtrada. Toma o lugar do endereçamento do próprio material.
engineSetWorldTextureClienteTroca uma textura em todos os modelos dos tipos escolhidos que a usam. Só os materiais dos modelos mudam, não o txd de onde a textura vem.
onClientAssetLoadClienteDisparado uma vez quando um asset que um script começou a carregar em segundo plano fica pronto, ou falha.

Materiais e shaders

NomeLadoDescrição
engineAddPostProcessClienteLiga um pós-processamento na tela: um material cujo shader é #type post.
engineCreateMaterialClienteCria um material: um shader com valores de parâmetros, que depois substitui ou se sobrepõe aos materiais dos modelos.
engineCreateShaderClienteCria um shader a partir de um arquivo .shader ou do próprio código-fonte. O shader compila em segundo plano.
engineGetElementStencilClienteDiz com que valor de stencil um veículo, ped ou objeto está marcado.
engineGetMaterialAlphaClipClienteDiz se o material recorta pixels pela transparência e a partir de que alfa.
engineGetMaterialParametersClienteLista os parâmetros do shader que um material usa.
engineGetMaterialShaderClienteDiz qual shader um material usa.
engineGetMaterialSwitchesClienteLista as chaves estáticas do shader de um material, com o valor que cada uma tem nele.
engineGetMaterialValueClienteLê um valor que o material define: um parâmetro, uma chave estática ou uma saída TARGET_n.
engineGetModelMaterialsClienteLista os materiais do modelo carregado, na ordem em que o modelo os guarda.
engineGetModelStencilClienteDiz com que valor de stencil um modelo está marcado.
engineGetPostImageClienteDá a imagem que um passo de um pós-processamento produz, para desenhar ou usar em outro material.
engineGetShaderErrorsClienteLista os erros da última compilação de um shader criado com engineCreateShader.
engineGetShaderGlobalClienteLê o valor atual de um global de shader.
engineGetShaderGlobalsClienteLista todos os globais de shader, dos pacotes e dos scripts.
engineGetShaderParametersClienteLista os parâmetros que um shader ou preset declara.
engineGetShaderQualityClienteDiz a qualidade atual dos materiais deste cliente.
engineGetShadersClienteLista todos os shaders e presets carregados, dos pacotes e dos scripts.
engineGetShaderSwitchesClienteLista as chaves estáticas (parâmetros bool) de um shader ou preset, com o valor padrão de cada uma.
engineRemovePostProcessClienteDesliga um pós-processamento que este recurso ligou com engineAddPostProcess.
engineResetMaterialValueClienteDesfaz um valor que o material definiu, ou todos, e volta ao que vem da base.
engineResetShaderGlobalClienteRetira o valor que este recurso deu a um global de shader, e o global volta ao valor de quem vem a seguir.
engineRestoreElementMaterialClienteDesfaz o que engineSetElementMaterial deste recurso fez de um único veículo, ped ou objeto.
engineRestoreElementOverlayClienteDesfaz o que engineSetElementOverlay deste recurso fez de um único veículo, ped ou objeto.
engineRestoreElementStencilClienteTira a marca de stencil que este recurso pôs com engineSetElementStencil.
engineRestoreModelMaterialClienteDesfaz o que engineSetModelMaterial deste recurso fez de todas as instâncias de um modelo.
engineRestoreModelOverlayClienteDesfaz o que engineSetModelOverlay deste recurso fez de todas as instâncias de um modelo.
engineRestoreModelStencilClienteTira a marca de stencil que este recurso pôs com engineSetModelStencil.
engineRestoreWorldMaterialClienteDesfaz o que engineSetWorldMaterial deste recurso fez de todos os modelos do mundo.
engineRestoreWorldOverlayClienteDesfaz o que engineSetWorldOverlay deste recurso fez de todos os modelos do mundo.
engineSetElementMaterialClienteSubstitui os materiais escolhidos de um único veículo, ped ou objeto por um material.
engineSetElementOverlayClienteDesenha um material como uma camada a mais por cima dos materiais escolhidos de um único veículo, ped ou objeto.
engineSetElementStencilClienteMarca um veículo, ped ou objeto com um valor de stencil, que os shaders de pós-processamento leem para contornos, destaques e efeitos parecidos.
engineSetMaterialAlphaClipClienteFaz o material recortar os pixels cujo alfa fica abaixo de um limite, ou deixar de recortar.
engineSetMaterialShaderClienteTroca o shader de um material, mantendo os valores que ele já tem.
engineSetMaterialValueClienteDefine um valor do material: um parâmetro do shader, uma chave estática ou a render target de uma saída TARGET_n.
engineSetModelMaterialClienteSubstitui os materiais escolhidos de todas as instâncias de um modelo por um material.
engineSetModelOverlayClienteDesenha um material como uma camada a mais por cima dos materiais escolhidos de todas as instâncias de um modelo.
engineSetModelStencilClienteMarca todas as instâncias de um modelo com um valor de stencil, que os shaders de pós-processamento leem para contornos, destaques e efeitos parecidos.
engineSetShaderGlobalClienteDefine um global de shader, um valor que todos os shaders leem. Um nome novo cria o global.
engineSetShaderQualityClienteMuda a qualidade dos materiais deste cliente. Shaders que leem QUALITY são compilados para o novo nível.
engineSetWorldMaterialClienteSubstitui os materiais escolhidos de todos os modelos do mundo por um material.
engineSetWorldOverlayClienteDesenha um material como uma camada a mais por cima dos materiais escolhidos de todos os modelos do mundo.

Modelos

NomeLadoDescrição
engineCreateModelClienteCria um novo modelo com um nome, só neste cliente. Ele é usado pelo nome, como qualquer outro modelo.
engineGetModelsClienteLista os modelos que este cliente conhece, com a origem de cada um.
engineLoadColClienteCarrega um arquivo de colisão (.kbn) do recurso para ser dado a um modelo.
engineLoadDrawableClienteCarrega um drawable (.kdr) de um arquivo do recurso para ser dado a um modelo.
engineRestoreModelColClienteTira a colisão que este recurso deu a um modelo com engineSetModelCol, para que ele colida como antes.
engineRestoreModelDrawableClienteTira o drawable que este recurso deu a um modelo com engineSetModelDrawable, para que ele desenhe o que desenhava antes.
engineSetModelColClienteFaz um modelo colidir com uma colisão carregada com engineLoadCol em vez da sua.
engineSetModelDrawableClienteFaz um modelo desenhar um drawable carregado com engineLoadDrawable em vez do seu.

Ajustes gráficos

NomeLadoDescrição
engineGetAmbientOcclusionClienteDevolve quantas amostras a oclusão de ambiente usa.
engineGetAntiAliasingClienteDevolve o antisserrilhamento em uso.
engineGetBloomClienteDevolve quantos níveis de desfoque o bloom usa.
engineGetCloudsClienteDevolve como as nuvens são desenhadas.
engineGetDecalsClienteDevolve quantas marcas podem existir ao mesmo tempo e quanto tempo elas duram.
engineGetLocalLightShadowsClienteDiz se as luzes locais projetam sombras.
engineGetMotionBlurClienteDiz se o desfoque de movimento está ligado.
engineGetParticleDensityClienteDevolve que fração das partículas dos efeitos é emitida.
engineGetParticleScaleClienteDevolve em que fração da resolução as partículas são desenhadas.
engineGetReflectionsClienteDevolve a configuração dos reflexos.
engineGetRenderResolutionClienteDevolve o tamanho em pixels em que a cena é renderizada e o tamanho da imagem final na janela.
engineGetRenderScaleClienteDevolve a fração da resolução da janela em que a cena 3D é renderizada.
engineGetShadowsClienteDevolve a configuração das sombras do sol.
engineGetSharpnessClienteDevolve quanto a imagem final é nitidizada.
engineGetSunShaftsClienteDevolve em que fração da resolução os raios de sol são calculados.
engineGetVolumetricFogClienteDiz se a neblina volumétrica está ligada.
engineHasCollisionLoadedAtClienteDiz se o mundo em volta de um ponto já está sólido: a colisão, os prédios e as paisagens dali carregados.
engineHasModelLoadedClienteDiz se um modelo está carregado na memória.
engineReleaseModelClienteDesfaz o pedido de modelo que este recurso fez com engineRequestModel.
engineRequestCollisionAtClientePede que a colisão em volta de um ponto seja carregada. O pedido continua até ela terminar de carregar.
engineRequestModelClientePede ao streaming que carregue um modelo e o mantém carregado para este recurso até ser liberado.
engineSetAmbientOcclusionClienteDefine quantas amostras a oclusão de ambiente usa. Mais amostras escurecem cantos e frestas com mais precisão.
engineSetAntiAliasingClienteEscolhe o antisserrilhamento da imagem.
engineSetBloomClienteDefine quantos níveis de desfoque o bloom usa. Mais níveis espalham o brilho mais longe.
engineSetCloudsClienteEscolhe como as nuvens são desenhadas.
engineSetDecalsClienteDefine quantas marcas (buracos de bala, sangue, marcas de pneu) podem existir ao mesmo tempo e quanto tempo elas duram.
engineSetLocalLightShadowsClienteLiga ou desliga as sombras das luzes locais (pontuais, spots e retangulares).
engineSetMotionBlurClienteLiga ou desliga o desfoque de movimento. No PC vem ligado.
engineSetParticleDensityClienteDefine que fração das partículas dos efeitos é emitida. As demais são descartadas ao acaso.
engineSetParticleScaleClienteDefine em que fração da resolução as partículas são desenhadas.
engineSetReflectionsClienteConfigura os reflexos: o tamanho da sonda de ambiente e os reflexos calculados na tela.
engineSetRenderScaleClienteDefine em que fração da resolução da janela a cena 3D é renderizada. A imagem é ampliada depois até o tamanho da janela.
engineSetShadowsClienteConfigura as sombras do sol: quantas cascatas, a resolução e se as bordas são suaves.
engineSetSharpnessClienteDefine quanto a imagem final é nitidizada.
engineSetSunShaftsClienteDefine em que fração da resolução os raios de sol são calculados, ou os desliga.
engineSetVolumetricFogClienteLiga ou desliga a neblina volumétrica. Vem desligada.

Som

NomeLadoDescrição
engineAddSoundClienteRegistra um arquivo de áudio com um nome, que playSound e playSound3D passam a tocar por esse nome.
engineGetSoundsClienteLista os sons com nome que valem agora, os do jogo, dos pacotes e dos recursos.
engineRemoveSoundClienteRemove um som que este recurso registrou com engineAddSound. Se outro registro do mesmo nome existe, ele volta a valer.
getSFXStatusClienteDiz se um contêiner de áudio do GTA San Andreas está disponível para playSFX e playSFX3D.
getSoundBPMClienteDetecta o andamento do som em batidas por minuto, arredondado para baixo.
getSoundBufferLengthClienteExiste por compatibilidade com o MTA, onde dá o tamanho do buffer de um stream da internet.
getSoundEffectParametersClienteDevolve os parâmetros atuais de um efeito de áudio ligado num som ou na voz de um jogador.
getSoundEffectsClienteLista os efeitos de áudio de um som ou da voz de um jogador e diz quais estão ligados.
getSoundFFTDataClienteDevolve o espectro de frequências do que o som está tocando agora, para fazer visualizadores.
getSoundLengthCompartilhadoDevolve a duração do som.
getSoundLevelDataClienteDevolve o pico de volume de cada canal nos últimos 20 ms do som.
getSoundMaxDistanceCompartilhadoDevolve a partir de que distância um som 3D fica mudo.
getSoundMetaTagsClienteLê as tags do arquivo de áudio (ID3 do MP3, comentários do OGG e do FLAC, INFO do WAV).
getSoundMinDistanceCompartilhadoDevolve até que distância um som 3D toca no volume cheio.
getSoundPanClienteDevolve o panorama de um som sem posição.
getSoundPositionCompartilhadoDevolve em que ponto da faixa o som está tocando.
getSoundPropertiesClienteDevolve a taxa de amostragem, o andamento e o tom de um som, e se ele toca ao contrário.
getSoundSpeakerClienteDevolve o ped que fala um som.
getSoundSpeedCompartilhadoDevolve a velocidade de um som.
getSoundVolumeCompartilhadoDevolve o volume de um som, sem contar a queda com a distância.
getSoundWaveDataClienteDevolve a forma de onda do que o som acabou de tocar, para desenhar osciloscópios.
isShowSoundEnabledClienteDiz se showSound está ligado.
isSoundLoopedCompartilhadoDiz se um som repete quando chega ao fim.
isSoundPanningEnabledClienteDiz se um som 3D tem panorama estéreo ligado.
isSoundPausedCompartilhadoDiz se um som está pausado.
isWorldSoundEnabledClienteDiz se um som do mundo, ou um grupo deles, está ligado.
playSFXClienteToca um som dos bancos de áudio do GTA San Andreas, sem posição no mundo.
playSFX3DClienteToca um som dos bancos de áudio do GTA San Andreas numa posição do mundo.
playSoundClienteToca um som sem posição no mundo, só neste cliente. Dispara onClientSoundStarted com o motivo play.
playSoundServidorCria um som sem posição no mundo que todos os clientes tocam juntos. As mudanças feitas nele no servidor chegam a todos.
playSound3DClienteToca um som numa posição do mundo, só neste cliente. O volume cai com a distância entre setSoundMinDistance (5 m) e setSoundMaxDistance (20 m). Dispara onClientSoundStarted com play.
playSound3DServidorCria um som numa posição do mundo que todos os clientes tocam juntos. As mudanças feitas nele no servidor chegam a todos.
playSoundFrontEndClienteToca um dos sons de interface do GTA San Andreas, como os de menu e de missão.
resetWorldSoundsClienteLiga de novo todos os sons do mundo desligados com setWorldSoundEnabled.
setSoundEffectEnabledClienteLiga ou desliga um efeito de áudio num som ou na voz de um jogador. Ao ligar, o efeito começa com seus parâmetros padrão.
setSoundEffectParameterClienteMuda um parâmetro de um efeito de áudio ligado num som ou na voz de um jogador.
setSoundLoopedCompartilhadoLiga ou desliga a repetição de um som. No servidor, a mudança é enviada a todos os clientes.
setSoundMaxDistanceCompartilhadoDefine a partir de que distância um som 3D fica mudo. O padrão é 20 m. No servidor, a mudança é enviada a todos os clientes.
setSoundMinDistanceCompartilhadoDefine até que distância um som 3D toca no volume cheio. O padrão é 5 m. No servidor, a mudança é enviada a todos os clientes.
setSoundPanClienteColoca um som sem posição mais à esquerda ou à direita.
setSoundPanningEnabledClienteLiga ou desliga o panorama estéreo de um som 3D. Ligado, o som soa mais à esquerda ou à direita conforme a câmera. Vem ligado.
setSoundPausedCompartilhadoPausa ou continua um som. No servidor, a mudança é enviada a todos os clientes.
setSoundPositionCompartilhadoPula para um ponto da faixa. O valor fica entre 0 e a duração do som. No servidor, a mudança é enviada a todos os clientes.
setSoundPropertiesClienteMuda a taxa de amostragem, o andamento e o tom de um som, e se ele toca ao contrário.
setSoundSpeakerClienteFaz um ped falar um som: a boca dele se mexe com o volume do som e, se o som é 3D, ele sai da cabeça do ped a cada quadro.
setSoundSpeedCompartilhadoMuda a velocidade de um som. O tom muda junto. No servidor, a mudança é enviada a todos os clientes.
setSoundVolumeCompartilhadoMuda o volume de um som. Num som 3D, ele ainda cai com a distância. No servidor, a mudança é enviada a todos os clientes.
setWorldSoundEnabledClienteLiga ou desliga sons do mundo do jogo (passos, tiros, colisões e outros) por grupo ou um a um.
showSoundClienteEscreve no console de depuração o grupo e o índice de cada som do mundo que toca. Só funciona no modo de desenvolvimento.
stopSoundClientePara um som criado por este cliente e destrói o elemento. Dispara onClientSoundStopped com o motivo destroyed.
stopSoundServidorPara um som criado pelo servidor e destrói o elemento em todos os clientes.
onClientSoundStartedClienteDisparado quando um som começa a tocar neste cliente ou sai da pausa.
onClientSoundStoppedClienteDisparado quando um som para de tocar neste cliente: pausado, parado ou terminado.
onClientWorldSoundClienteDisparado quando o jogo vai tocar um som do mundo. Cancelar o evento impede o som de tocar.

Voz

NomeLadoDescrição
addPlayerToVoiceChannelServidorPõe um jogador num canal de voz. A partir daí ele ouve e é ouvido pelos outros do canal.
createVoiceChannelServidorCria um canal de voz. Os jogadores só ouvem uns aos outros pelos canais em que estão.
deleteVoiceChannelServidorDestrói um canal de voz. Os jogadores que estavam nele deixam de se ouvir por ele.
isPlayerTalkingClienteDiz se um jogador está falando no chat de voz, do ponto de vista deste cliente.
isPlayerTalkingServidorDiz se um jogador está falando no chat de voz.
removePlayerFromVoiceChannelServidorTira um jogador de um canal de voz.
setPlayerDeafInVoiceChannelServidorDeixa um jogador surdo num canal de voz: os outros continuam ouvindo ele, mas ele não ouve ninguém por esse canal.
setPlayerMutedInVoiceChannelServidorDeixa um jogador mudo num canal de voz: ele continua ouvindo o canal, mas ninguém o ouve por ele.
setPlayerVoiceIgnoreFromServidorFaz um jogador deixar de ouvir a voz de certos elementos, em todos os canais.
onClientPlayerVoiceStartClienteDisparado neste cliente quando um jogador começa a falar no chat de voz: o jogador local ao apertar a tecla de falar, ou outro jogador quando a voz dele chega.
onClientPlayerVoiceStopClienteDisparado neste cliente quando um jogador para de falar no chat de voz.
onPlayerVoiceStartServidorDisparado quando um jogador começa a falar no chat de voz. Cancelar o evento faz ninguém ouvir essa fala.
onPlayerVoiceStopServidorDisparado quando um jogador para de falar no chat de voz.

Servidor

NomeLadoDescrição
getDevelopmentModeClienteDiz se o modo de desenvolvimento está ligado neste cliente.
getServerIPServidorDevolve o endereço IPv4 público da máquina, lido das interfaces de rede ao iniciar.
getServerNameServidorDevolve o nome do servidor, da convar server_name.
getServerPasswordServidorDevolve a senha que um jogador precisa dar para entrar.
setDevelopmentModeClienteLiga ou desliga o modo de desenvolvimento neste cliente. Com ele ligado, os comandos de console showcol e showsound passam a desenhar as áreas de colisão e os sons do mundo.
setServerPasswordServidorMuda a senha para entrar no servidor. Quem já está dentro continua.
shutdownServidorDesliga o servidor. Antes, dispara onShutdown.
onShutdownServidorDisparado quando um script chama shutdown, logo antes de o servidor desligar.

Banco de dados

NomeLadoDescrição
dbConnectServidorAbre uma conexão com um banco SQLite ou MySQL. As consultas rodam numa thread própria da conexão.
dbExecServidorExecuta um comando SQL sem esperar resposta.
dbFreeServidorDescarta uma consulta de dbQuery cuja resposta não vai ser lida.
dbPollServidorLê a resposta de uma consulta de dbQuery, esperando por ela se preciso.
dbPrepareStringServidorPreenche os marcadores de um SQL com valores escapados, sem executá-lo.
dbQueryServidorEnvia uma consulta SQL cuja resposta é lida depois com dbPoll.

Rede e HTTP

NomeLadoDescrição
fetchRemoteServidorFaz uma requisição HTTP ou HTTPS e entrega a resposta a uma função quando ela chega.
getServerIpClienteDevolve o endereço do servidor a que este cliente está conectado.