👨‍🏭User

Documentação da Classe User

A classe User permite manipular informações e atributos de jogadores, monstros ou NPCs em um servidor de jogos. Esta documentação apresenta as funções de forma clara, intuitiva e com exemplos práticos e concisos para facilitar o uso.


Como Usar a Classe User

  1. Inicialização: Crie um objeto User passando o índice (aIndex) do jogador, monstro ou NPC.

    local player = User.new(aIndex)
  2. Uso de Funções: Use o operador : para chamar as funções, que retornam ou definem atributos específicos.

  3. Observação:

    • Você pode usar a classe para um ou mais índices (ex.: player para um jogador, playerTarget para outro).

    • É possível usar dentro de loops, como em um for.

    • Exemplo com múltiplos índices:

      local player = User.new(aIndex)
      local playerTarget = User.new(TargetIndex)
      player:getName()
      playerTarget:getName()

Funções da Classe User

Abaixo estão todas as funções disponíveis, explicadas de forma simples com exemplos práticos:

1. getIndex()

  • Descrição: Retorna o aIndex do jogador, monstro ou NPC.

  • Exemplo:

2. getAccountID()

  • Descrição: Retorna o ID da conta do jogador.

  • Exemplo:

3. getName()

  • Descrição: Retorna o nome do jogador.

  • Exemplo:

4. getConnected()

  • Descrição: Retorna o estado de conexão: 0 = Offline, 1 = Conectado, 2 = Logado, 3 = Online.

  • Exemplo:

5. getLive()

  • Descrição: Retorna 1 se o jogador está vivo, ou 0 caso contrário.

  • Exemplo:

6. getType()

  • Descrição: Retorna o tipo: 0 = nenhum, 1 = usuário, 2 = monstro, 3 = NPC.

  • Exemplo:

7. getClass()

  • Descrição: Retorna a classe do jogador ou o número do monstro no monster.txt.

  • Exemplo:

8. setClass(value)

  • Descrição: Define a classe do jogador ou monstro.

  • Exemplo:

9. getDbClass()

  • Descrição: Retorna a classe do banco de dados.

  • Exemplo:

10. setDbClass(value)

  • Descrição: Define a classe do banco de dados.

  • Exemplo:

11. getChangeUP()

  • Descrição: Retorna a mudança de classe do jogador.

  • Exemplo:

12. setChangeUP(value)

  • Descrição: Define a mudança de classe.

  • Exemplo:

13. getLevel()

  • Descrição: Retorna o nível do jogador.

  • Exemplo:

14. setLevel(value)

  • Descrição: Define o nível do jogador.

  • Exemplo:

15. getLevelUpPoint()

  • Descrição: Retorna os pontos de nível disponíveis.

  • Exemplo:

16. setLevelUpPoint(value)

  • Descrição: Define os pontos de nível.

  • Exemplo:

17. getMoney()

  • Descrição: Retorna o dinheiro do jogador.

  • Exemplo:

18. setMoney(value)

  • Descrição: Define o dinheiro do jogador.

  • Exemplo:

19. getStrength()

  • Descrição: Retorna a força do jogador.

  • Exemplo:

20. setStrength(value)

  • Descrição: Define a força do jogador.

  • Exemplo:

21. getDexterity()

  • Descrição: Retorna a destreza do jogador.

  • Exemplo:

22. setDexterity(value)

  • Descrição: Define a destreza do jogador.

  • Exemplo:

23. getVitality()

  • Descrição: Retorna a vitalidade do jogador.

  • Exemplo:

24. setVitality(value)

  • Descrição: Define a vitalidade do jogador.

  • Exemplo:

25. getEnergy()

  • Descrição: Retorna a energia do jogador.

  • Exemplo:

26. setEnergy(value)

  • Descrição: Define a energia do jogador.

  • Exemplo:

27. getLeaderShip()

  • Descrição: Retorna a liderança do jogador.

  • Exemplo:

28. setLeaderShip(value)

  • Descrição: Define a liderança do jogador.

  • Exemplo:

29. getPKCount()

  • Descrição: Retorna a contagem de PK (Player Kill) do jogador.

  • Exemplo:

30. setPKCount(value)

  • Descrição: Define a contagem de PK.

  • Exemplo:

31. getPKLevel()

  • Descrição: Retorna o nível de PK do jogador.

  • Exemplo:

32. setPKLevel(value)

  • Descrição: Define o nível de PK.

  • Exemplo:

33. getPKTime()

  • Descrição: Retorna o tempo de PK do jogador.

  • Exemplo:

34. setPKTime(value)

  • Descrição: Define o tempo de PK.

  • Exemplo:

35. getX()

  • Descrição: Retorna a posição X do jogador no mapa.

  • Exemplo:

36. setX(value)

  • Descrição: Define a posição X do jogador no mapa.

  • Exemplo:

37. getY()

  • Descrição: Retorna a posição Y do jogador no mapa.

  • Exemplo:

38. setY(value)

  • Descrição: Define a posição Y do jogador no mapa.

  • Exemplo:

39. getTX()

  • Descrição: Retorna a posição TX do jogador.

  • Exemplo:

40. setTX(value)

  • Descrição: Define a posição TX do jogador.

  • Exemplo:

41. getTY()

  • Descrição: Retorna a posição TY do jogador.

  • Exemplo:

42. setTY(value)

  • Descrição: Define a posição TY do jogador.

  • Exemplo:

43. getMTX()

  • Descrição: Retorna a posição MTX do jogador.

  • Exemplo:

44. setMTX(value)

  • Descrição: Define a posição MTX do jogador.

  • Exemplo:

45. getMTY()

  • Descrição: Retorna a posição MTY do jogador.

  • Exemplo:

46. setMTY(value)

  • Descrição: Define a posição MTY do jogador.

  • Exemplo:

47. getMapNumber()

  • Descrição: Retorna o número do mapa onde o jogador está.

  • Exemplo:

48. setMapNumber(value)

  • Descrição: Define o número do mapa.

  • Exemplo:

49. getAuthority()

  • Descrição: Retorna a autoridade do jogador.

  • Exemplo:

50. setAuthority(value)

  • Descrição: Define a autoridade do jogador.

  • Exemplo:

51. getAuthorityCode()

  • Descrição: Retorna o código de autoridade do jogador.

  • Exemplo:

52. setAuthorityCode(value)

  • Descrição: Define o código de autoridade.

  • Exemplo:

53. getSkin()

  • Descrição: Retorna o número da skin do jogador.

  • Exemplo:

54. setSkin(value)

  • Descrição: Define o número da skin do jogador.

  • Exemplo:

55. getExp()

  • Descrição: Retorna a experiência atual do jogador.

  • Exemplo:

56. setExp(value)

  • Descrição: Define a experiência do jogador.

  • Exemplo:

57. getTargetState(viewport_ID)

  • Descrição: Retorna o estado do alvo na área de visão do jogador.

  • Exemplo:

58. getTargetNumber(viewport_ID)

  • Descrição: Retorna o aIndex do alvo na área de visão.

  • Exemplo:

59. getTargetType(viewport_ID)

  • Descrição: Retorna o tipo do alvo na área de visão.

  • Exemplo:

60. getInterfaceUse()

  • Descrição: Retorna 1 se a interface está em uso.

  • Exemplo:

61. setInterfaceUse(value)

  • Descrição: Define o uso da interface.

  • Exemplo:

62. getInterfaceState()

  • Descrição: Retorna o estado da interface.

  • Exemplo:

63. setInterfaceState(value)

  • Descrição: Define o estado da interface.

  • Exemplo:

64. getInterfaceType()

  • Descrição: Retorna o tipo de interface aberta.

  • Exemplo:

65. setInterfaceType(value)

  • Descrição: Define o tipo de interface.

  • Exemplo:

66. getDefense()

  • Descrição: Retorna o valor da defesa do jogador.

  • Exemplo:

67. setDefense(value)

  • Descrição: Define o valor da defesa.

  • Exemplo:

68. getDefensePvP()

  • Descrição: Retorna o valor da defesa PvP do jogador.

  • Exemplo:

69. setDefensePvP(value)

  • Descrição: Define o valor da defesa PvP.

  • Exemplo:

70. getSuccessBlock()

  • Descrição: Retorna a defesa de sucesso do jogador.

  • Exemplo:

71. setSuccessBlock(value)

  • Descrição: Define a defesa de sucesso.

  • Exemplo:

72. getSuccessBlockPvP()

  • Descrição: Retorna a defesa de sucesso PvP do jogador.

  • Exemplo:

73. setSuccessBlockPvP(value)

  • Descrição: Define a defesa de sucesso PvP.

  • Exemplo:

74. getState()

  • Descrição: Retorna o estado do jogador.

  • Exemplo:

75. setState(value)

  • Descrição: Define o estado do jogador.

  • Exemplo:

76. getDieRegen()

  • Descrição: Retorna se o jogador está morto.

  • Exemplo:

77. setDieRegen(value)

  • Descrição: Define se o jogador está morto.

  • Exemplo:

78. getTeleport()

  • Descrição: Retorna se o jogador está teleportando.

  • Exemplo:

79. setTeleport(value)

  • Descrição: Define se o jogador está teleportando.

  • Exemplo:

80. getTargetShopNumber()

  • Descrição: Retorna o número da loja do NPC.

  • Exemplo:

81. setTargetShopNumber(value)

  • Descrição: Define o número da loja do NPC.

  • Exemplo:

82. getReqWarehouseOpen()

  • Descrição: Retorna 1 se o armazém está aberto.

  • Exemplo:

83. setReqWarehouseOpen(value)

  • Descrição: Define se o armazém está aberto.

  • Exemplo:

84. getWarehouseCount()

  • Descrição: Retorna o número de armazéns.

  • Exemplo:

85. setWarehouseCount(value)

  • Descrição: Define o número de armazéns.

  • Exemplo:

86. getDir()

  • Descrição: Retorna a direção do jogador.

  • Exemplo:

87. setDir(value)

  • Descrição: Define a direção do jogador.

  • Exemplo:

88. getNextExp()

  • Descrição: Retorna a experiência necessária para o próximo nível.

  • Exemplo:

89. setNextExp(value)

  • Descrição: Define a experiência necessária para o próximo nível.

  • Exemplo:

90. getLife()

  • Descrição: Retorna a vida atual do jogador.

  • Exemplo:

91. setLife(value)

  • Descrição: Define a vida atual do jogador.

  • Exemplo:

92. getMana()

  • Descrição: Retorna o mana atual do jogador.

  • Exemplo:

93. setMana(value)

  • Descrição: Define o mana atual do jogador.

  • Exemplo:

94. getMaxLife()

  • Descrição: Retorna a vida máxima do jogador.

  • Exemplo:

95. setMaxLife(value)

  • Descrição: Define a vida máxima do jogador.

  • Exemplo:

96. getMaxMana()

  • Descrição: Retorna o mana máximo do jogador.

  • Exemplo:

97. setMaxMana(value)

  • Descrição: Define o mana máximo do jogador.

  • Exemplo:

98. getBP()

  • Descrição: Retorna o BP (Battle Power) atual do jogador.

  • Exemplo:

99. setBP(value)

  • Descrição: Define o BP atual do jogador.

  • Exemplo:

100. getMaxBP()

  • Descrição: Retorna o BP máximo do jogador.

  • Exemplo:

101. setMaxBP(value)

  • Descrição: Define o BP máximo do jogador.

  • Exemplo:

102. getShield()

  • Descrição: Retorna o escudo atual do jogador.

  • Exemplo:

103. setShield(value)

  • Descrição: Define o escudo atual do jogador.

  • Exemplo:

104. getMaxShield()

  • Descrição: Retorna o escudo máximo do jogador.

  • Exemplo:

105. setMaxShield(value)

  • Descrição: Define o escudo máximo do jogador.

  • Exemplo:

106. getVitalityToLife()

  • Descrição: Retorna a conversão de vitalidade em vida.

  • Exemplo:

107. setVitalityToLife(value)

  • Descrição: Define a conversão de vitalidade em vida.

  • Exemplo:

108. getEnergyToMana()

  • Descrição: Retorna a conversão de energia em mana.

  • Exemplo:

109. setEnergyToMana(value)

  • Descrição: Define a conversão de energia em mana.

  • Exemplo:

110. getOption()

  • Descrição: Retorna as opções do jogador (ex.: comércio, party).

  • Exemplo:

111. setOption(value)

  • Descrição: Define as opções do jogador.

  • Exemplo:

112. getAddLife()

  • Descrição: Retorna a vida adicional do jogador.

  • Exemplo:

113. setAddLife(value)

  • Descrição: Define a vida adicional do jogador.

  • Exemplo:

114. getAddMana()

  • Descrição: Retorna o mana adicional do jogador.

  • Exemplo:

115. setAddMana(value)

  • Descrição: Define o mana adicional do jogador.

  • Exemplo:

116. getAddBP()

  • Descrição: Retorna o BP adicional do jogador.

  • Exemplo:

117. setAddBP(value)

  • Descrição: Define o BP adicional do jogador.

  • Exemplo:

118. getAttackSpeed()

  • Descrição: Retorna a velocidade de ataque do jogador.

  • Exemplo:

119. setAttackSpeed(value)

  • Descrição: Define a velocidade de ataque do jogador.

  • Exemplo:

120. getMagicSpeed()

  • Descrição: Retorna a velocidade de magia do jogador.

  • Exemplo:

121. setMagicSpeed(value)

  • Descrição: Define a velocidade de magia do jogador.

  • Exemplo:

122. getMagicDamageMin()

  • Descrição: Retorna o dano mínimo de magia.

  • Exemplo:

123. setMagicDamageMin(value)

  • Descrição: Define o dano mínimo de magia.

  • Exemplo:

124. getMagicDamageMax()

  • Descrição: Retorna o dano máximo de magia.

  • Exemplo:

125. setMagicDamageMax(value)

  • Descrição: Define o dano máximo de magia.

  • Exemplo:

126. getAttackDamageMinLeft()

  • Descrição: Retorna o dano mínimo de ataque à esquerda.

  • Exemplo:

127. setAttackDamageMinLeft(value)

  • Descrição: Define o dano mínimo de ataque à esquerda.

  • Exemplo:

128. getAttackDamageMaxLeft()

  • Descrição: Retorna o dano máximo de ataque à esquerda.

  • Exemplo:

129. setAttackDamageMaxLeft(value)

  • Descrição: Define o dano máximo de ataque à esquerda.

  • Exemplo:

130. getAttackDamageMinRight()

  • Descrição: Retorna o dano mínimo de ataque à direita.

  • Exemplo:

131. setAttackDamageMinRight(value)

  • Descrição: Define o dano mínimo de ataque à direita.

  • Exemplo:

132. getAttackDamageMaxRight()

  • Descrição: Retorna o dano máximo de ataque à direita.

  • Exemplo:

133. setAttackDamageMaxRight(value)

  • Descrição: Define o dano máximo de ataque à direita.

  • Exemplo:

134. getRegenTime()

  • Descrição: Retorna o tempo de regeneração do jogador.

  • Exemplo:

135. setRegenTime(value)

  • Descrição: Define o tempo de regeneração do jogador.

  • Exemplo:

136. getViewSkillState()

  • Descrição: Retorna o estado da skill visual (funciona bem apenas na temporada 2).

  • Exemplo:

137. setViewSkillState(value)

  • Descrição: Define o estado da skill visual.

  • Exemplo:

138. getGetRegen()

  • Descrição: Retorna se a regeneração está ativa.

  • Exemplo:

139. setGetRegen(value)

  • Descrição: Define se a regeneração está ativa.

  • Exemplo:

140. getMagicSkill()

  • Descrição: Retorna a habilidade mágica em uso.

  • Exemplo:

141. setMagicSkill(value)

  • Descrição: Define a habilidade mágica em uso.

  • Exemplo:

142. getKillerType()

  • Descrição: Retorna o tipo de matador.

  • Exemplo:

143. setKillerType(value)

  • Descrição: Define o tipo de matador.

  • Exemplo:

144. getConnectCheckTime()

  • Descrição: Retorna o tempo de verificação de conexão.

  • Exemplo:

145. setConnectCheckTime(value)

  • Descrição: Define o tempo de verificação de conexão.

  • Exemplo:

146. getCheckSumTime()

  • Descrição: Retorna o tempo de verificação de checksum.

  • Exemplo:

147. setCheckSumTime(value)

  • Descrição: Define o tempo de verificação de checksum.

  • Exemplo:

148. getPathCount()

  • Descrição: Retorna a contagem de caminhos do jogador.

  • Exemplo:

149. setPathCount(value)

  • Descrição: Define a contagem de caminhos.

  • Exemplo:

150. getPathNextX()

  • Descrição: Retorna o próximo valor de caminho X.

  • Exemplo:

151. setPathNextX(value)

  • Descrição: Define o próximo valor de caminho X.

  • Exemplo:

152. getPathNextY()

  • Descrição: Retorna o próximo valor de caminho Y.

  • Exemplo:

153. setPathNextY(value)

  • Descrição: Define o próximo valor de caminho Y.

  • Exemplo:

154. getPathNextMapNumber()

  • Descrição: Retorna o próximo número de mapa.

  • Exemplo:

155. setPathNextMapNumber(value)

  • Descrição: Define o próximo número de mapa.

  • Exemplo:

156. getPathNextState()

  • Descrição: Retorna o próximo estado de caminho.

  • Exemplo:

157. setPathNextState(value)

  • Descrição: Define o próximo estado de caminho.

  • Exemplo:

158. getAddDefense()

  • Descrição: Retorna a defesa adicional do jogador.

  • Exemplo:

159. setAddDefense(value)

  • Descrição: Define a defesa adicional do jogador.

  • Exemplo:

160. getAddDamage()

  • Descrição: Retorna o dano adicional do jogador.

  • Exemplo:

161. setAddDamage(value)

  • Descrição: Define o dano adicional do jogador.

  • Exemplo:


Exemplo Prático Completo

Abaixo está um exemplo fictício que utiliza várias funções da classe User em uma única função para verificar e modificar atributos de um jogador. Este código pode ser usado como base para manipulações de jogadores.


Resumo

  • A classe User oferece um conjunto abrangente de funções para manipular atributos de jogadores, monstros ou NPCs, como vida, mana, posição, defesa, ataque e muito mais.

  • Use o operador : para chamar as funções, que retornam ou definem valores específicos.

  • O exemplo prático mostra como verificar e modificar atributos de um jogador, incluindo verificações de estado e interface.

Last updated