Editing your datapack

What are the languages used

There are two main languages used when working with TFS: XML and Lua. Depending on your knowledge, you may also want to edit the sources, which would mean you would have to work with C++ as well. XML is a markup language that lets you register Lua scripts and store information, while Lua is used for scripting and interacting with the game world. You can start learning Lua with Programming in Lua or Stigma's Lua guide.

TFS scripting interface

There are a few main functions that are needed when creating scripts.

The current scripting interfaces are: Actions, Chatchannels, Creaturescripts, Events, Globalevents, Monsters, Movements, Npc, Spells, Talkactions and Weapons.

For scripting purposes, you should use some reference or memorize the main functions used in these interfaces:


function onUse(player, item, fromPosition, target, toPosition, isHotkey)


function canJoin(player)
function onSpeak(player, type, message)


function onLogin(player)
function onLogout(player)
function onThink(creature, interval)
function onPrepareDeath(creature, killer)
function onDeath(creature, corpse, killer, mostDamageKiller, lastHitUnjustified)
function onKill(creature, target)
function onAdvance(player, skill, oldLevel, newLevel)
function onModalWindow(player, modalWindowId, buttonId, choiceId)
function onTextEdit(player, item, text)
function onHealthChange(creature, attacker, primaryDamage, primaryType, secondaryDamage, secondaryType, origin)
function onManaChange(creature, attacker, manaChange, origin)
function onExtendedOpcode(player, opcode, buffer)


function onThink(interval)
function onStartup()
function onShutdown()
function onRecord(current, old)
function onTime()


function onThink(interval)
function onCreatureMove(creature, newTile, newPos, oldTile, oldPos, teleport)
function onCreatureDisappear(creature, isLogout)
function onCreatureAppear(creature, isLogin)
function onCreatureSay(creature, type, text)


function onStepIn(creature, item, toPosition, fromPosition)
function onStepOut(creature, item, toPosition, fromPosition)
function onEquip(player, item, slot)
function onDeEquip(player, item, slot)
function onAddItem(moveitem, tileitem, pos)
function onRemoveItem(moveitem, tileitem, pos)


function onCreatureAppear(cid)
function onCreatureDisappear(cid)
function onCreatureSay(cid, type, msg)
function onThink()


function onCastSpell(creature, variant)


function onSay(player, words, param)


function onUseWeapon(player, variant)

Last updated