TXEFFECTS

# Documentación del producto — TX Effects v2.0.0 ## Instalación 1. Extrae la carpeta `tx_effects`. 2. Colócala dentro de la carpeta `resources` de tu servidor FiveM. 3. Añade la siguiente línea a tu `server.cfg`: `ensure tx_effects` Si utilizas VisualSettings u otro recurso encargado de iluminación, color grading o timecycles, se recomienda iniciar primero ese recurso y después TX Effects. Ejemplo: `ensure VisualSettings` `ensure tx_effects` --- ## Configuración La configuración principal se encuentra en: `config.lua` Desde este archivo puedes modificar: * Activación del efecto de salud baja. * Nivel de salud necesario para activar el efecto. * Nivel de recuperación. * Intensidad del camera shake. * Sistema de adrenalina. * Duración de adrenalina. * Incremento de velocidad durante adrenalina. * Feedback de tormenta. * Nivel mínimo de lluvia. * Intervalo entre efectos de tormenta. * Intensidad de luces de vehículos. * Intensidad de luces de emergencia. * Efecto de cámara con sirena. * Timecycle nocturno opcional. * Horario nocturno. * Compatibilidad con VisualSettings. * Intervalos de actualización. * Comandos. --- ## Low Health Effect El sistema detecta la salud actual del jugador. Cuando la salud cae por debajo del valor configurado, TX Effects activa un efecto de cámara. Cuando la salud vuelve a superar el valor de recuperación, el efecto se elimina automáticamente. El sistema utiliza valores separados de activación y recuperación para evitar activaciones repetitivas cuando la salud se encuentra cerca del límite. --- ## Sistema de Adrenalina La adrenalina puede ser activada desde cualquier otro recurso compatible. Durante el efecto: * La velocidad de carrera aumenta temporalmente. * Se activa una vibración ligera de cámara. * El efecto permanece activo durante el tiempo especificado. * Al finalizar, la velocidad normal del jugador se restaura automáticamente. ### Activar mediante evento `TriggerEvent('tx_effects:adrenaline', 6000)` El valor representa la duración en milisegundos. --- ## Exports ### StartAdrenaline Permite activar adrenalina desde otro recurso. `exports['tx_effects']:StartAdrenaline(6000)` --- ### ClearEffects Elimina los efectos controlados por TX Effects en el cliente. `exports['tx_effects']:ClearEffects()` --- ### IsLowHealthActive Permite comprobar si el efecto de salud baja está activo. `local active = exports['tx_effects']:IsLowHealthActive()` --- ### IsAdrenalineActive Permite comprobar si la adrenalina está activa. `local active = exports['tx_effects']:IsAdrenalineActive()` --- ## Feedback de tormenta TX Effects comprueba el nivel actual de lluvia del juego. Cuando supera el límite configurado, puede aplicar periódicamente una vibración ligera de cámara. Este sistema no controla el clima. TX Effects: * No inicia lluvia. * No cambia el clima. * No genera rayos visuales. * No modifica el sistema meteorológico del servidor. --- ## Vehicle Light Enhancement Cuando el jugador utiliza un vehículo, TX Effects puede aumentar temporalmente el multiplicador de iluminación del vehículo. Al abandonar el vehículo, el valor vuelve automáticamente a su estado normal. --- ## Emergency Vehicle Effects TX Effects detecta vehículos pertenecientes a la clase de emergencia de GTA/FiveM. Cuando la sirena está activa puede: * Incrementar adicionalmente el multiplicador de las luces. * Aplicar un efecto ligero de cámara. Cuando la sirena se apaga o el jugador abandona el vehículo, estos efectos son eliminados. --- ## Night Timecycle TX Effects incluye soporte para un timecycle nocturno opcional. Esta función está diseñada para permanecer desactivada cuando otro recurso controla la imagen del servidor. Si: `VisualSettingsCompatibility = true` TX Effects evita tomar control del timecycle nocturno. --- ## Comandos ### `/clearfx` Limpia los efectos de TX Effects únicamente para el jugador que ejecuta el comando. --- ### `/txfx_clearall` Limpia los efectos de TX Effects para todos los jugadores conectados. Este comando está protegido mediante ACE permissions. Ejemplo: `add_ace group.admin command.txfx_clearall allow` --- ## Limpieza automática Cuando TX Effects se detiene o reinicia, el recurso intenta restaurar automáticamente: * Velocidad normal del jugador. * Multiplicadores de iluminación. * Estados de Low Health. * Estados de Adrenaline. * Efectos de cámara. * Timecycle utilizado por TX Effects cuando corresponde. Esto ayuda a evitar que un efecto permanezca activo después de reiniciar el recurso. --- ## Compatibilidad TX Effects es standalone. No requiere directamente: * QBCore * ESX * Qbox * ox_lib * oxmysql * MySQL Puede utilizarse junto a esos frameworks mediante sus eventos y exports. --- ## Recomendación para producción Si tu servidor utiliza VisualSettings, gráficos personalizados o algún recurso que controle el color grading, se recomienda mantener: `VisualSettingsCompatibility = true` Esto ayuda a evitar conflictos entre diferentes recursos visuales. --- ## Soporte de integración Para integrar TX Effects con sistemas médicos, drogas, objetos, misiones o scripts personalizados, utiliza principalmente: `TriggerEvent('tx_effects:adrenaline', duration)` o: `exports['tx_effects']:StartAdrenaline(duration)`

## Dependencias **No requiere dependencias externas obligatorias.** TX Effects es un recurso **Standalone** y no necesita: * QBCore * ESX * Qbox * ox_lib * oxmysql * MySQL * Base de datos * NUI externo * Recursos de terceros ### Requisito principal * Servidor FiveM actualizado con soporte para los natives utilizados por el recurso. ### Opcional * **VisualSettings** u otro recurso visual puede utilizarse junto a TX Effects. * Si utilizas otro recurso que controla timecycles, iluminación o color grading, se recomienda mantener `VisualSettingsCompatibility = true`.

## Configuración TX Effects incluye un archivo `config.lua` desde el cual puedes ajustar el comportamiento principal del recurso sin modificar el código interno. Puedes configurar: * Activar o desactivar el efecto de salud baja. * Umbral de salud para activar el efecto. * Umbral de recuperación de salud. * Intensidad del camera shake por salud baja. * Activar o desactivar el sistema de adrenalina. * Duración predeterminada de adrenalina. * Duración máxima permitida. * Multiplicador de velocidad durante adrenalina. * Intensidad del camera shake de adrenalina. * Activar o desactivar el feedback de tormenta. * Nivel mínimo de lluvia requerido para el efecto. * Tiempo mínimo y máximo entre efectos de tormenta. * Intensidad del shake de tormenta. * Activar o desactivar la mejora de luces de vehículos. * Multiplicador de luces normal. * Multiplicador adicional para vehículos de emergencia. * Activar o desactivar el efecto de cámara con sirena. * Intensidad del efecto de sirena. * Activar o desactivar el timecycle nocturno opcional. * Horario de inicio y fin del modo nocturno. * Compatibilidad con VisualSettings. * Intervalos de actualización del recurso. * Comando local de limpieza de efectos. ### Compatibilidad visual recomendada Si tu servidor utiliza VisualSettings u otro recurso que controla iluminación, color grading o timecycles, se recomienda mantener: `VisualSettingsCompatibility = true` Esto evita que TX Effects tome control del timecycle nocturno y reduce conflictos visuales con otros recursos.

## Cambios y mejoras — v2.0.0 * Reestructuración completa del recurso para mejorar estabilidad y mantenimiento. * Implementación funcional del sistema de Low Health. * Añadido umbral de recuperación para evitar activaciones repetitivas cerca del límite de salud. * Nuevo sistema de adrenalina activable mediante eventos y exports. * Añadido incremento temporal de velocidad durante adrenalina. * Añadido camera shake configurable para adrenalina. * Añadido sistema de feedback de tormenta basado en el nivel de lluvia. * Mejora configurable de iluminación para vehículos. * Mejora adicional de iluminación para vehículos de emergencia. * Añadido efecto de cámara configurable cuando una sirena de emergencia está activa. * Añadido soporte opcional para timecycle nocturno. * Nuevo modo `VisualSettingsCompatibility` para reducir conflictos con recursos visuales externos. * Añadido sistema de limpieza automática al detener o reiniciar el recurso. * Restauración automática de velocidad del jugador. * Restauración automática de multiplicadores de luces. * Limpieza de estados de Low Health y Adrenaline. * Añadido comando local `/clearfx`. * Añadido comando administrativo `/txfx_clearall`. * Protección del comando global mediante ACE Permissions. * Añadidos exports para integración con otros recursos. * Añadidas funciones para consultar el estado de Low Health y Adrenaline. * Configuración centralizada y ampliada mediante `config.lua`. * Eliminadas dependencias innecesarias. * Recurso completamente standalone. * Mejor compatibilidad con servidores QBCore, ESX, Qbox y configuraciones personalizadas. * Mejor organización del código para facilitar futuras ampliaciones.

## Notas adicionales * TX Effects es un recurso standalone y puede utilizarse en servidores con o sin framework. * El recurso no controla el clima del servidor. * El sistema de tormenta utiliza el nivel de lluvia existente únicamente como condición para activar feedback de cámara. * La versión actual no genera rayos visuales ni flashes de relámpagos. * El sistema nocturno es opcional y puede desactivarse completamente. * Si utilizas VisualSettings u otro recurso que controle iluminación, color grading o timecycles, se recomienda mantener `VisualSettingsCompatibility = true`. * Los efectos de adrenalina pueden ser activados desde otros scripts mediante eventos o exports. * Los valores incluidos en `config.lua` pueden ajustarse según el estilo y necesidades de cada servidor. * El comando `/txfx_clearall` requiere los permisos ACE correspondientes para ser utilizado. * No requiere base de datos ni conexión externa. * No realiza llamadas HTTP, descargas remotas ni conexiones a servicios externos. * Se recomienda probar cualquier cambio de configuración en un entorno de staging antes de utilizarlo en producción. * Para evitar conflictos, no se recomienda utilizar simultáneamente varios recursos que controlen los mismos efectos de cámara, timecycles o multiplicadores visuales sin revisar su compatibilidad. * Después de actualizar TX Effects, se recomienda reiniciar el recurso o el servidor para asegurar que todos los estados y configuraciones se carguen correctamente. * La integración con sistemas médicos, drogas, objetos, misiones u otros recursos personalizados depende de cómo esos scripts utilicen los eventos y exports proporcionados por TX Effects.