File /std/room/punishments/fine.c

Written by Pinkfish

Started Thu Sep 21 14:35:32 PDT 2000

Inherits

Includes

Class Index

• fine_type

Method index

• pay_fine(string, int)
  This method pays a fine.
• query_current_fine(string)
  This method figures out the current fine for the person.
• query_money_area()
  This method returns the money area of the fine.
• query_people_with_fines()
  This method returns the list of players that have outstanding fines in the fine handler.
• query_save_file()
  This method returns the save file of the fines.
• query_total_fine(string)
  This method figures out the current total fine for the person.
• query_total_payments(string)
  This method figures out the current total fine for the person.
• remove_old_fines()
  This method nips through the list of fines and removes any fines that are either for people that do not exist any more, or totals that are old.
• set_money_area(string)
  This method sets the money area of the fine.
• set_save_file(string)
  This method sets the save file of the fines.

Public Functions

These are functions that everyone can access.

.

pay_fine

int pay_fine(string person,
             int amount)


This method pays a fine.

• Parameters:
  person - the person doing the payment
  amount - the amount being paid
• Returns:
  1 on success, 0 on failure

query_current_fine

int query_current_fine(string person)


This method figures out the current fine for the person.

• Parameters:
  person - the person to get the fine for
• Returns:
  the currently outstanding fines
  query_money_area

  string query_money_area()
  

  
  This method returns the money area of the fine.
  
  • Returns:
    the money area
    query_people_with_fines

    string * query_people_with_fines()
    

    
    This method returns the list of players that have outstanding fines in the fine handler.
    
    • Returns:
      the list of players
      query_save_file

      string query_save_file()
      

      
      This method returns the save file of the fines.
      
      • Returns:
        the save file name
        query_total_fine

        int query_total_fine(string person)
        

        
        This method figures out the current total fine for the person.
        
        • Parameters:
          person - the person to get the fine for
        • Returns:
          the currently outstanding fines
          query_total_payments

          int query_total_payments(string person)
          

          
          This method figures out the current total fine for the person.
          
          • Parameters:
            person - the person to get the fine for
          • Returns:
            the currently outstanding fines
            remove_old_fines

            void remove_old_fines()
            

            
            This method nips through the list of fines and removes any fines that are either for people that do not exist any more, or totals that are old.
            set_money_area

            void set_money_area(string area)
            

            
            This method sets the money area of the fine.
            
            • Parameters:
              area - the money area
              set_save_file

              void set_save_file(string fname)
              

              
              This method sets the save file of the fines.
              
              • Parameters:
                fname - the save file name

                Classes

                These are nice data types for dealing with... Data!
                • fine_type

                  class fine_type {
                                    int paid;
                                    int fines;
                                    int last_touched;
                  }