Funções Lua

Funções Lua
Nessa segunda parte irei mostrar como usar e quase todas as funções em lua existentes no otserver, lembrando que esse tutorial foi baseado no The Forgotten Server 0.3.0 Alpha 3. Portanto poderá haver funções aqui que não terá em outros otservers ou será diferente o nome.
Lembrando que todas as funções existentes aqui poderão ser usadas tanto em actions,npcs,movements,talk actions e spells.
Dividi as funções em três grandes grupos e subgrupos, os três grandes são funções get(receba), set (insira) e do (faça).

Use Forgotten Server 3.0 pelo amor de deus, se você não souber usar sql aprende a usar SqlLite.

Funções Get
São as funções que retornam valores, ou seja, elas fazem checagens. São muitos usadas e uteis. Ela é usada em condicionais (If, while, for) ou inseridas em variaveis. O modo de usa-la depende do tipo de script ou do jeito que você preferir.
Dividi elas em dois grupos, a get simples e a get com parametros.

Funções get simples
São funções simples mesmo basta coloca-las e elas retornarão um valor, pode coloca-las em condicionais ou em variaveis. E todas elas buscam valores em players.
Os que há creature pode ser usados em monstros (a maioria).
São elas :

getPlayerFood(cid) – Verifica quanto de tempo de comida o player possui.
getCreatureHealth(cid) – Verifica a health atual do player.
getCreatureMaxHealth(cid) – Verifica a health maxima do player.
getCreatureMana(cid) – Verifica a mana atual do player.
getCreatureMaxMana(cid) – Verifica a mana maxima do player.
getPlayerLevel(cid) – Verifica o level do player.
getPlayerExperience(cid) – Verifica a experiencia.
getPlayerMagLevel(cid) – Verifica o magic level.
getPlayerAccess(cid) – Verifica o nivel de acesso (player,gm,tutor...)
getPlayerTown(cid) - Verifica o id da cidade natal do player.
getPlayerVocation(cid) – Verifica a vocação dele.
getPlayerSoul(cid) – Verifica o soul points.
getPlayerFreeCap(cid) – Verifica quanto de capacidade atual existe.
getPlayerLight(cid) - Verifica o tamanho da luz do player.
getPlayerGuildId(cid) – Verifica o id atual da guild do player.
getPlayerGuildName(cid) – Verifica o nome da guild.
getPlayerGuildRank(cid) - Verifica o posto dele na guild.
getPlayerGuildNick(cid) – Verifica o nick dele na guild. (aquilo escrito no final entre parenteeses).
getPlayerGuildLevel(cid) – Verifica o nivel da guild.
getPlayerSex(cid) – Verifica o sexo do player(0-mulher, 1 – homem).
getPlayerLookDir(cid) – Verifica a direção na qual ele está olhando. (0-norte, 1-leste, 2-sul, 3 -oeste).
getPlayerGUID(cid) – Verifica o id dele na database.
getPlayerPromotionLevel(cid) – Verifica o nivel da promoção do player.
getPlayerGroupId(cid) – Verifica o nivel dele. (igual acesso).
getPlayerInstantSpellCount(cid) - Verifica quantas spells o player sabe.
getMonsterTargetList(cid) – Verifica os montros na qual você está atacando.
getMonsterFriendList(cid) – Verifica os monstros amigo (provavelmente summons).
getCreatureOutfit(cid) – Verifica o id da roupa do player.
getCreaturePosition(cid) – Verifica a posição x,y,z do player.
getCreatureSpeed(cid) – Verifica a velocidade atual do player.
getCreatureBaseSpeed(cid) – Verifica a velocidade base do player.
getCreatureName(cid) – Verifica o nome do player.
getCreatureTarget(cid) – Verifica quem o player está atacando.
getPlayerPremiumDays(cid) – Verifica quantos dias de premmium account o player possui.
getPlayerSkullType(cid) – Verifica qual skull o player possui.
getPlayerBalance(cid) – Verifica o saldo bancario do player.
getPlayerStamina(cid) – Verifica o tempo de stamina.
getPlayerNoMove(cid) – Verifica se ele pode se mover.
getPlayerExtraExpRate(cid) – Verifica a taxa de experiencia extra (a confirmar).
getPlayerPartner(cid) – Se o player está em parte ou não.
getPlayerParty(cid) – Verifica informações da party do player.
getPartyMembers(lid) – Verifica os membros da party segundo o id da função acima.
getCreatureMaster(cid) – Verifica a criatura mestre (a que sumona).
getCreatureSummons(cid) – Verifica os summons da criatura.

A sintaxe dessas funções é essa :
Exemplo :

if getCreatureMana(cid) == 20 then

Ou

mana = getCreatureMana(cid)
if mana == 20 then

Funções get com parametros.
Essas funções fazem o mesmo papel da outra get simples, porém elas tem certos parametros pois normalmente elas checam coisas a mais, e algumas checam objetos e não só valores do player.
Lembrando que se for comparar itens que são com nomes (exemplo : getItemNameById(2195) == 'boots of haste' then) deve se colocar entre aspas pois é uma função string. Numeros não prescisam estar dentro de aspas.
São elas :

getPlayerSkill(cid, skillid) - checa o skill especificado do player (0- fist,1-club, 2-sword, 3-axe, 4-distance, 5 -shield, 6 – fishing).
getPlayerItemCount(cid,itemid) - checa a quantidade de item agrupaveis.
getPlayerSlotItem(cid, slot) - Checa que item tem no slot do player (1-cabeca, 2- amuleto, 3- backpack, 4-armadura, 5-mao direita, 6-mao esquerda, 7-pernas, 8- botas, 9-anel, 10 slot da torcha).
getPlayerWeapon(cid, ignoreAmmo) - Checa que arma o player esta usando. (o outro paramentro ainda n usei).
getPlayerItemById(cid, deepSearch, itemId, subType) - Procura o item especifica no item, pode colocar o subtipo (viais por exemplo).
getPlayerDepotItems(cid, depotid) - Ve quantos itens tem no depot da cidade (Por id de cidade).
getPlayerFlagValue(cid, flag) - Ve as flag dos players (Apenas em TFS e nunca usei).
getPlayerCustomFlagValue(cid, flag) - Verifica o valor da flag.
getPlayerLearnedInstantSpell(cid, name) - Verifica se o player sabe a magia.
getPlayerInstantSpellInfo(cid, index) - Desconheço
getInstantSpellInfoByName(cid, name) - Verifica valores da magia
getInstantSpellWords(name) - Retorna a palavra magica da magia.
getPlayerStorageValue(uid, valueid) - Verifica o valor do storage do player
getCreatureByName(name) - Retorna o nome da criatura.
getPlayerGUIDByName(name) - Verifica o numero da tabela sql do player.
getPlayerNameByGUID(guid) - Verifica o nome do jogador pelo numero da tabela sql
getContainerSize(uid) - Verifica quantos slots tem o container.
getContainerCap(uid) - Verifica quanto pesa o container.
getContainerItem(uid, slot) - Verifica se há um container no slot especificado.
getDepotId(uid) - - Verifica o id da cidade do depot.
getItemDescriptionsById(itemid) - Pega a descrição do item pelo id.
getItemNameById(itemid) - - Pega o nome do item pelo id.
getItemPluralNameById(itemid) - Pega o nome em plural do item pelo id.(apenas itens agrupaveis).
getItemIdArticleById(itemid) - Retorna um valor pelo id. Desconheço essa função
getItemWeightById(itemid, count, precise) - -Pega o peso do item por id.
getItemDescriptions(uid) - - Pega a descrição do item por uid. (por exemplo se ele é item ou item2 em actions).
getItemName(uid) - - Pega a descrição do item por uid.
getItemAttack(uid) - Pega o ataque do item por uid.
getItemPluralName(uid) - Pega o nome em plural por uid.
getItemExtraAttack(uid) - Modifica o ataque extra da arma (Acho que deve ser ataque elemental ou defesa de armor).
getItemIdArticle(uid) - - Desconheço.
getItemDefense(uid) - - Pega a defesa do item por uid.
getItemExtraDefense(uid) - - Pega a defesa extra (armor) por uid.
getItemArmor(uid) - - Pega o valor de armour por uid.
getItemAttackSpeed(uid) - - Pega a velocidade de ataque por uid.
getItemHitChance(uid) - - Pega a chanche de dano do item por uid.
getItemIdByName(name) - - Retorna o id do item pelo nome.
getPromotedVocation(vocation) - - Verifica qual o nome da vocação promocional da vocação(Sorcerer = Master Sorcerer).
getPlayerBlessing(cid, blessing) - - Verifica qual nivel de benção o player tem (1 = 1, 2 =2...).
getTemplePositionByName(townName) - - Verifica as coordenadas do templo pelo nome da cidade.
getTemplePositionById(townId) - - Verifica as coordenadas do templo pelo id da cidade.

Funções Set
São poucas funções. Elas inserem valores ou seja inserem novos valores,
inutilizando os antigos. Deve se usa-las dentro de condicionais.
Exemplo :

if
getItemNameById(item.uid) == 'boots of haste' then
setItemArmor(item.uid, 5)
end

No caso se o item se chamar boots of haste, o script coloca arm 5 nela.

São
elas :

setItemAttack(uid, attack) - Modifica o ataque da arma
setPlayerStamina(cid, minutes) - Adicione
tempo em stamina.
setPlayerExtraExpRate(cid, value) - Modifica
mais taxa de experiencia
setPlayerPartner(cid, guid) - Desconheço
setItemPluralName(uid) - Modifica ou
adiciona o nome do item no plural.
setItemName(uid) - Muda o nome do item.
setItemIdArticle(uid) - Modifica o
article no item (sei la q merda é essa)
setItemExtraAttack(uid, extraattack) - Adiciona
ataque extra na arma.
setItemDefense(uid, defense) - Modifica
defesa no item
setItemExtraDefense(uid, extradefense) - Modifica
aquela defesa extra na arma
setItemArmor(uid, armor) - Modifica a
armor do item
setItemAttackSpeed(uid, attackspeed) - Muda
a velocidade de ataque do item
setItemHitChance(uid, hitChance) - Modifica
a taxa de dano do item
setGlobalStorageValue(valueid, newvalue) - Adiciona
um valor global (Muito util para scripts avançados)
setHouseOwner(houseid, ownerGUID) - Muda
o dono da casa
setWorldType(type) - Muda o estilo do
mundo para PvP, Non Pvp e Pvp Enforced

Funções do
Funções que fazer algo, normalmente modificam , porem ao contrario do set
algumas apenas adiciona valores. São usadas dentro de condicionais.
A sintaxe dela é :
if item.itemid == 2195 then
doCreatureAddHealth(cid, -1000)
end

No caso se o item usado no script for 2195, ele remove 1000 de hp.


Sao elas:

doPlayerLearnInstantSpell(cid, name) - Faz
o player aprende a magia pelo nome dela.
doRemoveItem(uid, quantidade) - Remove o
item do player.
doPlayerFeed(cid, food) - Adiciona
"comida" ao player.
doPlayerSendCancel(cid, text) - Manda
aquela mensagem branca no rodape da tela.
doPlayerSendDefaultCancel(cid, ReturnValue) - Inutil
pelo que saiba , pq nunca vi um script com isso e por isso n sei pra q serve.
doTeleportThing(cid, newpos,
pushmove) - Teleporta o player para uma nova posição.
doTransformItem(uid, toitemid,
count/subtype) - Transforma o item em outro.
doCreatureSay(cid, text, type) - - Faz o
player falar algo.
doSendMagicEffect(pos, type[, player]) - Faz
algum efeito magico
doSendDistanceShoot(frompos, topos, type) - Faz
algum efeito de distancia
doChangeTypeItem(uid, newtype) - Muda o
tipo dele ou a quantidade de itens agrupaveis.
doSetItemActionId(uid, actionid) - Adiciona
uma nova actionid por uid.
doSetItemText(uid, text) - - Adiciona um
texto ao item.
doSetItemSpecialDescription(uid, desc) - Coloca
a descrição especial no item. (Esse item foi feito especialmente para sei la
kem).
doSendAnimatedText(pos, text, color) - Manda
um texto animado (Se vc joga servidor Pvp Enforced sabe qual é).
doPlayerAddSkillTry(cid, skillid, n) - Adiciona
uma tentativa em um skill (Se vc colocar 9999999 ele aumenta apenas 1 skill).
doCreatureAddHealth(cid, health) - Adiciona
life ao player.
doCreatureAddMana(cid, mana) - Adiciona
mana ao player.
doPlayerSetTown(cid, townid) - Muda a
cidade do player.
doPlayerSetVocation(cid,voc) - Muda a
vocação do player ( Não coloque vocação promocional em TFS pq dará erros).
doPlayerRemoveItem(cid, itemid, count,
subtype) - Remove um item do player.
doPlayerAddExp(cid, exp) - Adiciona
experiencia ao player.
doPlayerAddOutfit(cid,looktype,addons) - Adiciona
addons do outfit ao player.
doPlayerRemoveOutfit(cid,looktype,addons) - Remove
addons do outfit do player.
doAddContainerItem(uid, itemid,
count/subtype) - Adiciona um container por uid.
doBroadcastMessage(message, type) - Manda
uma mensagem global ao servidor.
doPlayerBroadcastMessage(cid, message,
type) -
doPlayerSetSex(cid, newSex) - - Muda o
sexo do Player (0- mulher, 1 homem)
doCreatureChangeOutfit(cid, outfit) - Muda
a roupa do player.
doSetMonsterOutfit(cid, name, time) - Muda
a roupa para de um monstro.
doSetItemOutfit(cid, item, time) - Muda a
roupa do player para de um item.
doSetCreatureOutfit(cid, outfit, time) - Adiciona
uma roupa por tempo.
doPlayerAddMapMark(cid, pos, type,
description) - Adiciona aquelas marcações no mapa do jogador.
doPlayerAddPremiumDays(cid, days) - Adiciona
dias de premmium no jogador
doPlayerAddManaSpent(cid, mana) - Adiciona
% de magic level (Se vc colcoar 99999999 ele aumentará muitos mls...)
doPlayerAddSoul(cid, soul) - Adiciona
soul points ao jogador
doPlayerAddItem(uid, itemid,
count/subtype, canDropOnMap) - Adiciona
itens no player.
doPlayerAddItemEx(cid, uid, 0> canDropOnMap) - Adiciona um item2 no player (Estranho).
doPlayerSendTextMessage(cid, MessageClasses,
message) - Manda um texto pro player.
doPlayerAddMoney(cid, money) - Adiciona dinheiro ao player
doPlayerRemoveMoney(cid, money) - Remove dinheiro do player.
doPlayerWithdrawMoney(cid, money) - Remove dinheiro do banco
doPlayerDepositMoney(cid, money) - Adiciona dinheiro ao banco.
doPlayerTransferMoneyTo(cid, target, money) - Transfere dinheiro do banco.
doShowTextDialog(cid, itemid, text) - Mostra o texto do item
doDecayItem(uid) - Decai o item (aprodecer)
doCreateItem(itemid, type/count, pos) - Cria um item
doCreateItemEx(itemid, count/subtype) - Cria um item2.
doTileAddItemEx(pos, uid) - Cria um item2 em um tile
doAddContainerItemEx(uid, virtuid) - Adiciona um item2 no container
doCreateTeleport(itemid, topos, createpos) - Cria um teleport
doSummonCreature(name, pos) - Sumona um monstro

Este turorial foi criado por: Ta4e
Créditos: 90% Ta4e e 10% a mim por editar e trazer para o forum.

Ja lhe avisei onde postar tópicos