File /obj/furnitures/misc/newspaper_box.c

Written by Wirble

Started August 2001

Inherits

Includes

Method index

• check_for_new_papers()
  This function is called after the box loads and then again every hour.
• query_international()
  This queries if the box will work if it's in a house outside the newspaper's region.
• query_issues_left()
  This queries how many issues are left before the box is used up.
• query_last_issue()
  This queries the last issue of the paper.
• query_paper()
  This queries what paper the box is set to.
• set_international(int)
  This sets the box to international or not.
• set_issues_left(int)
  This sets the number of issues the box will handle.
• set_last_issue(int)
  This sets the last issue that was delivered.
• set_paper(string)
  This sets the newspaper the box is dedicated to.

Public Functions

These are functions that everyone can access.

.

check_for_new_papers

void check_for_new_papers()


This function is called after the box loads and then again every hour. If any new issues of the newspaper are available while the box is placed, the necessary property is added to the house's owner and the newspaper-object is put into the box. Once all issues are delivered, the call-out won't reoccur.
query_international

int query_international()


This queries if the box will work if it's in a house outside the newspaper's region.

• Returns:
  1 if international, 0 if not

query_issues_left

int query_issues_left()


This queries how many issues are left before the box is used up.

• Returns:
  the number of issues left
  query_last_issue

  int query_last_issue()
  

  
  This queries the last issue of the paper.
  
  • Returns:
    the number of the last delivered issue
    query_paper

    string query_paper()
    

    
    This queries what paper the box is set to.
    
    • Returns:
      the name of the paper
      set_international

      void set_international(int i)
      

      
      This sets the box to international or not.
      
      • Parameters:
        i - 1 for international, 0 for not.
        set_issues_left

        void set_issues_left(int _issues)
        

        
        This sets the number of issues the box will handle. This shouldn't be used after the initial creation of the box.
        
        • Parameters:
          _issues - The new number of issues
          set_last_issue

          void set_last_issue(int _issue)
          

          
          This sets the last issue that was delivered. Since it should only be called when the box is created, it makes sure that the player doesn't get issues that have been published before the box was purchased.
          
          • Parameters:
            _issue - The latest issue at the time of purchase
            set_paper

            void set_paper(string new_paper)
            

            
            This sets the newspaper the box is dedicated to.
            
            • Parameters:
              new_paper - The newspaper