Lua : Funcoes Transformice

• debug.disableEventLog ( desativar )
 Desativa os registros dos eventos.
 Parâmetros:
  - desativar (Boolean) : Se deve ser desativado (valor padrão = true)




• system.bindKeyboard ( jogador, codigoTecla, pressionar, ativo )
 Ativa os eventos de teclado para a tecla determinada ao jogador.
 Parâmetros:
  - jogador (String) : o jogador que você quer permitir o disparo dos eventos de teclado em relação a tecla escolhida
  - codigoTecla (Int) : código (em byte) da tecla
   - para apuração dos movimentos do jogador (setas, teclas wasd/zqsd), você pode usar 0 (Esquerda), 1 (Cima), 2 (Direita), 3 (Baixo)
   - código das teclas em byte podem ser encontradas no site da Adobe
  - pressionar (Boolean) : se o evento deve ocorrer por pressionar ou liberar a tecla.
  - ativo (Boolean) : se deve ser ativado ou desativado (valor padrão = true)



• system.bindMouse ( jogador, ativo )
 Ativos os eventos de mouse ao jogador.
 Parâmetros:
  - jogador (String) : o jogador que você quer permitir o disparo dos eventos de mouse
  - ativo (Boolean) : se deve ser ativado ou desativado (valor padrão = true)



• system.disableChatCommandDisplay ( comando, esconder )
 Previne que um comando de module (comandos que começam com " ! ") apareça no chat.
 Parâmetros:
  - comando (String) : o comando (sem o " ! " inicial) para esconder
  - esconder (Boolean) : se o comando deve ser escondido (valor padrão = true)



• system.exit ()
 Desativa o script Lua que está rodando.



• system.giveEventGift ( jogador, codigo )
 Dá um prêmio (título) de evento para o jogador escolhido.
 Parâmetros:
  - jogador (String) : o jogador para dar o prêmio (título)
  - codigo (String) : o id do prêmio (título) (pode ser adquirido apenas por um administrador)



• system.loadFile ( numero )
 Tenta carregar os dados do arquivo. O evento eventFileLoaded é disparado quando o arquivo é totalmente carregado.
 Parâmetros:
  - numero (Int) : o id do arquivo a ser carregado (valor padrão = 0)
 Retorna: (Boolean) se o carregamento foi iniciado



• system.loadPlayerData ( jogador )
 Tenta carregar os dados do jogador para este module. O evento eventPlayerDataLoaded é disparado quando os dados do jogador são carregados.
 Parâmetros:
  - jogador (String) : o jogador do qual você quer os dados
 Retorna: (Boolean) se o carregamento foi iniciado



• system.newTimer ( callback, tempo, loop, argumento1, argumento2, argumento3, argumento4 )
 Cria um novo timer para chamar uma função depois de um atraso (delay), uma vez ou continuamente.
 Parâmetros:
  - callback (Function) : A função a ser chamada
  - tempo (Int) : o número de milissegundos que a função deve ser atrasada
  - loop (Boolean) : se a execução da callback deve acontecer em loop ou apenas uma vez (valor padrão = false)
  - argumento1 (Object) : Primeiro argumento da função callback (valor padrão = nil)
  - argumento2 (Object) : Segundo argumento da função callback (valor padrão = nil)
  - argumento3 (Object) : Terceiro argumento da função callback (valor padrão = nil)
  - argumento4 (Object) : Quarto e último argumento da função callback [Não confunda arg1,2,3,4 com um vararg ...] (valor padrão = nil)
 Retorna: (Int) O id do novo timer



• system.removeTimer ( id )
 Destrói um timer.
 Parâmetros:
  - id (Int) : o id do timer a ser destruído



• system.saveFile ( dados, numero )
 Tenta salvar um arquivo de dados (uma vez por minuto). O evento eventFileSaved é disparado quando o arquivo é salvo.
 Parâmetros:
  - dados (String) : os dados a serem armazenados no arquivo
  - numero (Int) : o id (de 0 a 99) do arquivo para armazenar os dados (valor padrão = 0)
 Retorna: (Boolean) se o carregamento foi iniciado



• system.savePlayerData ( jogador, dados )
 Salva os dados do jogador no module.
 Parâmetros:
  - jogador (String) : o jogador do qual você quer salvar os dados
  - dados (String) : os dados do jogador a serem salvos




• tfm.exec.addConjuration ( posicaoX, posicaoY, duracao )
 Adiciona conjuração ao mapa. Nota: A grade de coordenadas são coordenadas regulares divididas por 10 (pois a conjuração tem um quadrado de 10x10px).
 Parâmetros:
  - posicaoX (Int) : a grade de coordenadas horizontal da conjuração
  - posicaoY (Int) : a grade de coordenadas vertical da conjuração
  - duracao (Int) : a duração da conjuração em milissegundos (valor padrão = 10000)



• tfm.exec.addImage ( id, tipo, posicaoX, posicaoY, jogador )
 Mostra uma imagem no mapa.
 Parâmetros:
  - id (String) : o id da imagem (Exemplo: "abc1d.png", id adquirido por um desenvolvedor Lua oficial)
  - tipo (String) : O elemento do jogo a ter a imagem
   - #IdObjetoShaman : Adiciona a imagem no objeto shaman
   - $jogador : Adiciona a imagem acima da imagem do rato
   - %jogador : Substitui a imagem do rato pela imagem inserida
   - ?idCamada : Adiciona a imagem na camada de background (fundo), acima dos pisos
   - _idCamada : Adiciona a imagem na camada de background (fundo), abaixo dos pisos até o id [0-50]
   - !idCamada : Adiciona a imagem na camada de foreground (primeiro plano)
   - &idCamada : Adiciona a imagem fixa
  - posicaoX (Int) : a compensação horizontal no topo, a esquerda, da imagem (valor padrão = 0)
  - posicaoY (Int) : a compensação vertical no topo, a esquerda, da imagem (valor padrão = 0)
  - jogador (String) : o jogador que irá ver a imagem (se nil, aplica-se para todos os jogadores) (valor padrão = nil)
 Retorna: (Int) o id da imagem no mapa



• tfm.exec.addJoint ( id, piso1, piso2, definicoes )
 Adiciona uma joint (junta) entre dois objetos físicos (pisos). Note: Num código XML, você também pode adicionar uma propriedade " lua="id" " numa tag de joint para poder interagir com a mesma com Lua.
 Parâmetros:
  - id (Int) : o id da joint
  - piso1 (Int) : o primeiro piso que a joint irá afetar
  - piso2 (Int) : o segundo piso que a joint irá afetar
  - definicoes (Table) : a descrição da joint [Não se deve traduzir o nome dos atributos]
   - 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.addPhysicObject ( id, posicaoX, posicaoY, definicoes )
 Spawna um piso.
 Parâmetros:
  - id (Int) : o id do objeto físico (piso)
  - posicaoX (Int) : a coordenada horizontal do centro do piso
  - posicaoY (Int) : a coordenada vertical do centro do piso
  - definicoes (Table) : a descrição do piso [Não se deve traduzir o nome dos atributos]
   - type (Int), width (Int), height (Int), foreground (Boolean), friction (Float), restitution (Float), angle (Int), color (Int), miceCollision (Boolean), groundCollision (Boolean) : Respectivamente, tipo, largura, altura, plano de fundo, fricção, restituição, ângulo, cor, colisão com os ratos, colisão com os pisos
   - dynamic (Boolean), fixedRotation (Boolean), mass (Int), linearDamping (Float), angularDamping (Float) : [Respectivamente, dinâmico, rotação fixa, massa, amortecimento linear, amortecimento angular] Usados apenas para pisos dinâmicos.



• tfm.exec.addShamanObject ( tipo, posicaoX, posicaoY, angulo, velocidadeX, velocidadeY, transparente )
 Spawna um objeto shaman.
 Parâmetros:
  - tipo (Int) : o tipo (id) do objeto shaman a ser spawnado
  - posicaoX (Int) : a posição horizontal de spawn
  - posicaoY (Int) : a posição vertical de spawn
  - angulo (Int) : o ângulo de rotação do objetothe rotation, em graus (valor padrão = 0)
  - velocidadeX (Int) : a velocidade horizontal do objeto (valor padrão = 0)
  - velocidadeY (Int) : a velocidade vertical do objeto (valor padrão = 0)
  - transparente (Boolean) : se o objeto a ser spawnado deve ser transparente (valor padrão = false)
 Retorna: (Int) o id do objeto shaman no mapa (não do objeto shaman)



• tfm.exec.chatMessage ( mensagem, jogador )
 Mostra uma mensagem no chat.
 Parâmetros:
  - mensagem (String) : a mensagem do chat a ser mostrada
  - jogador (String) : o jogador do qual receberá a mensagem (se nil, aplica-se para todos os jogadores) (valor padrão = nil)



• tfm.exec.disableAfkDeath ( desativar )
 Desativa a morte automática por ausência.
 Parâmetros:
  - desativar (Boolean) : se deve desativar ou não (valor padrão = true)



• tfm.exec.disableAllShamanSkills ( desativar )
 Desativa todas as habilidades shaman.
 Parâmetros:
  - desativar (Boolean) : se deve desativar ou não (valor padrão = true)



• tfm.exec.disableAutoNewGame ( desativar )
 Desativa o acontecimento de uma nova partida quando o tempo acaba.
 Parâmetros:
  - desativar (Boolean) : se deve desativar ou não (valor padrão = true)



• tfm.exec.disableAutoScore ( desativar )
 Desativa o sistema de pontuação automática ao morrer, entrar na toca, etc.
 Parâmetros:
  - desativar (Boolean) : se deve desativar ou não (valor padrão = true)



• tfm.exec.disableAutoShaman ( desativar )
 Desativa a seleção automática de shaman.
 Parâmetros:
  - desativar (Boolean) : se deve desativar ou não (valor padrão = true)



• tfm.exec.disableAutoTimeLeft ( desativar )
 Desativa a mudança automática de tempo para 20s (quando o shaman morre, por exemplo).
 Parâmetros:
  - desativar (Boolean) : se deve desativar ou não (valor padrão = true)



• tfm.exec.disableDebugCommand ( desativar )
 Desativa os efeitos do comando /debug.
 Parâmetros:
  - desativar (Boolean) : se deve desativar ou não (valor padrão = true)



• tfm.exec.disableMinimalistMode ( desativar )
 Desativa o modo minimalista.
 Parâmetros:
  - desativar (Boolean) : se deve desativar ou não (valor padrão = true)



• tfm.exec.disableMortCommand ( desativar )
 Desativa o comando /mort.
 Parâmetros:
  - desativar (Boolean) : se deve desativar ou não (valor padrão = true)



• tfm.exec.disablePhysicalConsumables ( desativar )
 Desativar consumíveis físicos (como nas salas bootcamp e racing).
 Parâmetros:
  - desativar (Boolean) : se deve desativar ou não (valor padrão = true)



• tfm.exec.disableWatchCommand ( desativar )
 Desativa os efeitos do comando /watch.
 Parâmetros:
  - desativar (Boolean) : se deve desativar ou não (valor padrão = true)



• tfm.exec.displayParticle ( tipo, posicaoX, posicaoY, velocidadeX, velocidadeY, aceleracaoX, aceleracaoY, jogador )
 Mostra uma partícula.
 Parâmetros:
  - tipo (Int) : o tipo de partícula [id] que você quer mostrar
  - posicaoX (Int) : a coordenada horizontal da partícula
  - posicaoY (Int) : a coordenada vertical da partícula
  - velocidadeX (Number) : a velocidade horizontal da partícula (valor padrão = 0)
  - velocidadeY (Number) : a velocidade horizontal da partícula (valor padrão = 0)
  - aceleracaoX (Number) : a aceleração horizontal da partícula (valor padrão = 0)
  - aceleracaoY (Number) : a aceleração vertical da partícula (valor padrão = 0)
  - jogador (String) : o jogador que deve ver a partícula (se nil, aplica-se para todos os jogadores) (valor padrão = nil)



• tfm.exec.explosion ( posicaoX, posicaoY, poder, raio, apenasRato )
 Faz uma explosão.
 Parâmetros:
  - posicaoX (Int) : a coordenada horizontal do centro da explosão
  - posicaoY (Int) : a coordenada vertical do centro da explosão
  - poder (Int) : o poder máximo da explosão
  - raio (Int) : o raio da explosão (ratos fora dele não serão afetados)
  - apenasRato (Boolean) : se a explosão deve afetar apenas os ratos, ou objetos também (valor padrão = false)



• tfm.exec.giveCheese ( jogador )
 Dá queijo ao jogador.
 Parâmetros:
  - jogador (String) : o jogador que deverá ter o queijo



• tfm.exec.giveConsumables ( jogador, id, quantidade )
 Dá consumíveis para o jogador selecionado.
 Parâmetros:
  - jogador (String) : o jogador a receber os consumíveis
  - id (String) : o id do consumível
  - quantidade (String) : a quantidade de consumíveis a serem atribuidos (valor padrão = "1")



• tfm.exec.giveMeep ( jogador )
 Dá a competência meep ao jogador.
 Parâmetros:
  - jogador (String) : o jogador que será capaz de meep!



• tfm.exec.killPlayer ( jogador )
 Mata o jogador selecionado.
 Parâmetros:
  - jogador (String) : o jogador selecionado



• tfm.exec.lowerSyncDelay ( jogador )
 Reduz o atraso de sincronização do jogador para o máximo de 400ms
 Parâmetros:
  - jogador (String) : o jogador que deverá ter o atraso (delay) reduzido



• tfm.exec.moveObject ( id, posicaoX, posicaoY, somaPosicao, velocidadeX, velocidadeY, somaVelocidade, angulo, somaAngulo )
 Define a velocidade, a posição e o angulo do objeto shaman.
 Parâmetros:
  - id (Int) : o id do objeto shaman (não do objeto, e sim o id do objeto presente no mapa)
  - posicaoX (Int) : a coordenada horizontal do ponto onde o objeto será movido
  - posicaoY (Int) : a coordenada vertical do ponto onde o objeto será movido
  - somaPosicao (Boolean) : se a posição especificada deve ser adicionada a atual ou não (valor padrão = false)
  - velocidadeX (Int) : a coordenada horizontal da velocidade a ser atribuída ao objeto (valor padrão = 0)
  - velocidadeY (Int) : a coordenada vertical da velocidade a ser atribuída ao objeto (valor padrão = 0)
  - somaVelocidade (Boolean) : se a velocidade especificada deve ser adicionada a atual ou não (valor padrão = false)
  - angulo (Int) : o angulo do objeto (valor padrão = 0)
  - somaAngulo (Boolean) : se o angulo especificada deve ser adicionado ao atual ou não (valor padrão = false)



• tfm.exec.movePlayer ( jogador, posicaoX, posicaoY, somaPosicao, velocidadeX, velocidadeY, somaVelocidade )
 Define a velocidade e a posição do jogador.
 Parâmetros:
  - jogador (String) : o jogador a ser movido
  - posicaoX (Int) : a coordenada horizontal do ponto onde o jogador será movido
  - posicaoY (Int) : a coordenada vertical do ponto onde o jogador será movido
  - somaPosicao (Boolean) : se a posição especificada deve ser adicionada a atual ou não (valor padrão = false)
  - velocidadeX (Int) : a coordenada horizontal da velocidade a ser atribuída ao jogador (valor padrão = 0)
  - velocidadeY (Int) : a coordenada vertical da velocidade a ser atribuída ao jogador (valor padrão = 0)
  - somaVelocidade (Boolean) : se a velocidade especificada deve ser adicionada a atual ou não (valor padrão = false)



• tfm.exec.newGame ( mapa, espelhado )
 Inicia uma nova partida
 Parâmetros:
  - mapa (String) : o código do mapa (valor padrão = nil)
   - nil (cafofo da tribo)
   - (int) 6 (mapa vanilla)
   - (String) @42583 (mapa do editor)
   - (String) #4 (categoria de mapas)
   - (String) qualquer coisa que comece com '<' (mapa XML)
  - espelhado (Boolean) : se o mapa deve ser espelhado (valor padrão = nil (espelhamento aleatório))



• tfm.exec.playEmote ( jogador, tipo, parametro )
 Faz com que um jogador faça uma emoção.
 Parâmetros:
  - jogador (String) : o jogador que deve fazer a emoção
  - tipo (Int) : o tipo (id) da emoção a ser feita
  - parametro (String) : o atributo da emoção (para a emoção da bandeira, por exemplo) (valor padrão = nil)



• tfm.exec.playerVictory ( jogador )
 Faz com que o jogador entre na toca.
 Parâmetros:
  - jogador (String) : o jogador que deve entrar na toca



• tfm.exec.removeImage ( id )
 Remove uma imagem.
 Parâmetros:
  - id (Int) : o id da imagem (não da imagem, e sim da imagem no mapa)



• tfm.exec.removeJoint ( id )
 Remove uma joint (junta) do mapa.
 Parâmetros:
  - id (Int) : o id da joint a ser removida



• tfm.exec.removeObject ( id )
 Remove um objeto shaman.
 Parâmetros:
  - id (Int) : o id do objeto shaman (não do objeto shaman, mas do objeto shaman no mapa)



• tfm.exec.removePhysicObject ( id )
 Remove um objeto físico (piso) do mapa.
 Parâmetros:
  - id (Int) : o id do piso a ser removido



• tfm.exec.respawnPlayer ( jogador )
 Revive um jogador.
 Parâmetros:
  - jogador (String) : o jogador a ser revivido



• tfm.exec.setAutoMapFlipMode ( espelhamento )
 Escolhe se o mapa seguinte deve ser espelhado ou não (sempre, nunca, comportamento padrão).
 Parâmetros:
  - espelhamento (Boolean) : Se os mapas devem ser espelhados (valor padrão = nil (comportamento padrão))



• tfm.exec.setGameTime ( tempo, controle )
 Atribui o tempo restante ao mapa.
 Parâmetros:
  - tempo (Int) : o tempo restante em segundos
  - controle (Boolean) : se o tempo restante deve mudar mesmo se o tempo especificado for maior que o tempo atual (valor padrão = true)



• tfm.exec.setNameColor ( jogador, cor )
 Altera a cor do nome do jogador.
 Parâmetros:
  - jogador (String) : o jogador que deve ter seu nome colorido
  - cor (Int) : a cor do nome



• tfm.exec.setPlayerScore ( jogador, pontos, adicionar )
 Atribui a pontuação do jogador.
 Parâmetros:
  - jogador (String) : o jogador que deve ter sua pontuação alterada
  - pontos (Int) : os pontos
  - adicionar (Boolean) : se a pontuação atual deve ser adicionada a especificada (valor padrão = false)



• tfm.exec.setRoomMaxPlayers ( jogadoresMaximos )
 Atribui a quantidade máxima de jogadores na sala.
 Parâmetros:
  - jogadoresMaximos (Int) : o número máximo de jogadores na sala



• tfm.exec.setRoomPassword ( senha )
 Protege a sala com senha.
 Parâmetros:
  - senha (String) : a senha em forma de texto (um texto vazio "" remove a senha)



• tfm.exec.setShaman ( jogador )
 Transforma o jogador em shaman.
 Parâmetros:
  - jogador (String) : o jogador que deve se tornar um shaman



• tfm.exec.setVampirePlayer ( jogador )
 Transforma um jogador num vampiro.
 Parâmetros:
  - jogador (String) : o jogador a ser transformado em vampiro



• tfm.exec.snow ( duracao, poder )
 Cria uma nevasca.
 Parâmetros:
  - duracao (Int) : a duração, em segundos, da nevasca (valor padrão = 60)
  - poder (Int) : o poder da nevasca (valor padrão = 10)




• ui.addPopup ( id, tipo, texto, jogador, x, y, largura, posicaoFixa )
 Mostra uma popup.
 Parâmetros:
  - id (Int) : o id da popup
  - tipo (Int) : o tipo da popup
   - 0 (Simples)
   - 1 (Sim | Não)
   - 2 (Caixa de texto)
  - texto (String) : o texto a ser mostrado
  - jogador (String) : o jogador que poderá ver a popup (se nil, aplica-se para todos os jogadores)
  - x (Int) : a coordenada horizontal do topo, a esquerda (valor padrão = 50)
  - y (Int) : a coordenada vertical do topo, a esquerda (valor padrão = 50)
  - largura (Int) : a largura em pixeis da popup (se 0, será ajustado de acordo com a largura do texto) (valor padrão = 0)
  - posicaoFixa (Boolean) : se a posição é fixa ou se deve seguir o jogador em mapas longos (valor padrão = false)



• ui.addTextArea ( id, texto, jogador, x, y, largura, altura, corFundo, corBorda, opacidade, posicaoFixa )
 Mostra uma textarea.
 Parâmetros:
  - id (Int) : o id da textarea
  - texto (String) : o texto a ser mostrado
  - jogador (String) : o jogador que poderá ver a popup (se nil, aplica-se para todos os jogadores)
  - x (Int) : a coordenada horizontal do topo, a esquerda (valor padrão = 50)
  - y (Int) : a coordenada vertical do topo, a esquerda (valor padrão = 50)
  - largura (Int) : a largura em pixeis da textarea (se 0, será ajustado de acordo com a largura do texto) (valor padrão = 0)
  - altura (Int) : a altura em pixeis da textarea (se 0, será ajustado de acordo com a altura do texto) (valor padrão = 0)
  - corFundo (Int) : a cor de fundo da textarea (valor padrão = 0x324650)
  - corBorda (Int) : a cor da borda da textarea (valor padrão = 0)
  - opacidade (Number) : a opacidade do fundo da textarea, de 0 (transparente) até 1 (opaco) (valor padrão = 1)
  - posicaoFixa (Boolean) : se a posição é fixa ou se deve seguir o jogador em mapas longos (valor padrão = false)



• ui.removeTextArea ( id, jogador )
 Remove uma textarea.
 Parâmetros:
  - id (Int) : o id da textarea
  - jogador (String) : o jogador que terá a textarea removida de sua tela (se nil, aplica-se para todos os jogadores) (valor padrão = nil)



• ui.setMapName ( texto )
 Atribui nome ao mapa.
 Parâmetros:
  - texto (String) : o texto a ser mostrado no nome do mapa



• ui.setShamanName ( texto )
 Atribui nome ao shaman (não ao jogador shaman).
 Parâmetros:
  - texto (String) : o texto a ser mostrado no nome do shaman



• ui.showColorPicker ( id, jogador, corPadrao, titulo )
 Mostra um selecionador de cores.
 Parâmetros:
  - id (Int) : o id do selecionador de cores
  - jogador (String) : o jogador que irá ver o selecionador de cores (se nil, aplica-se para todos os jogadores) (valor padrão = nil)
  - corPadrao (Int) : a cor padrão (inicial) no selecionador de cores (valor padrão = 0)
  - titulo (String) : o título do selecionador de cores (valor padrão = nil)



• ui.updateTextArea ( id, texto, jogador )
 Atualiza o conteúdo de uma textarea.
 Parâmetros:
  - id (Int) : o id da textarea
  - texto (String) : o novo texto a ser mostrado
  - jogador (String) : o jogador que verá o novo texto (se nil, aplica-se para todos os jogadores) (valor padrão = nil)