Scripts Lua - Eventos (BridgeFunctions)
Los eventos son el camino del GameServer hacia el script: cuando pasa algo en el juego (entra un personaje, muere un monstruo, alguien escribe un comando…) el GameServer llama a la función BridgeFunction_<Evento> de System\ScriptCore.lua, y esta llama a todas las funciones que se engancharon a ese evento.
Engancharse a un evento
BridgeFunctionAttach('OnCharacterEntry','MiScript_OnCharacterEntry')
function MiScript_OnCharacterEntry(aIndex)
NoticeSend(aIndex, 0, "Bienvenido " .. GetObjectName(aIndex))
end
BridgeFunctionAttach(Evento, NombreFuncion): el nombre de la función va como texto. La misma función no se engancha dos veces al mismo evento.- Varios scripts pueden engancharse al mismo evento; se llaman en el orden en que se cargaron en
ScriptMain.lua. - En los eventos que devuelven un valor, el resultado se combina entre todos los scripts como dice la columna Devuelve.
- No modifiques
ScriptCore.lua: si falta unBridgeFunction_, el evento deja de llegar a todos los scripts.
Lista de eventos
| Evento | Parámetros | Devuelve | Cuándo se llama |
|---|---|---|---|
OnReadScript | — | — | Al cargar los scripts: cuando arranca el GameServer y después de cada /reload. |
OnShutScript | — | — | Antes de recargar los scripts. Sirve para guardar datos o cerrar conexiones SQL. |
OnTimerThread | — | — | Cada 1 segundo. Para relojes, eventos por horario, etc. |
OnCommandManager | aIndex jugadorcode número del comandoarg texto escrito después del comando | 1 si el script manejó el comando, 0 si no. Si un script no devuelve 0, los siguientes no se llaman. | Al escribir un comando válido de CommandManager. Los argumentos se leen con CommandGetArgNumber y CommandGetArgString. |
OnCommandDone | aIndex jugadorcode número del comando | — | Después de ejecutar un comando. |
OnCharacterEntry | aIndex jugador | — | Al entrar al juego con un personaje. |
OnCharacterClose | aIndex jugador | — | Al salir del juego con un personaje (cambio de personaje, desconexión o cierre). |
OnNpcTalk | aIndex NPCbIndex jugador | 1 si el script manejó la charla (el NPC no abre su ventana normal), 0 si no. | Al hablar con un NPC. Con GetObjectClass(aIndex) sabés qué NPC es. |
OnMonsterDamaged | aIndex monstruobIndex atacantedamage daño calculadofinalDamage daño aplicado | — | Cada vez que un monstruo recibe daño. |
OnMonsterDie | aIndex monstruobIndex el que lo mató | — | Al morir un monstruo. |
OnUserDie | aIndex jugador que murióbIndex el que lo mató (jugador o monstruo) | — | Al morir un jugador. |
OnUserMove | aIndex jugadorMapIndex mapa de destino | — | Al cambiar de mapa (move, gate o teleport). |
OnUserRespawn | aIndex jugadorKillerType 0 monstruo, 1 jugador, 2 guerra de guild, 3 duelo | — | Cuando el jugador va a revivir después de morir. |
OnCheckUserTarget | aIndex atacantebIndex objetivo | 1 si puede atacarlo, 0 para impedirlo. Con que un script devuelva 0, no se ataca. | Antes de que un jugador ataque a otro. |
OnCheckUserKiller | aIndex asesinobIndex víctima | 1 si queda como asesino (PK), 0 para que no. | Al matar un jugador a otro. |
OnUserItemPick | aIndex jugadorslot número del ítem en el piso del mapa | 1 si lo puede levantar, 0 para impedirlo. | Al levantar un ítem del piso. MapGetItemTable(aIndex, slot) devuelve sus datos. |
OnUserItemDrop | aIndex jugadorslot casillero del inventariox, y posición en el mapa | 1 si lo puede tirar, 0 para impedirlo. | Al tirar un ítem al piso. InventoryGetItemTable(aIndex, slot) devuelve sus datos. |
OnUserItemMove | aIndex jugadoraFlag, aSlot origenbFlag, bSlot destino | 1 si lo puede mover, 0 para impedirlo. | Al mover un ítem. Flag: 0 inventario, 1 trade, 2 baúl, 3 Chaos Box, 4 tienda personal, 5 a 20 otras ventanas de mix. |
OnPartyEntry | aIndex jugadorindex número de party | — | Al entrar a una party (también el que la crea). |
OnPartyClose | aIndex jugadorindex número de party | — | Al salir de una party o cuando se disuelve. |
OnSQLAsyncResult | label etiquetaparam parámetroresult 1 si la consulta anduvo y trajo al menos una fila, 0 si no | — | Al terminar una consulta de SQLAsyncQuery. label y param son los que le pasaste a la consulta; la primera fila ya está leída y sus columnas se leen con SQLAsyncGetNumber, SQLAsyncGetSingle y SQLAsyncGetString. |
Ejemplo: bloquear el PvP en un mapa
BridgeFunctionAttach('OnCheckUserTarget','NoPvP_OnCheckUserTarget')
function NoPvP_OnCheckUserTarget(aIndex, bIndex)
if GetObjectMap(aIndex) == 0 then
return 0
end
return 1
end
OnCommandManager y OnNpcTalk cualquier valor que no sea 0, incluso no devolver nada, cuenta como "lo manejó el script": el comando o el NPC dejan de funcionar normal. Terminá esas funciones con return 0 cuando no hacen nada.
En los de chequeo (OnCheckUserTarget, OnCheckUserKiller, OnUserItemPick, OnUserItemDrop, OnUserItemMove) solo un return 0 bloquea; igual conviene terminar con return 1.
Las funciones que se pueden usar dentro de los eventos están en Scripts Lua - Funciones.