0 MSi - Logs

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 Code:

  
  
  #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 Code:

  
  
  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 Code:

  
  
  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 Code:

  
  
  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 Code:

  
  
  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 Code:

  
  
  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.

                                                                   Criador : Larceny