Docs /Data /Script /Lua: funciones (Interface Functions)

Scripts Lua - Funciones (Interface Functions)

Las funciones que el GameServer le da a los scripts para leer y cambiar el juego. Se usan dentro de los eventos. Están en SSeMU 2 y SSeMU 2 S6 salvo las marcadas.

Cómo leer las tablas: aIndex es el índice de un objeto (jugador, monstruo o NPC), el que llega en los eventos. Los parámetros entre corchetes son opcionales y llevan su valor por defecto. Si el índice no es válido, la función no hace nada y devuelve nil. Los textos se escriben en UTF-8, como el resto del script.

Servidor y objetos

FunciónDevuelveQué hace
GET_ITEM(grupo, numero)númeroEl índice de un ítem (grupo × 512 + número). Es el que piden las funciones de ítems.
CheckObject(aIndex)1 / 01 si es un jugador conectado y dentro del juego.
GetMaxIndex()númeroCantidad total de objetos.
GetMinUserIndex() / GetMaxUserIndex()númeroPrimer y último índice de jugadores. Para recorrer a todos: for i = GetMinUserIndex(), GetMaxUserIndex() - 1 do.
GetMinMonsterIndex() / GetMaxMonsterIndex()númeroRango de índices de monstruos.
GetGameServerCode()númeroServerCode del GameServer.
GetGameServerLang()númeroIdioma del servidor.
GetGameServerVersion()númeroVersión del GameServer (ej. 603 en S6).
GetGameServerProtocol() Solo SSeMU 2númeroProtocolo del cliente.
GetGameServerCurUser() / GetGameServerMaxUser()númeroJugadores conectados y máximo del servidor.
GetLicenseId() / GetLicenseCustomerName()número / textoDatos de la licencia.
GetObjectIndexByName(nombre)númeroÍndice del personaje conectado con ese nombre, o −1.
GetItemName(grupo, numero)textoNombre del ítem.
GetMapName(mapa)textoNombre del mapa.
GetMonsterName(clase)textoNombre del monstruo de MonsterList.
RandomGetNumber(max)númeroNúmero al azar de 0 a max − 1.

Personaje: leer

Todas reciben aIndex y devuelven un número, salvo las que dicen texto.

FunciónDevuelve
GetObjectConnectedEstado de conexión (0 desconectado, 1 conectado, 2 con la cuenta logueada, 3 en el juego).
GetObjectIpAddress / GetObjectHardwareIdTexto: IP y HardwareId.
GetObjectLangIdioma del jugador (para MessageGet).
GetObjectTypeTipo de objeto: 1 jugador, 2 monstruo, 3 NPC.
GetObjectAccount / GetObjectPassword / GetObjectName / GetObjectPersonalCodeTexto: cuenta, clave, nombre y código personal.
GetObjectClassClase del personaje, o número de monstruo/NPC.
GetObjectChangeTransformación (anillo o skin), la que cambia SkinChangeSend.
GetObjectChangeUpEvolución de la clase: 0 clase base, 1 segunda clase, 2 tercera clase.
GetObjectLevel / GetObjectLevelUpPointNivel y puntos libres.
GetObjectTotalLevelNivel + master level (en SSeMU 2, el nivel).
GetObjectMasterLevel / GetObjectMasterPoint Solo SSeMU 2 S6Master level y puntos master.
GetObjectReset / GetObjectMasterResetResets y master resets.
GetObjectMoneyZen.
GetObjectStrength, Dexterity, Vitality, Energy, LeadershipStat base (ej. GetObjectStrength).
GetObjectExtraStrength … GetObjectExtraLeadershipStat extra (ítems, buffs).
GetObjectTotalStrength … GetObjectTotalLeadershipBase + extra.
GetObjectDefaultStrength … GetObjectDefaultLeadershipStat inicial de la clase.
GetObjectLive1 vivo, 0 muerto.
GetObjectLife / GetObjectMaxLifeVida actual y máxima.
GetObjectMana / GetObjectMaxManaManá actual y máximo.
GetObjectBP / GetObjectMaxBPAG actual y máximo.
GetObjectShield / GetObjectMaxShieldSD actual y máximo.
GetObjectDefenseDefensa.
GetObjectPKCount / GetObjectPKLevel / GetObjectPKTimerAsesinatos, nivel de PK y tiempo de PK.
GetObjectKillCount / GetObjectDeathCountKills y muertes.
GetObjectDuelÍndice del rival de duelo, o −1.
GetObjectMap / GetObjectMapX / GetObjectMapYMapa y posición.
GetObjectDeathMap / GetObjectDeathMapX / GetObjectDeathMapYDónde murió por última vez.
GetObjectAuthorityAutoridad (GM).
GetObjectAccountLevelVIP: 0 Free, 1 a 3 VIP.
GetObjectAccountExpireDateTexto: fecha en que vence el VIP.
GetObjectPartyNumberNúmero de party, o −1.
GetObjectGuildNumber / GetObjectGuildStatus / GetObjectGuildNameNúmero de guild, rango en la guild y nombre (texto).
GetObjectGuildRelationship(aIndex, bIndex)Relación entre las guilds de los dos: 0 ninguna, 1 unión, 2 rival.
GetObjectGuildUnionNumber / GetObjectGuildUnionNameNúmero y nombre (texto) de la unión.
GetObjectGensRank, GensSymbol, GensFamily, GensContribution Solo SSeMU 2 S6Datos de Gens.
GetObjectCSGuildSideBando en Castle Siege.
GetObjectInterfaceVentana abierta: 0 ninguna, 1 trade, 2 party, 3 tienda, 4 guild, 6 baúl, 7 Chaos Box, 8 tienda personal…
GetObjectOfflineFlag1 si está en modo offline (helper o tienda), 0 si no.

Personaje: cambiar

Cambian el valor en el servidor. Para que el jugador lo vea, llamá después a UserCalcAttribute y UserInfoSend (o la función de envío que corresponda).

FunciónQué hace
SetObjectLevel(aIndex, nivel)Nivel. Después LevelUpSend.
SetObjectLevelUpPoint(aIndex, puntos)Puntos libres (mínimo 0).
SetObjectMoney(aIndex, zen)Zen (de 0 al máximo). Después MoneySend.
SetObjectStrength, Dexterity, Vitality, Energy, Leadership (aIndex, valor)Stat base, entre el inicial de la clase y el máximo de su VIP.
SetObjectMasterLevel(aIndex, nivel) / SetObjectMasterPoint(aIndex, puntos) Solo SSeMU 2 S6Master level y puntos master. Después MasterLevelUpSend.
SetObjectPKCount / SetObjectPKLevel / SetObjectPKTimer (aIndex, valor)Datos de PK. Para el color del nombre, PKLevelSend.
SetObjectMap / SetObjectMapX / SetObjectMapY (aIndex, valor)Cambia el dato sin mover al jugador; para moverlo usá MoveUser o MoveUserEx.
SetObjectChatLimitTime(aIndex, minutos)Silencia el chat por ese tiempo.
SetObjectSkillBlockTime(aIndex, skill, milisegundos)No deja usar ese skill por ese tiempo.
SetObjectWindowTitle(aIndex, texto)Cambia el título de la ventana del cliente.
SkinChangeSend(aIndex, skin)Transforma al personaje (como un anillo) y lo muestra a todos.
CharacterGetRespawnLocation(aIndex)Calcula dónde revive (útil en OnUserRespawn).
UserCalcAttribute(aIndex)Recalcula daño, defensa, vida, etc.
UserInfoSend(aIndex)Manda al cliente los datos del personaje y los guarda.
LevelUpSend(aIndex) / MoneySend(aIndex, zen) / PKLevelSend(aIndex, nivel)Manda al cliente el nivel, el zen y el nivel de PK.
MasterLevelUpSend(aIndex) Solo SSeMU 2 S6Manda el master level.
MasterSkillTreeRebuild(aIndex, tipo) Solo SSeMU 2 S6Resetea el árbol de skills master.
UserActionSend(aIndex, bIndex, accion)Hace que el personaje haga una acción (saludo, etc.) hacia bIndex.
UserSetAccountLevel(aIndex, vip, segundos)Pone el VIP (0 a 3) por esa cantidad de segundos y se lo avisa al jugador.
UserGameLogout(aIndex, tipo)Lo saca a los 5 segundos: 0 cierra el juego, 1 selección de personaje, 2 selección de servidor.
UserDisconnect(aIndex)Lo desconecta en el acto.
PermissionCheck(aIndex, n) / PermissionInsert(aIndex, n) / PermissionRemove(aIndex, n)Banderas propias del script por jugador (se borran al salir). Check devuelve 1 / 0.
QuestStateCheck(aIndex, quest)1 si terminó esa quest.

Mensajes

FunciónQué hace
NoticeSend(aIndex, tipo, texto)Aviso a un jugador. Tipo 0 = dorado en el centro, 1 = azul.
NoticeSendToAll(tipo, texto)Aviso a todos los del GameServer.
NoticeGlobalSend(tipo, texto)Aviso a todos los GameServers del grupo.
MessageSend(aIndex, tipo, color, texto)Mensaje con tipo y color, como los de Message.txt.
MessageSendToAll(tipo, color, texto) / MessageGlobalSend(tipo, color, texto)Lo mismo a todo el GameServer o a todo el grupo.
ChatTargetSend(aIndex, bIndex, texto)Hace que aIndex (un NPC o monstruo) "hable" sobre su cabeza. Con bIndex = −1 lo ven todos los jugadores cercanos.
PostSend(tipo, mensaje, nombre, texto)Post a todo el servidor con el formato del mensaje mensaje de Message.txt. Tipo 0 a 3: estilo del post.
MessageGet(numero, idioma)Texto de Message.txt en ese idioma (usá GetObjectLang).
FireworksSend(aIndex, x, y)Fuegos artificiales. Con −1 usa la posición del jugador.

Comandos y configuración

FunciónDevuelveQué hace
CommandGetArgNumber(arg, n)númeroEl argumento número n (desde 0) del texto del comando.
CommandGetArgString(arg, n)textoLo mismo, como texto.
CommandCheckGameMasterLevel(aIndex, nivel)1 / 01 si el jugador es GM de ese nivel o más.
CommandSend(aIndex, texto)—Ejecuta un comando como si lo escribiera el jugador (ej. "/move lorencia").
ConfigReadNumber(seccion, clave, archivo)númeroLee un .ini (0 si no existe).
ConfigReadString(seccion, clave, archivo)textoLee un .ini.
ConfigSaveString(seccion, clave, valor, archivo)—Escribe en un .ini.
LogPrint(texto)—Escribe en el log de scripts.
LogColor(color, texto)—Escribe en la ventana del GameServer: 0 negro, 1 rojo, 2 verde, 3 azul.
LogConsole(color, texto)—Escribe en la consola del GameServer.

Ítems e inventario

FunciónDevuelveQué hace
ItemGive(aIndex, bolsa)—Da un ítem al azar de la bolsa (ItemBag con ese SpecialValue).
ItemDrop(aIndex, mapa, x, y, bolsa)—Tira al piso un ítem de la bolsa, para aIndex.
ItemGiveEx(aIndex, item, nivel, durabilidad, skill, suerte, opcion, excelente, [ancient=0], [harmony=0], [opcion380=0], [socket1..5=255], [socketBonus=255], [duracion=0])—Da un ítem armado a mano. item = GET_ITEM(g, n). duracion en segundos (0 = permanente). Los sockets solo se usan en S6.
ItemDropEx(aIndex, mapa, x, y, item, nivel, durabilidad, skill, suerte, opcion, excelente, [ancient=0], [harmony=0], [opcion380=0], [socket1..5=255], [socketBonus=255], [duracion=0], [dueño=aIndex])—Tira al piso un ítem armado a mano. dueño = índice de quien lo puede levantar primero.
InventoryGetWearSize() / InventoryGetMainSize() / InventoryGetFullSize()númeroCasilleros de equipo, del inventario y total.
InventoryGetItemIndex(aIndex, slot)número o nilÍndice del ítem en ese casillero (nil si está vacío).
InventoryGetItemTable(aIndex, slot)tabla o nilDatos del ítem: Serial, Index, Level, Durability, Option1 (skill), Option2 (suerte), Option3 (opción), NewOption (excelente), SetOption, JoHOption, 380Option, SocketOption1..5, SocketOptionBonus.
MapGetItemTable(aIndex, slot)tabla o nilLo mismo para un ítem del piso del mapa del jugador (el slot de OnUserItemPick).
InventoryGetItemCount(aIndex, item, nivel)númeroCuántos tiene de ese ítem (nivel −1 = cualquiera).
InventoryDelItemCount(aIndex, item, nivel, cantidad)—Le saca esa cantidad.
InventoryDelItemIndex(aIndex, slot)—Borra el ítem de ese casillero.
InventoryGetFreeSlotCount(aIndex)númeroCasilleros libres.
InventoryCheckSpaceByItem(aIndex, item)1 / 01 si entra ese ítem.
InventoryCheckSpaceBySize(aIndex, ancho, alto)1 / 01 si hay lugar de ese tamaño.

Monedas y efectos

FunciónDevuelveQué hace
ObjectGetCoin(aIndex)tablaCoin1 WCoin, Coin2 WCoinP, Coin3 Goblin Points.
ObjectAddCoin(aIndex, wcoin, wcoinp, goblin)—Suma monedas.
ObjectSubCoin(aIndex, wcoin, wcoinp, goblin)—Resta monedas.
EffectAdd(aIndex, modo, efecto, tiempo, valor1, valor2, valor3, valor4)—Agrega un efecto de EffectList. Modo 0: tiempo en segundos de juego; modo 1: tiempo en segundos reales (sigue corriendo aunque salga).
EffectDel(aIndex, efecto)—Saca un efecto.
EffectCheck(aIndex, efecto)1 / 01 si tiene el efecto.
EffectClear(aIndex)—Saca todos los efectos.

Mundo y monstruos

FunciónDevuelveQué hace
MoveUser(aIndex, gate)—Lo mueve a un gate de Gate.txt.
MoveUserEx(aIndex, mapa, x, y)—Lo teletransporta a esa posición.
MapCheckAttr(mapa, x, y, atributo)1 / 01 si ese punto tiene el atributo del .att (1 zona segura, 2 ocupado, 4 bloqueado, 8 hueco, 16 agua).
MonsterCreate(clase, mapa, x, y, direccion)númeroCrea un monstruo y devuelve su índice. Dirección −1 = al azar.
MonsterDelete(aIndex)—Borra un monstruo creado.
MonsterCount(clase, mapa, [x=1], [y=1], [tx=255], [ty=255])númeroCuántos monstruos de esa clase hay en el mapa (o en ese rectángulo).
MonsterSummonCreate(aIndex, clase, vida, defensa, defRate, daño, ataqueRate)númeroInvoca un monstruo que pelea para el jugador. Los cinco últimos son % extra. Si ya tenía uno, lo saca.
MonsterSummonDelete(aIndex)—Saca la invocación del jugador.

Party

FunciónDevuelveQué hace
PartyGetMemberCount(party)númeroIntegrantes de la party (GetObjectPartyNumber).
PartyGetMemberIndex(party, n)númeroÍndice del integrante n (desde 0), o −1.
PartyCreate(aIndex)true / falseCrea una party con el jugador de líder.
PartyDestroy(party)true / falseDisuelve la party.
PartyAddMember(party, aIndex) / PartyDelMember(party, aIndex)true / falseAgrega o saca un integrante.

Base de datos

Hay dos conexiones independientes: la normal (espera la respuesta, frena el GameServer mientras tanto) y la asíncrona (la respuesta llega en el evento OnSQLAsyncResult). Para consultas que pueden tardar, usá la asíncrona.

FunciónDevuelveQué hace
SQLConnect(odbc, usuario, clave) / SQLAsyncConnect(…)1 / 0Conecta con un ODBC.
SQLCheck() / SQLAsyncCheck()1 / 01 si está conectado.
SQLDisconnect() / SQLAsyncDisconnect()—Cierra la conexión.
SQLQuery(consulta)1 / 0Ejecuta la consulta.
SQLFetch()1 / 0Lee la fila siguiente (0 cuando no hay más).
SQLGetResult(n)númeroValor de la columna n (desde 0) de la fila actual.
SQLGetNumber(columna) / SQLGetSingle(columna) / SQLGetString(columna)número / decimal / textoValor de la columna por nombre.
SQLClose()—Termina de leer la consulta. Llamala siempre después de SQLQuery.
SQLAsyncQuery(consulta, [etiqueta=""], [param=""])—Manda la consulta a la cola. Al terminar llama a OnSQLAsyncResult(etiqueta, param, resultado).
SQLAsyncGetResult(n), SQLAsyncGetNumber, SQLAsyncGetSingle, SQLAsyncGetStringigual que arribaLeen la fila dentro de OnSQLAsyncResult.

Ejemplo: comando /premio con consulta SQL

BridgeFunctionAttach('OnReadScript','Premio_OnReadScript')
BridgeFunctionAttach('OnCommandManager','Premio_OnCommandManager')
BridgeFunctionAttach('OnSQLAsyncResult','Premio_OnSQLAsyncResult')

function Premio_OnReadScript()
	SQLAsyncConnect("MuOnline", "sa", "clave")
end

function Premio_OnCommandManager(aIndex, code, arg)

	if code ~= 100 then
		return 0
	end

	local Account = GetObjectAccount(aIndex)

	SQLAsyncQuery(string.format("SELECT Premio FROM PremioTable WHERE AccountID='%s'", Account), "Premio", tostring(aIndex))

	return 1

end

function Premio_OnSQLAsyncResult(label, param, result)

	if label ~= "Premio" then
		return
	end

	local aIndex = tonumber(param)

	if result == 0 or CheckObject(aIndex) == 0 then
		return
	end

	ObjectAddCoin(aIndex, SQLAsyncGetNumber("Premio"), 0, 0)

	NoticeSend(aIndex, 1, "Recibiste tu premio")

end
Cuidado con las comillas: si metés en una consulta un texto que escribe el jugador (por ejemplo, un argumento de comando), sacale las comillas simples antes, para que no pueda alterar la consulta.