[Larceny]

Logs

- Нndice

• O que й msi_logs?
• Onde posso encontra-la?
• Como utilizar?
• Porque utilizar?
• Funзхes
• Timestamp
• Pastas necessбrias

- O que й msi_logs?

• msi_logs й uma include desenvolvida por Larceny e Lуs e tem como o objetivo facilitar a criaзгo e escrita de arquivos para LOG de dados.

- Onde posso encontra-la?

• msi_logs faz parte da livraria MSi(Master Server Includes) e pode ser encontrada neste tуpico.

- Como utilizar?

• A utilizaзгo da msi_logs й bastante simples, primeiramente vocк deve incluir a include a seu script:
  
  pawn Код:

  #include <MSi\msi_logs>

  Entгo vocк cria o arquivo log atravйs da funзгo CreateLog(file[])(caso o arquivo ainda nгo exista).
  
  E por fim jб pode comeзar a escrever as informaзхes que deseja salvar.

- Porque utilizar?

• Бs vezes й bom e importante ter um registro de certos acontecimentos do servidor & aзхes e/ou mensagens de jogadres e administradores, para garantir que tudo estб ocorrendo bem, evitar possнveis abusos da parte de jogadores e adminsitradores entre outros.
  
  Um exemplo:
  
  pawn Код:

  CMD:givemoney(playerid, params[])
  {
      new targetid, money;
      if(sscanf(params, "ud", targetid, money))
          return 0;
  
      if(!IsPlayerAdmin(playerid))
          return 0;
  
      GivePlayerMoney(targetid, money);
  
      new playerName[MAX_PLAYER_NAME];
      new targetName[MAX_PLAYER_NAME];
      GetPlayerName(playerid, playerName, MAX_PLAYER_NAME);
      GetPlayerName(targetid, targetName, MAX_PLAYER_NAME);
  
      new textToWrite[128];
      format(textToWrite, 128, "O administrador %s deu $%i para o jogador %s.", playerName, money, targetName);
      WriteLog ( "money.log", textToWrite );
  }

• O cуdigo acima escreve no arquivo money.log toda vez que um administrador der dinheiro para alguйm, assim vocк pode ficar atento a quaisquer usos indevidos deste comando.

- Funзхes

• CreateLog(file[])
  - file[]: Nome do arquivo + extensгo a ser criado.
  
  - Obs. Os logs criados vгo para a pasta MSi/Logs
  
  - Esta funзгo cria um arquivo para ser usado como LOG, exemplo:
  
  pawn Код:

  public OnGameModeInit()
  {
      if(!LogExists("money.log")) CreateLog("money.log");
      // Caso o arquivo money.log nгo existir, o arquivo й criado.
      return 1;
  }

• DeleteLog(file[])
  - file[]: Nome do arquivo + extensгo a ser deletado.
  
  - Esta funзгo deleta um arquivo de LOG.
  
  pawn Код:

  public OnGameModeInit()
  {
      if(LogExists("money.log")) DeleteLog("money.log");
      // Caso o arquivo money.log existir, o arquivo й deletado.
      return 1;
  }

• LogExists(file[])
  - file[]: Nome do arquivo + extensгo a ser deletado.
  
  - Esta funзгo verifica se um arquivo de LOG existe.
  - Obs. essa funзгo й apenas um macro para da funзгo fexist.
  
  pawn Код:

  public OnGameModeInit()
  {
      if(LogExists("money.log")) print("O arquivo money.log existe!");
      // Caso o arquivo money.log existir, й imprimido no console que ele existe.
      return 1;
  }

• WriteLog(file[], text[])
  - file[]: Nome do arquivo + extensгo a ser deletado.
  - text[]: Texto a ser escrito no log.
  
  - Esta funзгo escreve uma linha no arquivo de LOG.
  
  pawn Код:

  public OnGameModeInit()
  {
      if(!LogExists("server.log")) CreateLog("server.log");
      WriteLog("server.log", "O gamemode foi iniciado com sucesso.");
      // Escreve uma mensagem ao arquivo server.log
      return 1;
  }

- Timestamp

• Cada linha escrita no LOG conta com informaзхes de dia, mкs, ano, horas, minutos e segundos.

- Pastas necessбrias

• Apesar da livraria jб vir com as pastas necessбrias, vale reforзar que й necessбrio possuir a pasta "MSI/logs" em sua scriptfiles.