List of Lua Functions/revscriptsys

From OpenTibia Fans

This function list applies only to revscriptsys, for the standard function list. See List of Lua Functions.

A list of all functions available in OT.

Contents 1 Built-in Functions 1.1 String Functions 1.2 Table Functions 1.3 Coroutine Functions 1.4 Math Functions 1.5 IO Functions 1.6 OS functions 1.7 Debug Functions 2 System Functions 3 Game Functions 4 Classes 4.1 Event 4.2 Thing 4.3 Creature 4.4 Actor 4.5 Player 4.6 Item 4.7 Container 4.8 Map 4.9 Tile 4.10 House 4.11 Waypoint 4.12 Channel

Built-in Functions

For undocumented functions look at the builtin lua function list.

String Functions

• string.byte(string s [, int i [, int j] ] )
• string.char(...)
• string.dump(function f)
• string.find(string s, string pattern [, init [, plain] ] )
• string.format(string format, ...)
• string.gmatch(string s, string pattern)
• string.gsub(string s, string pattern, mixed replacement [, int n] )
• string.len(string s)
• string.lower(string s)
• string.match(string s, string pattern [, int n] ))
• string.rep(string s, int n)
• string.reverse(string s)
• string.sub(string s, int i [, int j] ))
• string.upper(string s)

Table Functions

• table.append(table t, mixed value)
• table.concat(table t [, string seperator [, int i [, int j] ] ] )
• table.empty(table)
• table.find(table t, mixed value)
• table.findf(table t, mixed value[, function comparator])
• table.insert(table t, [int pos], mixed value)
• table.maxn(table t)
• table.remove(table t [, int pos] )
• table.serialize(table t)
• table.sort(table t [, function comparator] )
• table.unserialize(table t)

Coroutine Functions

• coroutine.create(function f)
• coroutine.resume(coroutine co, ...)
• coroutine.running()
• coroutine.status(coroutine co)
• coroutine.wrap(function f)
• coroutine.yield(...)

Math Functions

• math.abs(float x)
• math.acos(float x)
• math.asin(float x)
• math.atan(float x)
• math.atan2(float y, float x)
• math.ceil(float x)
• math.cos(float x)
• math.cosh(float x)
• math.deg(float x)
• math.exp(float x)
• math.floor(float x)
• math.fmod(float x, float y)
• math.frexp(float x)
• math.ldexp(float m, float e)
• math.log(float x)
• math.log10(float x)
• math.max(float x, ...)
• math.min(float x, ...)
• math.modf(float x)
• math.pow(float x, float y)
• math.rad(float x)
• math.random([float from [, float to] )
• math.randomseed(float x)
• math.sin(float x)
• math.sinh(float x)
• math.sqrt(float x)
• math.tan(float x)
• math.tanh(float x)

IO Functions

• io.close( [file f] )
• io.flush()
• io.input( [file f] )
• io.lines( [string filename])
• io.open(string filename [, string mode] )
• io.output([file f] )
• io.popen(string prog [, string mode] )
• io.read(...)
• io.tmpfile()
• io.type(file f)
• io.write(...)
• file.close()
• file.flush()
• file.lines()
• file.read(...)
• file.seek([string mode] [, int offset] )
• file.setvbuf(string mode [, int size] )
• file.write(...)

OS functions

• os.clock()
• os.date([string format [, int time] ] )
• os.difftime(int t2, int t1)
• os.execute( [string command] )
• os.exit( [int code] )
• os.getenv(string var)
• os.remove(string path)
• os.rename(string old, string new)
• os.setlocale(string locale [, string category] )
• os.time( [table t] )
• os.tmpname()

Debug Functions

It is not really recommended to use these functions. They are internally by OpenTibia for error messages etc.

• debug.debug()
• debug.dump(mixed x)
• debug.getfenv( [coroutine co] )
• debug.gethook( [coroutine co] )
• debug.getinfo( [coroutine co,] function f [, string what] )
• debug.getlocal( [coroutine co,] int level, int stackindex)
• debug.getmetatable(mixed object)
• debug.getregistry()
• debug.getupvalue(function f, int index)
• debug.setfen(mixed objcet, table t)
• debug.sethook( [coroutine co,] function hook, string mask [, int count] )
• debug.setlocal( [coroutine co,] int level, int localindex, mixed value)
• debug.setmetatable(mixed object, table t)
• debug.setupvalue(function f, int upindex, mixed value)
• debug.traceback( [coroutine co,] [message] [, level] )

System Functions

System functions are not directly related to the game, but rather deal with internal state and script handling.

• stopListener(string ID)
• wait(int milliseconds)
• getConfigValue(string name)
• typeof(object instance, string class)

Game Functions

Functions that are not invoked on an object.

• getWorldType()

• getWorldTime()

• getWorldUpTime()

• sendMagicEffect(Position pos, MagicEffect effect)

• sendDistanceEffect([Creature c, ] Position from, Position to, ShootEffect effect)

• sendAnimatedText(Position pos, Color color, string text)

• sendMail(Item item, mixed player[, mixed town])

• sendMailTo(Item item, string playername[, Town town])

Classes

Event

Events are issued when something happends on the server, for more information, see Event Handling.

• Event.propagate()
• Event.skip()

Thing

Functions that can be applied to Thing objects.

• Thing.destroy()

• Thing.getCustomValue(string key)

• Thing.getName()

• Thing.getParent()

• Thing.getPosition()

• Thing.getDescription(int lookdistance)

• Thing.getParentTile()

• Thing.getRawCustomValue(string key)

• Thing.getStorageValue(string key)

• Thing.isMoveable()

• Thing.moveTo(Position pos)

• Thing.teleportTo(Position pos)

• Thing.setCustomValue(string key, mixed value)

• Thing.setRawCustomValue(string key, string value)

• Thing.setStorageValue(string key, mixed value)

Creature

Creature objects inherit from Thing objects, that is, all Thing functions can be used on Creature objects.

• Creature.addHealth(int howmuch)

• Creature.addSummon(Actor summon)

• Creature.getArmor()

• Creature.getBaseSpeed()

• Creature.getConditionImmunities()

• Creature.getDamageImmunities()

• Creature.getDefense()

• Creature.getDirection()

• Creature.getHealth()

• Creature.getHealthMax()

• Creature.getOrientation()

• Creature.getMaster()

• Creature.getTarget()

• Creature.getZone()

• Creature.isImmuneToCombat(int combattype)

• Creature.isImmuneToCondition(int conditiontype)

• Creature.getSpeed()

• Creature.isSummon()

• Creature.isPlayerSummon()

• Creature.isPushable()

• Creature.removeHealth(int howmuch)

• Creature.say(string message)

• Creature.setHealth(int newval)

• Creature.walk(Direction dir)

Actor

Actors are creatures that have an AI.

• createActor(string name, position where)

• createMonster(string monstertype, position where)

• Actor.closeShop(Player who)

• Actor.getAlwaysThink()

• Actor.getCanBeAttacked()

• Actor.getCanBeLured()

• Actor.getCanPushCreatures()

• Actor.getCanPushItems()

• Actor.getCorpseId()

• Actor.getExperienceWorth()

• Actor.getFleeHealth()

• Actor.getLightLevel()

• Actor.getLightColor()

• Actor.getManaCost()

• Actor.getMaxSummons()

• Actor.getRace()

• Actor.getShouldReload()

• Actor.getStaticAttackChance()

• Actor.getTargetDistance()

• Actor.isConvinceable()

• Actor.isIllusionable()

• Actor.isSummonable()

• Actor.openShop(Player who, table list)

• Actor.setAlwaysThink(boolean alwaysthink)

• Actor.setArmor(int newarmor)

• Actor.setPushable(bool pushable)

• Actor.setBaseSpeed(int newbasespeed)

• Actor.setCanBeAttacked(boolean isAttackable)

• Actor.setCanBeLured(boolean isLureable)

• Actor.setCanPushCreatures(int newvalue)

• Actor.setCanPushItems(int newvalue)

• Actor.setDefense(int newdefense)

• Actor.setExperienceWorth(int newexp)

• Actor.setFleeHealth(int health)

• Actor.setLightLevel(int newlightlevel)

• Actor.setLightColor(int newlightcolor-)

• Actor.setMaxHealth(int newmaxhealth)

• Actor.setMaxSummons(int newsummons)

• Actor.setName(string newname)

• Actor.setRace(int racetype)

• Actor.setShouldReload(boolean shouldreload)

• Actor.setSpeed(int newspeed)

• Actor.setStaticAttackChance(int chance)

• Actor.setTarget(Creature target)

• Actor.setTargetDistance(int newtargetdistance)

Player

Player objects inherit from Creature objects.

• Player.addAddon(int outfit, int addon)

• Player.addCap(int amount)

• Player.addExperience(int exp)

• Player.addItem(Item item [, SlotType slot [, boolean canDropOnMap])

• Player.addMana(integer howmuch)

• Player.addMoney(int amount)

• Player.addOutfit(int outfit)

• Player.addSoul(int howmuch)

• Player.cannotAttackPlayer()

• Player.cannotAttackMonster()

• Player.canUseSpells()

• Player.depositMoney(int amount)

• Player.drink(Item beverage)

• Player.enchantGem(Item gem, int enchantItemId)

• Player.getAvailableAddons()

• Player.getBalance()

• Player.getFood()

• Player.getFreeCap()

• Player.getGUID()

• Player.getGuildID()

• Player.getGuildName()

• Player.getGuildNick()

• Player.getGuildRank()

• Player.getInventoryItem(int slot)

• Player.getItemCount(int itemid [, int subtype])

• Player.getLevel()

• Player.getMagicLevel()

• Player.getManaMax()

• Player.getMana()

• Player.getMaximumCap()

• Player.getMoney()

• Player.getOutfit()

• Player.getPlayTime()

• Player.getPremiumDays()

• Player.getSex()

• Player.getSkull()

• Player.getSlot(Item item)

• Player.getSoulPoints()

• Player.getTimeSinceLogin()

• Player.getTownID()

• Player.getTown()

• Player.getVocationID()

• Player.getVocationName()

• Player.isPremium()

• Player.inRangeOfItem(Item item)

• Player.isAutoWalking()

• Player.hasAttacked(Player who)

• Player.hasBalance(int amount)

• Player.hasGroupFlag(integer flag)

• Player.hasInfiniteMana()

• Player.hasInfiniteSoul()

• Player.hasLearnedSpell(string spellname)

• Player.hasMoney(int amount)

• Player.hasSafeMode()

• Player.ignoreProtectionZone()

• Player.ignoreSpellcheck()

• Player.internalPickup(Item item)

• Player.internalWalkTo(position pos)

• Player.isEquipped(integer itemid)

• Player.pickup(Item item)

• Player.removeMana(integer howmuch)

• Player.removeMoney(int amount)

• Player.removeSoul(int howmuch)

• Player.sendCancel(mixed message)

• Player.sendMessage(integer message_class, mixed message)

• Player.sendNote(string message)

• Player.sendOutfitWindow()

• Player.sendWarning(string message)

• Player.setBalance(int amount)

• Player.setMana(integer newvalue)

• Player.setOutfit(int outfit, int addons)

• Player.setTown(Town town)

• Player.setVocation(int vocationID)

• Player.withdrawMoney(int amount)

• Player.walkTo(position pos)

Item

Item objects inherit from Thing objects.

• createItem(int id [,int subtype])

• getItemIDByName(string name)

• isValidItemID(int id)

• items_iterator()

• getItemNameByID(int itemid [, int count [, string alternate_name)]]

• getMaxItemType()

• Item.canFish()

• Item.closeDoor(boolean movecreatures)

• Item.getActionID()

• Item.getBedDirection()

• Item.getBedPartnerDirection()

• Item.getCount()

• Item.getFish(float roll)

• Item.getItemID()

• Item.getLongName()

• Item.getSpecialDescription()

• Item.getSubtype()

• Item.getText()

• Item.getUniqueID()

• Item.getWeight()

• Item.hasFish()

• Item.isBedModifiable()

• Item.isDoor()

• Item.isDoorClosed()

• Item.isDoorOpen()

• Item.openDoor([boolean movecreatures])

• Item.isPickupable()

• Item.setItemID(int newid [, int newcount])

• Item.setActionID(int aid)

• Item.setCount(int newcount)

• Item.setText(string text)

• Item.setSpecialDescription(string text)

• Item.setSubtype(int newtype)

• Item.startDecaying()

• Item.switchDoor([boolean movecreatures])

Container

Container objects inherit from Item objects.

• createContainer(table contents)

• Container.addItem(Item item)

• Container.getContentDescription()

• Container.getItem(int index)

• Container.getItems()

• Container.size()

• Container.capacity()

• Container.getItems()

Map

Functions that can be invoked on the global Map object (called "map").

• Map.getHouses([mixed town])

• Map.getTowns()

• Map.getHouse(mixed id)

• Map.getTile(int x, int y, int z)

• Map.getTile(Position pos)

• Map.getTown(mixed id)

• Map.getTownWildcard(mixed id)

• Map.raycast(Position from, Position to [, boolean floorcheck])

• Map.canThrowObjectTo(Position from, Position to, boolean checkLineOfSight [, int rangex [, int rangey] ])

• Map.getWaypoint(string name)

Tile

Functions that can be applied to Tiles.

• Map.getHouses([mixed town])

• Tile.addItem(Item item)

• Tile.blockProjectile()

• Tile.doesRefresh()

• Tile.floorChangeDown()

• Tile.floorChangeNorth()

• Tile.floorChangeSouth()

• Tile.floorChangeEast()

• Tile.floorChangeWest()

• Tile.floorChange()

• Tile.getCreatures([Player who])

• Tile.getItems()

• Tile.getMoveableItems()

• Tile.getPlayers([Player who])

• Tile.getThing(integer index)

• Tile.getTopCreature([Player who])

• Tile.getTopMoveableThing()

• Tile.getTopThing()

• Tile.getHouse()

• Tile.getPosition()

• Tile.getX()

• Tile.getY()

• Tile.getZ()

• Tile.hasProperty(TileProp prop)

• Tile.isBlocking()

• Tile.isInHouse()

• Tile.isNoLogout()

• Tile.isNoPVP()

• Tile.isPVP()

• Tile.isPZ()

• Tile.positionChange()

• Tile.queryAdd(Thing thing)

House

Functions that be applied to Houses.

• House.addInvite(string name)

• House.addSubowner(string name)

• House.cleanHouse()

• House.getDoors()

• House.getExitPosition()

• House.getID()

• House.getInvitedList()

• House.getName()

• House.getOwnerGUID()

• House.getPaidUntil()

• House.getRent()

• House.getSubownerList()

• House.getTiles()

• House.getTown()

• House.isInvited(Player who)

• House.kickPlayer(Player who)

• House.setInviteList([string] list)

• House.setOwner(int guid)

• House.setPaidUntil(int time)

• House.setSubownerList([string] list)

Waypoint

Functions that be applied to Waypoints.

• Waypoint.getName()

• Waypoint.getPosition()

Channel

Functions that can be applied on Channels.

• Channel.addUser(Player player)

• Channel.getID()

• Channel.getName()

• Channel.getUsers()

• Channel.message(string message)

• Channel.removeUser(Player player)

• Channel.talk(Player speaker, SpeakClass type, string msg)

Revscriptsys Reference
List of functions  · List of Event Types  · List of Examples
Lua Libraries - string  · table  · coroutine  · math  · IO  · OS  · Debug
Classes - Thing  · Creature  · Player  · Actor  · NPC  · Item  · Container  · Teleport  · Combat  · Condition  · Spell  · Map  · Tile  · Town  · House  · Waypoint  · Channel  · Command  · Vocation  · Event  · Enum  · Thread
Events - OnAccountLogin  · OnAttack  · OnAdvance  · OnConditionAdded  · OnConditionExpired  · OnConditionTick  · OnChangeOutfit  · OnDamage  · OnDeath  · OnEquip  · OnHear  · OnJoinChannel  · OnKill  · OnLeaveChannel  · OnLoadItem  · OnLogin  · OnLogout  · OnLook  · OnLoseCreature  · OnMove  · OnMoveItem  · OnSay  · OnServerLoad  · OnServerUnload  · OnSpawn  · OnSpotCreature  · OnTimer  · OnTurn  · OnUseItem