Docs /Data /Script /Lua: eventos (BridgeFunctions)

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 un BridgeFunction_, el evento deja de llegar a todos los scripts.

Lista de eventos

EventoParámetrosDevuelveCuá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.
OnCommandManageraIndex jugador
code número del comando
arg 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.
OnCommandDoneaIndex jugador
code número del comando
—Después de ejecutar un comando.
OnCharacterEntryaIndex jugador—Al entrar al juego con un personaje.
OnCharacterCloseaIndex jugador—Al salir del juego con un personaje (cambio de personaje, desconexión o cierre).
OnNpcTalkaIndex NPC
bIndex 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.
OnMonsterDamagedaIndex monstruo
bIndex atacante
damage daño calculado
finalDamage daño aplicado
—Cada vez que un monstruo recibe daño.
OnMonsterDieaIndex monstruo
bIndex el que lo mató
—Al morir un monstruo.
OnUserDieaIndex jugador que murió
bIndex el que lo mató (jugador o monstruo)
—Al morir un jugador.
OnUserMoveaIndex jugador
MapIndex mapa de destino
—Al cambiar de mapa (move, gate o teleport).
OnUserRespawnaIndex jugador
KillerType 0 monstruo, 1 jugador, 2 guerra de guild, 3 duelo
—Cuando el jugador va a revivir después de morir.
OnCheckUserTargetaIndex atacante
bIndex 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.
OnCheckUserKilleraIndex asesino
bIndex víctima
1 si queda como asesino (PK), 0 para que no.Al matar un jugador a otro.
OnUserItemPickaIndex jugador
slot 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.
OnUserItemDropaIndex jugador
slot casillero del inventario
x, 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.
OnUserItemMoveaIndex jugador
aFlag, aSlot origen
bFlag, 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.
OnPartyEntryaIndex jugador
index número de party
—Al entrar a una party (también el que la crea).
OnPartyCloseaIndex jugador
index número de party
—Al salir de una party o cuando se disuelve.
OnSQLAsyncResultlabel etiqueta
param parámetro
result 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
Devolver siempre un valor: en 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.