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
| Nome | Lado | Descrição |
|---|---|---|
| addElementDataSubscriber | Servidor | Inscreve 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. |
| createElement | Compartilhado | Cria um elemento de um tipo inventado pelo script, sem nada no mundo. Ele fica sob a raiz dinâmica do recurso. |
| destroyElement | Compartilhado | Destrói um elemento e todos os seus filhos. Antes de sumir, cada um dispara onElementDestroy no servidor ou onClientElementDestroy no cliente. |
| getAllElementData | Compartilhado | Lê todos os dados de um elemento de uma vez. |
| getElementAlpha | Compartilhado | Lê a transparência de um elemento, de 0 (invisível) a 255 (opaco). |
| getElementAngularVelocity | Compartilhado | Lê a velocidade de giro de um elemento em cada eixo, por passo da simulação. |
| getElementBoundingBox | Cliente | Lê a caixa de colisão do modelo de um elemento, relativa à origem do modelo. |
| getElementByID | Compartilhado | Procura o primeiro elemento com um ID, a partir de um elemento e descendo pelos seus filhos. |
| getElementCastShadow | Cliente | Diz se um elemento projeta sombra. |
| getElementChildren | Compartilhado | Lista os filhos diretos de um elemento, opcionalmente só os de um tipo. |
| getElementChildrenCount | Compartilhado | Conta os filhos diretos de um elemento. |
| getElementData | Compartilhado | Lê um dado guardado num elemento. |
| getElementDimension | Compartilhado | Lê a dimensão de um elemento, de 0 a 65535. |
| getElementDistanceFromCentreOfMassToBaseOfModel | Cliente | Lê a distância entre o centro de massa de um elemento e a base do seu modelo. |
| getElementHealth | Compartilhado | Lê a vida de um jogador, ped, veículo ou objeto. |
| getElementID | Compartilhado | Lê o ID de um elemento, o nome que getElementByID procura. |
| getElementInterior | Compartilhado | Lê o interior em que um elemento está. O interior 0 é o mundo aberto. |
| getElementMatrix | Compartilhado | Lê a matriz 4x4 de um elemento, feita da sua posição e rotação. |
| getElementModel | Compartilhado | Lê o nome do modelo de um elemento. |
| getElementParent | Compartilhado | Lê o pai de um elemento na árvore de elementos. |
| getElementPosition | Compartilhado | Lê a posição de um elemento no mundo. |
| getElementRadius | Cliente | Lê o raio da esfera de colisão do modelo de um elemento. |
| getElementRotation | Compartilhado | Lê a rotação de um elemento em graus. |
| getElementsByType | Cliente | Lista todos os elementos de um tipo abaixo de um elemento da árvore neste cliente. |
| getElementsByType | Servidor | Lista todos os elementos de um tipo abaixo de um elemento da árvore no servidor. |
| getElementsInRange | Compartilhado | Lista os elementos cuja posição está dentro de uma esfera. |
| getElementSyncer | Servidor | Diz qual jogador sincroniza um elemento, isto é, qual cliente simula e envia o seu estado ao servidor. |
| getElementType | Compartilhado | Lê o tipo de um elemento, como "player", "vehicle" ou o tipo dado em createElement. |
| getElementVelocity | Compartilhado | Devolve a velocidade de um elemento. |
| getRootElement | Compartilhado | Devolve o elemento raiz, o topo da árvore de elementos. É o mesmo valor da variável global root. |
| hasElementDataSubscriber | Servidor | Diz se um jogador está inscrito num dado de elemento. |
| isElement | Compartilhado | Diz se um valor é um elemento que ainda existe. |
| isElementFrozen | Compartilhado | Diz se um elemento está congelado. |
| isElementInWater | Cliente | Diz se um ped, jogador ou veículo está na água. |
| isElementLocal | Cliente | Diz se um elemento foi criado por este cliente, e não pelo servidor. |
| isElementOnFire | Compartilhado | Diz se um elemento está pegando fogo. |
| isElementOnScreen | Cliente | Diz se um elemento aparece na tela. |
| isElementStreamable | Cliente | Diz se um elemento entra e sai do streaming conforme a distância. |
| isElementStreamedIn | Cliente | Diz se um elemento está carregado no mundo deste cliente. |
| isElementSyncer | Cliente | Diz se este cliente sincroniza um ped ou veículo para o servidor. |
| removeElementData | Compartilhado | Apaga um dado guardado num elemento. |
| removeElementDataSubscriber | Servidor | Tira a inscrição de um jogador num dado de elemento. Ele deixa de receber as mudanças desse dado. |
| setElementAlpha | Compartilhado | Define a transparência de um elemento e de todos os seus filhos. |
| setElementAngularVelocity | Compartilhado | Define a velocidade de giro de um elemento. |
| setElementCastShadow | Cliente | Liga ou desliga a sombra que um elemento projeta. |
| setElementData | Cliente | Guarda um dado num elemento, só neste cliente. |
| setElementData | Servidor | Guarda um dado num elemento e, conforme o sync, envia aos jogadores. |
| setElementDimension | Compartilhado | Muda a dimensão de um elemento e de todos os seus filhos. |
| setElementFrozen | Compartilhado | Congela ou descongela um elemento e todos os seus filhos. |
| setElementHealth | Compartilhado | Define a vida de um ped, jogador, veículo ou objeto. |
| setElementID | Compartilhado | Dá um id (nome) a um elemento, para encontrá-lo depois com getElementByID. |
| setElementInterior | Compartilhado | Muda o interior de um elemento. |
| setElementMatrix | Compartilhado | Posiciona e gira um elemento a partir de uma matriz. |
| setElementModel | Servidor | Troca o modelo de um ped ou jogador, e dos seus filhos. |
| setElementOnFire | Cliente | Põe fogo ou apaga um elemento neste cliente. |
| setElementOnFire | Servidor | Põe fogo ou apaga um elemento e os seus filhos, para todos os jogadores. |
| setElementParent | Compartilhado | Põe um elemento como filho de outro na árvore de elementos. |
| setElementPosition | Compartilhado | Move um elemento para uma posição no mundo. |
| setElementRotation | Compartilhado | Define a rotação 3D de um elemento em graus. |
| setElementStreamable | Cliente | Escolhe se um elemento entra e sai do streaming conforme a distância ou fica sempre carregado. |
| setElementSyncer | Servidor | Escolhe qual jogador sincroniza um ped ou veículo. |
| setElementVelocity | Compartilhado | Define a velocidade de um elemento. |
| onClientElementDataChange | Cliente | Disparado 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. |
| onClientElementDestroy | Cliente | Disparado quando um elemento vai ser destruído, enquanto ele ainda existe. |
| onClientElementDimensionChange | Cliente | Disparado depois que um elemento muda de dimensão. Não dispara se a dimensão continua a mesma. |
| onClientElementInteriorChange | Cliente | Disparado depois que um elemento muda de interior. Não dispara se o interior continua o mesmo. |
| onClientElementStreamIn | Cliente | Disparado quando um elemento entra no streaming deste cliente e passa a existir no mundo do jogo. |
| onClientElementStreamOut | Cliente | Disparado quando um elemento sai do streaming deste cliente e deixa o mundo do jogo. O elemento continua existindo. |
| onElementDataChange | Servidor | Disparado 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. |
| onElementDestroy | Servidor | Disparado quando um elemento vai ser destruído, enquanto ele ainda existe. |
| onElementDimensionChange | Servidor | Disparado depois que um elemento muda de dimensão. Não dispara se a dimensão continua a mesma. |
| onElementInteriorChange | Servidor | Disparado depois que um elemento muda de interior. Não dispara se o interior continua o mesmo. |
| onElementModelChange | Servidor | Disparado depois que setElementModel troca o modelo de um elemento. Cancelar o evento restaura o modelo anterior, e setElementModel devolve false. |
| onElementStartSync | Servidor | Disparado quando um jogador passa a sincronizar um ped ou veículo. |
| onElementStopSync | Servidor | Disparado quando um jogador deixa de sincronizar um ped ou veículo. |
Anexos
| Nome | Lado | Descrição |
|---|---|---|
| attachElements | Compartilhado | Pendura um elemento em outro. A partir daí ele segue o alvo até ser solto. |
| detachElements | Compartilhado | Solta um elemento do elemento em que está anexado. Ele fica onde está. |
| getAttachedElements | Compartilhado | Lista os elementos anexados diretamente a um elemento. |
| getElementAttachedOffsets | Compartilhado | Lê o deslocamento, a rotação e o socket com que um elemento está anexado. |
| getElementAttachedTo | Compartilhado | Diz em qual elemento um elemento está anexado. |
| isElementAttached | Compartilhado | Diz se um elemento está anexado a outro. |
| setElementAttachedOffsets | Compartilhado | Muda o deslocamento, a rotação e, se pedido, o socket de um elemento anexado. |
| onClientElementAttach | Cliente | Disparado quando um script do cliente chama attachElements, antes de o elemento ser anexado. Cancelar o evento impede o anexo e faz attachElements devolver false. |
| onClientElementDetach | Cliente | Disparado 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. |
| onElementAttach | Servidor | Disparado quando o servidor chama attachElements, antes de o elemento ser anexado. Cancelar o evento impede o anexo e faz attachElements devolver false. |
| onElementDetach | Servidor | Disparado 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
| Nome | Lado | Descrição |
|---|---|---|
| getElementBoneMatrix | Cliente | Devolve a matriz de um osso de um ped ou objeto no mundo. |
| getElementBonePosition | Cliente | Devolve a posição de um osso de um ped ou objeto no mundo. |
| getElementBoneQuaternion | Cliente | Devolve a orientação de um osso de um ped ou objeto em relação ao osso pai, como quatérnio. |
| getElementBoneRotation | Cliente | Devolve a rotação de um osso de um ped ou objeto em relação ao osso pai, em graus. |
| getElementBoneScale | Cliente | Devolve a escala de um osso de um ped ou objeto. |
| getElementComponentPosition | Cliente | Devolve a posição de um componente de um veículo ou objeto. |
| getElementComponentRotation | Cliente | Devolve a rotação de um componente de um veículo ou objeto, em graus. |
| getElementComponents | Cliente | Lista os componentes de um veículo ou objeto: os frames com nome do seu modelo. |
| getElementComponentVisible | Cliente | Diz se um componente de um veículo ou objeto está visível. |
| getPedBonePosition | Cliente | Devolve a posição de um osso de um ped no mundo. |
| resetElementComponentPosition | Cliente | Devolve um componente de um veículo ou objeto à posição original do modelo, desfazendo setElementComponentPosition. |
| resetElementComponentRotation | Cliente | Devolve um componente de um veículo ou objeto à rotação original do modelo, desfazendo setElementComponentRotation. |
| setElementBoneMatrix | Cliente | Define 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. |
| setElementBonePosition | Cliente | Move um osso de um ped ou objeto para uma posição no mundo, mantendo a orientação. A mudança vale só neste cliente. |
| setElementBoneQuaternion | Cliente | Define 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. |
| setElementBoneRotation | Cliente | Gira um osso de um ped ou objeto em relação ao osso pai. A mudança vale só neste cliente. |
| setElementBoneScale | Cliente | Muda a escala de um osso de um ped ou objeto. A mudança vale só neste cliente. |
| setElementComponentPosition | Cliente | Move um componente de um veículo ou objeto. A mudança vale só neste cliente. |
| setElementComponentRotation | Cliente | Gira um componente de um veículo ou objeto. A mudança vale só neste cliente. |
| setElementComponentVisible | Cliente | Mostra ou esconde um componente de um veículo ou objeto. A mudança vale só neste cliente. |
Eventos
| Nome | Lado | Descrição |
|---|---|---|
| addEvent | Compartilhado | Registra um evento novo com esse nome. Só depois disso é possível adicionar handlers a ele e dispará-lo. |
| addEventHandler | Compartilhado | Faz uma função ser chamada sempre que o evento acontece no elemento indicado ou, com propagate, em qualquer descendente dele. |
| cancelEvent | Compartilhado | Marca o evento que está rodando como cancelado. O que o cancelamento impede depende do evento. |
| cancelLatentEvent | Cliente | Para o envio de um evento latente deste cliente ao servidor. O servidor descarta o que já tinha recebido e o evento não é disparado. |
| cancelLatentEvent | Servidor | Para 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á. |
| getCancelReason | Compartilhado | Dá o motivo passado a cancelEvent no último evento que terminou de rodar neste lado. |
| getEventHandlers | Compartilhado | Lista as funções que este recurso pôs num evento de um elemento com addEventHandler. |
| getLatentEventHandles | Cliente | Lista os eventos latentes que este cliente ainda está enviando ao servidor. |
| getLatentEventHandles | Servidor | Lista os eventos latentes que o servidor ainda está enviando a um jogador. |
| getLatentEventStatus | Cliente | Diz como está o envio de um evento latente deste cliente ao servidor. |
| getLatentEventStatus | Servidor | Diz como está o envio de um evento latente do servidor a um jogador. |
| removeEventHandler | Compartilhado | Tira uma função de um evento de um elemento, onde ela foi posta com addEventHandler. |
| triggerClientEvent | Servidor | Envia um evento aos clientes dos jogadores, que o disparam em source. A função retorna antes de os clientes receberem. |
| triggerEvent | Compartilhado | Dispara 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. |
| triggerLatentClientEvent | Servidor | Envia 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. |
| triggerLatentServerEvent | Cliente | Envia 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. |
| triggerServerEvent | Cliente | Envia um evento ao servidor, que o dispara em source lá. A função retorna antes de o servidor receber. |
| wasEventCancelled | Compartilhado | Diz se o último evento que terminou de rodar neste lado foi cancelado. |
| onPlayerTriggerEventThreshold | Servidor | Disparado 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
| Nome | Lado | Descrição |
|---|---|---|
| addCommandHandler | Compartilhado | Registra uma função que roda quando o comando é digitado no console. Os argumentos chegam como textos separados por espaço. |
| bindKey | Compartilhado | Liga uma tecla a uma função ou a um comando. A função roda quando a tecla é apertada, solta ou os dois. |
| executeCommandHandler | Cliente | Roda os handlers que os scripts do cliente registraram para um comando, como se ele tivesse sido digitado. |
| executeCommandHandler | Servidor | Roda os handlers que os scripts do servidor registraram para um comando, como se o jogador o tivesse digitado. |
| getBoundKeys | Cliente | Lista as teclas ligadas a um comando neste cliente. |
| getCommandsBoundToKey | Cliente | Lista os comandos ligados a uma tecla neste cliente. |
| getCursorPosition | Cliente | Lê onde o cursor está na tela e o ponto do mundo para onde ele aponta. |
| getFunctionsBoundToKey | Compartilhado | Lista as funções que este recurso ligou a uma tecla. |
| getKeyBoundToCommand | Cliente | Diz qual tecla roda um comando neste cliente. |
| getKeyBoundToFunction | Compartilhado | Diz a qual tecla este recurso ligou uma função. |
| getKeyState | Cliente | Diz se uma tecla está apertada agora. |
| isCursorShowing | Cliente | Diz se o cursor do mouse está aparecendo. |
| isKeyBound | Compartilhado | Diz se este recurso ligou uma função a uma tecla. |
| removeCommandHandler | Compartilhado | Remove o handler que este recurso registrou para um comando. |
| setCursorAlpha | Cliente | Muda a opacidade do cursor do mouse. |
| setCursorPosition | Cliente | Move o cursor para um ponto da tela. |
| showCursor | Cliente | Mostra ou esconde o cursor do mouse para este recurso. |
| unbindKey | Compartilhado | Desfaz binds que este recurso criou numa tecla. |
| onClientClick | Cliente | Disparado quando um botão do mouse é apertado ou solto com o cursor aparecendo. |
| onClientCursorMove | Cliente | Disparado quando o mouse se move. |
| onClientDoubleClick | Cliente | Disparado quando um botão do mouse é apertado duas vezes seguidas com o cursor aparecendo. |
| onClientKey | Cliente | Disparado 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. |
| onPlayerCommand | Servidor | Disparado quando um jogador manda um comando ao servidor, antes de ele rodar. Cancelar o evento impede o comando. |
Recursos e módulos
| Nome | Lado | Descrição |
|---|---|---|
| call | Compartilhado | Chama uma função que outro recurso exporta no seu meta.xml e devolve o que ela devolver. |
| deleteResource | Servidor | Tira 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. |
| getResourceDynamicElementRoot | Compartilhado | Devolve o elemento sob o qual ficam os elementos que o recurso cria por script. Ele é filho do elemento do recurso e se chama dynamic. |
| getResourceExportedFunctions | Compartilhado | Lista os nomes das funções que um recurso exporta no seu meta.xml, de qualquer lado. |
| getResourceFiles | Compartilhado | Lista os arquivos que um recurso declara com <file> no meta.xml, com os padrões já expandidos, em ordem alfabética. |
| getResourceFromName | Compartilhado | Encontra um recurso pelo nome. |
| getResourceInfo | Servidor | Lê um atributo da tag <info> do meta.xml de um recurso, como author ou version. |
| getResourceName | Compartilhado | Devolve o nome de um recurso. |
| getResourceRootElement | Compartilhado | Devolve o elemento raiz de um recurso, o mesmo que a variável global resourceRoot desse recurso. |
| getResources | Compartilhado | Lista os recursos que estão rodando neste lado. |
| getResourceState | Compartilhado | Diz em que estado um recurso está. |
| getThisResource | Compartilhado | Devolve o recurso em que o script está rodando. |
| import | Compartilhado | Roda 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. |
| refreshResources | Compartilhado | Lê 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. |
| restartResource | Compartilhado | Pede 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. |
| startResource | Compartilhado | Inicia um recurso na hora, depois de iniciar os recursos que ele inclui com <include> no meta.xml. |
| stopResource | Compartilhado | Pede para parar um recurso que está rodando. Ele para no próximo ciclo dos recursos, não durante a chamada. |
| onClientResourceStart | Cliente | Disparado quando um recurso termina de começar, depois que os seus scripts rodaram. |
| onClientResourceStop | Cliente | Disparado quando um recurso vai parar, enquanto os seus scripts e elementos ainda existem. |
| onResourcePreStart | Servidor | Disparado quando um recurso está começando, antes de rodar os seus scripts. Cancelar o evento impede o recurso de começar. |
| onResourceStart | Servidor | Disparado quando um recurso termina de começar, depois que os seus scripts e mapas rodaram. |
| onResourceStop | Servidor | Disparado quando um recurso vai parar, enquanto os seus scripts e elementos ainda existem. |
Tempo e assíncrono
| Nome | Lado | Descrição |
|---|---|---|
| async.all | Compartilhado | Roda cada função da lista na sua própria thread, todas ao mesmo tempo, e faz a thread atual esperar até todas terminarem. |
| async.cancel | Compartilhado | Para uma thread async deste recurso. Uma thread pausada é encerrada na hora; chamada na própria thread, ela para ali mesmo. |
| async.map | Compartilhado | Chama 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.mutex | Compartilhado | Roda 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.promise | Compartilhado | Roda 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.status | Compartilhado | Diz em que estado está uma thread async deste recurso. |
| async.thread | Compartilhado | Roda 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.wait | Compartilhado | Pausa a thread async atual por ms milissegundos. O resto do jogo continua rodando. |
| async.yield | Compartilhado | Pausa a thread async atual até a próxima atualização dos scripts, para dividir um trabalho longo em pedaços. |
| getTimerDetails | Compartilhado | Lê o estado de um timer: quanto falta, quantas repetições sobram e o intervalo. |
| getTimers | Compartilhado | Lista os timers ativos do recurso que chama. |
| isTimer | Compartilhado | Diz se um timer ainda existe neste recurso. |
| killTimer | Compartilhado | Cancela um timer antes de ele terminar. |
| resetTimer | Compartilhado | Recomeça a contagem de um timer do zero, com o mesmo intervalo. As repetições que faltam não mudam. |
| setTimer | Compartilhado | Chama uma função depois de um intervalo, uma vez ou repetidamente. |
| setTimerPaused | Compartilhado | Pausa ou retoma um timer. Pausado, ele guarda o tempo que faltava e não é chamado. |
Convars
| Nome | Lado | Descrição |
|---|---|---|
| getConvar | Compartilhado | Lê uma convar como texto. No cliente, uma convar que o servidor sincroniza vem antes da do próprio cliente. |
| getConvarInt | Compartilhado | Lê uma convar como número inteiro. |
| setConvar | Cliente | Define 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. |
| setConvar | Servidor | Define 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
| Nome | Lado | Descrição |
|---|---|---|
| fileClose | Compartilhado | Fecha um arquivo, gravando o que falta, e destrói o elemento dele. |
| fileCopy | Compartilhado | Copia um arquivo, que pode ser de outro recurso, para o recurso que chama. As pastas que faltam no destino são criadas. |
| fileCreate | Compartilhado | Cria 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. |
| fileDelete | Compartilhado | Apaga um arquivo do recurso que chama. |
| fileExists | Compartilhado | Diz se um caminho é um arquivo. Faz o mesmo que pathIsFile. |
| fileFlush | Compartilhado | Grava no disco o que foi escrito no arquivo e ainda está em memória. |
| fileGetContents | Compartilhado | Lê um arquivo inteiro de uma vez, sem abri-lo. |
| fileGetPath | Compartilhado | Devolve o caminho de um arquivo aberto. |
| fileGetPos | Compartilhado | Devolve a posição atual de leitura e escrita de um arquivo. |
| fileGetSize | Compartilhado | Devolve o tamanho de um arquivo aberto. |
| fileIsEOF | Compartilhado | Diz se a posição de um arquivo chegou ao fim. |
| fileOpen | Compartilhado | Abre um arquivo que já existe, com a posição no começo. |
| fileRead | Compartilhado | Lê bytes de um arquivo a partir da posição atual e avança a posição. |
| fileRename | Compartilhado | Renomeia ou move um arquivo dentro do recurso que chama. As pastas que faltam no destino são criadas. |
| fileSetPos | Compartilhado | Muda a posição de leitura e escrita de um arquivo. |
| fileWrite | Compartilhado | Escreve um ou mais textos num arquivo, na posição atual. |
| pathIsDirectory | Compartilhado | Diz se um caminho é uma pasta. |
| pathIsFile | Compartilhado | Diz se um caminho é um arquivo. Faz o mesmo que fileExists. |
| pathListDir | Compartilhado | Lista o que há numa pasta. |
Dados e utilidades
| Nome | Lado | Descrição |
|---|---|---|
| decodeString | Compartilhado | Decodifica ou decifra um texto produzido por encodeString. |
| encodeString | Compartilhado | Codifica ou cifra um texto com um algoritmo: TEA, AES-128, RSA, Base64, Base32 ou zlib. |
| fromJSON | Compartilhado | Converte texto JSON num valor Lua. É a mesma função que json.decode. |
| getDistanceBetweenPoints2D | Compartilhado | Mede a distância entre dois pontos no plano horizontal, ignorando a altura. |
| getDistanceBetweenPoints3D | Compartilhado | Mede a distância em linha reta entre dois pontos no espaço. |
| getEasingValue | Compartilhado | Calcula o valor de uma curva de easing num ponto do progresso. |
| getRealTime | Compartilhado | Devolve a data e a hora reais do computador, no fuso local. |
| getTickCount | Compartilhado | Devolve quantos milissegundos se passaram desde que os scripts deste lado começaram a rodar. |
| getVersion | Compartilhado | Devolve informações sobre a versão do jogo e do Lua. |
| hash | Compartilhado | Calcula o hash de um texto: MD5, SHA-1, SHA-2 ou um HMAC. |
| interpolateBetween | Compartilhado | Interpola entre dois conjuntos de três números seguindo uma curva de easing. |
| isnan | Compartilhado | Diz se um valor é o número especial NaN (não é um número). |
| json.decode | Compartilhado | Converte texto JSON num valor Lua. É a mesma função que fromJSON. |
| json.encode | Compartilhado | Converte um valor Lua em texto JSON. É a mesma função que toJSON. |
| rgb | Compartilhado | Junta os componentes de uma cor num único número ARGB. É a mesma função que tocolor. |
| rgba | Compartilhado | Junta os componentes de uma cor num único número ARGB, com a opacidade de 0 a 1. |
| split | Compartilhado | Divide um texto em pedaços nos separadores. |
| tocolor | Compartilhado | Junta os componentes de uma cor num único número ARGB. É a mesma função que rgb. |
| toJSON | Compartilhado | Converte um valor Lua em texto JSON. É a mesma função que json.encode. |
Saída e depuração
| Nome | Lado | Descrição |
|---|---|---|
| createTrayNotification | Cliente | Mostra uma notificação do sistema na bandeja do Windows, enquanto o jogo está sem foco. |
| outputDebugString | Compartilhado | Escreve uma linha no log de scripts deste lado, como erro, aviso ou mensagem. |
| outputServerLog | Compartilhado | Escreve uma mensagem no log deste lado, com o nome do recurso na frente. |
| Compartilhado | Escreve os valores dados no log de scripts como uma mensagem, separados por tabulação. | |
| setClipboard | Cliente | Copia um texto para a área de transferência do computador do jogador. |
| onClientDebugMessage | Cliente | Disparado neste cliente para cada linha de script que vai para o log: erros, avisos e mensagens. |
| onDebugMessage | Servidor | Disparado no servidor para cada linha de script que vai para o log: erros, avisos e mensagens. |
Jogadores e contas
| Nome | Lado | Descrição |
|---|---|---|
| getMaxPlayers | Servidor | Devolve quantos jogadores o servidor aceita ao mesmo tempo. |
| getPlayerAccount | Servidor | Devolve a conta MYMP com que o jogador entrou. |
| getPlayerCount | Servidor | Devolve quantos jogadores estão no servidor. |
| getPlayerFromName | Servidor | Encontra um jogador pelo nome exato, diferenciando maiúsculas e minúsculas. |
| getPlayerIdentifier | Servidor | Devolve um identificador do jogador de um tipo, como steam ou discord. |
| getPlayerIdentifiers | Servidor | Lista todos os identificadores do jogador, cada um como tipo:valor, por exemplo steam:110000112345678 e discord:80351110224678912. |
| getPlayerIP | Servidor | Devolve o endereço IP de onde o jogador está conectado, sem a porta. |
| getPlayerName | Servidor | Devolve o nome do jogador. Num servidor com server_key, é o nome da conta MYMP no formato Nome#Tag. |
| getPlayerPing | Cliente | Devolve 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. |
| getPlayerPing | Servidor | Devolve o ping do jogador com o servidor, medido pela conexão. |
| getPlayers | Servidor | Lista todos os jogadores do servidor. |
| getQueuePriority | Servidor | Lê a prioridade de uma conta na fila do servidor cheio. |
| getRandomPlayer | Servidor | Escolhe um jogador do servidor ao acaso. |
| isPlayerSpawned | Servidor | Diz se o jogador já foi colocado no mundo por spawnPlayer. |
| kickPlayer | Servidor | Desconecta um jogador do servidor com um motivo. |
| playSoundFrontEnd | Servidor | Toca um som de interface do jogo para um jogador, ou para todos os jogadores dentro de um elemento, como root. |
| setMaxPlayers | Servidor | Muda quantos jogadores o servidor aceita ao mesmo tempo. |
| setQueuePriority | Servidor | Define a prioridade de uma conta na fila do servidor cheio. Quem tem prioridade maior passa na frente. |
| spawnPlayer | Servidor | Coloca o jogador no mundo, com a vida em 100, sem colete, no interior 0 e sem armas. |
| onPlayerConnect | Servidor | Disparado quando uma conexão vai ser aceita, antes de o jogador existir. Cancelar o evento recusa a entrada. |
| onPlayerJoin | Servidor | Disparado quando um jogador terminou de entrar e já recebeu o estado inicial do servidor. |
| onPlayerQueue | Servidor | Disparado quando uma conta vai entrar na fila de um servidor cheio. Cancelar o evento recusa a entrada. |
| onPlayerQuit | Servidor | Disparado quando um jogador sai do servidor, antes de o seu elemento ser destruído. |
| onPlayerSpawn | Servidor | Disparado depois que spawnPlayer faz um jogador nascer. |
Peds
| Nome | Lado | Descrição |
|---|---|---|
| canPedBeKnockedOffBike | Cliente | Diz se um ped pode cair da moto ou bicicleta ao bater. |
| createPed | Cliente | Cria um ped que existe só neste cliente. |
| createPed | Servidor | Cria um ped no servidor, visto por todos os jogadores. |
| getPedArmour | Servidor | Lê o colete de um ped ou jogador. |
| getPedBikeControl | Cliente | Lê a habilidade de um ped para pilotar motos e bicicletas. |
| getPedCyclePower | Cliente | Lê a força com que um ped pedala uma bicicleta. |
| getPedJumpPower | Cliente | Lê a força do pulo de um ped. |
| getPedMeleeStrength | Cliente | Lê a força dos golpes corpo a corpo de um ped. |
| getPedMoveState | Cliente | Diz como um ped a pé está se movendo. |
| getPedOccupiedVehicle | Compartilhado | Lê o veículo em que um ped ou jogador está. |
| getPedOccupiedVehicleSeat | Compartilhado | Lê o assento que um ped ou jogador ocupa no veículo. |
| getPedSimplestTask | Cliente | Lê a tarefa mais simples que o ped está executando agora. |
| getPedStrafePower | Cliente | Lê como o ped acelera ao andar de lado enquanto luta ou mira uma arma. |
| getPedTask | Cliente | Lê a tarefa que um ped executa num slot e todas as subtarefas dela. |
| getPedWeapon | Servidor | Lê a arma que um ped ou jogador está segurando. |
| giveWeapon | Servidor | Dá uma arma com munição a um ped ou jogador. |
| isPedDead | Servidor | Diz se um ped ou jogador está morto. |
| isPedDoingTask | Cliente | Diz se um ped está executando uma tarefa, em qualquer slot e em qualquer nível de subtarefa. |
| isPedDucked | Compartilhado | Diz se um ped ou jogador está agachado. |
| isPedInVehicle | Compartilhado | Diz se um ped ou jogador está num veículo. |
| isPedInWater | Compartilhado | Diz se um ped ou jogador está na água. |
| isPedOnGround | Compartilhado | Diz se um ped ou jogador está no chão. |
| isPedUsingDoubleWeapons | Cliente | Diz se o ped segura uma cópia da arma também na mão esquerda. |
| killPedTask | Cliente | Remove a tarefa que um ped executa num slot. |
| removePedFromVehicle | Compartilhado | Tira um ped ou jogador do veículo na hora, sem animação. |
| setPedArmour | Servidor | Define o colete de um ped ou jogador e o envia aos clientes. |
| setPedBikeControl | Cliente | Define a habilidade de um ped para pilotar motos e bicicletas. |
| setPedCanBeKnockedOffBike | Cliente | Define se um ped pode cair da moto ou bicicleta ao bater. |
| setPedCyclePower | Cliente | Define a força com que um ped pedala uma bicicleta. |
| setPedDoubleWeapons | Cliente | Define se o ped segura uma cópia da arma também na mão esquerda. |
| setPedEnterVehicle | Cliente | Faz um ped ir até um veículo e entrar nele, como se o jogador apertasse para entrar. |
| setPedExitVehicle | Cliente | Faz um ped sair do veículo em que está pela porta, com a animação de saída. |
| setPedJumpPower | Cliente | Define a força do pulo de um ped. |
| setPedMeleeStrength | Cliente | Define a força dos golpes corpo a corpo de um ped. |
| setPedStrafePower | Cliente | Define como o ped acelera ao andar de lado enquanto luta ou mira uma arma. |
| warpPedIntoVehicle | Compartilhado | Coloca um ped ou jogador direto num assento de um veículo, sem animação. |
| onClientPedStep | Cliente | Disparado a cada passo de um ped ou jogador, quando o pé toca o chão. |
| onClientPedsProcessed | Cliente | Disparado a cada quadro depois que os peds e objetos foram animados, antes de serem apresentados e desenhados. |
Controles
| Nome | Lado | Descrição |
|---|---|---|
| getControlState | Cliente | Diz se um controle de um ped está pressionado, como forwards, fire ou accelerate. |
| getControlState | Servidor | Diz se um jogador está pressionando um controle, segundo as teclas que o cliente dele mandou por último. |
| getPedAnalogControlState | Cliente | Diz o quanto um controle de um ped está pressionado, de 0 a 1. Serve para os controles analógicos, como andar, virar e acelerar. |
| getPedCameraRotation | Cliente | Diz 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. |
| getPedContactElement | Cliente | Devolve o veículo ou objeto sobre o qual um ped está pisando. |
| getPedControlState | Cliente | Diz se um controle de um ped está pressionado, como forwards, fire ou accelerate. |
| isControlEnabled | Cliente | Diz se um controle do jogador local está ligado. |
| isControlEnabled | Servidor | Diz se um controle de um jogador está ligado, segundo o que o servidor mandou ao cliente dele. |
| setControlState | Cliente | Pressiona ou solta um controle de um ped como se fosse uma tecla, por exemplo para fazê-lo andar, pular ou atirar. |
| setControlState | Servidor | Pressiona 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. |
| setPedAnalogControlState | Cliente | Pressiona um controle analógico de um ped só em parte, por exemplo para ele andar devagar ou virar de leve. |
| setPedCameraRotation | Cliente | Muda 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. |
| setPedControlState | Cliente | Pressiona ou solta um controle de um ped como se fosse uma tecla, por exemplo para fazê-lo andar, pular ou atirar. |
| toggleAllControls | Cliente | Liga ou desliga de uma vez todos os controles do jogador local. |
| toggleAllControls | Servidor | Liga ou desliga de uma vez todos os controles de um jogador. A ordem vai para o cliente dele. |
| toggleControl | Cliente | Liga ou desliga um controle do jogador local. Um controle desligado não chega ao jogo, mesmo com a tecla pressionada. |
| toggleControl | Servidor | Liga ou desliga um controle de um jogador. O cliente dele deixa de passar esse controle ao jogo, mesmo com a tecla pressionada. |
Animações
| Nome | Lado | Descrição |
|---|---|---|
| getPedAnimation | Cliente | Diz qual animação de setPedAnimation um ped está tocando neste cliente. |
| getPedAnimationLength | Cliente | Diz a duração da animação que o ped toca, como a de setPedAnimation. |
| getPedAnimationProgress | Cliente | Diz em que ponto está a animação que o ped toca, como a de setPedAnimation. |
| getPedAnimationSpeed | Cliente | Diz a velocidade da animação que o ped toca, como a de setPedAnimation. |
| setPedAnimation | Cliente | Faz 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. |
| setPedAnimationProgress | Cliente | Pula uma animação que o ped está tocando para um ponto dela. Sem anim, para a animação de setPedAnimation. |
| setPedAnimationSpeed | Cliente | Muda a velocidade de uma animação que o ped está tocando. |
Aparência
| Nome | Lado | Descrição |
|---|---|---|
| addPedClothes | Compartilhado | Veste uma peça de roupa num ped. A peça ocupa o seu encaixe e troca a que estava nele. |
| getClothesVariantCount | Compartilhado | Conta quantas texturas uma peça de roupa tem para o modelo de um ped. |
| getPedBodyShape | Compartilhado | Diz quanto de uma forma de corpo um ped tem. |
| getPedClothes | Compartilhado | Diz que roupas um ped veste, todas ou a de um encaixe. |
| getPedHairColor | Compartilhado | Diz a cor do cabelo de um ped e das mechas, se houver. |
| getPedHeadBlend | Compartilhado | Diz como o rosto de um ped mistura os seus dois pais. |
| getPedHeadShape | Compartilhado | Diz quanto um traço do rosto de um ped foi ajustado. |
| getPedOverlay | Compartilhado | Diz qual variante de uma sobreposição um ped usa no rosto. |
| getPedOverlayColor | Compartilhado | Diz a cor de uma sobreposição que o ped usa no rosto. |
| removePedClothes | Compartilhado | Tira a peça de roupa que um ped veste num encaixe. |
| setPedBodyShape | Compartilhado | Muda o corpo de um ped por uma forma nomeada, que aumenta os ossos que ela declara. |
| setPedHairColor | Compartilhado | Tinge o cabelo de um ped e, se quiser, as mechas. |
| setPedHeadBlend | Compartilhado | Monta o rosto de um ped misturando a cabeça e a pele de dois pais. |
| setPedHeadShape | Compartilhado | Ajusta um traço do rosto de um ped, como o nariz ou o queixo. |
| setPedOverlay | Compartilhado | Põe ou tira uma sobreposição no rosto de um ped, como barba, sobrancelha ou maquiagem. |
| setPedOverlayColor | Compartilhado | Tinge uma sobreposição que o ped usa no rosto, por uma linha da paleta ou por uma cor. |
Ambiente do jogador
| Nome | Lado | Descrição |
|---|---|---|
| getLocalization | Cliente | Devolve o idioma em que o jogador está jogando, o mesmo escolhido no launcher. |
| isStreamerMode | Cliente | Diz se o modo streamer está ligado. Nele, o console esconde todo endereço IPv4 que mostra. |
| onClientStreamerModeChange | Cliente | Disparado quando o modo streamer liga ou desliga. |
Veículos
| Nome | Lado | Descrição |
|---|---|---|
| addVehicleUpgrade | Compartilhado | Instala um upgrade de tuning em um veículo, trocando o que estiver no mesmo slot. |
| createVehicle | Cliente | Cria um veículo que existe só neste cliente. |
| createVehicle | Servidor | Cria um veículo no servidor, visto por todos os jogadores. |
| fixVehicle | Compartilhado | Conserta 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. |
| getVehicleCompatibleUpgrades | Compartilhado | Devolve os upgrades de tuning que servem no modelo de um veículo. |
| getVehicleController | Compartilhado | Devolve quem está dirigindo um veículo, ou seja, o ocupante do banco 0. |
| getVehicleDoorOpenRatio | Compartilhado | Devolve quanto uma ou mais portas de um veículo estão abertas. |
| getVehicleDoorState | Compartilhado | Devolve o estado de uma ou mais portas de um veículo. |
| getVehicleEngineSound | Cliente | Devolve os sons de motor e de indução que setVehicleEngineSound pôs num veículo. |
| getVehicleEngineSounds | Cliente | Lista os conjuntos de sons de motor que os pacotes montados trazem. |
| getVehicleEngineState | Compartilhado | Devolve se o motor de um veículo está ligado. |
| getVehicleHeadLightColor | Compartilhado | Devolve a cor da luz dos faróis de um veículo. |
| getVehicleHydraulics | Compartilhado | Diz se um veículo tem hidráulica instalada por setVehicleHydraulics. |
| getVehicleHydraulicsControl | Compartilhado | Devolve quanto setVehicleHydraulicsControl mandou levantar cada roda de um veículo. |
| getVehicleLightState | Compartilhado | Devolve se uma ou mais luzes de um veículo estão quebradas. |
| getVehicleMaxPassengers | Cliente | Diz quantos passageiros cabem num veículo, sem contar o motorista. |
| getVehicleMaxPassengers | Servidor | Diz quantos passageiros cabem num veículo, sem contar o motorista. |
| getVehicleOccupant | Compartilhado | Devolve o ped ou jogador sentado em um banco de um veículo. |
| getVehicleOccupants | Compartilhado | Devolve todos os peds e jogadores dentro de um veículo. |
| getVehicleOverrideLights | Compartilhado | Devolve se os faróis de um veículo estão forçados a ficar ligados ou desligados. |
| getVehicleSuspensionHeight | Compartilhado | Devolve a altura de suspensão que setVehicleSuspensionHeight deu a um veículo. |
| getVehicleTowedByVehicle | Compartilhado | Devolve o reboque ou veículo que este veículo está puxando. |
| getVehicleTowingVehicle | Compartilhado | Devolve o veículo que está puxando este veículo. |
| getVehicleUpgradeOnSlot | Compartilhado | Devolve o upgrade instalado em um slot de um veículo. |
| getVehicleUpgrades | Compartilhado | Devolve todos os upgrades de tuning instalados em um veículo. |
| getVehicleUpgradeSlotName | Compartilhado | Devolve o nome de um slot de upgrade, a partir do índice do slot ou de um upgrade que vai nele. |
| getVehicleUpgradeSlots | Compartilhado | Devolve os nomes de todos os slots de upgrade que os pacotes montados declaram. |
| getVehicleWheelCamber | Compartilhado | Devolve a cambagem das rodas de um veículo. |
| getVehicleWheelFrictionState | Cliente | Diz como as rodas de um veículo estão aderindo ao chão. |
| getVehicleWheelOffset | Compartilhado | Devolve o deslocamento das rodas de um veículo. |
| getVehicleWheelScale | Compartilhado | Devolve o fator de raio dos pneus de um veículo. |
| getVehicleWheelState | Compartilhado | Devolve o estado de uma ou mais rodas de um veículo. |
| getVehicleWheelStates | Compartilhado | Devolve o estado das quatro rodas de um veículo. |
| getVehicleWheelWidth | Compartilhado | Devolve o fator de largura dos pneus de um veículo. |
| isVehicleFullBeam | Compartilhado | Devolve se o farol alto de um veículo está ligado. |
| isVehicleLocked | Compartilhado | Devolve se as portas de um veículo estão trancadas. |
| isVehicleOnGround | Compartilhado | Devolve se um veículo está apoiado no chão. |
| isVehicleWheelOnGround | Cliente | Diz se as rodas de um veículo estão tocando alguma coisa. |
| removeVehicleUpgrade | Compartilhado | Tira um upgrade de tuning de um veículo. |
| setVehicleDoorOpenRatio | Compartilhado | Abre ou fecha uma ou mais portas de um veículo até uma fração, de uma vez ou aos poucos. |
| setVehicleDoorState | Compartilhado | Muda o estado de uma ou mais portas de um veículo: fechada, aberta, amassada ou arrancada. |
| setVehicleEngineSound | Cliente | Troca o som do motor de um veículo neste cliente por um conjunto de sons dos pacotes montados. |
| setVehicleEngineState | Compartilhado | Liga ou desliga o motor de um veículo. |
| setVehicleFullBeam | Compartilhado | Liga ou desliga o farol alto de um veículo. |
| setVehicleHeadLightColor | Compartilhado | Muda a cor da luz dos faróis de um veículo. |
| setVehicleHydraulics | Compartilhado | Instala ou tira a hidráulica de um veículo. |
| setVehicleHydraulicsControl | Compartilhado | Levanta cada roda de um veículo com a hidráulica, sem ninguém nos controles. |
| setVehicleLightState | Compartilhado | Quebra ou conserta uma ou mais luzes de um veículo. |
| setVehicleLocked | Compartilhado | Tranca ou destranca as portas de um veículo. |
| setVehicleOverrideLights | Compartilhado | Força os faróis de um veículo a ficarem ligados ou desligados, ou devolve a decisão ao jogo. |
| setVehicleSuspensionHeight | Compartilhado | Sobe ou rebaixa a suspensão de um veículo. |
| setVehicleWheelCamber | Compartilhado | Inclina as rodas de um veículo para dentro ou para fora (cambagem). |
| setVehicleWheelOffset | Compartilhado | Desloca as rodas de um veículo de onde o modelo as põe. |
| setVehicleWheelScale | Compartilhado | Aumenta ou diminui o raio dos pneus de um veículo. |
| setVehicleWheelState | Compartilhado | Muda o estado de uma ou mais rodas de um veículo: cheia, furada, solta ou sem colisão. |
| setVehicleWheelStates | Compartilhado | Muda o estado das quatro rodas de um veículo de uma vez. |
| setVehicleWheelWidth | Compartilhado | Alarga ou estreita os pneus de um veículo. |
| onClientPedVehicleEnter | Cliente | Disparado no cliente quando um ped (que não é jogador) termina de entrar num veículo. |
| onClientPedVehicleExit | Cliente | Disparado no cliente quando um ped (que não é jogador) sai de um veículo. |
| onClientPlayerVehicleEnter | Cliente | Disparado no cliente quando um jogador termina de entrar num veículo. |
| onClientPlayerVehicleExit | Cliente | Disparado no cliente quando um jogador sai de um veículo. |
| onClientTrailerAttach | Cliente | Disparado no cliente quando um reboque é engatado num veículo. |
| onClientTrailerDetach | Cliente | Disparado no cliente quando um reboque é solto do veículo que o puxava. |
| onClientVehicleEnter | Cliente | Disparado no cliente quando um ped termina de entrar num veículo. |
| onClientVehicleExit | Cliente | Disparado no cliente quando um ped sai de um veículo. |
| onClientVehicleStartEnter | Cliente | Disparado no cliente quando um ped começa a entrar num veículo. Cancelar o evento impede a entrada. |
| onClientVehicleStartExit | Cliente | Disparado no cliente quando um ped começa a sair de um veículo. Cancelar o evento impede a saída. |
| onPedVehicleEnter | Servidor | Disparado no servidor quando um ped (que não é jogador) termina de entrar num veículo. |
| onPedVehicleExit | Servidor | Disparado no servidor quando um ped (que não é jogador) sai de um veículo. |
| onPlayerVehicleEnter | Servidor | Disparado no servidor quando um jogador termina de entrar num veículo. |
| onPlayerVehicleExit | Servidor | Disparado no servidor quando um jogador sai de um veículo. |
| onTrailerAttach | Servidor | Disparado no servidor quando um reboque é engatado num veículo. Cancelar o evento solta o reboque. |
| onTrailerDetach | Servidor | Disparado no servidor quando um reboque é solto do veículo que o puxava. |
| onVehicleEnter | Servidor | Disparado no servidor quando um ped termina de entrar num veículo. |
| onVehicleExit | Servidor | Disparado no servidor quando um ped sai de um veículo. |
| onVehicleStartEnter | Servidor | Disparado no servidor quando um ped começa a entrar num veículo. Cancelar o evento impede a entrada. |
| onVehicleStartExit | Servidor | Disparado 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
| Nome | Lado | Descrição |
|---|---|---|
| areVehicleLightTrailsEnabled | Cliente | Diz se um veículo deixa rastros de luz atrás das lanternas traseiras. |
| getVehicleDirtColor | Compartilhado | Diz a cor da sujeira na pintura de um veículo. |
| getVehicleDirtLevel | Compartilhado | Diz quanta sujeira aparece na pintura de um veículo. |
| getVehicleNeonColor | Compartilhado | Diz a cor do neon de um veículo. |
| getVehicleNeonPower | Compartilhado | Diz o brilho do neon de um veículo. |
| getVehicleNeonStrips | Compartilhado | Lista as faixas de neon que o modelo de um veículo tem. |
| getVehicleWetnessLevel | Compartilhado | Diz quão molhado um veículo foi fixado. |
| isVehicleBackfireEnabled | Cliente | Diz se um veículo solta chamas sozinho pelo escapamento. |
| isVehicleNeonEnabled | Compartilhado | Diz se faixas de neon de um veículo estão acesas. |
| resetVehicleDirtColor | Compartilhado | Volta a sujeira de um veículo à cor padrão, 59, 57, 52. |
| resetVehicleWetnessLevel | Compartilhado | Faz um veículo voltar a ficar molhado conforme a chuva, desfazendo setVehicleWetnessLevel. |
| setVehicleBackfireEnabled | Cliente | Liga 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. |
| setVehicleDirtColor | Compartilhado | Muda a cor da sujeira na pintura de um veículo, como lama ou areia. |
| setVehicleDirtLevel | Compartilhado | Muda quanta sujeira aparece na pintura de um veículo. |
| setVehicleLightTrailsEnabled | Cliente | Liga ou desliga rastros de luz vermelha atrás das lanternas traseiras acesas de um veículo, mais longos quanto mais rápido ele anda. |
| setVehicleNeonColor | Compartilhado | Muda a cor do neon de um veículo. A cor vale para todas as faixas. |
| setVehicleNeonEnabled | Compartilhado | Acende ou apaga faixas de neon sob um veículo. |
| setVehicleNeonPower | Compartilhado | Muda o brilho do neon de um veículo. |
| setVehicleWetnessLevel | Compartilhado | Fixa quão molhado um veículo aparece, em vez de seguir a chuva. |
| triggerVehicleBackfire | Cliente | Faz sair uma pequena chama de cada escapamento de um veículo, uma vez. |
Handling
| Nome | Lado | Descrição |
|---|---|---|
| getModelHandling | Servidor | Lê o handling de um modelo de veículo, com que os veículos novos desse modelo começam. |
| getOriginalHandling | Cliente | Lê o handling original de um modelo de veículo, como o jogo o carregou, sem as mudanças dos scripts. |
| getOriginalHandling | Servidor | Lê o handling original de um modelo de veículo, como os pacotes de conteúdo o declaram, sem as mudanças dos scripts. |
| getVehicleHandling | Compartilhado | Lê o handling de um veículo: massa, motor, tração, suspensão e o resto do que define como ele anda. |
| setModelHandling | Servidor | Muda uma propriedade do handling de um modelo de veículo, com que os veículos novos desse modelo começam. |
| setVehicleHandling | Cliente | Muda o handling de um veículo só neste cliente. |
| setVehicleHandling | Servidor | Muda o handling de um veículo para todos os jogadores. |
Mundo e clima
| Nome | Lado | Descrição |
|---|---|---|
| createFire | Cliente | Acende um fogo num ponto, só neste cliente. Ele queima por 5 segundos. |
| createLadder | Cliente | Cria uma escada em que peds podem subir, só neste cliente. |
| extinguishFire | Cliente | Apaga os fogos dentro de um raio de um ponto. Sem argumentos, apaga todos os fogos deste cliente. |
| getCloudsDensity | Cliente | Devolve quanto do céu as nuvens cobrem: o valor de setCloudsDensity ou, sem ele, o atual das nuvens. |
| getFarClipDistance | Cliente | Devolve até que distância o mundo está sendo desenhado agora. |
| getFiresInRange | Cliente | Lista os fogos acesos perto de um ponto. A distância é medida só no plano horizontal. |
| getFogDistance | Cliente | Devolve a que distância a neblina começa: o valor de setFogDistance ou, sem ele, o do ciclo de tempo. |
| getGroundPosition | Cliente | Procura o chão logo abaixo de um ponto, até 1000 m para baixo. Só prédios e objetos contam. |
| getMinuteDuration | Cliente | Devolve quanto tempo real dura um minuto do jogo neste cliente. |
| getMoonColor | Cliente | Devolve a cor da lua que está sendo usada: a definida por setMoonColor ou, sem ela, a do ciclo de tempo. |
| getMoonSize | Cliente | Devolve o tamanho do disco da lua: o definido por setMoonSize ou, sem ele, o do ciclo de tempo. |
| getScreenFromWorldPosition | Cliente | Projeta um ponto do mundo na tela, com a câmera do quadro atual. |
| getSkyColor | Cliente | Devolve o degradê do céu definido por setSkyColor. |
| getSunColor | Cliente | Devolve a cor do sol que está sendo usada: a definida por setSunColor ou, sem ela, a do ciclo de tempo. |
| getSunSize | Cliente | Devolve o tamanho do disco do sol: o definido por setSunSize ou, sem ele, o do ciclo de tempo. |
| getTime | Cliente | Devolve a hora do jogo neste cliente. |
| getWeather | Cliente | Devolve o clima atual deste cliente. Durante uma transição, é o clima de destino. |
| getWeatherNames | Cliente | Lista os climas que os pacotes carregados declaram. |
| getWorldFromScreenPosition | Cliente | Converte um ponto da tela, a uma profundidade, num ponto do mundo, com a câmera do quadro atual. |
| isLineOfSightClear | Cliente | Diz se nada bloqueia o segmento entre dois pontos. Só prédios e objetos bloqueiam; veículos e peds não. |
| isTimeFrozen | Cliente | Diz se o relógio do jogo está congelado neste cliente. |
| processLineOfSight | Cliente | Lança um raio entre dois pontos e devolve a primeira coisa que ele acerta. |
| resetCloudsDensity | Cliente | Desfaz setCloudsDensity: a cobertura de nuvens volta a seguir o ciclo de tempo. |
| resetFarClipDistance | Cliente | Desfaz setFarClipDistance: a distância de desenho volta a seguir o ciclo de tempo. |
| resetFogDistance | Cliente | Desfaz setFogDistance: a neblina volta a seguir o ciclo de tempo. |
| resetMoonColor | Cliente | Desfaz setMoonColor: a cor da lua volta a seguir o ciclo de tempo. |
| resetMoonSize | Cliente | Desfaz setMoonSize: o tamanho da lua volta a seguir o ciclo de tempo. |
| resetSkyColor | Cliente | Desfaz setSkyColor: o céu volta a seguir o ciclo de tempo. |
| resetSunColor | Cliente | Desfaz setSunColor: a cor do sol volta a seguir o ciclo de tempo. |
| resetSunSize | Cliente | Desfaz setSunSize: o tamanho do sol volta a seguir o ciclo de tempo. |
| setCloudsDensity | Cliente | Muda quanto do céu as nuvens cobrem, por cima do ciclo de tempo, até ser restaurado com resetCloudsDensity. |
| setFarClipDistance | Cliente | Muda até que distância da câmera o mundo é desenhado, por cima do ciclo de tempo, até ser restaurada com resetFarClipDistance. |
| setFogDistance | Cliente | Muda a que distância da câmera a neblina começa, por cima do ciclo de tempo, até ser restaurada com resetFogDistance. |
| setMinuteDuration | Cliente | Define quanto tempo real dura um minuto do jogo neste cliente. |
| setMoonColor | Cliente | Muda a cor da lua, por cima do ciclo de tempo, até ser restaurada com resetMoonColor. |
| setMoonSize | Cliente | Muda o tamanho do disco da lua no céu, por cima do ciclo de tempo, até ser restaurado com resetMoonSize. |
| setSkyColor | Cliente | Pinta o céu com um degradê do topo ao horizonte, por cima do ciclo de tempo, até ser restaurado com resetSkyColor. |
| setSunColor | Cliente | Muda a cor do sol, por cima do ciclo de tempo, até ser restaurada com resetSunColor. |
| setSunSize | Cliente | Muda o tamanho do disco do sol no céu, por cima do ciclo de tempo, até ser restaurado com resetSunSize. |
| setTime | Cliente | Muda a hora do jogo neste cliente. O relógio continua andando a partir dela. |
| setTimeFrozen | Cliente | Congela ou descongela o relógio do jogo neste cliente. Congelado, a hora não avança, mas setTime ainda a muda. |
| setWeather | Cliente | Muda o clima deste cliente, de uma vez ou numa transição. |
Objetos
| Nome | Lado | Descrição |
|---|---|---|
| breakObject | Compartilhado | Quebra um objeto quebrável na hora. |
| createObject | Cliente | Cria um objeto que existe só neste cliente. |
| createObject | Servidor | Cria um objeto que todos os jogadores veem. |
| getObjectScale | Compartilhado | Devolve a escala de um objeto em cada eixo. |
| moveObject | Compartilhado | Move um objeto suavemente até uma posição, girando-o no caminho. |
| setObjectBreakable | Compartilhado | Define se um objeto quebrável pode ser quebrado. Um objeto que não pode fica imune a qualquer dano. |
| setObjectScale | Compartilhado | Muda o tamanho de um objeto, por igual ou em cada eixo. |
| stopObject | Compartilhado | Para o movimento de um objeto onde ele estiver. |
| onClientObjectMoveStart | Cliente | Disparado neste cliente quando um objeto começa um movimento de moveObject, criado por este cliente ou vindo do servidor. |
| onClientObjectMoveStop | Cliente | Disparado 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
| Nome | Lado | Descrição |
|---|---|---|
| createColCircle | Compartilhado | Cria uma área de colisão circular, sem limite de altura. |
| createColCuboid | Compartilhado | Cria uma área de colisão em forma de caixa, alinhada aos eixos do mundo. |
| createColPolygon | Compartilhado | Cria uma área de colisão com a forma de um polígono no plano, sem limite de altura até setColPolygonHeight dar um. |
| createColRectangle | Compartilhado | Cria uma área de colisão retangular, alinhada aos eixos do mundo e sem limite de altura. |
| createColSphere | Compartilhado | Cria uma área de colisão esférica. |
| createColTube | Compartilhado | Cria uma área de colisão em forma de cilindro vertical. |
| getColPolygonHeight | Compartilhado | Devolve entre que alturas um polígono de colisão detecta elementos. |
| getColShapeType | Compartilhado | Diz que forma uma área de colisão tem. |
| getElementsWithinColShape | Compartilhado | Lista os elementos que estão dentro de uma área de colisão. |
| isElementWithinColShape | Compartilhado | Diz se um elemento está dentro de uma área de colisão. |
| setColPolygonHeight | Compartilhado | Limita entre que alturas um polígono de colisão detecta elementos. |
| onClientColShapeHit | Cliente | Disparado quando um jogador, ped, veículo ou objeto entra numa área de colisão neste cliente. |
| onClientColShapeLeave | Cliente | Disparado quando um jogador, ped, veículo ou objeto sai de uma área de colisão neste cliente. |
| onClientElementColShapeHit | Cliente | Disparado num jogador, ped, veículo ou objeto quando ele entra numa área de colisão neste cliente. |
| onClientElementColShapeLeave | Cliente | Disparado num jogador, ped, veículo ou objeto quando ele sai de uma área de colisão neste cliente. |
| onColShapeHit | Servidor | Disparado quando um jogador, ped, veículo ou objeto entra numa área de colisão. |
| onColShapeLeave | Servidor | Disparado quando um jogador, ped, veículo ou objeto sai de uma área de colisão. |
| onElementColShapeHit | Servidor | Disparado num jogador, ped, veículo ou objeto quando ele entra numa área de colisão. |
| onElementColShapeLeave | Servidor | Disparado num jogador, ped, veículo ou objeto quando ele sai de uma área de colisão. |
Ruas e caminhos
| Nome | Lado | Descrição |
|---|---|---|
| arePathNodesLoaded | Cliente | Diz se os nós de caminho de uma área já estão carregados. |
| calculatePathRoute | Cliente | Calcula 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. |
| getClosestPathNode | Cliente | Acha o nó de rua ou de calçada mais perto de um ponto. |
| getClosestStraightRoad | Cliente | Acha 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. |
| getNthClosestPathNode | Cliente | Acha o n-ésimo nó de rua ou de calçada mais perto de um ponto. |
| getParkingNodeInArea | Cliente | Acha um nó de estacionamento dentro de uma caixa. Cada chamada devolve o próximo da caixa, voltando ao primeiro no fim. |
| getPathNodeInfo | Cliente | Devolve o que se sabe de um nó de caminho. |
| getPathNodeNeighbours | Cliente | Lista os nós ligados a um nó de caminho e como é cada ligação. |
| getPathNodePosition | Cliente | Devolve a posição de um nó de caminho. |
| getPathNodesInRadius | Cliente | Lista os nós de rua ou de calçada dentro de um raio. |
| getRoadDensity | Cliente | Mede 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. |
| getSafePedSpawnPosition | Cliente | Sorteia 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. |
| releasePathNodes | Cliente | Desfaz o pedido de requestPathNodesInArea. As áreas longe do jogador podem ser descarregadas de novo. |
| requestPathNodesInArea | Cliente | Pede 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
| Nome | Lado | Descrição |
|---|---|---|
| attachCameraToElement | Cliente | Prende a câmera a um elemento: ela acompanha a posição e a rotação dele até setCameraTarget devolvê-la a um ped. |
| fadeCamera | Cliente | Escurece a tela até uma cor ou a clareia de volta. |
| getCameraMatrix | Cliente | Devolve onde a câmera está e para onde olha. |
| getCameraTarget | Cliente | Devolve o jogador ou ped que a câmera está seguindo. |
| setCameraMatrix | Cliente | Fixa a câmera num ponto, olhando para outro, até setCameraTarget devolvê-la a um ped. |
| setCameraTarget | Cliente | Põe a câmera para seguir um jogador ou ped, como no jogo normal. Também desfaz setCameraMatrix e attachCameraToElement. |
Cinemáticas
| Nome | Lado | Descrição |
|---|---|---|
| castCinematicActor | Cliente | Faz 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. |
| createCinematic | Cliente | Cria um elemento cinematic, vazio ou a partir de uma cinemática salva. Ele pertence ao recurso que o criou e existe só neste cliente. |
| getCinematicActor | Cliente | Devolve o elemento local (ped ou veículo) que faz um ator na reprodução atual. |
| getCinematicActorPose | Cliente | Devolve onde um ator está num tempo da cinemática. Não precisa de reprodução. |
| getCinematicActors | Cliente | Lista os atores da cinemática: os gravados e os posicionados. |
| getCinematicAdjustments | Cliente | Devolve os deslocamentos e as animações postos sobre a tomada de um ator. |
| getCinematicAudio | Cliente | Devolve os sons da cinemática. |
| getCinematicCamera | Cliente | Devolve os planos de câmera da cinemática. |
| getCinematicCaptions | Cliente | Devolve as legendas da cinemática. |
| getCinematicData | Cliente | Devolve a cinemática inteira como bytes .cine, que createCinematic lê de volta. |
| getCinematicDuration | Cliente | Devolve quanto dura a cinemática. |
| getCinematicPosition | Cliente | Devolve em que tempo da cinemática a reprodução está. |
| getCinematicShotView | Cliente | Devolve onde a câmera de um plano está e para onde olha num tempo da cinemática, com o tremor. |
| getCinematicWorld | Cliente | Devolve as chaves de clima, hora e fade da cinemática. |
| isCinematicPaused | Cliente | Diz se a reprodução da cinemática está pausada. |
| playCinematic | Cliente | Reproduz 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. |
| removeCinematicActor | Cliente | Tira um ator da cinemática, com a tomada dele. |
| setCinematicActorTiming | Cliente | Posiciona 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. |
| setCinematicAdjustments | Cliente | Põ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. |
| setCinematicAudio | Cliente | Define os sons que a cinemática toca durante a reprodução. Substitui os sons anteriores. |
| setCinematicCamera | Cliente | Define os planos de câmera que a cinemática dirige durante a reprodução. Substitui os planos anteriores. |
| setCinematicCameraEnabled | Cliente | Liga 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. |
| setCinematicCaptions | Cliente | Define as legendas que a cinemática desenha na tela durante a reprodução. Substitui as legendas anteriores. |
| setCinematicDuration | Cliente | Fixa a duração da cinemática. A reprodução termina ao chegar nela. |
| setCinematicPaused | Cliente | Pausa ou retoma a reprodução da cinemática. Pausada, os clones param nas suas animações, os veículos congelam e os sons pausam. |
| setCinematicPosition | Cliente | Pula 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. |
| setCinematicProp | Cliente | Posiciona um veículo ou objeto parado numa parte da cinemática, ou muda um que já foi posicionado. |
| setCinematicWorld | Cliente | Define as chaves de clima, hora e fade da tela que a cinemática aplica durante a reprodução. Substitui as chaves anteriores. |
| startCinematicRecording | Cliente | Começ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. |
| stopCinematic | Cliente | Para a reprodução da cinemática. Os clones somem e o clima, a hora e o fade voltam ao que o mundo tinha. |
| stopCinematicRecording | Cliente | Para a gravação da cinemática. Os outros atores que eram reproduzidos durante a gravação param também. |
| onClientCinematicFinish | Cliente | Disparado quando a reprodução de uma cinemática chega ao fim sozinha. |
Desenho na tela
| Nome | Lado | Descrição |
|---|---|---|
| dxConvertPixels | Cliente | Converte uma imagem guardada numa string para outro formato, em segundo plano, e entrega o resultado a uma função. |
| dxCreateFont | Cliente | Cria uma fonte a partir de um arquivo de fonte do recurso, para usar nas funções de texto. |
| dxCreateRenderTarget | Cliente | Cria um render target: uma imagem em que as funções dx podem desenhar e que pode ser usada como qualquer outra imagem. |
| dxCreateScreenSource | Cliente | Cria uma screen source: uma imagem que recebe uma cópia da tela do jogo a cada dxUpdateScreenSource. |
| dxDrawCircle | Cliente | Desenha um círculo preenchido, ou um setor dele, na tela durante um quadro. |
| dxDrawImage | Cliente | Desenha uma imagem na tela durante um quadro. |
| dxDrawImageSection | Cliente | Desenha uma parte de uma imagem na tela durante um quadro. |
| dxDrawLine | Cliente | Desenha uma linha 2D na tela durante um quadro. |
| dxDrawLine3D | Cliente | Desenha uma linha no mundo 3D durante um quadro. A linha fica virada para a câmera. |
| dxDrawMaterialLine3D | Cliente | Desenha uma imagem esticada ao longo de uma linha no mundo 3D durante um quadro. |
| dxDrawMaterialPrimitive | Cliente | Desenha uma primitiva 2D com uma imagem na tela durante um quadro. |
| dxDrawMaterialPrimitive3D | Cliente | Desenha uma primitiva com uma imagem no mundo 3D durante um quadro. |
| dxDrawMaterialSectionLine3D | Cliente | Desenha uma parte de uma imagem esticada ao longo de uma linha no mundo 3D durante um quadro. |
| dxDrawPrimitive | Cliente | Desenha uma primitiva 2D (pontos, linhas ou triângulos) na tela durante um quadro. |
| dxDrawRectangle | Cliente | Desenha um retângulo preenchido na tela durante um quadro. |
| dxDrawText | Cliente | Desenha um texto na tela durante um quadro, dentro de uma caixa. |
| dxGetBlendMode | Cliente | Devolve o modo de mistura das funções dx 2D. |
| dxGetFontHeight | Cliente | Devolve a altura de uma linha de texto de uma fonte. |
| dxGetMaterialSize | Cliente | Devolve o tamanho de uma imagem em pixels. |
| dxGetPixelColor | Cliente | Lê a cor de um pixel de uma imagem em plain. |
| dxGetPixelsFormat | Cliente | Detecta o formato de uma imagem guardada numa string. |
| dxGetPixelsSize | Cliente | Devolve a largura e a altura de uma imagem guardada numa string (plain, png, jpeg ou dds). |
| dxGetStatus | Cliente | Devolve informações sobre a placa de vídeo e a memória de vídeo usada pelos scripts. |
| dxGetTextSize | Cliente | Mede a largura e a altura que um texto ocupa na tela. |
| dxGetTexturePixels | Cliente | Lê os pixels de uma imagem e os entrega a uma função, alguns quadros depois. |
| dxGetTextWidth | Cliente | Mede a largura que um texto ocupa na tela, na linha mais larga. |
| dxSetBlendMode | Cliente | Escolhe como as próximas funções dx 2D se misturam com o que já está desenhado. |
| dxSetPixelColor | Cliente | Muda a cor de um pixel de uma imagem em plain, na própria string. |
| dxSetRenderTarget | Cliente | Escolhe onde as próximas funções dx desenham: num render target ou, sem ele, na tela. |
| dxSetTextureEdge | Cliente | Escolhe o que uma imagem mostra quando é lida fora das suas bordas. |
| dxSetTexturePixels | Cliente | Escreve pixels numa textura criada por script ou num render target. |
| dxUpdateScreenSource | Cliente | Copia a tela do jogo para uma screen source. |
| getScreenSize | Cliente | Devolve o tamanho da tela do jogo em pixels. |
| onClientHUDRender | Cliente | Disparado a cada quadro, logo antes de onClientRender. |
| onClientPreRender | Cliente | Disparado a cada quadro, depois da simulação do mundo e antes de o mundo ser desenhado. |
| onClientRender | Cliente | Disparado a cada quadro, quando os desenhos dx daquele quadro devem ser feitos. |
Interface web
| Nome | Lado | Descrição |
|---|---|---|
| createDui | Cliente | Abre uma página web fora da tela, com fundo transparente, e a devolve como uma imagem que pode ser desenhada. |
| drawDui | Cliente | Desenha um dui na tela durante um quadro, em coordenadas relativas à tela. |
| isDuiReady | Cliente | Diz se a página de um dui terminou de carregar. |
| isNuiFocused | Cliente | Diz se alguma página de interface tem o foco. |
| registerNuiCallback | Cliente | Registra uma função que a página de interface do recurso chama com um fetch para /nome no próprio endereço dela. |
| sendDuiMessage | Cliente | Manda uma mensagem para a página de um dui. A página a recebe no evento message do window. |
| sendDuiMouseButton | Cliente | Aperta ou solta um botão do mouse sobre a página de um dui. |
| sendDuiMouseMove | Cliente | Move o ponteiro do mouse sobre a página de um dui. |
| sendDuiMouseWheel | Cliente | Rola a página de um dui com a roda do mouse. |
| sendNuiMessage | Cliente | Manda uma mensagem para a página de interface do recurso que chama. A página a recebe no evento message do window. |
| setDuiUrl | Cliente | Leva um dui para outro endereço. |
| setNuiFocus | Cliente | Dá ou tira o foco da página de interface do recurso que chama. Com foco, a página recebe o mouse e o teclado. |
| setNuiKeepInput | Cliente | Escolhe se o jogo continua recebendo o mouse e o teclado enquanto uma página de interface tem o foco. |
Luzes
| Nome | Lado | Descrição |
|---|---|---|
| createPointLight | Cliente | Cria uma luz que ilumina em todas as direções a partir de um ponto. A luz existe só neste cliente. |
| createRectLight | Cliente | Cria uma luz que sai de um retângulo, como um painel ou uma janela iluminada. A luz existe só neste cliente. |
| createSpotLight | Cliente | Cria uma luz que ilumina dentro de um cone, como um holofote. A luz existe só neste cliente. |
| dxDrawPointLight | Cliente | Acende uma luz em todas as direções a partir de um ponto, por um único quadro, sem criar elemento. |
| dxDrawRectLight | Cliente | Acende uma luz que sai de um retângulo por um único quadro, sem criar elemento. |
| dxDrawSpotLight | Cliente | Acende uma luz dentro de um cone por um único quadro, sem criar elemento. |
| getLightBarnDoor | Cliente | Lê as abas de uma luz rect. |
| getLightCastShadow | Cliente | Diz se uma luz projeta sombras. |
| getLightColor | Cliente | Lê a cor de uma luz. |
| getLightCone | Cliente | Lê a abertura e a dureza da borda do cone de uma luz spot. |
| getLightDirection | Cliente | Lê para onde uma luz spot ou rect aponta. |
| getLightFalloff | Cliente | Lê o expoente de desvanecimento de uma luz. |
| getLightIntensity | Cliente | Lê o brilho de uma luz. |
| getLightRadius | Cliente | Lê o alcance de uma luz. |
| getLightSize | Cliente | Lê a largura e a altura de uma luz rect. |
| getLightSourceRadius | Cliente | Lê o tamanho do bulbo de uma luz spot. |
| getLightTangent | Cliente | Lê para onde aponta a largura de uma luz rect. |
| getLightType | Cliente | Diz o tipo de uma luz. |
| isLightEnabled | Cliente | Diz se uma luz está ligada. |
| setLightBarnDoor | Cliente | Muda as abas de uma luz rect, que limitam para onde a luz sai do retângulo. |
| setLightCastShadow | Cliente | Liga ou desliga as sombras de uma luz. |
| setLightColor | Cliente | Muda a cor de uma luz. |
| setLightCone | Cliente | Muda a abertura e a dureza da borda do cone de uma luz spot. |
| setLightDirection | Cliente | Muda para onde uma luz spot ou rect aponta. |
| setLightEnabled | Cliente | Liga ou desliga uma luz sem destruí-la. |
| setLightFalloff | Cliente | Muda como a luz desvanece até o fim do alcance. |
| setLightIntensity | Cliente | Muda o brilho de uma luz. |
| setLightRadius | Cliente | Muda o alcance de uma luz. |
| setLightSize | Cliente | Muda a largura e a altura de uma luz rect. |
| setLightSourceRadius | Cliente | Muda o tamanho do bulbo de uma luz spot. Um bulbo maior deixa o brilho e as sombras mais suaves. |
| setLightTangent | Cliente | Muda para onde aponta a largura de uma luz rect, girando o retângulo em torno da normal. |
Efeitos
| Nome | Lado | Descrição |
|---|---|---|
| createEffect | Compartilhado | Cria um efeito de partículas no mundo. No servidor, todos os clientes o veem; num cliente, só esse cliente. |
| engineAddEffects | Cliente | Registra os efeitos de partículas de um arquivo do recurso, para que createEffect os use por nome. |
| engineGetEffects | Cliente | Lista os efeitos de partículas carregados neste cliente. |
| engineRemoveEffects | Cliente | Remove os efeitos que este recurso adicionou de um arquivo com engineAddEffects. |
| getEffectColor | Compartilhado | Lê a cor de um efeito. |
| getEffectEvolution | Compartilhado | Lê o nível de uma evolução de um efeito. |
| getEffectScale | Compartilhado | Lê o tamanho de um efeito. |
| setEffectColor | Compartilhado | Tinge um efeito com uma cor. |
| setEffectEvolution | Compartilhado | Muda o nível de uma evolução de um efeito, um parâmetro que o próprio efeito declara para variar a aparência. |
| setEffectScale | Compartilhado | Muda o tamanho de um efeito. |
| stopEffect | Compartilhado | Para um efeito: ele deixa de emitir e as partículas que já existem terminam. |
Texturas
| Nome | Lado | Descrição |
|---|---|---|
| engineCreateTexture | Cliente | Cria 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. |
| engineCreateTxd | Cliente | Cria um dicionário de texturas vazio com um nome. Preencha-o com engineSetTxdTexture. Ele existe só neste cliente. |
| engineGetModelTxds | Cliente | Lista os txds de onde um modelo tira suas texturas, na ordem em que ele os procura. |
| engineGetTxds | Cliente | Lista todos os dicionários de texturas que este cliente conhece, com a origem de cada um. |
| engineGetTxdTexture | Cliente | Dá um elemento texture que mostra o que um txd mostra sob um nome de textura, para desenhá-lo ou usá-lo como fonte. |
| engineGetTxdTextures | Cliente | Lista os nomes das texturas que um txd dá, incluindo os links. |
| engineIsAssetLoaded | Cliente | Diz se um asset criado por um script está pronto para uso. |
| engineLoadTxd | Cliente | Carrega um dicionário de texturas (.ktd) de um arquivo do recurso com um nome. Ele existe só neste cliente. |
| engineRestoreElementTexture | Cliente | Remove as trocas de textura que este recurso aplicou num elemento com engineSetElementTexture. |
| engineRestoreModelTexture | Cliente | Remove as trocas de textura que este recurso aplicou num modelo com engineSetModelTexture. |
| engineRestoreModelTxd | Cliente | Tira os txds que este recurso colocou na frente de um modelo com engineSetModelTxd. |
| engineRestoreTxdTexture | Cliente | Remove os links que este recurso criou num txd com engineSetTxdTexture, para que ele volte a dar suas próprias texturas. |
| engineRestoreTxdTextureSampling | Cliente | Remove a mudança de amostragem que este recurso aplicou na textura de um txd com engineSetTxdTextureSampling. |
| engineRestoreWorldTexture | Cliente | Remove as trocas de textura do mundo que este recurso aplicou com engineSetWorldTexture. |
| engineSetElementTexture | Cliente | Troca uma textura de um único veículo, ped, jogador ou objeto. As outras instâncias do mesmo modelo mantêm suas texturas. |
| engineSetModelTexture | Cliente | Troca 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. |
| engineSetModelTxd | Cliente | Coloca 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. |
| engineSetTxdTexture | Cliente | Coloca 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. |
| engineSetTxdTextureSampling | Cliente | Muda 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. |
| engineSetWorldTexture | Cliente | Troca 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. |
| onClientAssetLoad | Cliente | Disparado uma vez quando um asset que um script começou a carregar em segundo plano fica pronto, ou falha. |
Materiais e shaders
| Nome | Lado | Descrição |
|---|---|---|
| engineAddPostProcess | Cliente | Liga um pós-processamento na tela: um material cujo shader é #type post. |
| engineCreateMaterial | Cliente | Cria um material: um shader com valores de parâmetros, que depois substitui ou se sobrepõe aos materiais dos modelos. |
| engineCreateShader | Cliente | Cria um shader a partir de um arquivo .shader ou do próprio código-fonte. O shader compila em segundo plano. |
| engineGetElementStencil | Cliente | Diz com que valor de stencil um veículo, ped ou objeto está marcado. |
| engineGetMaterialAlphaClip | Cliente | Diz se o material recorta pixels pela transparência e a partir de que alfa. |
| engineGetMaterialParameters | Cliente | Lista os parâmetros do shader que um material usa. |
| engineGetMaterialShader | Cliente | Diz qual shader um material usa. |
| engineGetMaterialSwitches | Cliente | Lista as chaves estáticas do shader de um material, com o valor que cada uma tem nele. |
| engineGetMaterialValue | Cliente | Lê um valor que o material define: um parâmetro, uma chave estática ou uma saída TARGET_n. |
| engineGetModelMaterials | Cliente | Lista os materiais do modelo carregado, na ordem em que o modelo os guarda. |
| engineGetModelStencil | Cliente | Diz com que valor de stencil um modelo está marcado. |
| engineGetPostImage | Cliente | Dá a imagem que um passo de um pós-processamento produz, para desenhar ou usar em outro material. |
| engineGetShaderErrors | Cliente | Lista os erros da última compilação de um shader criado com engineCreateShader. |
| engineGetShaderGlobal | Cliente | Lê o valor atual de um global de shader. |
| engineGetShaderGlobals | Cliente | Lista todos os globais de shader, dos pacotes e dos scripts. |
| engineGetShaderParameters | Cliente | Lista os parâmetros que um shader ou preset declara. |
| engineGetShaderQuality | Cliente | Diz a qualidade atual dos materiais deste cliente. |
| engineGetShaders | Cliente | Lista todos os shaders e presets carregados, dos pacotes e dos scripts. |
| engineGetShaderSwitches | Cliente | Lista as chaves estáticas (parâmetros bool) de um shader ou preset, com o valor padrão de cada uma. |
| engineRemovePostProcess | Cliente | Desliga um pós-processamento que este recurso ligou com engineAddPostProcess. |
| engineResetMaterialValue | Cliente | Desfaz um valor que o material definiu, ou todos, e volta ao que vem da base. |
| engineResetShaderGlobal | Cliente | Retira o valor que este recurso deu a um global de shader, e o global volta ao valor de quem vem a seguir. |
| engineRestoreElementMaterial | Cliente | Desfaz o que engineSetElementMaterial deste recurso fez de um único veículo, ped ou objeto. |
| engineRestoreElementOverlay | Cliente | Desfaz o que engineSetElementOverlay deste recurso fez de um único veículo, ped ou objeto. |
| engineRestoreElementStencil | Cliente | Tira a marca de stencil que este recurso pôs com engineSetElementStencil. |
| engineRestoreModelMaterial | Cliente | Desfaz o que engineSetModelMaterial deste recurso fez de todas as instâncias de um modelo. |
| engineRestoreModelOverlay | Cliente | Desfaz o que engineSetModelOverlay deste recurso fez de todas as instâncias de um modelo. |
| engineRestoreModelStencil | Cliente | Tira a marca de stencil que este recurso pôs com engineSetModelStencil. |
| engineRestoreWorldMaterial | Cliente | Desfaz o que engineSetWorldMaterial deste recurso fez de todos os modelos do mundo. |
| engineRestoreWorldOverlay | Cliente | Desfaz o que engineSetWorldOverlay deste recurso fez de todos os modelos do mundo. |
| engineSetElementMaterial | Cliente | Substitui os materiais escolhidos de um único veículo, ped ou objeto por um material. |
| engineSetElementOverlay | Cliente | Desenha um material como uma camada a mais por cima dos materiais escolhidos de um único veículo, ped ou objeto. |
| engineSetElementStencil | Cliente | Marca 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. |
| engineSetMaterialAlphaClip | Cliente | Faz o material recortar os pixels cujo alfa fica abaixo de um limite, ou deixar de recortar. |
| engineSetMaterialShader | Cliente | Troca o shader de um material, mantendo os valores que ele já tem. |
| engineSetMaterialValue | Cliente | Define um valor do material: um parâmetro do shader, uma chave estática ou a render target de uma saída TARGET_n. |
| engineSetModelMaterial | Cliente | Substitui os materiais escolhidos de todas as instâncias de um modelo por um material. |
| engineSetModelOverlay | Cliente | Desenha um material como uma camada a mais por cima dos materiais escolhidos de todas as instâncias de um modelo. |
| engineSetModelStencil | Cliente | Marca 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. |
| engineSetShaderGlobal | Cliente | Define um global de shader, um valor que todos os shaders leem. Um nome novo cria o global. |
| engineSetShaderQuality | Cliente | Muda a qualidade dos materiais deste cliente. Shaders que leem QUALITY são compilados para o novo nível. |
| engineSetWorldMaterial | Cliente | Substitui os materiais escolhidos de todos os modelos do mundo por um material. |
| engineSetWorldOverlay | Cliente | Desenha um material como uma camada a mais por cima dos materiais escolhidos de todos os modelos do mundo. |
Modelos
| Nome | Lado | Descrição |
|---|---|---|
| engineCreateModel | Cliente | Cria um novo modelo com um nome, só neste cliente. Ele é usado pelo nome, como qualquer outro modelo. |
| engineGetModels | Cliente | Lista os modelos que este cliente conhece, com a origem de cada um. |
| engineLoadCol | Cliente | Carrega um arquivo de colisão (.kbn) do recurso para ser dado a um modelo. |
| engineLoadDrawable | Cliente | Carrega um drawable (.kdr) de um arquivo do recurso para ser dado a um modelo. |
| engineRestoreModelCol | Cliente | Tira a colisão que este recurso deu a um modelo com engineSetModelCol, para que ele colida como antes. |
| engineRestoreModelDrawable | Cliente | Tira o drawable que este recurso deu a um modelo com engineSetModelDrawable, para que ele desenhe o que desenhava antes. |
| engineSetModelCol | Cliente | Faz um modelo colidir com uma colisão carregada com engineLoadCol em vez da sua. |
| engineSetModelDrawable | Cliente | Faz um modelo desenhar um drawable carregado com engineLoadDrawable em vez do seu. |
Ajustes gráficos
| Nome | Lado | Descrição |
|---|---|---|
| engineGetAmbientOcclusion | Cliente | Devolve quantas amostras a oclusão de ambiente usa. |
| engineGetAntiAliasing | Cliente | Devolve o antisserrilhamento em uso. |
| engineGetBloom | Cliente | Devolve quantos níveis de desfoque o bloom usa. |
| engineGetClouds | Cliente | Devolve como as nuvens são desenhadas. |
| engineGetDecals | Cliente | Devolve quantas marcas podem existir ao mesmo tempo e quanto tempo elas duram. |
| engineGetLocalLightShadows | Cliente | Diz se as luzes locais projetam sombras. |
| engineGetMotionBlur | Cliente | Diz se o desfoque de movimento está ligado. |
| engineGetParticleDensity | Cliente | Devolve que fração das partículas dos efeitos é emitida. |
| engineGetParticleScale | Cliente | Devolve em que fração da resolução as partículas são desenhadas. |
| engineGetReflections | Cliente | Devolve a configuração dos reflexos. |
| engineGetRenderResolution | Cliente | Devolve o tamanho em pixels em que a cena é renderizada e o tamanho da imagem final na janela. |
| engineGetRenderScale | Cliente | Devolve a fração da resolução da janela em que a cena 3D é renderizada. |
| engineGetShadows | Cliente | Devolve a configuração das sombras do sol. |
| engineGetSharpness | Cliente | Devolve quanto a imagem final é nitidizada. |
| engineGetSunShafts | Cliente | Devolve em que fração da resolução os raios de sol são calculados. |
| engineGetVolumetricFog | Cliente | Diz se a neblina volumétrica está ligada. |
| engineHasCollisionLoadedAt | Cliente | Diz se o mundo em volta de um ponto já está sólido: a colisão, os prédios e as paisagens dali carregados. |
| engineHasModelLoaded | Cliente | Diz se um modelo está carregado na memória. |
| engineReleaseModel | Cliente | Desfaz o pedido de modelo que este recurso fez com engineRequestModel. |
| engineRequestCollisionAt | Cliente | Pede que a colisão em volta de um ponto seja carregada. O pedido continua até ela terminar de carregar. |
| engineRequestModel | Cliente | Pede ao streaming que carregue um modelo e o mantém carregado para este recurso até ser liberado. |
| engineSetAmbientOcclusion | Cliente | Define quantas amostras a oclusão de ambiente usa. Mais amostras escurecem cantos e frestas com mais precisão. |
| engineSetAntiAliasing | Cliente | Escolhe o antisserrilhamento da imagem. |
| engineSetBloom | Cliente | Define quantos níveis de desfoque o bloom usa. Mais níveis espalham o brilho mais longe. |
| engineSetClouds | Cliente | Escolhe como as nuvens são desenhadas. |
| engineSetDecals | Cliente | Define quantas marcas (buracos de bala, sangue, marcas de pneu) podem existir ao mesmo tempo e quanto tempo elas duram. |
| engineSetLocalLightShadows | Cliente | Liga ou desliga as sombras das luzes locais (pontuais, spots e retangulares). |
| engineSetMotionBlur | Cliente | Liga ou desliga o desfoque de movimento. No PC vem ligado. |
| engineSetParticleDensity | Cliente | Define que fração das partículas dos efeitos é emitida. As demais são descartadas ao acaso. |
| engineSetParticleScale | Cliente | Define em que fração da resolução as partículas são desenhadas. |
| engineSetReflections | Cliente | Configura os reflexos: o tamanho da sonda de ambiente e os reflexos calculados na tela. |
| engineSetRenderScale | Cliente | Define em que fração da resolução da janela a cena 3D é renderizada. A imagem é ampliada depois até o tamanho da janela. |
| engineSetShadows | Cliente | Configura as sombras do sol: quantas cascatas, a resolução e se as bordas são suaves. |
| engineSetSharpness | Cliente | Define quanto a imagem final é nitidizada. |
| engineSetSunShafts | Cliente | Define em que fração da resolução os raios de sol são calculados, ou os desliga. |
| engineSetVolumetricFog | Cliente | Liga ou desliga a neblina volumétrica. Vem desligada. |
Som
| Nome | Lado | Descrição |
|---|---|---|
| engineAddSound | Cliente | Registra um arquivo de áudio com um nome, que playSound e playSound3D passam a tocar por esse nome. |
| engineGetSounds | Cliente | Lista os sons com nome que valem agora, os do jogo, dos pacotes e dos recursos. |
| engineRemoveSound | Cliente | Remove um som que este recurso registrou com engineAddSound. Se outro registro do mesmo nome existe, ele volta a valer. |
| getSFXStatus | Cliente | Diz se um contêiner de áudio do GTA San Andreas está disponível para playSFX e playSFX3D. |
| getSoundBPM | Cliente | Detecta o andamento do som em batidas por minuto, arredondado para baixo. |
| getSoundBufferLength | Cliente | Existe por compatibilidade com o MTA, onde dá o tamanho do buffer de um stream da internet. |
| getSoundEffectParameters | Cliente | Devolve os parâmetros atuais de um efeito de áudio ligado num som ou na voz de um jogador. |
| getSoundEffects | Cliente | Lista os efeitos de áudio de um som ou da voz de um jogador e diz quais estão ligados. |
| getSoundFFTData | Cliente | Devolve o espectro de frequências do que o som está tocando agora, para fazer visualizadores. |
| getSoundLength | Compartilhado | Devolve a duração do som. |
| getSoundLevelData | Cliente | Devolve o pico de volume de cada canal nos últimos 20 ms do som. |
| getSoundMaxDistance | Compartilhado | Devolve a partir de que distância um som 3D fica mudo. |
| getSoundMetaTags | Cliente | Lê as tags do arquivo de áudio (ID3 do MP3, comentários do OGG e do FLAC, INFO do WAV). |
| getSoundMinDistance | Compartilhado | Devolve até que distância um som 3D toca no volume cheio. |
| getSoundPan | Cliente | Devolve o panorama de um som sem posição. |
| getSoundPosition | Compartilhado | Devolve em que ponto da faixa o som está tocando. |
| getSoundProperties | Cliente | Devolve a taxa de amostragem, o andamento e o tom de um som, e se ele toca ao contrário. |
| getSoundSpeaker | Cliente | Devolve o ped que fala um som. |
| getSoundSpeed | Compartilhado | Devolve a velocidade de um som. |
| getSoundVolume | Compartilhado | Devolve o volume de um som, sem contar a queda com a distância. |
| getSoundWaveData | Cliente | Devolve a forma de onda do que o som acabou de tocar, para desenhar osciloscópios. |
| isShowSoundEnabled | Cliente | Diz se showSound está ligado. |
| isSoundLooped | Compartilhado | Diz se um som repete quando chega ao fim. |
| isSoundPanningEnabled | Cliente | Diz se um som 3D tem panorama estéreo ligado. |
| isSoundPaused | Compartilhado | Diz se um som está pausado. |
| isWorldSoundEnabled | Cliente | Diz se um som do mundo, ou um grupo deles, está ligado. |
| playSFX | Cliente | Toca um som dos bancos de áudio do GTA San Andreas, sem posição no mundo. |
| playSFX3D | Cliente | Toca um som dos bancos de áudio do GTA San Andreas numa posição do mundo. |
| playSound | Cliente | Toca um som sem posição no mundo, só neste cliente. Dispara onClientSoundStarted com o motivo play. |
| playSound | Servidor | Cria um som sem posição no mundo que todos os clientes tocam juntos. As mudanças feitas nele no servidor chegam a todos. |
| playSound3D | Cliente | Toca 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. |
| playSound3D | Servidor | Cria um som numa posição do mundo que todos os clientes tocam juntos. As mudanças feitas nele no servidor chegam a todos. |
| playSoundFrontEnd | Cliente | Toca um dos sons de interface do GTA San Andreas, como os de menu e de missão. |
| resetWorldSounds | Cliente | Liga de novo todos os sons do mundo desligados com setWorldSoundEnabled. |
| setSoundEffectEnabled | Cliente | Liga 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. |
| setSoundEffectParameter | Cliente | Muda um parâmetro de um efeito de áudio ligado num som ou na voz de um jogador. |
| setSoundLooped | Compartilhado | Liga ou desliga a repetição de um som. No servidor, a mudança é enviada a todos os clientes. |
| setSoundMaxDistance | Compartilhado | Define 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. |
| setSoundMinDistance | Compartilhado | Define 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. |
| setSoundPan | Cliente | Coloca um som sem posição mais à esquerda ou à direita. |
| setSoundPanningEnabled | Cliente | Liga ou desliga o panorama estéreo de um som 3D. Ligado, o som soa mais à esquerda ou à direita conforme a câmera. Vem ligado. |
| setSoundPaused | Compartilhado | Pausa ou continua um som. No servidor, a mudança é enviada a todos os clientes. |
| setSoundPosition | Compartilhado | Pula 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. |
| setSoundProperties | Cliente | Muda a taxa de amostragem, o andamento e o tom de um som, e se ele toca ao contrário. |
| setSoundSpeaker | Cliente | Faz 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. |
| setSoundSpeed | Compartilhado | Muda a velocidade de um som. O tom muda junto. No servidor, a mudança é enviada a todos os clientes. |
| setSoundVolume | Compartilhado | Muda 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. |
| setWorldSoundEnabled | Cliente | Liga ou desliga sons do mundo do jogo (passos, tiros, colisões e outros) por grupo ou um a um. |
| showSound | Cliente | Escreve no console de depuração o grupo e o índice de cada som do mundo que toca. Só funciona no modo de desenvolvimento. |
| stopSound | Cliente | Para um som criado por este cliente e destrói o elemento. Dispara onClientSoundStopped com o motivo destroyed. |
| stopSound | Servidor | Para um som criado pelo servidor e destrói o elemento em todos os clientes. |
| onClientSoundStarted | Cliente | Disparado quando um som começa a tocar neste cliente ou sai da pausa. |
| onClientSoundStopped | Cliente | Disparado quando um som para de tocar neste cliente: pausado, parado ou terminado. |
| onClientWorldSound | Cliente | Disparado quando o jogo vai tocar um som do mundo. Cancelar o evento impede o som de tocar. |
Voz
| Nome | Lado | Descrição |
|---|---|---|
| addPlayerToVoiceChannel | Servidor | Põe um jogador num canal de voz. A partir daí ele ouve e é ouvido pelos outros do canal. |
| createVoiceChannel | Servidor | Cria um canal de voz. Os jogadores só ouvem uns aos outros pelos canais em que estão. |
| deleteVoiceChannel | Servidor | Destrói um canal de voz. Os jogadores que estavam nele deixam de se ouvir por ele. |
| isPlayerTalking | Cliente | Diz se um jogador está falando no chat de voz, do ponto de vista deste cliente. |
| isPlayerTalking | Servidor | Diz se um jogador está falando no chat de voz. |
| removePlayerFromVoiceChannel | Servidor | Tira um jogador de um canal de voz. |
| setPlayerDeafInVoiceChannel | Servidor | Deixa um jogador surdo num canal de voz: os outros continuam ouvindo ele, mas ele não ouve ninguém por esse canal. |
| setPlayerMutedInVoiceChannel | Servidor | Deixa um jogador mudo num canal de voz: ele continua ouvindo o canal, mas ninguém o ouve por ele. |
| setPlayerVoiceIgnoreFrom | Servidor | Faz um jogador deixar de ouvir a voz de certos elementos, em todos os canais. |
| onClientPlayerVoiceStart | Cliente | Disparado 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. |
| onClientPlayerVoiceStop | Cliente | Disparado neste cliente quando um jogador para de falar no chat de voz. |
| onPlayerVoiceStart | Servidor | Disparado quando um jogador começa a falar no chat de voz. Cancelar o evento faz ninguém ouvir essa fala. |
| onPlayerVoiceStop | Servidor | Disparado quando um jogador para de falar no chat de voz. |
Servidor
| Nome | Lado | Descrição |
|---|---|---|
| getDevelopmentMode | Cliente | Diz se o modo de desenvolvimento está ligado neste cliente. |
| getServerIP | Servidor | Devolve o endereço IPv4 público da máquina, lido das interfaces de rede ao iniciar. |
| getServerName | Servidor | Devolve o nome do servidor, da convar server_name. |
| getServerPassword | Servidor | Devolve a senha que um jogador precisa dar para entrar. |
| setDevelopmentMode | Cliente | Liga 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. |
| setServerPassword | Servidor | Muda a senha para entrar no servidor. Quem já está dentro continua. |
| shutdown | Servidor | Desliga o servidor. Antes, dispara onShutdown. |
| onShutdown | Servidor | Disparado quando um script chama shutdown, logo antes de o servidor desligar. |
Banco de dados
| Nome | Lado | Descrição |
|---|---|---|
| dbConnect | Servidor | Abre uma conexão com um banco SQLite ou MySQL. As consultas rodam numa thread própria da conexão. |
| dbExec | Servidor | Executa um comando SQL sem esperar resposta. |
| dbFree | Servidor | Descarta uma consulta de dbQuery cuja resposta não vai ser lida. |
| dbPoll | Servidor | Lê a resposta de uma consulta de dbQuery, esperando por ela se preciso. |
| dbPrepareString | Servidor | Preenche os marcadores de um SQL com valores escapados, sem executá-lo. |
| dbQuery | Servidor | Envia uma consulta SQL cuja resposta é lida depois com dbPoll. |
Rede e HTTP
| Nome | Lado | Descrição |
|---|---|---|
| fetchRemote | Servidor | Faz uma requisição HTTP ou HTTPS e entrega a resposta a uma função quando ela chega. |
| getServerIp | Cliente | Devolve o endereço do servidor a que este cliente está conectado. |