File /obj/handlers/guild_things/quota/thief_quota.c

Written by Eron

Started 01/03/2001

Inherits

Includes

Method index

• adjust_debts(string, int)
  This method is used to pay a given amount toward a thief's quota up to the amount the thief owes.
• calc_thief_quota(string, int)
  This method is used to calculate a thief's quota values.
• login(string, string)
  This method is called by the login handler when a player logs on or by the code for thief leaves of absence.
• pay_thief_fines(string, int)
  This method is used to pay a given amount in fines to the Guild.
• pay_thief_quota(string, int)
  This method is used when a thief pays the Guild.
• player_quit(string)
  This method is called to log players off the quota system.
• query_old_data(string)
  This method returns quota values from the time of the previous quota reset
• query_quota(string, string)
  This method is used to retrieve quota values for a named thief.
• query_quota_data(string)
  This method returns the raw quota data
• remove_thief(string)
  This method is used to delete all quota data for a player
• reset_fines(string)
  This method is called be creators to remove fines from a thief's quota
• reset_quota(string)
  This method is used by creators to reset a thief's quota

Public Functions

These are functions that everyone can access.

.

adjust_debts

int adjust_debts(string thief,
                 int amount)


This method is used to pay a given amount toward a thief's quota up to the amount the thief owes.

• Parameters:
  thief - name of thief
• Returns:
  amount paid

calc_thief_quota

varargs class thief_quota_data calc_thief_quota(string thief,
                                                int flag)


This method is used to calculate a thief's quota values.

• Parameters:
  thief - name of thief
  flag - 1: reset quota now, 2: load data without checking reset
• Returns:
  quota record for named thief
  login

  void login(string player,
             string type)
  

  
  This method is called by the login handler when a player logs on or by the code for thief leaves of absence. It is used to start timing their time on the quota system.
  
  • Parameters:
    player - name of player logging in.
    type - may be: LOGIN, LOGOUT, or NETDEATH
    pay_thief_fines

    int pay_thief_fines(string thief,
                        int amount)
    

    
    This method is used to pay a given amount in fines to the Guild. It is used by the heavies to force payment of fines.
    
    • Parameters:
      thief - name of thief
      amount - amount paid
    • Returns:
      1 for success 0 for failure
      pay_thief_quota

      int pay_thief_quota(string thief,
                          int value)
      

      
      This method is used when a thief pays the Guild. Fines are paid first followed by theft cut owed to guild.
      
      • Parameters:
        thief - name of thief
        value - amount paid
      • Returns:
        amount left (if any) after payments are made
        player_quit

        varargs void player_quit(string player)
        

        
        This method is called to log players off the quota system.
        
        • Parameters:
          string - player name of player
          query_old_data

          mapping query_old_data(string name)
          

          
          This method returns quota values from the time of the previous quota reset
          
          • Parameters:
            name - name of thief
          • Returns:
            mapping containing old quota values
            query_quota

            varargs mixed query_quota(string thief,
                                      string type)
            

            
            This method is used to retrieve quota values for a named thief. The format of the return value depends on the "type" parameter given.
            
            • Parameters:
              thief - name of thief
              type: - "string": formatted string response showing quota data "maxquota": return maxquota value "minquota": return minquota value "total_stolen" : value of items stolen "quota_paid": value of money paid toward quota "thief_owes": value of money owed to guild "fines": value of fines owed to guild "last_check": time of last check for quota reset "time_on": time in seconds since last reset "time_to_reset": time left until quota resets default: mapping containing various values
            • Returns:
              -1 for failure or value dependent upon type
              query_quota_data

              class thief_quota_data query_quota_data(string name)
              

              
              This method returns the raw quota data
              
              • Parameters:
                name - name of thief
              • Returns:
                quota class containing quota values
                remove_thief

                void remove_thief(string thief)
                

                
                This method is used to delete all quota data for a player
                reset_fines

                int reset_fines(string thief)
                

                
                This method is called be creators to remove fines from a thief's quota
                
                • Parameters:
                  thief - name of thief
                • Returns:
                  1 for success or 0 for failure
                  reset_quota

                  int reset_quota(string thief)
                  

                  
                  This method is used by creators to reset a thief's quota
                  
                  • Parameters:
                    thief - name of thief
                  • Returns:
                    1 for success or 0 for failure