Documentação Lua

Intro
Árvore

Versão da API: 0.28
Ajuda: [Oficial] Module FAQ

Significado dos tipos de parâmetros/argumentos:

a dit :
(Int) - número inteiro : 5;
(String) - textos entre ' ', " " ou [[ ]] : 'isto é uma string';
(Boolean) - true ou false (verdadeiro ou falso);
(Table) - uma compilação de vários dados em uma só variável : {1, 0.03, 'string', 10};
(Object) - similar a uma Table;
(Float) - número decimal : 0.9;
(Number) - número inteiro ou decimal : 0.0001, 10.

Créditos: Indexinel#5948, Ikke#0095 e Infectsoul#2048

error
getmetatable
ipairs
math

next
os

pairs
pcall
print
rawequal
rawget
rawlen
rawset
select
setmetatable
string

system

tfm

: 0

: 1

: 2

: 3

: 5

: 6

: 0

: 1

: 2

: 3

: 4

: 5

: 6

: 7

: 8

: 9

: 10

: 11

: 12

: 13

: 14

: 15

: 16

: 17

: 18

: 19

: 20

: 21

: 22

: 23

: 24

: 25

: 26

: 27

: 0

: 1

: 2

: 3

: 4

: 5

: 6

: 7

: 8

: 9

: 10

: 11

: 12

: 13

: 14

: 15

: 17

: 18

: 19

: 0

: 1

: 2

: 3

: 4

: 5

: 6

: 9

: 10

: 11

: 12

: 13

: 14

: 15

: 16

: 17

: 18

: 19

: 20

: 21

: 22

: 23

: 24

: 25

: 26

: 27

: 28

: 29

: 30

: 31

: 32

: 33

: 34

: 35

: 36

: 37

: 38

: 39

: 40

: 0

: 1

: 2

: 3

: 4

: 6

: 7

: 10

: 17

: 23

: 26

: 28

: 29

: 30

: 31

: 32

: 33

: 34

: 35

: 39

: 40

: 45

: 46

: 54

: 57

: 59

: 60

: 61

: 62

: 65

: 67

: 68

: 69

: 80

: 85

: 89

: 90

: 95

: 0.28

: 6.09

: -

: int

: false

: 0

: 50

: false

: -

: 0

: 2

: false

: 1

: 203

: 0

: 400

: 200

: false

: 120

: 0

: en

: 0

: false

: 0

: true

: false

: int

: 1;0,0,0,0,0,0,0,0,0

: false

: Tigrounette#0001

: 0

: 1

: Pikashu#0095

: 0

: 1234

: Kikoo

: 0

: 1

: Tigrounette#0001

: 184924

: 1

: <C><P /><Z><S /><D /><O /></Z></C>

tonumber
tostring
type
ui

xpcall

Dernière modification le

Eventos são funções que são disparadas automaticamente, sempre que uma ação determinada é feita no jogo. obs.: eventos em vermelho significa que estão disponíveis apenas para a Equipe Lua.

eventChatCommand ( playerName, command )
Este evento dispara sempre que alguém usa um comando do chat (uma mensagem que contém « ! » no inicio).
Argumentos:
- playerName (String) : o jogador que escreveu o comando
- command (String) : a mensagem (sem o « ! » no início)
eventChatMessage ( playerName, message )
Este evento dispara quando alguém escreve uma mensagem no chat.
Argumentos:
- playerName (String) : o jogador que escreveu a mensagem
- message (String) : a mensagem
eventEmotePlayed ( playerName, emoteType, emoteParam )
Este evento dispara com um jogador usa um emote.
Argumentos:
- playerName (String) : o jogador que usou a emoção
- emoteType (Int) : o tipo da emoção
- emoteParam (String) : os atributos da emoção (só para a emoção da bandeira)
eventFileLoaded ( fileNumber, fileData ) *
Este evento dispara quando um arquivo é carregado completamente.
Argumentos:
- fileNumber (String) : o ID do arquivo
- fileData (String) : os dados do arquivo
eventFileSaved ( fileNumber ) *
Este evento dispara quando um arquivo é salvado.
Argumentos:
- fileNumber (String) : o ID do arquivo
eventKeyboard ( playerName, keyCode, down, xPlayerPosition, yPlayerPosition, xPlayerVelocity, yPlayerVelocity )
Este evento dispara quando um jogador pressiona uma tecla (veja system.bindKeyboard para ativar a detecção da tecla).
Argumentos:
- playerName (String) : o jogador que pressionou
- keyCode (Int) : o ID da tecla pressionada
- down (Boolean) : se a tecla está pressionada ou não
- xPlayerPosition (Int) : coordenada horizontal do jogador que pressionou
- yPlayerPosition (Int) : coordenada vertical do jogador que pressionou
- xPlayerVelocity (Int) : a velocidade horizontal do jogador
- yPlayerVelocity (Int) : a velocidade vertical do jogador
eventMouse ( playerName, xMousePosition, yMousePosition )
Este evento dispara quando um jogador clica sobre a tela do mapa (veja system.bindMouse para ativar a detecção do mouse).
Argumentos:
- playerName (String) : o jogador que clicou
- xMousePosition (Int) : a coordenada horizontal do mouse
- yMousePosition(Int) : a coordenada vertical do mouse
eventLoop ( elapsedTime, remainingTime )
Este evento dispara a cada 500 ms.
Argumentos:
- elapsedTime (Int) : o tempo em milissegundos desde o início da rodada atual
- remainingTime (Int) : o tempo em milissegundos que falta para a próxima rodada
eventNewGame ( )
Este evento dispara quando um novo mapa começa.
eventNewPlayer ( playerName )
Este evento dispara quando um jogador entra na sala.
Argumentos:
- playerName (String) : o jogador que entrou na sala

eventPlayerDataLoaded ( playerName, playerData ) *
Este evento dispara quando os dados de um jogador é carregado.
Argumentos:
- playerName (String) : o jogador que teve os dados carregados
- playerData (String) : os dados
eventPlayerDied ( playerName )
Este evento dispara quando um jogador morre.
Argumentos:
- playerName (String) : o jogador que morreu
⠀
eventPlayerGetCheese ( playerName )
Este evento dispara quando um jogador pega o queijo.
Argumentos:
- playerName (String) : o jogador que pegou o queijo
⠀
eventPlayerBonusGrabbed ( playerName , bonusId )
Este evento dispara quando um jogador pega o bônus de tipo 0 ().
Argumentos:
- playerName (String) : o jogador que pegou o bônus
- bonusId (Int) : o ID do bônus (se o bônus pertencer ao mapa, será 0)
eventPlayerLeft ( playerName )
Este evento dispara quando um jogador sai da sala.
Argumentos:
- playerName (String) : o jogador que saiu da sala
eventPlayerVampire ( playerName , vampire )
Este evento dispara quando o jogador se torna vampiro.
Argumentos:
- playerName (String) : o jogador que foi transformado em vampiro
- vampire (String) : o vampiro que o transformou em vampiro (nil se ele não foi transformado por outro jogador)
eventPlayerWon ( playerName, timeElapsed, timeElapsedSinceRespawn )
Este evento dispara quando um jogador ganha o jogo.
Argumentos:
- playerName (String) : o jogador que ganhou o jogo
- timeElapsed(Int) : o tempo que já passou da partida
- timeElapsedSinceRespawn (Int) : o tempo que já passou desde que o rato nasceu
eventPlayerRespawn ( playerName )
Este evento dispara quando um jogador revive.
- playerName (String) : o jogador que reviveu
eventPlayerMeep ( playerName , xPosition , yPosition )
Este evento dispara quando um jogador usa meep.
Argumentos:
- playerName (String) : o jogador que usou o meep
- xPosition (Int) : coordenada horizontal do jogador que usou meep
- yPositon (Int) : coordenada vertical do jogador que usou meep
eventPopupAnswer ( popupId, playerName, answer )
Este evento dispara quando um jogador usa um pop-up (do tipo 1 ou 2).
Argumentos:
- popupId (Int) : o ID do pop-up
- playerName (String) : o jogador que respondeu ao pop-up
- answer (String) : a resposta do jogador
- ["Sim ou Não"] tipo 1 de pop-up
- ["Qualquer texto"] tipo 2 de pop-up
eventSummoningStart ( playerName, objectType, xPosition, yPosition, angle )
Este evento dispara quando um shaman começa a conjurar um objeto.
Argumentos:
- playerName (String) : o jogador que invocou o objeto
- objectType (Int) : o tipo do objeto invocado
- xPosition (Int) : coordenada horizontal de onde o objeto começou a ser invocado
- yPosition (Int) : coordenada vertical de onde o objeto começou a ser invocado
- angle (Int) : o ângulo do objeto que está sendo invocado
eventSummoningCancel ( playerName )
Este evento dispara quando um shaman cancela a invocação.
Argumentos:
- playerName (String) : o jogador que cancelou a invocação
eventSummoningEnd ( playerName, objectType, xPosition, yPosition, angle , objectDescription )
Este evento dispara quando um shaman termina de conjurar o objeto.
Argumentos:
- playerName (String) : o jogador que invocou
- objectType (Int) : o tipo do objeto
- xPosition (Int) : a coordenada horizontal do objeto
- yPosition (Int) : a coordenada vertical do objeto
- angle (Int) : o ângulo do objeto
- objectDescription (Table) : a descrição do objeto
eventTextAreaCallback ( textAreaId, playerName, eventName )
Este evento dispara quando um jogador clica em um callback dentro de uma textarea.
Os callbacks começam com "event", são seguidos por ":" e depois pelo nome do evento (eventName) (ex.: <a href="event:meuNomeDoEvento">Clique aqui</a>).
Se o callback começar com "#clear", a textArea será apagada e o argumento eventName retornará o que vier depois de uma vírgula.
Argumentos:
- textAreaId (Int) : o ID da textArea
- playerName (String) : o jogador que clicou nela
- eventName (String) : o nome do evento (que vem depois de "event:")
eventColorPicked ( colorPickerId, playerName, color )
Este evento dispara quando um jogador escolhe uma cor no seletor de cores.
Argumentos:
- colorPickerId (Int) : o ID da cor selecionada
- playerName (String) : o jogador que selecionou a cor
- color (Int) : a cor que o jogador selecionou ("-1" se o jogador não selecionou nenhuma)
eventContactListener ( playerName, groundId, contactInfos )
Este evento dispara quando um jogador toca um piso com o atributo contactListener.
Argumentos:
- playerName (String) : o jogador que tocou o piso
- groundId (Int) : o ID do piso
- contactInfos (Table) : a informação do contato:
- contactX : a coordenada horizontal de onde o jogador tocou
- contactY : a coordenada vertical de onde o jogador tocou
- playerX : a coordenada horizontal do jogador que tocou
- playerY : a coordenada vertical do jogador que tocou
- speedX : a velocidade horizontal do jogador no momento do contato
- speedY : a velocidade vertical do jogador no momento do contato
eventTalkToNPC ( playerName, npcName )
Este evento dispara quando um jogador clica em um NPC com interação ativada.
Argumentos:
- playerName (String) : o jogador que clicou no NPC
- npcName (String) : o nome do NPC

Dernière modification le

Funções são ações que são executadas no jogo de acordo com os parâmetros que são dados a elas. obs.: funções em vermelho significa que estão disponíveis apenas para a Equipe Lua.

tfm.exec.addBonus ( type, x, y, id, angle, visible, targetPlayer )
Adiciona um bônus de defilante no mapa, e, se o tipo for 0 (), irá disparar eventPlayerBonusGrabbed quando alguém pegá-lo.⠀

Parâmetros:
- type (Int) : tipo do bônus (valor padrão = 1)
- x (Int) : coordenada dele na horizontal (valor padrão = 0)
- y (Int) : coordenada dele na vertical (valor padrão = 0)
- id (Int) : identificador (valor padrão = 0)
- angle (Int) : ângulo (em graus) (valor padrão = 0)
- visible (Boolean) : se o bônus deve estar visível (valor padrão = true)
- targetPlayer (String) : o jogador para o qual irá aparecer o bônus (se nil, aplica para todos) (valor padrão = nil)

tfm.exec.addConjuration ( xPosition, yPosition, duration )
Adiciona uma conjuracão no mapa. Nota: A coordenada deve ser divida por 10, já que a conjuração é um quadrado de 10x10
Parâmetros:
- xPosition (Int) : coordenada horizontal da conjuração
- yPosition (Int) : coordenada vertical da conjuração
- duration (Int) : o tempo, em milissegundos, que a conjuração permanecerá no mapa (valor padrão = 10000)
⠀
tfm.exec.addImage ( imageName, target, xPosition, yPosition, targetPlayer, scaleX, scaleY, angle, alpha, anchorX, anchorY, fadeIn )
Mostra uma imagem no mapa.
Parâmetros:
- imageName (String) : o código da imagem (exemplo: ''177c03f3f43.png")
- target (String) : o elemento do jogo no qual a imagem será atrelada
- =mobileId Sobre um objeto de shaman
- #mobileId Sobre um objeto de shaman, mas removendo a imagem do objeto
- $playerName Sobre o rato
- %playerName Sobre o rato, mas removendo a imagem do rato
- ?backgroundLayerDepth Como imagem de fundo (background), atrás dos pisos
- _groundLayerDepth Entre os pisos
- +physicObjectID Sobre um piso
- !foregroundLayerDepth Como imagem em primeiro plano, à frente dos pisos
- :fixedLayerDepth Sob a interface Lua
- ~fixedLayerDepth Entre a interface Lua
- &fixedLayerDepth Sobre a interface Lua
- xPosition (Int) : coordenada horizontal da imagem, ancoragem: a partir do canto superior esquerdo (pode ser alterado com anchorX e anchorY) (valor padrão = 0)
- yPosition (Int) : coordenada vertical da imagem, ancoragem: a partir do canto superior esquerdo (pode ser alterado com anchorX e anchorY)(valor padrão = 0)
- targetPlayer (String) : o jogador que verá a imagem (se nil, todos os jogadores veem) (valor padrão = nil)
- scaleX (Number) : a escala da largura da imagem (1 é o mesmo que 100%, 0.5 é o mesmo que 50% do tamanho) (valor padrão = 1.0)
- scaleY (Number) : a escala da altura da imagem (valor padrão = 1.0)
- angle (Number) : o ângulo da imagem (em radiano, use math.rad() no valor) (valor padrão = 0)
- alpha (Number) : a opacidade da imagem (0.0 = transparente, 1.0 = opaco) (valor padrão = 1.0)
- anchorX (Number) : a ancoragem horizontal em que a coordenada da imagem usará. (desde -1 a 1, sendo 0.5 o centro) (valor padrão = 0)
- anchorY (Number) : a ancoragem vertical em que a coordenada da imagem usará. (desde -1 a 1, sendo 0.5 o centro) (valor padrão = 0)
- fadeIn (Boolean) : se a imagem deve ter um efeito de suavização ao ser adicionada (por um tempo de 500 ms) (valor padrão = false)
Retorna: (Int) o identificador (ID) da imagen
⠀
tfm.exec.addJoint ( id, physicObject1, physicObject2, jointDef )
Adiciona um joint (junção) entre dois pisos. Nota: No código XML dos mapas, você pode adicionar a propriedade «lua="id"» para interagir com o código Lua.
Parâmetros:
- id (Int) : o identificador (ID) do joint
- physicObject1 (Int) : o primeiro piso que será afetado pela junção
- physicObject2 (Int) : o segundo piso que será afetado pela junção
- jointDef (Table) : a descrição do piso
- type (Int): O tipo da joint
- 0 (JD, Joint de Distância)
- 1 (JP, Joint Prismática)
- 2 (JPL, Joint de Polias)
- 3 (JR, Joint de Revolução)
- point1 (String "x,y"): local da âncora do piso1 (padrão: o centro de piso1)
- point2 (String "x,y"): local da âncora do piso2 (padrão: o centro de piso2) (usado apenas em JD[0] e JPL[2])
- point3 (String "x,y"), point4 (String "x,y"): local da âncora das polias, usado apenas em JPL[2]
- frequency (Float), damping (Float): frequência da JD[0] e amortecimento
- axis (String "x,y"), angle (Int): eixo da JP[1] e ângulo
- limit1 (Float), limit2 (Float), forceMotor (Float), speedMotor (Float): [Respectivamente: LIM1, LIM2, Força do Motor, Velocidade do Motor] limites de translação e rotação de JP[1] e JR[3] e motores
- ratio (Float): proporção da JR[3]
- line (Int), color (Int), alpha (Float), foreground (Boolean): [Respectivamente: Linha, Cor, Opacidade, Plano de Fundo] Se nenhum dessas propriedades estiver definida, a joint não será desenhada.
⠀
tfm.exec.addNPC ( name, npcDef, targetPlayer )
Adiciona um NPC (non-playable character, ou «personagem não jogável» em português) no mapa.
Parâmetros:
- name (String) : o nome do NPC
- options (Table) : a descrição do NPC
- title (Int): título
- look (String): o visual, como aparece no /dressing
- x (Int): coordenada horizontal
- y (Int): coordenada vertical
- female (Boolean): se o NPC é feminino
- lookLeft (Boolean): se o NPC deve estar olhando à esquerda (true) ou à direita derecha (false)
- lookAtPlayer (Boolean): se o NPC deve sempre olhar para o jogador ou não (se não for nil, o parâmetro lookLeft é ignorado)
- interactive (Boolean): se o NPC é interativo, se true, irá disparar o eventTalkToNPC quando um jogador clicar nele
- targetPlayer (String) : o jogador que verá o NPC (se nil, aplica para todos)
⠀
tfm.exec.addPhysicObject ( id, xPosition, yPosition, bodyDef )
Adiciona um objeto físico (um piso) no mapa.
Parâmetros:
- id (Int) : o ID do piso
- xPosition (Int) : coordenada horizontal, a partir do centro, do piso
- yPosition (Int) : coordenada vertical, a partir do centro, do piso
- bodyDef (Table) : a descrição do piso
- type (Int): o tipo do piso
- width (Int): largura
- height (Int): altura
- foreground (Boolean): se deve ficar como plano de fundo ou não
- friction (Float): a fricção do piso
- restitution (Float): a restitução do piso
- angle (Int): o ângulo do piso em graus
- color (Int): a cor dele, em hexadecimal
- contactListener (Int): o identificador (ID) para o evento eventContactListener
- miceCollision (Boolean): se deve colidir com ratos
- groundCollision (Boolean): se deve colidir com objetos
- dynamic (Boolean): se deve ser dinâmico
- fixedRotation (Boolean): se deve ter um ângulo de rotação fixo
- mass (Int): massa do piso
- linearDamping (Float): o amortecimento linear
- angularDamping (Float): o amortecimento angular
tfm.exec.addShamanObject ( objectType, xPosition, yPosition, angle , xSpeed , ySpeed , ghost, object )
Adiciona um objeto de shaman.
Parâmetros:
- objectType (Int) : o tipo do objeto para adicionar
- xPosition (Int) : coordenada horizontal
- yPosition (Int) : coordenada vertical
- angle (Int) : ângulo (valor padrão = 0)
- xSpeed (Int) : a velocidade horizontal do objeto (valor padrão = 0)
- ySpeed (Int) : a velocidade vertical do objeto (valor padrão = 0)
- ghost (Boolean) : se é transparente ou não (valor padrão = false)
- options (Table) : a descrição do objeto
- fixedXSpeed (Number): a velocidade horizontal fixa do objeto
- fixedYSpeed (Number): a velocidade vertical fixa do objeto
Retorna: (Int) o identificador (ID) do objeto de shaman
⠀
tfm.exec.disableAfkDeath ( activate )
Desativa a morte automática quando um jogador está ausente.
Parâmetros:
- activate (Boolean) : se deve ser desativada ou não (valor padrão = true)
⠀
tfm.exec.disableAllShamanSkills ( active )
Desativa as habilidades do shaman.
Parâmetros:
- active (Boolean) : se deve ser desativada ou não (valor padrão = true)
⠀
tfm.exec.disableAutoNewGame ( activate )
Desativa o inicio automático de um novo mapa.
Parâmetros:
- activate (Boolean) : se deve ser desativada ou não (valor padrão = true)
⠀
tfm.exec.disableAutoScore ( activate )
Desativa a pontuação (score) automática.
Parâmetros:
- activate (Boolean) : se deve ser desativada ou não (valor padrão = true)
⠀
tfm.exec.disableAutoShaman ( activate )
Desativa a seleção automática de shaman.
Parâmetros:
- activate (Boolean) : se deve ser desativada ou não (valor padrão = true)
⠀
tfm.exec.disableAutoTimeLeft ( activate )
Desativa o tempo restante automático de 20s (quando um shaman morre ou sobra só 2 jogadores).
Parâmetros:
- activate (Boolean) : se deve ser desativada ou não (valor padrão = true)
⠀
tfm.exec.disableDebugCommand ( activate )
Desativa os efeitos do comando /debug.
Parâmetros:
- activate (Boolean) : se deve ser desativada ou não (valor padrão = true)
⠀
tfm.exec.disableMinimalistMode ( activate )
Desactiva el modo minimalista.
Parâmetros:
- activate (Boolean) : se deve ser desativada ou não (valor padrão = true)
⠀
tfm.exec.disableMortCommand ( activate )
Desativa o comando /mort.
Parâmetros:
- activate (Boolean) : se deve ser desativado ou não (valor padrão = true)
⠀
tfm.exec.disablePhysicalConsumables ( active )
Desativa os consumíveis físicos do inventário (igual às salas de racing e bootcamp).
Parâmetros:
- active (Boolean) : se deve ser desativada ou não (valor padrão = true)
⠀
tfm.exec.disablePrespawnPreview ( display )
Desativa a pré-visualização dos objetos de shaman que estão sendo invocados.
Parâmetros:
- display (Boolean) : se deve ser mostrado ou não (valor padrão = true)
⠀
tfm.exec.disableWatchCommand ( activate )
Desativa os efeitos do comando /watch.
Parâmetros:
- activate (Boolean) : se deve ser desativada ou não (valor padrão = true)⠀

tfm.exec.removeBonus ( id, targetPlayer )
Remove um bônus que foi gerado pelo tfm.exec.addBonus
Parâmetros:
- id (Int) : o identificador do bônus (valor padrão = 0)
- targetPlayer (String) : o jogador para o qual o bônus será removido (se nil, aplica para todos) (valor padrão = nil)
⠀
tfm.exec.removeCheese ( playerName )
Remove o queijo de um jogador.
Parâmetros:
- playerName (String) : o jogador do qual se removerá o queijo
⠀
tfm.exec.removeImage ( imageId, fadeOut )
Remove uma imagem.
Parâmetros:
- imageId (Int) : o ID da imagem, retornado pela função tfm.exec.addImage
- fadeOut (Boolean) : se a imagem deve ter efeito de suavização enquanto é removida (valor padrão = false)
tfm.exec.removeJoint ( id )
Remove um joint/junção do jogo.
Parâmetros:
- id (Int) : o ID do joint a ser removido
⠀
tfm.exec.removeObject ( objectId )
Remove um objeto de shaman.
Parâmetros:
- objectId (Int) : o ID do objeto a ser removido
⠀
tfm.exec.removePhysicObject ( id )
Remove um piso do jogo.
Parâmetros:
- id (Int) : o ID do piso a ser removido⠀

tfm.exec.setAieMode ( enable, sensibility, targetPlayer )
Ativa o parâmetro "aie", em que o jogador morre depois de cair de uma altura muito alta.
Parâmetros:
- enable (Boolean) : se deve estar ativo (valor padrão = true)
- sensibility (Number) : a sensibilidade do "aie" (valor padrão = 1.0)
- targetPlayer (String) : o jogador que será afetado pelo "aie" (se nil, aplica para todos) (valor padrão = nil)
⠀
tfm.exec.setAutoMapFlipMode ( flipped )
Estabelece se os próximos mapas devem estar invertido ou não.
Parâmetros:
- flipped (Boolean) : se os mapas devem estar invertidos (valor padrão = nil)
⠀
tfm.exec.setGameTime ( time, init )
Modifica o tempo restante do jogo.
Parâmetros:
- time (Int) : o tempo restante em segundos
- init (Boolean) : se o tempo deve ser alterado mesmo se o tempo restante definido for maior que o tempo restante atual (valor padrão = true)
⠀
tfm.exec.setNameColor ( playerName, color )
Muda a cor do nome do jogador.
Parâmetros:
- playerName (String) : o jogador que terá a cor do nome mudada
- color (Number) : a cor do nome, em hexadecimal
⠀
tfm.exec.setPlayerGravityScale ( playerName, gravityScale )
Estabelece a escala da gravidade sobre um rato.
Parâmetros:
- playerName (String) : o jogador que terá a nova gravidade
- gravityScale (Number) : a escala da gravidade (valor padrão = 1.0)
⠀
tfm.exec.setPlayerNightMode ( nightMode, playerName )
Estabelece o modo noturno.
Parâmetros:
- nightMode (Boolean) : se o modo noturno deve estar ativado (valor padrão = true)
- playerName (String) : o jogador que será afetado pelo modo nortuno (se nil, aplica para todos)
⠀
tfm.exec.setPlayerScore ( playerName, score, add )
Estabelece a pontuação (score) de um jogador.
Parâmetros:
- playerName (String) : o jogador o qual receberá a pontuação
- score (Int) : a nova pontuação
- add (Boolean) : se nil ou false, a pontuação do jogador será sobrescrita, se true, a nova pontuação será adicionada à pontuação atual do jogador (valor padrão = false)
⠀
tfm.exec.setPlayerSync ( playerName ) *
Define o jogador pelo qual a sala sincronizará.
Parâmetros:
- playerName (String) : o jogador que será o responsável pela sincronização, se nil, o servidor que decidirá
⠀
tfm.exec.setRoomMaxPlayers ( maxPlayers ) *
Establece o máximo de jogadores que podem entrar na sala.
Parâmetros:
- maxPlayers (Int) : número do máximo de jogadores
⠀
tfm.exec.setRoomPassword ( password ) *
Protege com senha uma sala.
Parâmetros:
- password (String) : a senha (se vazio, removerá a senha da sala)
⠀
tfm.exec.setShaman ( playerName, makeAShaman )
Transforma um jogador em shaman.
Parâmetros:
- playerName (String) : o jogador que será shaman
- makeAShaman (Boolean) : se o jogador deve ser shaman ou não (valor padrão = true)
⠀
tfm.exec.setShamanMode ( playerName, mode )
Estabelece o modo de shaman, mesmo se o jogador não tiver o modo desbloqueado.
Parâmetros:
- playerName (String) : o jogador que será afetado pela função
- mode (Int) : o novo modo de shaman para o jogador (se nil, o modo selecionado será de acordo com que o jogador selecionou) (valor padrão = nil)
⠀
tfm.exec.setVampirePlayer ( playerName, makeAVampire )
Transforma um jogador em vampiro.
Parâmetros:
- playerName (String) : o jogador que será transformado
- makeAVampire (Boolean) : se o jogador deve ser vampiro ou não (valor padrão = true)
⠀
tfm.exec.setWorldGravity ( x, y)
Estabelece o vento (x) e a gravidade (y) do mapa.
Parâmetros:
- x (Int) : força do vento (valor padrão = 0)
- y (Int) : força da gravidade (valor padrão = 10)⠀

tfm.exec.attachBalloon ( playerName, isAttached, colorType, ghost, speed )
Coloca um balão no jogador.
Parâmetros:
- playerName (String) : o jogador que terá o balão anexado
- isAttached (Boolean) : se o balão deve estar ligado ou não ao jogador (valor padrão = true)
- colorType (Int) : a cor do balão [1-4] (valor padrão = 1)
- ghost (Boolean) : se o balão deve ser transparente (valor padrão = false)
- speed (Number) : a velocidade com que o balão sobe (valor padrão = 1)
⠀
tfm.exec.changePlayerSize ( playerName, size )
Muda o tamanho de um jogador.
Parâmetros:
- playerName (String) : o nome do jogador
- size (Number) : o novo tamanho do jogador (entre 0.1 e 5) (valor padrão = 1)
⠀
tfm.exec.chatMessage ( message, playerName ) *
Escreve uma mensagem no chat.
Parâmetros:
- message (String) : a mensagem que será escrita no chat
- playerName (String) : o jogador que verá a mensagem (se nil, aplica a todos) (valor padrão = nil)
⠀
tfm.exec.displayParticle ( particleType, xPosition, yPosition, xSpeed, ySpeed, xAcceleration, yAcceleration, targetPlayer )
Exibe uma partícula.
Parâmetros:
- particleType (Int) : o tipo da partícula
- xPosition (Int) : coordenada horizontal
- yPosition (Int) : coordenada vertical
- xSpeed (Number) : velocidade horizontal (valor padrão = 0)
- ySpeed (Number) : velocidade vertical (valor padrão = 0)
- xAcceleration (Number) : aceleração horizontal (valor padrão = 0)
- yAcceleration (Number) : aceleração vertical (valor padrão = 0)
- targetPlayer (String) : o jogador que verá a partícula (se nil, aplica a todos) (valor padrão = nil)
tfm.exec.explosion ( xPosition, yPosition, power, radius, miceOnly )
Cria uma explosão.
Parâmetros:
- xPosition (Int) : coordenada horizontal, a partir do centro, da explosão
- yPosition (Int) : coordenada vertical, a partir do centro, da explosão
- power (Int) : o poder máximo da explosão (valor padrão = 0)
- radius (Int) : o raio da explosão (jogadores de fora do raio não serão afetados) (valor padrão = 0)
- miceOnly (Boolean) : se a explosão deve afetar só ratos ou também outros objetos dinâmicos (valor padrão = false)
⠀
tfm.exec.freezePlayer ( playerName, freeze, displayIce )
Congela um jogador.
Parâmetros:
- playerName (String) : o jogador que será congelado
- freeze (Boolean) : se o efeito de congelamento deve estar ativo ou não (valor padrão = true)
- displayIce (Boolean) : se o efeito de congelamento vai estar visível ou não (valor padrão = true)
⠀
tfm.exec.getPlayerSync ( ) *
Retorna qual jogador que está sincronizando a sala.
⠀
tfm.exec.giveCheese ( playerName )
Dá queijo a um jogador.
Parâmetros:
- playerName (String) : o jogador que receberá um queijo
⠀
tfm.exec.giveConsumables ( playerName, consumableId, amount ) *
Dá consumíveis a um jogador.
Parâmetros:
- playerName (String) : o jogador que receberá os consumíveis
- consumableId (String) : o ID do consumível
- amount (String) : a quantidade de consumíveis que se deve dar (valor padrão = "1")
⠀
tfm.exec.giveMeep ( playerName, canMeep )
Dá meep a um jogador
Parâmetros:
- playerName (String) : o jogador que receberá o meep
- canMeep (Boolean) : se o jogador deve receber o meep ou não (valor padrão = true)
⠀
tfm.exec.giveTransformations ( playerName, canTransform )
Dá a habilidade de transformação a um jogador.
Parâmetros:
- playerName (String) : o jogador que receberá as habilidade de transformação
- canTransform (Boolean) : se o jogador pode usar transformações ou não (valor padrão = true)
⠀
tfm.exec.killPlayer ( playerName )
Mata um jogador.
Parâmetros:
- playerName (String) : o jogador para matar
⠀
tfm.exec.linkMice ( playerName1, playerName2, linked )
Permite tornar dois jogadores em almas gêmeas (igual aos mapas de alma).
Parâmetros:
- playerName1 (String) : o primeiro jogador
- playerName2 (String) : o segundo jogador
- linked (Boolean) : se os dois jogadores devem ser almas ou não (valor padrão = true)
⠀
tfm.exec.lowerSyncDelay ( playerName ) *
Reduz o intervalo de sincronização do servidor a 400 milissegundos, no máximo.
Parâmetros:
- playerName (String) : o jogador que terá a velocidade de sincronização reduzida
⠀
tfm.exec.moveObject ( objectId, xPosition, yPosition, positionOffset, xSpeed, ySpeed, speedOffset, angle, angleOffset )
Define a velocidade e posição de um objeto de shaman.
Parâmetros:
- objectId (Int) : o ID do objeto
- xPosition (Int) : a coordenada horizontal em que o objeto será movido
- yPosition (Int) : a coordenada vertical em que o objeto será movido
- positionOffset (Boolean) : se a mudança de posição deve ser adicionada à atual ou sobrescrita (valor padrão = false)
- xSpeed (Int) : a velocidade horizontal do objeto (valor padrão = 0)
- ySpeed (Int) : a velocidade vertical do objeto (valor padrão = 0)
- speedOffset (Boolean) : se a velocidade definida deve ser adicionada à atual ou sobrescrita (valor padrão = false)
- angle (Int) : o novo ângulo para o objeto (em graus) (valor padrão = 0)
- angleOffset (Boolean) : se a mudança de ângulo deve ser adicionada ao atual ou sobrescrita (valor padrão = false)
⠀
tfm.exec.movePhysicObject ( objectId, xPosition, yPosition, positionOffset, xSpeed, ySpeed, speedOffset, angle, angleOffset )
Define a velocidade e posição de um piso.
Parâmetros:
- objectId (Int) : o ID do piso
- xPosition (Int) : a coordenada horizontal em que o piso será movido
- yPosition (Int) : a coordenada vertical em que o piso será movido
- positionOffset (Boolean) : se a mudança de posição deve ser adicionada à atual ou sobrescrita (valor padrão = false)
- xSpeed (Int) : a velocidade horizontal do piso (valor padrão = 0)
- ySpeed (Int) : a velocidade vertical do piso (valor padrão = 0)
- speedOffset (Boolean) : se a velocidade definida deve ser adicionada à atual ou sobrescrita (valor padrão = false)
- angle (Int) : o novo ângulo para o piso (em graus) (valor padrão = 0)
- angleOffset (Boolean) : se a mudança de ângulo deve ser adicionada ao atual ou sobrescrita (valor padrão = false)
⠀
tfm.exec.movePlayer ( playerName, xPosition, yPosition, positionOffset, xSpeed, ySpeed, speedOffset )
Define a posição e velocidade de um jogador.
Parâmetros:
- playerName (String) : o jogador para se mover
- xPosition (Int) : a coordenada horizontal em que o jogador será movido
- yPosition (Int) : a coordenada vertical em que o jogador será movido
- positionOffset (Boolean) : se a mudança de posição deve ser adicionada à atual ou sobrescrita (valor padrão = false)
- xSpeed (Int) : a velocidade horizontal do jogador(valor padrão = 0)
- ySpeed (Int) : a velocidade vertical do jogador (valor padrão = 0)
- speedOffset (Boolean) : se a velocidade definida deve ser adicionada à atual ou sobrescrita (valor padrão = false)
⠀
tfm.exec.newGame ( mapCode, flipped )
Carrega um novo mapa.
Parâmetros:
- mapCode (String) : o código do mapa (valor padrão = nil)
- nil (mapa aleatorio)
- 0 (apenas número = mapa vanilla)
- @3965432 (se começar com @ = mapa do editor)
- #4 (se começar com # = categoria, neste exemplo: P4)
- se começar com '<' = mapa XML
- flipped (Boolean) : se o mapa deve estar invertido horizontalmente (valor padrão = nil)
⠀
tfm.exec.playEmote ( playerName, emoteId, emoteArg )
Faz com que um jogador execute uma emoção.
Parâmetros:
- playerName (String) : o jogador que deverá fazer a emoção
- emoteId (Int) : o tipo da emoção
- emoteArg (String) : o atributo da emoção (valor padrão = nil)
⠀
tfm.exec.playerVictory ( playerName )
Faz com que o jogador entre na toca instantaneamente.
Parâmetros:
- playerName (String) : o jogador que entrará na toca
⠀
tfm.exec.playMusic ( music, channel, volume, loop, fade, targetPlayer )
Toca uma música. A lista de músicas/efeitos sonoros pode ser encontrada aqui: http://audio.atelier801.com/sounds.html.
Parâmetros:
- music (String) : o código da música para reproduzir
- channel (String) : o canal pelo qual a música tocará
- volume (Int) : o volume da música (entre 0 e 100) (valor padrão = 70)
- loop (Boolean) : se a música deve tocar infinitamente, repetindo sempre que acabar (valor padrão = false)
- fade (Boolean) : se a música deve começar com um efeito de suavização (valor padrão = true)
- targetPlayer (String) : o jogador que ouvirá a música (se nil, aplica para todos) (valor padrão = nil)
⠀
tfm.exec.playSound ( sound, volume, soundPosX, soundPosY, targetPlayer )
Toca um efeito sonoro. A lista de músicas/efeitos sonoros pode ser encontrada aqui: http://audio.atelier801.com/sounds.html.
Parâmetros:
- sound (String) : o código do som para reproduzir
- volume (Int) : o volume do som (entre 0 e 100) (valor padrão = 70)
- soundPosX (Int) : a coordenada horizontal do som, quanto mais longe o jogador, mais baixo será o volume (valor padrão = nil)
- soundPosY (Int) : a coordenada vertical do som (valor padrão = nil)
- targetPlayer (String) : o jogador que escutará o som (se nil, aplica para todos) (valor padrão = nil)
⠀
tfm.exec.respawnPlayer ( playerName )
Revive um jogador.
Parâmetros:
- playerName (String) : o jogador que será revivido
⠀
tfm.exec.stopMusic ( channel, targetPlayer )
Para uma música que está tocando.
Parâmetros:
- channel (String) : o canal em que a música está tocando
- targetPlayer (String) : o jogador que será afetado pela função (se nil, aplica para todos (valor padrão = nil)
⠀
tfm.exec.snow ( duration, snowballPower )
Faz com que caia neve.
Parâmetros:
- duration (Int) : duração da neve em segundos
- snowballPower (Int) : a força da bola de neve (valor padrão = 10)

Dernière modification le

ui.addPopup ( id, type, text, targetPlayer, x, y, width, fixedPos )
Mostra um pop-up.
Parâmetros:
- id (Int) : o ID do pop-up
- type (Int) : o tipo do pop-up (0 para 1 botão "fechar", 1 para [Sim ou Não], 2 para caixa de texto)
- text (String) : o texto do pop-up
- targetPlayer (String) : o jogador que verá o pop-up (se nil, aplica a todos)
- x (Int) : a coordenada horizontal, a partir do canto superior esquerdo (valor padrão = 50)
- y (Int) : a coordenada vertical a partir do canto superior esquerdo (valor padrão = 50)
- width (Int) : o tamanho do pop-up em pixels (se nil, o pop-up será ajustado de acordo com o texto) (valor padrão = nil)
- fixedPos (Boolean) : se o pop-up deve seguir o jogador (valor padrão = false)
⠀
ui.addTextArea ( id, text, targetPlayer, x, y, width, height, backgroundColor, borderColor, backgroundAlpha, fixedPos )
Mostra uma textarea.
Parâmetros:
- id (Int) : o ID da textarea
- text (String) : o texto a se mostrar
- targetPlayer (String) : o jogador que verá a textArea (se nil, aplica a todos) (valor padrão = nil)
- x (Int) : coordenada horizontal, a partir do canto superior esquerdo (valor padrão = 50)
- y (Int) : coordenada vertical a partir do canto superior esquerdo (valor padrão = 50)
- width (Int) : a largura da textArea (se nil, se ajustará de acordo com o texto) (valor padrão = 0)
- height (Int) : a altura da textArea (se nil, se ajustará de acordo com o texto) (valor padrão = 0)
- backgroundColor (Int) : a cor de fundo da textArea (se -1, o fundo será invisível) (valor padrão = 0x324650)
- borderColor (Int) : a cor da borda da textArea (se -1, a borda será invisível) (valor padrão = 0)
- backgroundAlpha (Number) : a opacidade da textArea (de 0 = transparente a 1.0 = opaco). (valor padrão = 1)
- fixedPos (Boolean) : se a textArea deve seguir o jogador (valor padrão = false)
⠀
ui.removeTextArea ( id, targetPlayer )
Remove uma textArea.
Parâmetros:
- id (Int) : o ID da textArea para ser removida
- targetPlayer (String) : o jogador que deixará de ver a textArea (se nil, aplica a todos) (valor padrão = nil)
⠀
ui.setMapName ( text )
Muda o nome do mapa.
Parâmetros:
- text (String) : o novo nome do mapa
⠀
ui.setBackgroundColor ( color )
Muda a cor de fundo do mapa (só dura por uma rodada).
Parâmetros:
- color (String) : A cor do fundo (no formato de HTML "#RRGGBB") (valor padrão = "#6A7495")
⠀
ui.setShamanName ( text )
Muda o nome do shaman.
Parâmetros:
- text (String) : o texto que será o nome do shaman
⠀
ui.showColorPicker ( id, targetPlayer, defaultColor, title )
Mostra um seletor de cores.
Parâmetros:
- id (Int) : o ID do colorPicker
- targetPlayer (String) : o jogador que verá o seletor de cores (se nil, aplica a todos) (valor padrão = nil)
- defaultColor (Int) : a cor padrão do seletor de cores (valor padrão = 0)
- title (String) : o título do seletor de cores (valor padrão = nil)
⠀
ui.updateTextArea ( id, text, targetPlayer )
Atualiza uma textArea.
Parâmetros:
- id (Int) : o ID da textArea
- text (String) : o novo texto para mostrar
- targetPlayer (String) : o jogador que verá a nova textArea (se nil, aplica a todos) (valor padrão = nil)

system.bindKeyboard ( playerName, keyCode, down, activate )
Ativa a detecção do teclado.
Parâmetros:
- playerName (String) : o jogador que se deve detectar as teclas pressionadas
- keyCode (Int) : o ID da tecla que deve ser detectada (código AS3)
- down (Boolean) : se o evento deve ocorrer quando a tecla for pressionada ou liberada
- activate (Boolean) : se deve detectar o pressionamento da tecla (valor padrão = true)
⠀
system.bindMouse ( playerName, active )
Ativa a detecção do botão esquerdo do mouse.
Parâmetros:
- playerName (String) : o jogador que será afetado pela função
- activate (Boolean) : se deve detectar ou não (valor padrão = true)
⠀
system.disableChatCommandDisplay ( command, hide )
Previne que um comando do chat (mensagem que começa com « ! ») seja exibida.
Parâmetros:
- command (String) : o comando (sem a « ! ») para esconder
- hide (Boolean) : se o comando deve ser ocultado ou não (valor padrão = true)
⠀
system.exit ( )
Desativa todo o script Lua.
⠀
system.giveAdventurePoint ( playerName, achievementCode, amount ) *
Dá pontos de aventura para um jogador.
Parâmetros:
- playerName (String) : o jogador que receberá os pontos de aventura
- achievementCode (String) : o código da conquista
- amount (String) : o números de pontos para se dar (valor padrão = '1')
⠀
system.giveEventGift ( playerName, giftCode ) *
Dá uma recompensa de um evento a um jogador.
Parâmetros:
- playerName (String) : o jogador que receberá a recompensa
- giftCode (String) : o código da recompensa (dado por um administrador)
⠀
system.loadFile ( fileNumber ) *
Solicita o carregamento de um arquivo.
Parâmetros:
- fileNumber (Int) : o ID do arquivo (valor padrão = 0)
Retorna: (Boolean) se o carregamento começou ou não
⠀
system.loadPlayerData ( playerName ) *
Solicita o carregamento de dados de um jogador. Dispara eventFileLoaded quando este é totalmente carregado.
Parâmetros:
- playerName (String) : o jogador do qual se deseja obter os dados
Retorna: (Boolean) se o carregamento começou ou não
⠀
system.luaEventLaunchInterval ( interval, random ) *
Obtém ou estabelece o tempo de intervalo entre os mapas do evento Lua.
Parâmetros:
- interval (Int) : o intervalo em minutos (valor padrão = 40)
- random (Int) : a diferença aleatória máxima do intervalo (valor padrão = 20)
Retorna: (Table) a configuração de intervalo atual
⠀
system.newTimer ( callback, time, loop, arg1, arg2, arg3, arg4 ) *
Cria um temporizador com uma função para atrasar e, em seguida, executa uma vez em um loop. Só pode haver 40 temporizadores simultâneos em execução.
Parâmetros:
- callback (Function) : a função a ser executada; o primeiro argumento dela será o ID do temporizador
- time (Int) : o tempo em milissegundos que demorará para que a função seja executada (mínimo de 500 milissegundos)
- loop (Boolean) : se ela se executará de maneira repetida (valor padrão = true)
- arg1 (Object) : 1.° argumento da função (valor padrão = nil)
- arg2 (Object) : 2.° argumento da função (valor padrão = nil)
- arg3 (Object) : 3.° argumento da função (valor padrão = nil)
- arg4 (Object) : 4.° argumento da função (valor padrão = nil)
Retorna: (Int) o identificador do novo temporizador
⠀
system.openEventShop ( eventName, playerName ) ** só para eventos Lua
Abre a loja do evento Lua.
Parâmetros:
- eventName (String) : o nome do evento
- playerName (String) : o jogador para o qual abrirá a loja
⠀
system.removeTimer ( timerId ) *
Remove um temporizador.
Parâmetros:
- timerId (Int) : o ID do temporizador
⠀
system.saveFile ( data, fileNumber ) *
Salva um arquivo. Máximo de 1 solicitação por minuto.
Parâmetros:
- data (String) : os dados para se salvar
- fileNumber (Int) : o ID do arquivo para se salvar os dados (valor padrão = 0)
Retorna: (Boolean) se o salvamento começou ou não
⠀
system.savePlayerData ( playerName, data ) *
Salva os dados de um jogador em um módule. Máximo de 1 solicitação a cada 10 segundos.
Parâmetros:
- playerName (String) : o jogador do qual os dados serão salvos
- data (String) : os dados do jogador para se salvar (5000 caracteres máximo)
⠀
system.setLuaEventBanner ( bannerId ) ** só para eventos Lua
Estabelece o banner do Evento Lua na tela de login do jogo.
Parâmetros:
- bannerId(Int) : o ID do banner

debug.disableEventLog ( activate )
Desativa o registro de eventos.
Parâmetros:
- activate (Boolean) : se irá desativar ou não (valor padrão = true)

debug.getCurrentLuaThreadName ( )
Retorna o nome da thread atual ("Module")

debug.disableTimerLog ( activate )
Desativa o registro do temporizador. Função descontinuada.
Parâmetros:
- activate (Boolean) : se irá desativar ou não (valor padrão = true)

Dernière modification le

auxílio aqui

Dernière modification le

English	Français
Português do Brasil	Español
Türkçe	Polski
Magyar	Română
العربية	Skandinavisk
Nederlands	Deutsch
Bahasa Indonesia	Русский
中文	Filipino
Lietuvių kalba	日本語
Suomi	עברית
Italiano	Česky
Hrvatski	Slovensky
Български	Latviešu
Estonian

Langue