Referencia de scripting
Catálogo completo de funciones y eventos Lua de MY Multiplayer (MYMP) por categoría, indicando el lado de ejecución (cliente, servidor o compartido).
Elementos
| Nombre | Lado | Descripción |
|---|---|---|
| addElementDataSubscriber | Servidor | Suscribe a un jugador a un dato de elemento definido con el modo de sincronización "subscribe". El jugador recibe el valor actual al momento y cada cambio posterior. |
| createElement | Compartido | Crea un elemento de un tipo inventado por el script, sin nada en el mundo. Queda bajo la raíz dinámica del recurso. |
| destroyElement | Compartido | Destruye un elemento y todos sus hijos. Antes de desaparecer, cada uno dispara onElementDestroy en el servidor u onClientElementDestroy en el cliente. |
| getAllElementData | Compartido | Lee todos los datos de un elemento de una vez. |
| getElementAlpha | Compartido | Lee la transparencia de un elemento, de 0 (invisible) a 255 (opaco). |
| getElementAngularVelocity | Compartido | Lee la velocidad de giro de un elemento en cada eje, por paso de la simulación. |
| getElementBoundingBox | Cliente | Lee la caja de colisión del modelo de un elemento, relativa al origen del modelo. |
| getElementByID | Compartido | Busca el primer elemento con un ID, a partir de un elemento y bajando por sus hijos. |
| getElementCastShadow | Cliente | Indica si un elemento proyecta sombra. |
| getElementChildren | Compartido | Lista los hijos directos de un elemento, opcionalmente solo los de un tipo. |
| getElementChildrenCount | Compartido | Cuenta los hijos directos de un elemento. |
| getElementData | Compartido | Lee un dato guardado en un elemento. |
| getElementDimension | Compartido | Lee la dimensión de un elemento, de 0 a 65535. |
| getElementDistanceFromCentreOfMassToBaseOfModel | Cliente | Lee la distancia entre el centro de masa de un elemento y la base de su modelo. |
| getElementHealth | Compartido | Lee la vida de un jugador, ped, vehículo u objeto. |
| getElementID | Compartido | Lee el ID de un elemento, el nombre que busca getElementByID. |
| getElementInterior | Compartido | Lee el interior en el que está un elemento. El interior 0 es el mundo exterior. |
| getElementMatrix | Compartido | Lee la matriz 4x4 de un elemento, hecha con su posición y rotación. |
| getElementModel | Compartido | Lee el nombre del modelo de un elemento. |
| getElementParent | Compartido | Lee el padre de un elemento en el árbol de elementos. |
| getElementPosition | Compartido | Lee la posición de un elemento en el mundo. |
| getElementRadius | Cliente | Lee el radio de la esfera de colisión del modelo de un elemento. |
| getElementRotation | Compartido | Lee la rotación de un elemento en grados. |
| getElementsByType | Cliente | Lista todos los elementos de un tipo debajo de un elemento del árbol en este cliente. |
| getElementsByType | Servidor | Lista todos los elementos de un tipo debajo de un elemento del árbol en el servidor. |
| getElementsInRange | Compartido | Lista los elementos cuya posición está dentro de una esfera. |
| getElementSyncer | Servidor | Indica qué jugador sincroniza un elemento, es decir, qué cliente lo simula y envía su estado al servidor. |
| getElementType | Compartido | Lee el tipo de un elemento, como "player", "vehicle" o el tipo dado en createElement. |
| getElementVelocity | Compartido | Devuelve la velocidad de un elemento. |
| getRootElement | Compartido | Devuelve el elemento raíz, la cima del árbol de elementos. Es el mismo valor que la variable global root. |
| hasElementDataSubscriber | Servidor | Indica si un jugador está suscrito a un dato de elemento. |
| isElement | Compartido | Indica si un valor es un elemento que todavía existe. |
| isElementFrozen | Compartido | Indica si un elemento está congelado. |
| isElementInWater | Cliente | Indica si un ped, jugador o vehículo está en el agua. |
| isElementLocal | Cliente | Indica si un elemento fue creado por este cliente y no por el servidor. |
| isElementOnFire | Compartido | Indica si un elemento está en llamas. |
| isElementOnScreen | Cliente | Indica si un elemento aparece en pantalla. |
| isElementStreamable | Cliente | Indica si un elemento entra y sale del streaming según la distancia. |
| isElementStreamedIn | Cliente | Indica si un elemento está cargado en el mundo de este cliente. |
| isElementSyncer | Cliente | Indica si este cliente sincroniza un ped o vehículo para el servidor. |
| removeElementData | Compartido | Borra un dato guardado en un elemento. |
| removeElementDataSubscriber | Servidor | Quita la suscripción de un jugador a un dato de elemento. Deja de recibir los cambios de ese dato. |
| setElementAlpha | Compartido | Define la transparencia de un elemento y de todos sus hijos. |
| setElementAngularVelocity | Compartido | Define la velocidad de giro de un elemento. |
| setElementCastShadow | Cliente | Activa o desactiva la sombra que proyecta un elemento. |
| setElementData | Cliente | Guarda un dato en un elemento, solo en este cliente. |
| setElementData | Servidor | Guarda un dato en un elemento y, según sync, lo envía a los jugadores. |
| setElementDimension | Compartido | Cambia la dimensión de un elemento y de todos sus hijos. |
| setElementFrozen | Compartido | Congela o descongela un elemento y todos sus hijos. |
| setElementHealth | Compartido | Define la vida de un ped, jugador, vehículo u objeto. |
| setElementID | Compartido | Da un id (nombre) a un elemento, para encontrarlo después con getElementByID. |
| setElementInterior | Compartido | Cambia el interior de un elemento. |
| setElementMatrix | Compartido | Coloca y gira un elemento a partir de una matriz. |
| setElementModel | Servidor | Cambia el modelo de un ped o jugador, y de sus hijos. |
| setElementOnFire | Cliente | Prende fuego o apaga un elemento en este cliente. |
| setElementOnFire | Servidor | Prende fuego o apaga un elemento y sus hijos, para todos los jugadores. |
| setElementParent | Compartido | Hace de un elemento el hijo de otro en el árbol de elementos. |
| setElementPosition | Compartido | Mueve un elemento a una posición del mundo. |
| setElementRotation | Compartido | Define la rotación 3D de un elemento en grados. |
| setElementStreamable | Cliente | Elige si un elemento entra y sale del streaming según la distancia o queda siempre cargado. |
| setElementSyncer | Servidor | Elige qué jugador sincroniza un ped o vehículo. |
| setElementVelocity | Compartido | Define la velocidad de un elemento. |
| onClientElementDataChange | Cliente | Se dispara cuando un dato de un elemento cambia o se elimina. Cancelar el evento no deshace el cambio: el dato de este cliente se queda con el nuevo valor. |
| onClientElementDestroy | Cliente | Se dispara cuando un elemento va a ser destruido, mientras todavía existe. |
| onClientElementDimensionChange | Cliente | Se dispara después de que un elemento cambia de dimensión. No se dispara si la dimensión sigue igual. |
| onClientElementInteriorChange | Cliente | Se dispara después de que un elemento cambia de interior. No se dispara si el interior sigue igual. |
| onClientElementStreamIn | Cliente | Se dispara cuando un elemento entra en el streaming de este cliente y pasa a existir en el mundo del juego. |
| onClientElementStreamOut | Cliente | Se dispara cuando un elemento sale del streaming de este cliente y deja el mundo del juego. El elemento sigue existiendo. |
| onElementDataChange | Servidor | Se dispara cuando un dato de un elemento cambia o se elimina. Cancelar el evento devuelve el valor anterior (o borra la clave si no existía) y el cambio no se envía a los jugadores. |
| onElementDestroy | Servidor | Se dispara cuando un elemento va a ser destruido, mientras todavía existe. |
| onElementDimensionChange | Servidor | Se dispara después de que un elemento cambia de dimensión. No se dispara si la dimensión sigue igual. |
| onElementInteriorChange | Servidor | Se dispara después de que un elemento cambia de interior. No se dispara si el interior sigue igual. |
| onElementModelChange | Servidor | Se dispara después de que setElementModel cambia el modelo de un elemento. Cancelar el evento devuelve el modelo anterior, y setElementModel devuelve false. |
| onElementStartSync | Servidor | Se dispara cuando un jugador empieza a sincronizar un ped o vehículo. |
| onElementStopSync | Servidor | Se dispara cuando un jugador deja de sincronizar un ped o vehículo. |
Adjuntos
| Nombre | Lado | Descripción |
|---|---|---|
| attachElements | Compartido | Cuelga un elemento de otro. A partir de ahí sigue al objetivo hasta que se suelte. |
| detachElements | Compartido | Suelta un elemento del elemento del que cuelga. Se queda donde está. |
| getAttachedElements | Compartido | Lista los elementos adjuntos directamente a un elemento. |
| getElementAttachedOffsets | Compartido | Lee el desplazamiento, la rotación y el socket con que un elemento está adjunto. |
| getElementAttachedTo | Compartido | Dice de qué elemento cuelga un elemento. |
| isElementAttached | Compartido | Dice si un elemento está adjunto a otro. |
| setElementAttachedOffsets | Compartido | Cambia el desplazamiento, la rotación y, si se pide, el socket de un elemento adjunto. |
| onClientElementAttach | Cliente | Se dispara cuando un script del cliente llama a attachElements, antes de adjuntar el elemento. Cancelar el evento impide el adjunto y hace que attachElements devuelva false. |
| onClientElementDetach | Cliente | Se dispara antes de soltar un elemento desde un script del cliente, por detachElements o por attachElements llevándolo a otro objetivo. Cancelar el evento mantiene el elemento adjunto. |
| onElementAttach | Servidor | Se dispara cuando el servidor llama a attachElements, antes de adjuntar el elemento. Cancelar el evento impide el adjunto y hace que attachElements devuelva false. |
| onElementDetach | Servidor | Se dispara antes de soltar un elemento en el servidor, por detachElements o por attachElements llevándolo a otro objetivo. Cancelar el evento mantiene el elemento adjunto. |
Componentes y huesos
| Nombre | Lado | Descripción |
|---|---|---|
| getElementBoneMatrix | Cliente | Devuelve la matriz en el mundo de un hueso de un ped u objeto. |
| getElementBonePosition | Cliente | Devuelve la posición en el mundo de un hueso de un ped u objeto. |
| getElementBoneQuaternion | Cliente | Devuelve la orientación de un hueso de un ped u objeto respecto a su hueso padre, como cuaternión. |
| getElementBoneRotation | Cliente | Devuelve la rotación de un hueso de un ped u objeto respecto a su hueso padre, en grados. |
| getElementBoneScale | Cliente | Devuelve la escala de un hueso de un ped u objeto. |
| getElementComponentPosition | Cliente | Devuelve la posición de un componente de un vehículo u objeto. |
| getElementComponentRotation | Cliente | Devuelve la rotación de un componente de un vehículo u objeto, en grados. |
| getElementComponents | Cliente | Lista los componentes de un vehículo u objeto: los frames con nombre de su modelo. |
| getElementComponentVisible | Cliente | Indica si un componente de un vehículo u objeto está visible. |
| getPedBonePosition | Cliente | Devuelve la posición en el mundo de un hueso de un ped. |
| resetElementComponentPosition | Cliente | Devuelve un componente de un vehículo u objeto a la posición original del modelo, deshaciendo setElementComponentPosition. |
| resetElementComponentRotation | Cliente | Devuelve un componente de un vehículo u objeto a la rotación original del modelo, deshaciendo setElementComponentRotation. |
| setElementBoneMatrix | Cliente | Define la matriz en el mundo de un hueso de un ped u objeto: posición, orientación y escala a la vez. El cambio solo vale en este cliente. |
| setElementBonePosition | Cliente | Mueve un hueso de un ped u objeto a una posición en el mundo, conservando su orientación. El cambio solo vale en este cliente. |
| setElementBoneQuaternion | Cliente | Define la orientación de un hueso de un ped u objeto respecto a su hueso padre, como cuaternión. El cambio solo vale en este cliente. |
| setElementBoneRotation | Cliente | Gira un hueso de un ped u objeto respecto a su hueso padre. El cambio solo vale en este cliente. |
| setElementBoneScale | Cliente | Cambia la escala de un hueso de un ped u objeto. El cambio solo vale en este cliente. |
| setElementComponentPosition | Cliente | Mueve un componente de un vehículo u objeto. El cambio solo vale en este cliente. |
| setElementComponentRotation | Cliente | Gira un componente de un vehículo u objeto. El cambio solo vale en este cliente. |
| setElementComponentVisible | Cliente | Muestra u oculta un componente de un vehículo u objeto. El cambio solo vale en este cliente. |
Eventos
| Nombre | Lado | Descripción |
|---|---|---|
| addEvent | Compartido | Registra un evento nuevo con este nombre. Solo entonces se le pueden añadir handlers y dispararlo. |
| addEventHandler | Compartido | Hace que una función se llame cada vez que el evento ocurre en el elemento indicado o, con propagate, en cualquiera de sus descendientes. |
| cancelEvent | Compartido | Marca el evento en curso como cancelado. Lo que impide la cancelación depende del evento. |
| cancelLatentEvent | Cliente | Detiene el envío de un evento latente de este cliente al servidor. El servidor descarta lo que ya había recibido y el evento no se dispara. |
| cancelLatentEvent | Servidor | Detiene el envío de un evento latente del servidor a un jugador. El cliente descarta lo que ya había recibido y el evento no se dispara allí. |
| getCancelReason | Compartido | Da el motivo pasado a cancelEvent en el último evento que terminó de ejecutarse en este lado. |
| getEventHandlers | Compartido | Lista las funciones que este recurso puso en un evento de un elemento con addEventHandler. |
| getLatentEventHandles | Cliente | Lista los eventos latentes que este cliente aún está enviando al servidor. |
| getLatentEventHandles | Servidor | Lista los eventos latentes que el servidor aún está enviando a un jugador. |
| getLatentEventStatus | Cliente | Indica cómo va el envío de un evento latente de este cliente al servidor. |
| getLatentEventStatus | Servidor | Indica cómo va el envío de un evento latente del servidor a un jugador. |
| removeEventHandler | Compartido | Quita una función de un evento de un elemento, donde la puso addEventHandler. |
| triggerClientEvent | Servidor | Envía un evento a los clientes de los jugadores, que lo disparan en source. La función vuelve antes de que los clientes lo reciban. |
| triggerEvent | Compartido | Dispara un evento en este lado, en source. Los handlers del propio elemento y los de sus ancestros que propagan se llaman en el acto, antes de que la función vuelva. |
| triggerLatentClientEvent | Servidor | Envía un evento a los clientes de los jugadores poco a poco, en segundo plano, a no más de bandwidth bytes por segundo por jugador. Sirve para datos grandes que no deben frenar el resto del tráfico. |
| triggerLatentServerEvent | Cliente | Envía un evento al servidor poco a poco, en segundo plano, a no más de bandwidth bytes por segundo. Sirve para datos grandes que no deben frenar el resto del tráfico. |
| triggerServerEvent | Cliente | Envía un evento al servidor, que lo dispara allí en source. La función vuelve antes de que el servidor lo reciba. |
| wasEventCancelled | Compartido | Indica si el último evento que terminó de ejecutarse en este lado fue cancelado. |
| onPlayerTriggerEventThreshold | Servidor | Se dispara cuando un jugador llama a triggerServerEvent o triggerLatentServerEvent demasiadas veces en un intervalo. El servidor no hace nada más: qué hacer queda en manos de los scripts. |
Teclado
| Nombre | Lado | Descripción |
|---|---|---|
| addCommandHandler | Compartido | Registra una función que se ejecuta cuando se escribe el comando en la consola. Los argumentos llegan como textos separados por espacios. |
| bindKey | Compartido | Asocia una tecla a una función o a un comando. La función se ejecuta cuando la tecla se pulsa, se suelta o ambas. |
| executeCommandHandler | Cliente | Ejecuta los handlers que los scripts del cliente registraron para un comando, como si se hubiera escrito. |
| executeCommandHandler | Servidor | Ejecuta los handlers que los scripts del servidor registraron para un comando, como si el jugador lo hubiera escrito. |
| getBoundKeys | Cliente | Lista las teclas asociadas a un comando en este cliente. |
| getCommandsBoundToKey | Cliente | Lista los comandos asociados a una tecla en este cliente. |
| getCursorPosition | Cliente | Lee dónde está el cursor en la pantalla y el punto del mundo al que apunta. |
| getFunctionsBoundToKey | Compartido | Lista las funciones que este recurso asoció a una tecla. |
| getKeyBoundToCommand | Cliente | Dice qué tecla ejecuta un comando en este cliente. |
| getKeyBoundToFunction | Compartido | Dice a qué tecla asoció este recurso una función. |
| getKeyState | Cliente | Dice si una tecla está pulsada ahora mismo. |
| isCursorShowing | Cliente | Dice si el cursor del ratón se está mostrando. |
| isKeyBound | Compartido | Dice si este recurso asoció una función a una tecla. |
| removeCommandHandler | Compartido | Quita el handler que este recurso registró para un comando. |
| setCursorAlpha | Cliente | Cambia la opacidad del cursor del ratón. |
| setCursorPosition | Cliente | Mueve el cursor a un punto de la pantalla. |
| showCursor | Cliente | Muestra u oculta el cursor del ratón para este recurso. |
| unbindKey | Compartido | Quita binds que este recurso creó en una tecla. |
| onClientClick | Cliente | Se dispara cuando se pulsa o se suelta un botón del ratón con el cursor visible. |
| onClientCursorMove | Cliente | Se dispara cuando se mueve el ratón. |
| onClientDoubleClick | Cliente | Se dispara cuando se pulsa dos veces seguidas un botón del ratón con el cursor visible. |
| onClientKey | Cliente | Se dispara cuando se pulsa o se suelta una tecla o un botón del ratón. Cancelar el evento impide los binds de esa tecla y, al pulsar, oculta la tecla al juego mientras se mantiene. |
| onPlayerCommand | Servidor | Se dispara cuando un jugador envía un comando al servidor, antes de que se ejecute. Cancelar el evento impide el comando. |
Recursos y módulos
| Nombre | Lado | Descripción |
|---|---|---|
| call | Compartido | Llama a una función que otro recurso exporta en su meta.xml y devuelve lo que ella devuelva. |
| deleteResource | Servidor | Saca un recurso detenido de la lista de recursos y mueve su carpeta o su archivo a la carpeta trash de la caché de recursos del servidor. |
| getResourceDynamicElementRoot | Compartido | Devuelve el elemento bajo el que quedan los elementos que el recurso crea por script. Es hijo del elemento del recurso y se llama dynamic. |
| getResourceExportedFunctions | Compartido | Lista los nombres de las funciones que un recurso exporta en su meta.xml, de cualquier lado. |
| getResourceFiles | Compartido | Lista los archivos que un recurso declara con <file> en su meta.xml, con los patrones ya expandidos, en orden alfabético. |
| getResourceFromName | Compartido | Busca un recurso por su nombre. |
| getResourceInfo | Servidor | Lee un atributo de la etiqueta <info> del meta.xml de un recurso, como author o version. |
| getResourceName | Compartido | Devuelve el nombre de un recurso. |
| getResourceRootElement | Compartido | Devuelve el elemento raíz de un recurso, el mismo que la variable global resourceRoot de ese recurso. |
| getResources | Compartido | Lista los recursos en ejecución en este lado. |
| getResourceState | Compartido | Indica en qué estado está un recurso. |
| getThisResource | Compartido | Devuelve el recurso en el que se está ejecutando el script. |
| import | Compartido | Ejecuta un módulo de un recurso en el estado Lua de este script, una vez por estado, y da lo que devolvió. Las globales que definió el módulo pasan a ser de este script. |
| refreshResources | Compartido | Vuelve a leer la carpeta de recursos: agrega los recursos nuevos, quita los que desaparecieron (deteniendo los que estaban en ejecución) y avisa en el log qué recursos en ejecución cambiaron en el disco. |
| restartResource | Compartido | Pide detener y volver a iniciar un recurso en ejecución. Ocurre en el siguiente ciclo de los recursos, no durante la llamada, y el recurso conserva su lugar en el orden de inicio. |
| startResource | Compartido | Inicia un recurso en el momento, después de iniciar los recursos que incluye con <include> en su meta.xml. |
| stopResource | Compartido | Pide detener un recurso en ejecución. Se detiene en el siguiente ciclo de los recursos, no durante la llamada. |
| onClientResourceStart | Cliente | Se dispara cuando un recurso termina de arrancar, después de ejecutar sus scripts. |
| onClientResourceStop | Cliente | Se dispara cuando un recurso va a detenerse, mientras sus scripts y elementos todavía existen. |
| onResourcePreStart | Servidor | Se dispara cuando un recurso está arrancando, antes de ejecutar sus scripts. Cancelar el evento impide que el recurso arranque. |
| onResourceStart | Servidor | Se dispara cuando un recurso termina de arrancar, después de ejecutar sus scripts y mapas. |
| onResourceStop | Servidor | Se dispara cuando un recurso va a detenerse, mientras sus scripts y elementos todavía existen. |
Temporizadores y asíncrono
| Nombre | Lado | Descripción |
|---|---|---|
| async.all | Compartido | Ejecuta cada función de la lista en su propio hilo, todas a la vez, y hace que el hilo actual espere hasta que todas terminen. |
| async.cancel | Compartido | Detiene un hilo async de este recurso. Un hilo en pausa termina en el acto; llamada desde el propio hilo, se detiene ahí mismo. |
| async.map | Compartido | Llama a handler(valor, clave) para cada entrada de la tabla, en el orden de pairs, y junta en una lista los resultados que no son nil. El handler puede pausar con async.wait. |
| async.mutex | Compartido | Ejecuta una función en un hilo async nuevo, como async.thread, pero no empieza mientras otro hilo iniciado desde la misma línea del código, con la misma key, siga en marcha. |
| async.promise | Compartido | Ejecuta handler(resolve, reject) en un hilo nuevo y hace que el hilo actual espere hasta que llame a resolve o reject. Sirve para esperar una función que responde por callback. |
| async.status | Compartido | Indica en qué estado está un hilo async de este recurso. |
| async.thread | Compartido | Ejecuta una función en un hilo async nuevo, en el acto. La llamada vuelve cuando la función termina o hace su primera pausa, como con async.wait. |
| async.wait | Compartido | Pausa el hilo async actual durante ms milisegundos. El resto del juego sigue en marcha. |
| async.yield | Compartido | Pausa el hilo async actual hasta la próxima actualización de los scripts, para dividir un trabajo largo en partes. |
| getTimerDetails | Compartido | Lee el estado de un timer: cuánto falta, cuántas repeticiones quedan y su intervalo. |
| getTimers | Compartido | Lista los timers activos del recurso que llama. |
| isTimer | Compartido | Indica si un timer todavía existe en este recurso. |
| killTimer | Compartido | Cancela un timer antes de que termine. |
| resetTimer | Compartido | Vuelve a empezar la cuenta de un timer desde cero, con el mismo intervalo. Las repeticiones que faltan no cambian. |
| setTimer | Compartido | Llama a una función después de un intervalo, una vez o repetidamente. |
| setTimerPaused | Compartido | Pausa o reanuda un timer. En pausa conserva el tiempo que le faltaba y no se llama. |
Convars
| Nombre | Lado | Descripción |
|---|---|---|
| getConvar | Compartido | Lee una convar como texto. En el cliente, una convar que sincroniza el servidor va antes que la del propio cliente. |
| getConvarInt | Compartido | Lee una convar como número entero. |
| setConvar | Cliente | Define una convar solo en este cliente. Nunca se envía al servidor. Con persist, el valor se guarda para este servidor y vuelve en la próxima sesión. |
| setConvar | Servidor | Define una convar en el servidor y la crea si no existe. Con synced, el valor llega a todos los clientes, incluso a los que entren después, y su getConvar pasa a leerlo. |
Archivos
| Nombre | Lado | Descripción |
|---|---|---|
| fileClose | Compartido | Cierra un archivo, escribiendo lo que falta, y destruye su elemento. |
| fileCopy | Compartido | Copia un archivo, que puede ser de otro recurso, al recurso que llama. Las carpetas que faltan en el destino se crean. |
| fileCreate | Compartido | Crea un archivo vacío y lo abre para leer y escribir. Un archivo que ya existe se borra y se crea de nuevo; las carpetas que faltan se crean. |
| fileDelete | Compartido | Borra un archivo del recurso que llama. |
| fileExists | Compartido | Indica si una ruta es un archivo. Hace lo mismo que pathIsFile. |
| fileFlush | Compartido | Graba en el disco lo que se escribió en el archivo y sigue en memoria. |
| fileGetContents | Compartido | Lee un archivo entero de una vez, sin abrirlo. |
| fileGetPath | Compartido | Devuelve la ruta de un archivo abierto. |
| fileGetPos | Compartido | Devuelve la posición actual de lectura y escritura de un archivo. |
| fileGetSize | Compartido | Devuelve el tamaño de un archivo abierto. |
| fileIsEOF | Compartido | Indica si la posición de un archivo llegó al final. |
| fileOpen | Compartido | Abre un archivo que ya existe, con la posición al principio. |
| fileRead | Compartido | Lee bytes de un archivo desde la posición actual y avanza la posición. |
| fileRename | Compartido | Renombra o mueve un archivo dentro del recurso que llama. Las carpetas que faltan en el destino se crean. |
| fileSetPos | Compartido | Cambia la posición de lectura y escritura de un archivo. |
| fileWrite | Compartido | Escribe uno o más textos en un archivo, en la posición actual. |
| pathIsDirectory | Compartido | Indica si una ruta es una carpeta. |
| pathIsFile | Compartido | Indica si una ruta es un archivo. Hace lo mismo que fileExists. |
| pathListDir | Compartido | Lista lo que hay en una carpeta. |
Datos y utilidades
| Nombre | Lado | Descripción |
|---|---|---|
| decodeString | Compartido | Decodifica o descifra un texto producido por encodeString. |
| encodeString | Compartido | Codifica o cifra un texto con un algoritmo: TEA, AES-128, RSA, Base64, Base32 o zlib. |
| fromJSON | Compartido | Convierte texto JSON en un valor de Lua. Es la misma función que json.decode. |
| getDistanceBetweenPoints2D | Compartido | Mide la distancia entre dos puntos en el plano horizontal, sin contar la altura. |
| getDistanceBetweenPoints3D | Compartido | Mide la distancia en línea recta entre dos puntos en el espacio. |
| getEasingValue | Compartido | Calcula el valor de una curva de easing en un punto del progreso. |
| getRealTime | Compartido | Devuelve la fecha y la hora reales del ordenador, en la zona horaria local. |
| getTickCount | Compartido | Devuelve cuántos milisegundos pasaron desde que los scripts empezaron a correr en este lado. |
| getVersion | Compartido | Devuelve información sobre la versión del juego y de Lua. |
| hash | Compartido | Calcula el hash de un texto: MD5, SHA-1, SHA-2 o un HMAC. |
| interpolateBetween | Compartido | Interpola entre dos grupos de tres números siguiendo una curva de easing. |
| isnan | Compartido | Indica si un valor es el número especial NaN (no es un número). |
| json.decode | Compartido | Convierte texto JSON en un valor de Lua. Es la misma función que fromJSON. |
| json.encode | Compartido | Convierte un valor de Lua en texto JSON. Es la misma función que toJSON. |
| rgb | Compartido | Junta los componentes de un color en un único número ARGB. Es la misma función que tocolor. |
| rgba | Compartido | Junta los componentes de un color en un único número ARGB, con la opacidad de 0 a 1. |
| split | Compartido | Divide un texto en trozos en los separadores. |
| tocolor | Compartido | Junta los componentes de un color en un único número ARGB. Es la misma función que rgb. |
| toJSON | Compartido | Convierte un valor de Lua en texto JSON. Es la misma función que json.encode. |
Salida y depuración
| Nombre | Lado | Descripción |
|---|---|---|
| createTrayNotification | Cliente | Muestra una notificación del sistema en la bandeja de Windows, mientras el juego no tiene el foco. |
| outputDebugString | Compartido | Escribe una línea en el log de scripts de este lado, como error, aviso o mensaje. |
| outputServerLog | Compartido | Escribe un mensaje en el log de este lado, con el nombre del recurso delante. |
| Compartido | Escribe los valores dados en el log de scripts como un mensaje, separados por tabulaciones. | |
| setClipboard | Cliente | Copia un texto al portapapeles del ordenador del jugador. |
| onClientDebugMessage | Cliente | Se dispara en este cliente por cada línea de script que va al log: errores, avisos y mensajes. |
| onDebugMessage | Servidor | Se dispara en el servidor por cada línea de script que va al log: errores, avisos y mensajes. |
Jugadores y cuentas
| Nombre | Lado | Descripción |
|---|---|---|
| getMaxPlayers | Servidor | Devuelve cuántos jugadores acepta el servidor a la vez. |
| getPlayerAccount | Servidor | Devuelve la cuenta MYMP con la que entró el jugador. |
| getPlayerCount | Servidor | Devuelve cuántos jugadores hay en el servidor. |
| getPlayerFromName | Servidor | Busca un jugador por su nombre exacto, distinguiendo mayúsculas y minúsculas. |
| getPlayerIdentifier | Servidor | Devuelve un identificador del jugador de un tipo, como steam o discord. |
| getPlayerIdentifiers | Servidor | Lista todos los identificadores del jugador, cada uno como tipo:valor, por ejemplo steam:110000112345678 y discord:80351110224678912. |
| getPlayerIP | Servidor | Devuelve la dirección IP desde la que está conectado el jugador, sin el puerto. |
| getPlayerName | Servidor | Devuelve el nombre del jugador. En un servidor con server_key, es el nombre de la cuenta MYMP con el formato Nombre#Tag. |
| getPlayerPing | Cliente | Devuelve el ping de un jugador. Para el jugador local, es el ping de este cliente con el servidor; para los demás, lo que el servidor informó de ellos. |
| getPlayerPing | Servidor | Devuelve el ping del jugador con el servidor, medido por la conexión. |
| getPlayers | Servidor | Lista todos los jugadores del servidor. |
| getQueuePriority | Servidor | Lee la prioridad de una cuenta en la cola del servidor lleno. |
| getRandomPlayer | Servidor | Elige un jugador del servidor al azar. |
| isPlayerSpawned | Servidor | Indica si el jugador ya fue colocado en el mundo por spawnPlayer. |
| kickPlayer | Servidor | Desconecta a un jugador del servidor con un motivo. |
| playSoundFrontEnd | Servidor | Reproduce un sonido de interfaz del juego para un jugador, o para todos los jugadores dentro de un elemento, como root. |
| setMaxPlayers | Servidor | Cambia cuántos jugadores acepta el servidor a la vez. |
| setQueuePriority | Servidor | Define la prioridad de una cuenta en la cola del servidor lleno. Una prioridad mayor pasa primero. |
| spawnPlayer | Servidor | Coloca al jugador en el mundo, con la vida en 100, sin chaleco, en el interior 0 y sin armas. |
| onPlayerConnect | Servidor | Se dispara cuando una conexión va a ser aceptada, antes de que exista el jugador. Cancelar el evento la rechaza. |
| onPlayerJoin | Servidor | Se dispara cuando un jugador terminó de entrar y ya recibió el estado inicial del servidor. |
| onPlayerQueue | Servidor | Se dispara cuando una cuenta va a entrar en la cola de un servidor lleno. Cancelar el evento la rechaza. |
| onPlayerQuit | Servidor | Se dispara cuando un jugador sale del servidor, antes de que su elemento sea destruido. |
| onPlayerSpawn | Servidor | Se dispara después de que spawnPlayer hace aparecer a un jugador. |
Peds
| Nombre | Lado | Descripción |
|---|---|---|
| canPedBeKnockedOffBike | Cliente | Indica si un ped puede caerse de la moto o bicicleta al chocar. |
| createPed | Cliente | Crea un ped que solo existe en este cliente. |
| createPed | Servidor | Crea un ped en el servidor, visible para todos los jugadores. |
| getPedArmour | Servidor | Obtiene el chaleco de un ped o jugador. |
| getPedBikeControl | Cliente | Obtiene la habilidad de un ped para conducir motos y bicicletas. |
| getPedCyclePower | Cliente | Obtiene la fuerza con que un ped pedalea una bicicleta. |
| getPedJumpPower | Cliente | Obtiene la fuerza del salto de un ped. |
| getPedMeleeStrength | Cliente | Obtiene la fuerza de los golpes cuerpo a cuerpo de un ped. |
| getPedMoveState | Cliente | Indica cómo se mueve un ped a pie. |
| getPedOccupiedVehicle | Compartido | Obtiene el vehículo en el que está un ped o jugador. |
| getPedOccupiedVehicleSeat | Compartido | Obtiene el asiento que ocupa un ped o jugador en su vehículo. |
| getPedSimplestTask | Cliente | Obtiene la tarea más simple que el ped está ejecutando ahora. |
| getPedStrafePower | Cliente | Obtiene cómo acelera un ped al moverse de lado mientras pelea o apunta un arma. |
| getPedTask | Cliente | Obtiene la tarea que un ped ejecuta en un slot y todas sus subtareas. |
| getPedWeapon | Servidor | Obtiene el arma que sostiene un ped o jugador. |
| giveWeapon | Servidor | Da un arma con munición a un ped o jugador. |
| isPedDead | Servidor | Indica si un ped o jugador está muerto. |
| isPedDoingTask | Cliente | Indica si un ped está ejecutando una tarea, en cualquier slot y en cualquier nivel de subtarea. |
| isPedDucked | Compartido | Indica si un ped o jugador está agachado. |
| isPedInVehicle | Compartido | Indica si un ped o jugador está en un vehículo. |
| isPedInWater | Compartido | Indica si un ped o jugador está en el agua. |
| isPedOnGround | Compartido | Indica si un ped o jugador está en el suelo. |
| isPedUsingDoubleWeapons | Cliente | Indica si el ped sostiene una copia del arma también en la mano izquierda. |
| killPedTask | Cliente | Quita la tarea que un ped ejecuta en un slot. |
| removePedFromVehicle | Compartido | Saca a un ped o jugador de su vehículo en el acto, sin animación. |
| setPedArmour | Servidor | Define el chaleco de un ped o jugador y lo envía a los clientes. |
| setPedBikeControl | Cliente | Define la habilidad de un ped para conducir motos y bicicletas. |
| setPedCanBeKnockedOffBike | Cliente | Define si un ped puede caerse de la moto o bicicleta al chocar. |
| setPedCyclePower | Cliente | Define la fuerza con que un ped pedalea una bicicleta. |
| setPedDoubleWeapons | Cliente | Define si el ped sostiene una copia del arma también en la mano izquierda. |
| setPedEnterVehicle | Cliente | Hace que un ped camine hasta un vehículo y suba, como si el jugador pulsara la tecla de entrar. |
| setPedExitVehicle | Cliente | Hace que un ped baje de su vehículo por la puerta, con la animación de salida. |
| setPedJumpPower | Cliente | Define la fuerza del salto de un ped. |
| setPedMeleeStrength | Cliente | Define la fuerza de los golpes cuerpo a cuerpo de un ped. |
| setPedStrafePower | Cliente | Define cómo acelera un ped al moverse de lado mientras pelea o apunta un arma. |
| warpPedIntoVehicle | Compartido | Pone a un ped o jugador directamente en un asiento de un vehículo, sin animación. |
| onClientPedStep | Cliente | Se dispara en cada paso de un ped o jugador, cuando el pie toca el suelo. |
| onClientPedsProcessed | Cliente | Se dispara en cada fotograma después de animar los peds y objetos, antes de presentarlos y dibujarlos. |
Controles
| Nombre | Lado | Descripción |
|---|---|---|
| getControlState | Cliente | Indica si un control de un ped está pulsado, como forwards, fire o accelerate. |
| getControlState | Servidor | Indica si un jugador está pulsando un control, según las teclas que su cliente envió por última vez. |
| getPedAnalogControlState | Cliente | Indica cuánto está pulsado un control de un ped, de 0 a 1. Sirve para los controles analógicos, como caminar, girar y acelerar. |
| getPedCameraRotation | Cliente | Indica hacia dónde mira la cámara de un ped, en grados. En el jugador local es la cámara del juego; en un jugador remoto, la que llegó por la red; en un ped, la que puso un script. |
| getPedContactElement | Cliente | Devuelve el vehículo u objeto sobre el que está parado un ped. |
| getPedControlState | Cliente | Indica si un control de un ped está pulsado, como forwards, fire o accelerate. |
| isControlEnabled | Cliente | Indica si un control del jugador local está activado. |
| isControlEnabled | Servidor | Indica si un control de un jugador está activado, según lo que el servidor envió a su cliente. |
| setControlState | Cliente | Pulsa o suelta un control de un ped como si fuera una tecla, por ejemplo para que camine, salte o dispare. |
| setControlState | Servidor | Pulsa o suelta un control de un jugador como si fuera una tecla. La orden va a su cliente, que la aplica como setControlState en el jugador local. |
| setPedAnalogControlState | Cliente | Pulsa solo en parte un control analógico de un ped, por ejemplo para que camine despacio o gire suave. |
| setPedCameraRotation | Cliente | Cambia hacia dónde mira la cámara de un ped. En el jugador local, gira la cámara del juego; en un ped, es la dirección en la que mira y apunta. |
| setPedControlState | Cliente | Pulsa o suelta un control de un ped como si fuera una tecla, por ejemplo para que camine, salte o dispare. |
| toggleAllControls | Cliente | Activa o desactiva de una vez todos los controles del jugador local. |
| toggleAllControls | Servidor | Activa o desactiva de una vez todos los controles de un jugador. La orden va a su cliente. |
| toggleControl | Cliente | Activa o desactiva un control del jugador local. Un control desactivado no llega al juego, aunque se mantenga pulsada su tecla. |
| toggleControl | Servidor | Activa o desactiva un control de un jugador. Su cliente deja de pasar ese control al juego, aunque se mantenga pulsada la tecla. |
Animaciones
| Nombre | Lado | Descripción |
|---|---|---|
| getPedAnimation | Cliente | Indica qué animación de setPedAnimation reproduce un ped en este cliente. |
| getPedAnimationLength | Cliente | Indica la duración de la animación que reproduce el ped, como la de setPedAnimation. |
| getPedAnimationProgress | Cliente | Indica en qué punto está la animación que reproduce el ped, como la de setPedAnimation. |
| getPedAnimationSpeed | Cliente | Indica la velocidad de la animación que reproduce el ped, como la de setPedAnimation. |
| setPedAnimation | Cliente | Hace que un ped reproduzca una animación de un bloque, o detiene la animación que está reproduciendo. La animación solo vale en este cliente. |
| setPedAnimationProgress | Cliente | Salta una animación que el ped reproduce a un punto de ella. Sin anim, detiene la animación de setPedAnimation. |
| setPedAnimationSpeed | Cliente | Cambia la velocidad de una animación que el ped reproduce. |
Apariencia
| Nombre | Lado | Descripción |
|---|---|---|
| addPedClothes | Compartido | Viste una prenda en un ped. La prenda ocupa su ranura y reemplaza la que estaba en ella. |
| getClothesVariantCount | Compartido | Cuenta cuántas texturas tiene una prenda para el modelo de un ped. |
| getPedBodyShape | Compartido | Dice cuánto de una forma de cuerpo tiene un ped. |
| getPedClothes | Compartido | Dice qué ropa lleva un ped, toda o la de una ranura. |
| getPedHairColor | Compartido | Dice el color del pelo de un ped y de los reflejos, si los hay. |
| getPedHeadBlend | Compartido | Dice cómo el rostro de un ped mezcla a sus dos padres. |
| getPedHeadShape | Compartido | Dice cuánto se ajustó un rasgo del rostro de un ped. |
| getPedOverlay | Compartido | Dice qué variante de una superposición lleva un ped en el rostro. |
| getPedOverlayColor | Compartido | Dice el color de una superposición que el ped lleva en el rostro. |
| removePedClothes | Compartido | Quita la prenda que un ped lleva en una ranura. |
| setPedBodyShape | Compartido | Cambia el cuerpo de un ped con una forma nombrada, que agranda los huesos que declara. |
| setPedHairColor | Compartido | Tiñe el pelo de un ped y, si se quiere, los reflejos. |
| setPedHeadBlend | Compartido | Arma el rostro de un ped mezclando la cabeza y la piel de dos padres. |
| setPedHeadShape | Compartido | Ajusta un rasgo del rostro de un ped, como la nariz o el mentón. |
| setPedOverlay | Compartido | Pone o quita una superposición en el rostro de un ped, como barba, cejas o maquillaje. |
| setPedOverlayColor | Compartido | Tiñe una superposición que el ped lleva en el rostro, con una fila de la paleta o con un color. |
Entorno del jugador
| Nombre | Lado | Descripción |
|---|---|---|
| getLocalization | Cliente | Devuelve el idioma en el que juega el jugador, el mismo elegido en el launcher. |
| isStreamerMode | Cliente | Indica si el modo streamer está activo. En él, la consola oculta toda dirección IPv4 que muestra. |
| onClientStreamerModeChange | Cliente | Se dispara cuando el modo streamer se activa o se desactiva. |
Vehículos
| Nombre | Lado | Descripción |
|---|---|---|
| addVehicleUpgrade | Compartido | Instala una mejora de tuning en un vehículo, reemplazando la que haya en el mismo slot. |
| createVehicle | Cliente | Crea un vehículo que solo existe en este cliente. |
| createVehicle | Servidor | Crea un vehículo en el servidor, visible para todos los jugadores. |
| fixVehicle | Compartido | Repara un vehículo por completo: su vida vuelve a 1000 y sus puertas, ruedas y luces a su estado inicial, sin abolladuras ni agujeros de bala. |
| getVehicleCompatibleUpgrades | Compartido | Devuelve las mejoras de tuning que sirven para el modelo de un vehículo. |
| getVehicleController | Compartido | Devuelve quién conduce un vehículo, es decir, el ocupante del asiento 0. |
| getVehicleDoorOpenRatio | Compartido | Devuelve cuánto están abiertas una o más puertas de un vehículo. |
| getVehicleDoorState | Compartido | Devuelve el estado de una o más puertas de un vehículo. |
| getVehicleEngineSound | Cliente | Devuelve los sonidos de motor y de inducción que setVehicleEngineSound puso en un vehículo. |
| getVehicleEngineSounds | Cliente | Lista los conjuntos de sonidos de motor que traen los paquetes montados. |
| getVehicleEngineState | Compartido | Devuelve si el motor de un vehículo está encendido. |
| getVehicleHeadLightColor | Compartido | Devuelve el color de los faros de un vehículo. |
| getVehicleHydraulics | Compartido | Indica si un vehículo tiene hidráulica instalada con setVehicleHydraulics. |
| getVehicleHydraulicsControl | Compartido | Devuelve cuánto mandó setVehicleHydraulicsControl levantar cada rueda de un vehículo. |
| getVehicleLightState | Compartido | Devuelve si una o más luces de un vehículo están rotas. |
| getVehicleMaxPassengers | Cliente | Indica cuántos pasajeros caben en un vehículo, sin contar al conductor. |
| getVehicleMaxPassengers | Servidor | Indica cuántos pasajeros caben en un vehículo, sin contar al conductor. |
| getVehicleOccupant | Compartido | Devuelve el ped o jugador sentado en un asiento de un vehículo. |
| getVehicleOccupants | Compartido | Devuelve todos los peds y jugadores dentro de un vehículo. |
| getVehicleOverrideLights | Compartido | Devuelve si las luces de un vehículo están forzadas encendidas o apagadas. |
| getVehicleSuspensionHeight | Compartido | Devuelve la altura de suspensión que setVehicleSuspensionHeight le dio a un vehículo. |
| getVehicleTowedByVehicle | Compartido | Devuelve el remolque o vehículo que este vehículo está remolcando. |
| getVehicleTowingVehicle | Compartido | Devuelve el vehículo que está remolcando a este vehículo. |
| getVehicleUpgradeOnSlot | Compartido | Devuelve la mejora instalada en un slot de un vehículo. |
| getVehicleUpgrades | Compartido | Devuelve todas las mejoras de tuning instaladas en un vehículo. |
| getVehicleUpgradeSlotName | Compartido | Devuelve el nombre de un slot de mejora, a partir del índice del slot o de una mejora que va en él. |
| getVehicleUpgradeSlots | Compartido | Devuelve los nombres de todos los slots de mejora que declaran los paquetes montados. |
| getVehicleWheelCamber | Compartido | Devuelve la caída de las ruedas de un vehículo. |
| getVehicleWheelFrictionState | Cliente | Indica cómo se agarran al suelo las ruedas de un vehículo. |
| getVehicleWheelOffset | Compartido | Devuelve el desplazamiento de las ruedas de un vehículo. |
| getVehicleWheelScale | Compartido | Devuelve el factor de radio de los neumáticos de un vehículo. |
| getVehicleWheelState | Compartido | Devuelve el estado de una o más ruedas de un vehículo. |
| getVehicleWheelStates | Compartido | Devuelve el estado de las cuatro ruedas de un vehículo. |
| getVehicleWheelWidth | Compartido | Devuelve el factor de ancho de los neumáticos de un vehículo. |
| isVehicleFullBeam | Compartido | Devuelve si las luces largas de un vehículo están encendidas. |
| isVehicleLocked | Compartido | Devuelve si las puertas de un vehículo están bloqueadas. |
| isVehicleOnGround | Compartido | Devuelve si un vehículo está apoyado en el suelo. |
| isVehicleWheelOnGround | Cliente | Indica si las ruedas de un vehículo están tocando algo. |
| removeVehicleUpgrade | Compartido | Quita una mejora de tuning de un vehículo. |
| setVehicleDoorOpenRatio | Compartido | Abre o cierra una o más puertas de un vehículo hasta una fracción, de golpe o poco a poco. |
| setVehicleDoorState | Compartido | Cambia el estado de una o más puertas de un vehículo: cerrada, abierta, dañada o arrancada. |
| setVehicleEngineSound | Cliente | Cambia el sonido del motor de un vehículo en este cliente por un conjunto de sonidos de los paquetes montados. |
| setVehicleEngineState | Compartido | Enciende o apaga el motor de un vehículo. |
| setVehicleFullBeam | Compartido | Enciende o apaga las luces largas de un vehículo. |
| setVehicleHeadLightColor | Compartido | Cambia el color de los faros de un vehículo. |
| setVehicleHydraulics | Compartido | Instala o quita la hidráulica de un vehículo. |
| setVehicleHydraulicsControl | Compartido | Levanta cada rueda de un vehículo con su hidráulica, sin nadie a los mandos. |
| setVehicleLightState | Compartido | Rompe o arregla una o más luces de un vehículo. |
| setVehicleLocked | Compartido | Bloquea o desbloquea las puertas de un vehículo. |
| setVehicleOverrideLights | Compartido | Fuerza las luces de un vehículo encendidas o apagadas, o devuelve la decisión al juego. |
| setVehicleSuspensionHeight | Compartido | Sube o baja la suspensión de un vehículo. |
| setVehicleWheelCamber | Compartido | Inclina las ruedas de un vehículo hacia dentro o hacia fuera (caída). |
| setVehicleWheelOffset | Compartido | Desplaza las ruedas de un vehículo de donde el modelo las pone. |
| setVehicleWheelScale | Compartido | Agranda o achica el radio de los neumáticos de un vehículo. |
| setVehicleWheelState | Compartido | Cambia el estado de una o más ruedas de un vehículo: inflada, pinchada, desprendida o sin colisión. |
| setVehicleWheelStates | Compartido | Cambia el estado de las cuatro ruedas de un vehículo de una vez. |
| setVehicleWheelWidth | Compartido | Ensancha o estrecha los neumáticos de un vehículo. |
| onClientPedVehicleEnter | Cliente | Se dispara en el cliente cuando un ped (que no es jugador) termina de subir a un vehículo. |
| onClientPedVehicleExit | Cliente | Se dispara en el cliente cuando un ped (que no es jugador) sale de un vehículo. |
| onClientPlayerVehicleEnter | Cliente | Se dispara en el cliente cuando un jugador termina de subir a un vehículo. |
| onClientPlayerVehicleExit | Cliente | Se dispara en el cliente cuando un jugador sale de un vehículo. |
| onClientTrailerAttach | Cliente | Se dispara en el cliente cuando un remolque se engancha a un vehículo. |
| onClientTrailerDetach | Cliente | Se dispara en el cliente cuando un remolque se suelta del vehículo que lo arrastraba. |
| onClientVehicleEnter | Cliente | Se dispara en el cliente cuando un ped termina de subir a un vehículo. |
| onClientVehicleExit | Cliente | Se dispara en el cliente cuando un ped sale de un vehículo. |
| onClientVehicleStartEnter | Cliente | Se dispara en el cliente cuando un ped empieza a subir a un vehículo. Cancelar el evento lo impide. |
| onClientVehicleStartExit | Cliente | Se dispara en el cliente cuando un ped empieza a bajar de un vehículo. Cancelar el evento lo impide. |
| onPedVehicleEnter | Servidor | Se dispara en el servidor cuando un ped (que no es jugador) termina de subir a un vehículo. |
| onPedVehicleExit | Servidor | Se dispara en el servidor cuando un ped (que no es jugador) sale de un vehículo. |
| onPlayerVehicleEnter | Servidor | Se dispara en el servidor cuando un jugador termina de subir a un vehículo. |
| onPlayerVehicleExit | Servidor | Se dispara en el servidor cuando un jugador sale de un vehículo. |
| onTrailerAttach | Servidor | Se dispara en el servidor cuando un remolque se engancha a un vehículo. Cancelar el evento suelta el remolque. |
| onTrailerDetach | Servidor | Se dispara en el servidor cuando un remolque se suelta del vehículo que lo arrastraba. |
| onVehicleEnter | Servidor | Se dispara en el servidor cuando un ped termina de subir a un vehículo. |
| onVehicleExit | Servidor | Se dispara en el servidor cuando un ped sale de un vehículo. |
| onVehicleStartEnter | Servidor | Se dispara en el servidor cuando un ped empieza a subir a un vehículo. Cancelar el evento lo impide. |
| onVehicleStartExit | Servidor | Se dispara en el servidor cuando un ped empieza a bajar de un vehículo o lo van a sacar a la fuerza. Cancelar el evento lo impide. |
Aspecto de los vehículos
| Nombre | Lado | Descripción |
|---|---|---|
| areVehicleLightTrailsEnabled | Cliente | Dice si un vehículo deja estelas de luz detrás de las luces traseras. |
| getVehicleDirtColor | Compartido | Dice el color de la suciedad en la pintura de un vehículo. |
| getVehicleDirtLevel | Compartido | Dice cuánta suciedad se ve en la pintura de un vehículo. |
| getVehicleNeonColor | Compartido | Dice el color del neón de un vehículo. |
| getVehicleNeonPower | Compartido | Dice el brillo del neón de un vehículo. |
| getVehicleNeonStrips | Compartido | Lista las franjas de neón que tiene el modelo de un vehículo. |
| getVehicleWetnessLevel | Compartido | Dice qué tan mojado se fijó un vehículo. |
| isVehicleBackfireEnabled | Cliente | Dice si un vehículo suelta llamas solo por el escape. |
| isVehicleNeonEnabled | Compartido | Dice si las franjas de neón de un vehículo están encendidas. |
| resetVehicleDirtColor | Compartido | Devuelve la suciedad de un vehículo al color por defecto, 59, 57, 52. |
| resetVehicleWetnessLevel | Compartido | Hace que un vehículo vuelva a mojarse con la lluvia, deshaciendo setVehicleWetnessLevel. |
| setVehicleBackfireEnabled | Cliente | Enciende o apaga las llamas que salen solas del escape de un vehículo al soltar el acelerador a altas revoluciones o al subir de marcha. |
| setVehicleDirtColor | Compartido | Cambia el color de la suciedad en la pintura de un vehículo, como barro o arena. |
| setVehicleDirtLevel | Compartido | Cambia cuánta suciedad se ve en la pintura de un vehículo. |
| setVehicleLightTrailsEnabled | Cliente | Enciende o apaga estelas de luz roja detrás de las luces traseras encendidas de un vehículo, más largas cuanto más rápido va. |
| setVehicleNeonColor | Compartido | Cambia el color del neón de un vehículo. El color vale para todas las franjas. |
| setVehicleNeonEnabled | Compartido | Enciende o apaga franjas de neón bajo un vehículo. |
| setVehicleNeonPower | Compartido | Cambia el brillo del neón de un vehículo. |
| setVehicleWetnessLevel | Compartido | Fija qué tan mojado se ve un vehículo, en lugar de seguir la lluvia. |
| triggerVehicleBackfire | Cliente | Hace salir una pequeña llama de cada escape de un vehículo, una vez. |
Handling
| Nombre | Lado | Descripción |
|---|---|---|
| getModelHandling | Servidor | Lee el handling de un modelo de vehículo, con el que empiezan los vehículos nuevos de ese modelo. |
| getOriginalHandling | Cliente | Lee el handling original de un modelo de vehículo, tal como lo cargó el juego, sin los cambios de los scripts. |
| getOriginalHandling | Servidor | Lee el handling original de un modelo de vehículo, tal como lo declaran los paquetes de contenido, sin los cambios de los scripts. |
| getVehicleHandling | Compartido | Lee el handling de un vehículo: su masa, motor, tracción, suspensión y el resto de lo que define cómo se conduce. |
| setModelHandling | Servidor | Cambia una propiedad del handling de un modelo de vehículo, con el que empiezan los vehículos nuevos de ese modelo. |
| setVehicleHandling | Cliente | Cambia el handling de un vehículo solo en este cliente. |
| setVehicleHandling | Servidor | Cambia el handling de un vehículo para todos los jugadores. |
Mundo y clima
| Nombre | Lado | Descripción |
|---|---|---|
| createFire | Cliente | Enciende un fuego en un punto, solo en este cliente. Arde durante 5 segundos. |
| createLadder | Cliente | Crea una escalera por la que los peds pueden subir, solo en este cliente. |
| extinguishFire | Cliente | Apaga los fuegos dentro de un radio alrededor de un punto. Sin argumentos, apaga todos los fuegos de este cliente. |
| getCloudsDensity | Cliente | Devuelve cuánto del cielo cubren las nubes: el valor de setCloudsDensity o, sin él, el actual de las nubes. |
| getFarClipDistance | Cliente | Devuelve hasta qué distancia se está dibujando el mundo ahora. |
| getFiresInRange | Cliente | Lista los fuegos encendidos cerca de un punto. La distancia se mide solo en el plano horizontal. |
| getFogDistance | Cliente | Devuelve a qué distancia empieza la niebla: el valor de setFogDistance o, sin él, el del ciclo de tiempo. |
| getGroundPosition | Cliente | Busca el suelo justo debajo de un punto, hasta 1000 m hacia abajo. Solo cuentan edificios y objetos. |
| getMinuteDuration | Cliente | Devuelve cuánto tiempo real dura un minuto del juego en este cliente. |
| getMoonColor | Cliente | Devuelve el color de la luna en uso: el que fijó setMoonColor o, sin él, el del ciclo de tiempo. |
| getMoonSize | Cliente | Devuelve el tamaño del disco de la luna: el que fijó setMoonSize o, sin él, el del ciclo de tiempo. |
| getScreenFromWorldPosition | Cliente | Proyecta un punto del mundo en la pantalla, con la cámara del fotograma actual. |
| getSkyColor | Cliente | Devuelve el degradado del cielo que fijó setSkyColor. |
| getSunColor | Cliente | Devuelve el color del sol en uso: el que fijó setSunColor o, sin él, el del ciclo de tiempo. |
| getSunSize | Cliente | Devuelve el tamaño del disco del sol: el que fijó setSunSize o, sin él, el del ciclo de tiempo. |
| getTime | Cliente | Devuelve la hora del juego en este cliente. |
| getWeather | Cliente | Devuelve el clima actual de este cliente. Durante una transición, es el clima de destino. |
| getWeatherNames | Cliente | Lista los climas que declaran los paquetes cargados. |
| getWorldFromScreenPosition | Cliente | Convierte un punto de la pantalla, a una profundidad, en un punto del mundo, con la cámara del fotograma actual. |
| isLineOfSightClear | Cliente | Indica si nada bloquea el segmento entre dos puntos. Solo bloquean edificios y objetos, no vehículos ni peds. |
| isTimeFrozen | Cliente | Indica si el reloj del juego está congelado en este cliente. |
| processLineOfSight | Cliente | Lanza un rayo entre dos puntos y devuelve lo primero que toca. |
| resetCloudsDensity | Cliente | Deshace setCloudsDensity: la cobertura de nubes vuelve a seguir el ciclo de tiempo. |
| resetFarClipDistance | Cliente | Deshace setFarClipDistance: la distancia de dibujo vuelve a seguir el ciclo de tiempo. |
| resetFogDistance | Cliente | Deshace setFogDistance: la niebla vuelve a seguir el ciclo de tiempo. |
| resetMoonColor | Cliente | Deshace setMoonColor: el color de la luna vuelve a seguir el ciclo de tiempo. |
| resetMoonSize | Cliente | Deshace setMoonSize: el tamaño de la luna vuelve a seguir el ciclo de tiempo. |
| resetSkyColor | Cliente | Deshace setSkyColor: el cielo vuelve a seguir el ciclo de tiempo. |
| resetSunColor | Cliente | Deshace setSunColor: el color del sol vuelve a seguir el ciclo de tiempo. |
| resetSunSize | Cliente | Deshace setSunSize: el tamaño del sol vuelve a seguir el ciclo de tiempo. |
| setCloudsDensity | Cliente | Cambia cuánto del cielo cubren las nubes, por encima del ciclo de tiempo, hasta que resetCloudsDensity lo restaura. |
| setFarClipDistance | Cliente | Cambia hasta qué distancia de la cámara se dibuja el mundo, por encima del ciclo de tiempo, hasta que resetFarClipDistance la restaura. |
| setFogDistance | Cliente | Cambia a qué distancia de la cámara empieza la niebla, por encima del ciclo de tiempo, hasta que resetFogDistance la restaura. |
| setMinuteDuration | Cliente | Define cuánto tiempo real dura un minuto del juego en este cliente. |
| setMoonColor | Cliente | Cambia el color de la luna, por encima del ciclo de tiempo, hasta que resetMoonColor lo restaura. |
| setMoonSize | Cliente | Cambia el tamaño del disco de la luna en el cielo, por encima del ciclo de tiempo, hasta que resetMoonSize lo restaura. |
| setSkyColor | Cliente | Pinta el cielo con un degradado de arriba al horizonte, por encima del ciclo de tiempo, hasta que resetSkyColor lo restaura. |
| setSunColor | Cliente | Cambia el color del sol, por encima del ciclo de tiempo, hasta que resetSunColor lo restaura. |
| setSunSize | Cliente | Cambia el tamaño del disco del sol en el cielo, por encima del ciclo de tiempo, hasta que resetSunSize lo restaura. |
| setTime | Cliente | Cambia la hora del juego en este cliente. El reloj sigue andando desde ahí. |
| setTimeFrozen | Cliente | Congela o descongela el reloj del juego en este cliente. Congelado, la hora no avanza, pero setTime todavía la cambia. |
| setWeather | Cliente | Cambia el clima de este cliente, de golpe o con una transición. |
Objetos
| Nombre | Lado | Descripción |
|---|---|---|
| breakObject | Compartido | Rompe un objeto rompible al instante. |
| createObject | Cliente | Crea un objeto que existe solo en este cliente. |
| createObject | Servidor | Crea un objeto que ven todos los jugadores. |
| getObjectScale | Compartido | Devuelve la escala de un objeto en cada eje. |
| moveObject | Compartido | Mueve un objeto suavemente hasta una posición, girándolo por el camino. |
| setObjectBreakable | Compartido | Define si un objeto rompible puede romperse. Un objeto que no puede queda inmune a cualquier daño. |
| setObjectScale | Compartido | Cambia el tamaño de un objeto, por igual o en cada eje. |
| stopObject | Compartido | Detiene el movimiento de un objeto donde esté. |
| onClientObjectMoveStart | Cliente | Se dispara en este cliente cuando un objeto empieza un movimiento de moveObject, lo haya creado este cliente o el servidor. |
| onClientObjectMoveStop | Cliente | Se dispara en este cliente cuando termina el movimiento de un objeto: llegó, stopObject lo detuvo o un nuevo moveObject ocupó su lugar. |
Formas de colisión
| Nombre | Lado | Descripción |
|---|---|---|
| createColCircle | Compartido | Crea una forma de colisión circular, sin límite de altura. |
| createColCuboid | Compartido | Crea una forma de colisión con forma de caja, alineada con los ejes del mundo. |
| createColPolygon | Compartido | Crea una forma de colisión con forma de polígono plano, sin límite de altura hasta que setColPolygonHeight le dé uno. |
| createColRectangle | Compartido | Crea una forma de colisión rectangular, alineada con los ejes del mundo y sin límite de altura. |
| createColSphere | Compartido | Crea una forma de colisión esférica. |
| createColTube | Compartido | Crea una forma de colisión con forma de cilindro vertical. |
| getColPolygonHeight | Compartido | Devuelve entre qué alturas un polígono de colisión detecta elementos. |
| getColShapeType | Compartido | Indica qué forma tiene una forma de colisión. |
| getElementsWithinColShape | Compartido | Lista los elementos que están dentro de una forma de colisión. |
| isElementWithinColShape | Compartido | Indica si un elemento está dentro de una forma de colisión. |
| setColPolygonHeight | Compartido | Limita entre qué alturas un polígono de colisión detecta elementos. |
| onClientColShapeHit | Cliente | Se dispara cuando un jugador, ped, vehículo u objeto entra en una forma de colisión en este cliente. |
| onClientColShapeLeave | Cliente | Se dispara cuando un jugador, ped, vehículo u objeto sale de una forma de colisión en este cliente. |
| onClientElementColShapeHit | Cliente | Se dispara en un jugador, ped, vehículo u objeto cuando entra en una forma de colisión en este cliente. |
| onClientElementColShapeLeave | Cliente | Se dispara en un jugador, ped, vehículo u objeto cuando sale de una forma de colisión en este cliente. |
| onColShapeHit | Servidor | Se dispara cuando un jugador, ped, vehículo u objeto entra en una forma de colisión. |
| onColShapeLeave | Servidor | Se dispara cuando un jugador, ped, vehículo u objeto sale de una forma de colisión. |
| onElementColShapeHit | Servidor | Se dispara en un jugador, ped, vehículo u objeto cuando entra en una forma de colisión. |
| onElementColShapeLeave | Servidor | Se dispara en un jugador, ped, vehículo u objeto cuando sale de una forma de colisión. |
Calles y rutas
| Nombre | Lado | Descripción |
|---|---|---|
| arePathNodesLoaded | Cliente | Indica si los nodos de ruta de un área ya están cargados. |
| calculatePathRoute | Cliente | Calcula la ruta más corta por los nodos de ruta entre dos puntos, partiendo del nodo más cercano a cada uno. Para coches, respeta las calles de sentido único. |
| getClosestPathNode | Cliente | Busca el nodo de calle o de acera más cercano a un punto. |
| getClosestStraightRoad | Cliente | Busca el tramo de calle más cercano a un punto: dos nodos de coche unidos y la dirección entre ellos. Los nodos desactivados quedan fuera. |
| getNthClosestPathNode | Cliente | Busca el n-ésimo nodo de calle o de acera más cercano a un punto. |
| getParkingNodeInArea | Cliente | Busca un nodo de estacionamiento dentro de una caja. Cada llamada devuelve el siguiente de la caja, volviendo al primero al final. |
| getPathNodeInfo | Cliente | Devuelve lo que se sabe de un nodo de ruta. |
| getPathNodeNeighbours | Cliente | Lista los nodos unidos a un nodo de ruta y cómo es cada unión. |
| getPathNodePosition | Cliente | Devuelve la posición de un nodo de ruta. |
| getPathNodesInRadius | Cliente | Lista los nodos de calle o de acera dentro de un radio. |
| getRoadDensity | Cliente | Mide cuánta calle hay alrededor de un punto: los carriles por la longitud de las uniones de coche que salen a menos de 80 m de él, en una escala reducida. |
| getSafePedSpawnPosition | Cliente | Sortea un lugar en una acera cerca de un punto donde puede aparecer un peatón, como SA elige dónde crear peatones. El lugar queda sobre el suelo. |
| releasePathNodes | Cliente | Deshace el pedido de requestPathNodesInArea. Las áreas lejos del jugador pueden descargarse otra vez. |
| requestPathNodesInArea | Cliente | Pide que se carguen los nodos de ruta de un área además de los que están cerca del jugador. El área sigue cargada hasta releasePathNodes. |
Cámara
| Nombre | Lado | Descripción |
|---|---|---|
| attachCameraToElement | Cliente | Une la cámara a un elemento: sigue su posición y su rotación hasta que setCameraTarget la devuelve a un ped. |
| fadeCamera | Cliente | Oscurece la pantalla hasta un color o la vuelve a aclarar. |
| getCameraMatrix | Cliente | Devuelve dónde está la cámara y hacia dónde mira. |
| getCameraTarget | Cliente | Devuelve el jugador o ped al que sigue la cámara. |
| setCameraMatrix | Cliente | Fija la cámara en un punto, mirando a otro, hasta que setCameraTarget la devuelve a un ped. |
| setCameraTarget | Cliente | Hace que la cámara siga a un jugador o ped, como en el juego normal. También deshace setCameraMatrix y attachCameraToElement. |
Cinemáticas
| Nombre | Lado | Descripción |
|---|---|---|
| castCinematicActor | Cliente | Hace que un actor sea interpretado con el aspecto y los datos de elemento de un ped, jugador o vehículo de la sesión. Se aplica desde la próxima reproducción. |
| createCinematic | Cliente | Crea un elemento cinematic, vacío o a partir de una cinemática guardada. Pertenece al recurso que lo creó y solo existe en este cliente. |
| getCinematicActor | Cliente | Devuelve el elemento local (ped o vehículo) que interpreta a un actor en la reproducción actual. |
| getCinematicActorPose | Cliente | Devuelve dónde está un actor en un tiempo de la cinemática. No necesita reproducción. |
| getCinematicActors | Cliente | Lista los actores de la cinemática: los grabados y los colocados. |
| getCinematicAdjustments | Cliente | Devuelve los desplazamientos y las animaciones puestos sobre la toma de un actor. |
| getCinematicAudio | Cliente | Devuelve los sonidos de la cinemática. |
| getCinematicCamera | Cliente | Devuelve los planos de cámara de la cinemática. |
| getCinematicCaptions | Cliente | Devuelve los subtítulos de la cinemática. |
| getCinematicData | Cliente | Devuelve la cinemática entera como bytes .cine, que createCinematic vuelve a leer. |
| getCinematicDuration | Cliente | Devuelve cuánto dura la cinemática. |
| getCinematicPosition | Cliente | Devuelve en qué tiempo de la cinemática está la reproducción. |
| getCinematicShotView | Cliente | Devuelve dónde está la cámara de un plano y hacia dónde mira en un tiempo de la cinemática, con el temblor incluido. |
| getCinematicWorld | Cliente | Devuelve las claves de clima, hora y fundido de la cinemática. |
| isCinematicPaused | Cliente | Indica si la reproducción de la cinemática está en pausa. |
| playCinematic | Cliente | Reproduce la cinemática: los actores como clones locales, y también la cámara, el clima, la hora, el fundido, los sonidos y los subtítulos. |
| removeCinematicActor | Cliente | Quita un actor de la cinemática, con su toma. |
| setCinematicActorTiming | Cliente | Coloca la toma de un actor en el tiempo de la cinemática, recorta el tramo mostrado y fija su velocidad. Fuera de ese tramo el actor sale de escena. |
| setCinematicAdjustments | Cliente | Pone desplazamientos y animaciones sobre la toma de un actor. La toma queda como se grabó y se mueve con ellos. Reemplaza los ajustes anteriores del actor. |
| setCinematicAudio | Cliente | Define los sonidos que la cinemática reproduce durante la reproducción. Reemplaza los sonidos anteriores. |
| setCinematicCamera | Cliente | Define los planos de cámara que la cinemática dirige durante la reproducción. Reemplaza los planos anteriores. |
| setCinematicCameraEnabled | Cliente | Activa o desactiva la cámara de la cinemática. Desactivada, la reproducción no mueve la cámara y los planos de setCinematicCamera se ignoran. |
| setCinematicCaptions | Cliente | Define los subtítulos que la cinemática dibuja en pantalla durante la reproducción. Reemplaza los subtítulos anteriores. |
| setCinematicDuration | Cliente | Fija la duración de la cinemática. La reproducción termina al llegar a ella. |
| setCinematicPaused | Cliente | Pausa o reanuda la reproducción de la cinemática. En pausa, los clones mantienen sus animaciones, los vehículos se congelan y los sonidos se pausan. |
| setCinematicPosition | Cliente | Salta la reproducción a otro tiempo de la cinemática. Los clones se mantienen; cada uno vuelve a su muestra y entra o sale de su vehículo según su toma. |
| setCinematicProp | Cliente | Coloca un vehículo u objeto quieto durante una parte de la cinemática, o cambia uno ya colocado. |
| setCinematicWorld | Cliente | Define las claves de clima, hora y fundido de pantalla que la cinemática aplica durante la reproducción. Reemplaza las claves anteriores. |
| startCinematicRecording | Cliente | Empieza a grabar un ped, jugador o vehículo como actor de la cinemática. Llamada de nuevo durante la grabación, añade otro actor a la misma grabación. |
| stopCinematic | Cliente | Detiene la reproducción de la cinemática. Los clones desaparecen y el clima, la hora y el fundido vuelven a lo que tenía el mundo. |
| stopCinematicRecording | Cliente | Detiene la grabación de la cinemática. Los demás actores que se reproducían durante la grabación también se detienen. |
| onClientCinematicFinish | Cliente | Se dispara cuando la reproducción de una cinemática llega al final por sí sola. |
Dibujo en pantalla
| Nombre | Lado | Descripción |
|---|---|---|
| dxConvertPixels | Cliente | Convierte una imagen guardada en un string a otro formato, en segundo plano, y entrega el resultado a una función. |
| dxCreateFont | Cliente | Crea una fuente a partir de un archivo de fuente del recurso, para las funciones de texto. |
| dxCreateRenderTarget | Cliente | Crea un render target: una imagen en la que las funciones dx pueden dibujar y que se puede usar como cualquier otra imagen. |
| dxCreateScreenSource | Cliente | Crea una screen source: una imagen que recibe una copia de la pantalla del juego en cada dxUpdateScreenSource. |
| dxDrawCircle | Cliente | Dibuja un círculo relleno, o un sector de él, en la pantalla durante un fotograma. |
| dxDrawImage | Cliente | Dibuja una imagen en la pantalla durante un fotograma. |
| dxDrawImageSection | Cliente | Dibuja una parte de una imagen en la pantalla durante un fotograma. |
| dxDrawLine | Cliente | Dibuja una línea 2D en la pantalla durante un fotograma. |
| dxDrawLine3D | Cliente | Dibuja una línea en el mundo 3D durante un fotograma. La línea mira a la cámara. |
| dxDrawMaterialLine3D | Cliente | Dibuja una imagen estirada a lo largo de una línea en el mundo 3D durante un fotograma. |
| dxDrawMaterialPrimitive | Cliente | Dibuja una primitiva 2D con una imagen en la pantalla durante un fotograma. |
| dxDrawMaterialPrimitive3D | Cliente | Dibuja una primitiva con una imagen en el mundo 3D durante un fotograma. |
| dxDrawMaterialSectionLine3D | Cliente | Dibuja una parte de una imagen estirada a lo largo de una línea en el mundo 3D durante un fotograma. |
| dxDrawPrimitive | Cliente | Dibuja una primitiva 2D (puntos, líneas o triángulos) en la pantalla durante un fotograma. |
| dxDrawRectangle | Cliente | Dibuja un rectángulo relleno en la pantalla durante un fotograma. |
| dxDrawText | Cliente | Dibuja un texto en la pantalla durante un fotograma, dentro de una caja. |
| dxGetBlendMode | Cliente | Devuelve el modo de mezcla de las funciones dx 2D. |
| dxGetFontHeight | Cliente | Devuelve el alto de una línea de texto de una fuente. |
| dxGetMaterialSize | Cliente | Devuelve el tamaño de una imagen en píxeles. |
| dxGetPixelColor | Cliente | Lee el color de un píxel de una imagen en plain. |
| dxGetPixelsFormat | Cliente | Detecta el formato de una imagen guardada en un string. |
| dxGetPixelsSize | Cliente | Devuelve el ancho y el alto de una imagen guardada en un string (plain, png, jpeg o dds). |
| dxGetStatus | Cliente | Devuelve información sobre la tarjeta gráfica y la memoria de vídeo usada por los scripts. |
| dxGetTextSize | Cliente | Mide el ancho y el alto que ocupa un texto en la pantalla. |
| dxGetTexturePixels | Cliente | Lee los píxeles de una imagen y los entrega a una función, unos fotogramas después. |
| dxGetTextWidth | Cliente | Mide el ancho que ocupa un texto en la pantalla, en su línea más ancha. |
| dxSetBlendMode | Cliente | Elige cómo se mezclan las siguientes funciones dx 2D con lo que ya está dibujado. |
| dxSetPixelColor | Cliente | Cambia el color de un píxel de una imagen en plain, en el propio string. |
| dxSetRenderTarget | Cliente | Elige dónde dibujan las siguientes funciones dx: en un render target o, sin él, en la pantalla. |
| dxSetTextureEdge | Cliente | Elige lo que muestra una imagen cuando se lee fuera de sus bordes. |
| dxSetTexturePixels | Cliente | Escribe píxeles en una textura creada por script o en un render target. |
| dxUpdateScreenSource | Cliente | Copia la pantalla del juego en una screen source. |
| getScreenSize | Cliente | Devuelve el tamaño de la pantalla del juego en píxeles. |
| onClientHUDRender | Cliente | Se dispara en cada fotograma, justo antes de onClientRender. |
| onClientPreRender | Cliente | Se dispara en cada fotograma, después de simular el mundo y antes de dibujarlo. |
| onClientRender | Cliente | Se dispara en cada fotograma, cuando se deben hacer los dibujos dx de ese fotograma. |
Interfaz web
| Nombre | Lado | Descripción |
|---|---|---|
| createDui | Cliente | Abre una página web fuera de la pantalla, con fondo transparente, y la devuelve como una imagen que se puede dibujar. |
| drawDui | Cliente | Dibuja un dui en la pantalla durante un fotograma, en coordenadas relativas a la pantalla. |
| isDuiReady | Cliente | Dice si la página de un dui terminó de cargar. |
| isNuiFocused | Cliente | Dice si alguna página de interfaz tiene el foco. |
| registerNuiCallback | Cliente | Registra una función que la página de interfaz del recurso que llama invoca con un fetch a /nombre en su propia dirección. |
| sendDuiMessage | Cliente | Envía un mensaje a la página de un dui. La página lo recibe en el evento message del window. |
| sendDuiMouseButton | Cliente | Pulsa o suelta un botón del ratón sobre la página de un dui. |
| sendDuiMouseMove | Cliente | Mueve el puntero del ratón sobre la página de un dui. |
| sendDuiMouseWheel | Cliente | Desplaza la página de un dui con la rueda del ratón. |
| sendNuiMessage | Cliente | Envía un mensaje a la página de interfaz del recurso que llama. La página lo recibe en el evento message del window. |
| setDuiUrl | Cliente | Lleva un dui a otra dirección. |
| setNuiFocus | Cliente | Da o quita el foco a la página de interfaz del recurso que llama. Con foco, la página recibe el ratón y el teclado. |
| setNuiKeepInput | Cliente | Elige si el juego sigue recibiendo el ratón y el teclado mientras una página de interfaz tiene el foco. |
Luces
| Nombre | Lado | Descripción |
|---|---|---|
| createPointLight | Cliente | Crea una luz que ilumina en todas las direcciones desde un punto. La luz solo existe en este cliente. |
| createRectLight | Cliente | Crea una luz que sale de un rectángulo, como un panel o una ventana iluminada. La luz solo existe en este cliente. |
| createSpotLight | Cliente | Crea una luz que ilumina dentro de un cono, como un foco. La luz solo existe en este cliente. |
| dxDrawPointLight | Cliente | Ilumina en todas las direcciones desde un punto durante un solo fotograma, sin crear un elemento. |
| dxDrawRectLight | Cliente | Ilumina desde un rectángulo durante un solo fotograma, sin crear un elemento. |
| dxDrawSpotLight | Cliente | Ilumina un cono durante un solo fotograma, sin crear un elemento. |
| getLightBarnDoor | Cliente | Lee las aletas de una luz rect. |
| getLightCastShadow | Cliente | Dice si una luz proyecta sombras. |
| getLightColor | Cliente | Lee el color de una luz. |
| getLightCone | Cliente | Lee la apertura y la dureza del borde del cono de una luz spot. |
| getLightDirection | Cliente | Lee hacia dónde apunta una luz spot o rect. |
| getLightFalloff | Cliente | Lee el exponente de desvanecimiento de una luz. |
| getLightIntensity | Cliente | Lee el brillo de una luz. |
| getLightRadius | Cliente | Lee el alcance de una luz. |
| getLightSize | Cliente | Lee el ancho y el alto de una luz rect. |
| getLightSourceRadius | Cliente | Lee el tamaño de la bombilla de una luz spot. |
| getLightTangent | Cliente | Lee hacia dónde apunta el ancho de una luz rect. |
| getLightType | Cliente | Dice el tipo de una luz. |
| isLightEnabled | Cliente | Dice si una luz está encendida. |
| setLightBarnDoor | Cliente | Cambia las aletas de una luz rect, que limitan hacia dónde sale la luz del rectángulo. |
| setLightCastShadow | Cliente | Activa o desactiva las sombras de una luz. |
| setLightColor | Cliente | Cambia el color de una luz. |
| setLightCone | Cliente | Cambia la apertura y la dureza del borde del cono de una luz spot. |
| setLightDirection | Cliente | Cambia hacia dónde apunta una luz spot o rect. |
| setLightEnabled | Cliente | Enciende o apaga una luz sin destruirla. |
| setLightFalloff | Cliente | Cambia cómo se desvanece la luz hacia el final de su alcance. |
| setLightIntensity | Cliente | Cambia el brillo de una luz. |
| setLightRadius | Cliente | Cambia el alcance de una luz. |
| setLightSize | Cliente | Cambia el ancho y el alto de una luz rect. |
| setLightSourceRadius | Cliente | Cambia el tamaño de la bombilla de una luz spot. Una bombilla mayor suaviza los brillos y las sombras. |
| setLightTangent | Cliente | Cambia hacia dónde apunta el ancho de una luz rect, girando el rectángulo alrededor de su normal. |
Efectos
| Nombre | Lado | Descripción |
|---|---|---|
| createEffect | Compartido | Crea un efecto de partículas en el mundo. En el servidor lo ven todos los clientes; en un cliente, solo ese cliente. |
| engineAddEffects | Cliente | Registra los efectos de partículas de un archivo del recurso, para que createEffect los use por nombre. |
| engineGetEffects | Cliente | Lista los efectos de partículas cargados en este cliente. |
| engineRemoveEffects | Cliente | Quita los efectos que este recurso añadió desde un archivo con engineAddEffects. |
| getEffectColor | Compartido | Lee el color de un efecto. |
| getEffectEvolution | Compartido | Lee el nivel de una evolución de un efecto. |
| getEffectScale | Compartido | Lee el tamaño de un efecto. |
| setEffectColor | Compartido | Tiñe un efecto con un color. |
| setEffectEvolution | Compartido | Cambia el nivel de una evolución de un efecto, un parámetro que el propio efecto declara para variar su aspecto. |
| setEffectScale | Compartido | Cambia el tamaño de un efecto. |
| stopEffect | Compartido | Detiene un efecto: deja de emitir y las partículas que ya existen terminan. |
Texturas
| Nombre | Lado | Descripción |
|---|---|---|
| engineCreateTexture | Cliente | Crea una textura a partir de un archivo de imagen del recurso o de los bytes de una imagen en memoria. La textura solo existe en este cliente. |
| engineCreateTxd | Cliente | Crea un diccionario de texturas vacío con un nombre. Llénalo con engineSetTxdTexture. Solo existe en este cliente. |
| engineGetModelTxds | Cliente | Lista los txds de los que un modelo toma sus texturas, en el orden en que los busca. |
| engineGetTxds | Cliente | Lista todos los diccionarios de texturas que conoce este cliente, con el origen de cada uno. |
| engineGetTxdTexture | Cliente | Da un elemento texture que muestra lo que un txd muestra bajo un nombre de textura, para dibujarlo o usarlo como fuente. |
| engineGetTxdTextures | Cliente | Lista los nombres de las texturas que da un txd, incluidos los enlaces. |
| engineIsAssetLoaded | Cliente | Indica si un asset creado por un script está listo para usarse. |
| engineLoadTxd | Cliente | Carga un diccionario de texturas (.ktd) desde un archivo del recurso con un nombre. Solo existe en este cliente. |
| engineRestoreElementTexture | Cliente | Quita los cambios de textura que este recurso aplicó a un elemento con engineSetElementTexture. |
| engineRestoreModelTexture | Cliente | Quita los cambios de textura que este recurso aplicó a un modelo con engineSetModelTexture. |
| engineRestoreModelTxd | Cliente | Quita los txds que este recurso puso delante de un modelo con engineSetModelTxd. |
| engineRestoreTxdTexture | Cliente | Quita los enlaces que este recurso hizo en un txd con engineSetTxdTexture, para que vuelva a dar sus propias texturas. |
| engineRestoreTxdTextureSampling | Cliente | Quita el cambio de muestreo que este recurso aplicó a la textura de un txd con engineSetTxdTextureSampling. |
| engineRestoreWorldTexture | Cliente | Quita los cambios de textura del mundo que este recurso aplicó con engineSetWorldTexture. |
| engineSetElementTexture | Cliente | Cambia una textura de un solo vehículo, ped, jugador u objeto. Las demás instancias del mismo modelo conservan sus texturas. |
| engineSetModelTexture | Cliente | Cambia una textura en todas las instancias de un modelo. Solo cambian los materiales de ese modelo, no el txd del que viene la textura. |
| engineSetModelTxd | Cliente | Pone un txd delante del txd propio de un modelo, para que el modelo busque sus texturas ahí primero y use el suyo para el resto. |
| engineSetTxdTexture | Cliente | Pone una imagen en un txd bajo un nombre de textura, reemplazando la textura con ese nombre o agregando una nueva. Todo lo que lee el txd la sigue: modelos, peds, landscapes, calles, partículas, agua y cielo. |
| engineSetTxdTextureSampling | Cliente | Cambia cómo el mundo muestrea la textura de un txd: qué pasa más allá de sus bordes y cómo se filtra. Toma el lugar del direccionamiento del propio material. |
| engineSetWorldTexture | Cliente | Cambia una textura en todos los modelos de los tipos elegidos que la usan. Solo cambian los materiales de los modelos, no el txd del que viene la textura. |
| onClientAssetLoad | Cliente | Se dispara una vez cuando un asset que un script empezó a cargar en segundo plano está listo, o ha fallado. |
Materiales y shaders
| Nombre | Lado | Descripción |
|---|---|---|
| engineAddPostProcess | Cliente | Activa un posprocesado en la pantalla: un material cuyo shader es #type post. |
| engineCreateMaterial | Cliente | Crea un material: un shader con valores de parámetros, que luego reemplaza o se superpone a los materiales de los modelos. |
| engineCreateShader | Cliente | Crea un shader a partir de un archivo .shader o de su código fuente. El shader compila en segundo plano. |
| engineGetElementStencil | Cliente | Indica con qué valor de stencil está marcado un vehículo, ped u objeto. |
| engineGetMaterialAlphaClip | Cliente | Indica si el material recorta píxeles por su alfa, y por debajo de qué alfa. |
| engineGetMaterialParameters | Cliente | Lista los parámetros del shader que usa un material. |
| engineGetMaterialShader | Cliente | Indica qué shader usa un material. |
| engineGetMaterialSwitches | Cliente | Lista los interruptores estáticos del shader de un material, con el valor que tiene cada uno en él. |
| engineGetMaterialValue | Cliente | Lee un valor que define el material: un parámetro, un interruptor estático o una salida TARGET_n. |
| engineGetModelMaterials | Cliente | Lista los materiales del modelo cargado, en el orden en que el modelo los guarda. |
| engineGetModelStencil | Cliente | Indica con qué valor de stencil está marcado un modelo. |
| engineGetPostImage | Cliente | Da la imagen que produce un paso de un posprocesado, para dibujarla o usarla en otro material. |
| engineGetShaderErrors | Cliente | Lista los errores de la última compilación de un shader creado con engineCreateShader. |
| engineGetShaderGlobal | Cliente | Lee el valor actual de un global de shader. |
| engineGetShaderGlobals | Cliente | Lista todos los globales de shader, de los paquetes y de los scripts. |
| engineGetShaderParameters | Cliente | Lista los parámetros que declara un shader o preset. |
| engineGetShaderQuality | Cliente | Indica la calidad actual de los materiales de este cliente. |
| engineGetShaders | Cliente | Lista todos los shaders y presets cargados, de los paquetes y de los scripts. |
| engineGetShaderSwitches | Cliente | Lista los interruptores estáticos (parámetros bool) de un shader o preset, con el valor por defecto de cada uno. |
| engineRemovePostProcess | Cliente | Desactiva un posprocesado que este recurso activó con engineAddPostProcess. |
| engineResetMaterialValue | Cliente | Deshace un valor que definió el material, o todos, y vuelve a lo que da su base. |
| engineResetShaderGlobal | Cliente | Quita el valor que este recurso dio a un global de shader, y el global vuelve al valor del siguiente. |
| engineRestoreElementMaterial | Cliente | Deshace lo que hizo engineSetElementMaterial de este recurso de un único vehículo, ped u objeto. |
| engineRestoreElementOverlay | Cliente | Deshace lo que hizo engineSetElementOverlay de este recurso de un único vehículo, ped u objeto. |
| engineRestoreElementStencil | Cliente | Quita la marca de stencil que este recurso puso con engineSetElementStencil. |
| engineRestoreModelMaterial | Cliente | Deshace lo que hizo engineSetModelMaterial de este recurso de todas las instancias de un modelo. |
| engineRestoreModelOverlay | Cliente | Deshace lo que hizo engineSetModelOverlay de este recurso de todas las instancias de un modelo. |
| engineRestoreModelStencil | Cliente | Quita la marca de stencil que este recurso puso con engineSetModelStencil. |
| engineRestoreWorldMaterial | Cliente | Deshace lo que hizo engineSetWorldMaterial de este recurso de todos los modelos del mundo. |
| engineRestoreWorldOverlay | Cliente | Deshace lo que hizo engineSetWorldOverlay de este recurso de todos los modelos del mundo. |
| engineSetElementMaterial | Cliente | Reemplaza los materiales elegidos de un único vehículo, ped u objeto por un material. |
| engineSetElementOverlay | Cliente | Dibuja un material como una capa más encima de los materiales elegidos de un único vehículo, ped u objeto. |
| engineSetElementStencil | Cliente | Marca un vehículo, ped u objeto con un valor de stencil, que los shaders de posprocesado leen para contornos, resaltados y efectos parecidos. |
| engineSetMaterialAlphaClip | Cliente | Hace que el material recorte los píxeles cuyo alfa queda por debajo de un umbral, o que deje de recortar. |
| engineSetMaterialShader | Cliente | Cambia el shader de un material, manteniendo los valores que ya tiene. |
| engineSetMaterialValue | Cliente | Define un valor del material: un parámetro del shader, un interruptor estático o el render target de una salida TARGET_n. |
| engineSetModelMaterial | Cliente | Reemplaza los materiales elegidos de todas las instancias de un modelo por un material. |
| engineSetModelOverlay | Cliente | Dibuja un material como una capa más encima de los materiales elegidos de todas las instancias de un modelo. |
| engineSetModelStencil | Cliente | Marca todas las instancias de un modelo con un valor de stencil, que los shaders de posprocesado leen para contornos, resaltados y efectos parecidos. |
| engineSetShaderGlobal | Cliente | Define un global de shader, un valor que leen todos los shaders. Un nombre nuevo crea el global. |
| engineSetShaderQuality | Cliente | Cambia la calidad de los materiales de este cliente. Los shaders que leen QUALITY se compilan para el nuevo nivel. |
| engineSetWorldMaterial | Cliente | Reemplaza los materiales elegidos de todos los modelos del mundo por un material. |
| engineSetWorldOverlay | Cliente | Dibuja un material como una capa más encima de los materiales elegidos de todos los modelos del mundo. |
Modelos
| Nombre | Lado | Descripción |
|---|---|---|
| engineCreateModel | Cliente | Crea un nuevo modelo con un nombre, solo en este cliente. Se usa por su nombre, como cualquier otro modelo. |
| engineGetModels | Cliente | Lista los modelos que conoce este cliente, con el origen de cada uno. |
| engineLoadCol | Cliente | Carga un archivo de colisión (.kbn) del recurso para dárselo a un modelo. |
| engineLoadDrawable | Cliente | Carga un drawable (.kdr) desde un archivo del recurso para dárselo a un modelo. |
| engineRestoreModelCol | Cliente | Quita la colisión que este recurso dio a un modelo con engineSetModelCol, para que colisione como antes. |
| engineRestoreModelDrawable | Cliente | Quita el drawable que este recurso dio a un modelo con engineSetModelDrawable, para que dibuje lo que dibujaba antes. |
| engineSetModelCol | Cliente | Hace que un modelo colisione con una colisión cargada con engineLoadCol en lugar de la suya. |
| engineSetModelDrawable | Cliente | Hace que un modelo dibuje un drawable cargado con engineLoadDrawable en lugar del suyo. |
Ajustes gráficos
| Nombre | Lado | Descripción |
|---|---|---|
| engineGetAmbientOcclusion | Cliente | Devuelve cuántas muestras usa la oclusión ambiental. |
| engineGetAntiAliasing | Cliente | Devuelve el antialiasing en uso. |
| engineGetBloom | Cliente | Devuelve cuántos niveles de desenfoque usa el bloom. |
| engineGetClouds | Cliente | Devuelve cómo se dibujan las nubes. |
| engineGetDecals | Cliente | Devuelve cuántas marcas pueden existir a la vez y cuánto duran. |
| engineGetLocalLightShadows | Cliente | Indica si las luces locales proyectan sombras. |
| engineGetMotionBlur | Cliente | Indica si el desenfoque de movimiento está activo. |
| engineGetParticleDensity | Cliente | Devuelve qué fracción de las partículas de los efectos se emite. |
| engineGetParticleScale | Cliente | Devuelve a qué fracción de la resolución se dibujan las partículas. |
| engineGetReflections | Cliente | Devuelve la configuración de los reflejos. |
| engineGetRenderResolution | Cliente | Devuelve el tamaño en píxeles al que se renderiza la escena y el tamaño de la imagen final en la ventana. |
| engineGetRenderScale | Cliente | Devuelve la fracción de la resolución de la ventana a la que se renderiza la escena 3D. |
| engineGetShadows | Cliente | Devuelve la configuración de las sombras del sol. |
| engineGetSharpness | Cliente | Devuelve cuánto se enfoca la imagen final. |
| engineGetSunShafts | Cliente | Devuelve a qué fracción de la resolución se calculan los rayos de sol. |
| engineGetVolumetricFog | Cliente | Indica si la niebla volumétrica está activa. |
| engineHasCollisionLoadedAt | Cliente | Indica si el mundo alrededor de un punto ya está sólido: su colisión, edificios y paisajes cargados. |
| engineHasModelLoaded | Cliente | Indica si un modelo está cargado en memoria. |
| engineReleaseModel | Cliente | Deshace el pedido de modelo que este recurso hizo con engineRequestModel. |
| engineRequestCollisionAt | Cliente | Pide que se cargue la colisión alrededor de un punto. El pedido sigue hasta que termina de cargarse. |
| engineRequestModel | Cliente | Pide al streaming que cargue un modelo y lo mantiene cargado para este recurso hasta que se libere. |
| engineSetAmbientOcclusion | Cliente | Define cuántas muestras usa la oclusión ambiental. Más muestras oscurecen esquinas y grietas con más precisión. |
| engineSetAntiAliasing | Cliente | Elige el antialiasing de la imagen. |
| engineSetBloom | Cliente | Define cuántos niveles de desenfoque usa el bloom. Más niveles extienden el brillo más lejos. |
| engineSetClouds | Cliente | Elige cómo se dibujan las nubes. |
| engineSetDecals | Cliente | Define cuántas marcas (agujeros de bala, sangre, marcas de neumático) pueden existir a la vez y cuánto duran. |
| engineSetLocalLightShadows | Cliente | Activa o desactiva las sombras de las luces locales (puntuales, focos y rectangulares). |
| engineSetMotionBlur | Cliente | Activa o desactiva el desenfoque de movimiento. En PC viene activado. |
| engineSetParticleDensity | Cliente | Define qué fracción de las partículas de los efectos se emite. Las demás se descartan al azar. |
| engineSetParticleScale | Cliente | Define a qué fracción de la resolución se dibujan las partículas. |
| engineSetReflections | Cliente | Configura los reflejos: el tamaño de la sonda de entorno y los reflejos en espacio de pantalla. |
| engineSetRenderScale | Cliente | Define a qué fracción de la resolución de la ventana se renderiza la escena 3D. La imagen se amplía después al tamaño de la ventana. |
| engineSetShadows | Cliente | Configura las sombras del sol: cuántas cascadas, su resolución y si los bordes son suaves. |
| engineSetSharpness | Cliente | Define cuánto se enfoca la imagen final. |
| engineSetSunShafts | Cliente | Define a qué fracción de la resolución se calculan los rayos de sol, o los desactiva. |
| engineSetVolumetricFog | Cliente | Activa o desactiva la niebla volumétrica. Viene desactivada. |
Sonido
| Nombre | Lado | Descripción |
|---|---|---|
| engineAddSound | Cliente | Registra un archivo de audio con un nombre, que playSound y playSound3D pasan a reproducir por ese nombre. |
| engineGetSounds | Cliente | Lista los sonidos con nombre que valen ahora: los del juego, los de los paquetes y los de los recursos. |
| engineRemoveSound | Cliente | Quita un sonido que este recurso registró con engineAddSound. Si hay otro registro con el mismo nombre, vuelve a valer. |
| getSFXStatus | Cliente | Indica si un contenedor de audio de GTA San Andreas está disponible para playSFX y playSFX3D. |
| getSoundBPM | Cliente | Detecta el tempo del sonido en pulsaciones por minuto, redondeado hacia abajo. |
| getSoundBufferLength | Cliente | Existe por compatibilidad con MTA, donde da el tamaño del búfer de un stream de internet. |
| getSoundEffectParameters | Cliente | Devuelve los parámetros actuales de un efecto de audio activado en un sonido o en la voz de un jugador. |
| getSoundEffects | Cliente | Lista los efectos de audio de un sonido o de la voz de un jugador e indica cuáles están activados. |
| getSoundFFTData | Cliente | Devuelve el espectro de frecuencias de lo que el sonido está reproduciendo ahora, para hacer visualizadores. |
| getSoundLength | Compartido | Devuelve la duración del sonido. |
| getSoundLevelData | Cliente | Devuelve el pico de volumen de cada canal en los últimos 20 ms del sonido. |
| getSoundMaxDistance | Compartido | Devuelve a partir de qué distancia un sonido 3D queda en silencio. |
| getSoundMetaTags | Cliente | Lee las etiquetas del archivo de audio (ID3 del MP3, comentarios del OGG y del FLAC, INFO del WAV). |
| getSoundMinDistance | Compartido | Devuelve hasta qué distancia un sonido 3D suena a volumen completo. |
| getSoundPan | Cliente | Devuelve el panorama de un sonido sin posición. |
| getSoundPosition | Compartido | Devuelve en qué punto de la pista se está reproduciendo el sonido. |
| getSoundProperties | Cliente | Devuelve la frecuencia de muestreo, el tempo y el tono de un sonido, y si suena al revés. |
| getSoundSpeaker | Cliente | Devuelve el ped que habla un sonido. |
| getSoundSpeed | Compartido | Devuelve la velocidad de un sonido. |
| getSoundVolume | Compartido | Devuelve el volumen de un sonido, sin contar la caída con la distancia. |
| getSoundWaveData | Cliente | Devuelve la forma de onda de lo que el sonido acaba de reproducir, para dibujar osciloscopios. |
| isShowSoundEnabled | Cliente | Indica si showSound está activado. |
| isSoundLooped | Compartido | Indica si un sonido se repite cuando llega al final. |
| isSoundPanningEnabled | Cliente | Indica si un sonido 3D tiene el panorama estéreo activado. |
| isSoundPaused | Compartido | Indica si un sonido está en pausa. |
| isWorldSoundEnabled | Cliente | Indica si un sonido del mundo, o un grupo de ellos, está activado. |
| playSFX | Cliente | Reproduce un sonido de los bancos de audio de GTA San Andreas, sin posición en el mundo. |
| playSFX3D | Cliente | Reproduce un sonido de los bancos de audio de GTA San Andreas en una posición del mundo. |
| playSound | Cliente | Reproduce un sonido sin posición en el mundo, solo en este cliente. Dispara onClientSoundStarted con el motivo play. |
| playSound | Servidor | Crea un sonido sin posición en el mundo que todos los clientes reproducen a la vez. Los cambios que se le hacen en el servidor llegan a todos. |
| playSound3D | Cliente | Reproduce un sonido en una posición del mundo, solo en este cliente. El volumen baja con la distancia entre setSoundMinDistance (5 m) y setSoundMaxDistance (20 m). Dispara onClientSoundStarted con play. |
| playSound3D | Servidor | Crea un sonido en una posición del mundo que todos los clientes reproducen a la vez. Los cambios que se le hacen en el servidor llegan a todos. |
| playSoundFrontEnd | Cliente | Reproduce uno de los sonidos de interfaz de GTA San Andreas, como los del menú y las misiones. |
| resetWorldSounds | Cliente | Vuelve a activar todos los sonidos del mundo desactivados con setWorldSoundEnabled. |
| setSoundEffectEnabled | Cliente | Activa o desactiva un efecto de audio en un sonido o en la voz de un jugador. Al activarlo, el efecto empieza con sus parámetros por defecto. |
| setSoundEffectParameter | Cliente | Cambia un parámetro de un efecto de audio activado en un sonido o en la voz de un jugador. |
| setSoundLooped | Compartido | Activa o desactiva la repetición de un sonido. En el servidor, el cambio se envía a todos los clientes. |
| setSoundMaxDistance | Compartido | Define a partir de qué distancia un sonido 3D queda en silencio. Por defecto son 20 m. En el servidor, el cambio se envía a todos los clientes. |
| setSoundMinDistance | Compartido | Define hasta qué distancia un sonido 3D suena a volumen completo. Por defecto son 5 m. En el servidor, el cambio se envía a todos los clientes. |
| setSoundPan | Cliente | Coloca un sonido sin posición más a la izquierda o a la derecha. |
| setSoundPanningEnabled | Cliente | Activa o desactiva el panorama estéreo de un sonido 3D. Activado, el sonido se inclina a la izquierda o a la derecha según la cámara. Viene activado. |
| setSoundPaused | Compartido | Pausa o reanuda un sonido. En el servidor, el cambio se envía a todos los clientes. |
| setSoundPosition | Compartido | Salta a un punto de la pista. El valor se mantiene entre 0 y la duración del sonido. En el servidor, el cambio se envía a todos los clientes. |
| setSoundProperties | Cliente | Cambia la frecuencia de muestreo, el tempo y el tono de un sonido, y si suena al revés. |
| setSoundSpeaker | Cliente | Hace que un ped hable un sonido: su boca se mueve con el volumen del sonido y, si el sonido es 3D, sale de la cabeza del ped en cada fotograma. |
| setSoundSpeed | Compartido | Cambia la velocidad de un sonido. El tono cambia con ella. En el servidor, el cambio se envía a todos los clientes. |
| setSoundVolume | Compartido | Cambia el volumen de un sonido. En un sonido 3D, sigue bajando con la distancia. En el servidor, el cambio se envía a todos los clientes. |
| setWorldSoundEnabled | Cliente | Activa o desactiva sonidos del mundo del juego (pasos, disparos, choques y otros) por grupo o uno a uno. |
| showSound | Cliente | Escribe en la consola de depuración el grupo y el índice de cada sonido del mundo que suena. Solo funciona en el modo de desarrollo. |
| stopSound | Cliente | Detiene un sonido creado por este cliente y destruye el elemento. Dispara onClientSoundStopped con el motivo destroyed. |
| stopSound | Servidor | Detiene un sonido creado por el servidor y destruye el elemento en todos los clientes. |
| onClientSoundStarted | Cliente | Se dispara cuando un sonido empieza a sonar en este cliente o sale de la pausa. |
| onClientSoundStopped | Cliente | Se dispara cuando un sonido deja de sonar en este cliente: en pausa, detenido o terminado. |
| onClientWorldSound | Cliente | Se dispara cuando el juego va a reproducir un sonido del mundo. Cancelar el evento impide que suene. |
Voz
| Nombre | Lado | Descripción |
|---|---|---|
| addPlayerToVoiceChannel | Servidor | Mete a un jugador en un canal de voz. A partir de ahí oye y lo oyen los demás del canal. |
| createVoiceChannel | Servidor | Crea un canal de voz. Los jugadores solo se oyen entre sí por los canales en los que están. |
| deleteVoiceChannel | Servidor | Destruye un canal de voz. Los jugadores que estaban en él dejan de oírse por él. |
| isPlayerTalking | Cliente | Indica si un jugador está hablando en el chat de voz, desde el punto de vista de este cliente. |
| isPlayerTalking | Servidor | Indica si un jugador está hablando en el chat de voz. |
| removePlayerFromVoiceChannel | Servidor | Saca a un jugador de un canal de voz. |
| setPlayerDeafInVoiceChannel | Servidor | Ensordece a un jugador en un canal de voz: los demás lo siguen oyendo, pero él no oye a nadie por ese canal. |
| setPlayerMutedInVoiceChannel | Servidor | Silencia a un jugador en un canal de voz: sigue oyendo el canal, pero nadie lo oye por él. |
| setPlayerVoiceIgnoreFrom | Servidor | Hace que un jugador deje de oír la voz de ciertos elementos, en todos los canales. |
| onClientPlayerVoiceStart | Cliente | Se dispara en este cliente cuando un jugador empieza a hablar en el chat de voz: el jugador local al pulsar la tecla de hablar, u otro jugador cuando llega su voz. |
| onClientPlayerVoiceStop | Cliente | Se dispara en este cliente cuando un jugador deja de hablar en el chat de voz. |
| onPlayerVoiceStart | Servidor | Se dispara cuando un jugador empieza a hablar en el chat de voz. Cancelar el evento hace que nadie oiga esa intervención. |
| onPlayerVoiceStop | Servidor | Se dispara cuando un jugador deja de hablar en el chat de voz. |
Servidor
| Nombre | Lado | Descripción |
|---|---|---|
| getDevelopmentMode | Cliente | Indica si el modo de desarrollo está activo en este cliente. |
| getServerIP | Servidor | Devuelve la dirección IPv4 pública de la máquina, leída de sus interfaces de red al arrancar. |
| getServerName | Servidor | Devuelve el nombre del servidor, de la convar server_name. |
| getServerPassword | Servidor | Devuelve la contraseña que un jugador debe dar para entrar. |
| setDevelopmentMode | Cliente | Activa o desactiva el modo de desarrollo en este cliente. Con él activo, los comandos de consola showcol y showsound dibujan las formas de colisión y los sonidos del mundo. |
| setServerPassword | Servidor | Cambia la contraseña para entrar en el servidor. Quien ya está dentro se queda. |
| shutdown | Servidor | Apaga el servidor. Antes, dispara onShutdown. |
| onShutdown | Servidor | Se dispara cuando un script llama a shutdown, justo antes de que el servidor se apague. |
Base de datos
| Nombre | Lado | Descripción |
|---|---|---|
| dbConnect | Servidor | Abre una conexión con una base de datos SQLite o MySQL. Las consultas corren en un hilo propio de la conexión. |
| dbExec | Servidor | Ejecuta una sentencia SQL sin esperar respuesta. |
| dbFree | Servidor | Descarta una consulta de dbQuery cuya respuesta no se va a leer. |
| dbPoll | Servidor | Lee la respuesta de una consulta de dbQuery, esperándola si hace falta. |
| dbPrepareString | Servidor | Rellena los marcadores de un SQL con valores escapados, sin ejecutarlo. |
| dbQuery | Servidor | Envía una consulta SQL cuya respuesta se lee después con dbPoll. |
Red y HTTP
| Nombre | Lado | Descripción |
|---|---|---|
| fetchRemote | Servidor | Hace una petición HTTP o HTTPS y entrega la respuesta a una función cuando llega. |
| getServerIp | Cliente | Devuelve la dirección del servidor al que está conectado este cliente. |