File /std/room/controller/club_room_controller.c

Written by Pinkfish

Started May 16th

Inherits

Includes

Class Index

• ownership

Method index

• add_controlled_ownership(string, int, int, mixed)
  This method adds an item to have ownership.
• discuss_elect_ownership(string, string, class discussion_idea, string, string)
  This is the function used for electing whoever gets to have the nice owned room.
• discuss_nominate_ownership(string, string, class discussion_idea, string, string)
  This is the function used for nominating someone exciting the the owned position of the club rooms.
• is_option(string)
  This method checks to see if there is an option associated with the club room.
• load_me()
  This method loads all the data from the save file.
• query_board_associated()
  This method queries to see if there is a board associated or not
• query_club()
  This method queries the club that currently owns the set of rooms.
• query_option(string)
  This method queries and option associated with the club room.
• query_room_save_file_name(mixed)
  This method returns the save file name to use for the room.
• query_save_directory()
  This method returns the save file for the club room controller.
• remove_option(string)
  This remove removes an option associated with the club room.
• save_me()
  This method saves all the data to the save file.
• set_board_associated(int)
  This method sets if a board is associated with the club room set or not.
• set_club(string)
  This method sets the club that currently owns the set of rooms.
• set_controlled_ownership_owner(string, string, int)
  This method sets the owner of the controlled ownership type.
• set_option(string, mixed)
  This method sets the value of the option associated with the club room.
• set_save_directory(string)
  This method sets the save directory for the club room controller.

Public Functions

These are functions that everyone can access.

.

add_controlled_ownership

int add_controlled_ownership(string name,
                             int type,
                             int default_type,
                             mixed default_name)


This method adds an item to have ownership. If a function pointer is set as the default name, then the method will be evaluated each time the club changes. The first arguement will be the name of the owned item being changed and the second argument will be the new club name.

• Parameters:
  name - the name of the option that needs ownership control
  type - the type of controlled ownership
  default_type - the default ownership of the item
  default_name - the default name of the owner
• Returns:
  1 on success, 0 on failure

discuss_elect_ownership

mixed discuss_elect_ownership(string message,
                              string club_name,
                              class discussion_idea frog,
                              string arg1,
                              string arg2)


This is the function used for electing whoever gets to have the nice owned room.

• Parameters:
  message - the message being sent
  club_name - the name of the club
  frog - the discussion item
  arg1 - the first argument
  arg2 - the second argument
  discuss_nominate_ownership

  mixed discuss_nominate_ownership(string message,
                                   string club_name,
                                   class discussion_idea frog,
                                   string arg1,
                                   string arg2)
  

  
  This is the function used for nominating someone exciting the the owned position of the club rooms.
  
  • Parameters:
    message - the message being sent
    club_name - the name of the club
    frog - the discussion item
    arg1 - the first argument
    arg2 - the second argument
    is_option

    int is_option(string name)
    

    
    This method checks to see if there is an option associated with the club room.
    
    • Parameters:
      name - the name of the optionto check
    • Returns:
      1 if there is, 0 if not
      load_me

      void load_me()
      

      
      This method loads all the data from the save file.
      query_board_associated

      int query_board_associated()
      

      
      This method queries to see if there is a board associated or not
      
      • Returns:
        1 if there is aboard associated with this club room set
        query_club

        string query_club()
        

        
        This method queries the club that currently owns the set of rooms.
        
        • Returns:
          the club that owns the rooms
          query_option

          mixed query_option(string name)
          

          
          This method queries and option associated with the club room.
          
          • Parameters:
            name - the name of the option
          • Returns:
            the value of the option
            query_room_save_file_name

            string query_room_save_file_name(mixed fname)
            

            
            This method returns the save file name to use for the room.
            
            • Parameters:
              fname - the file name to use for the room
            • Returns:
              the save file name to use
              query_save_directory

              string query_save_directory()
              

              
              This method returns the save file for the club room controller.
              
              • Returns:
                the save file for the club room controller
                remove_option

                int remove_option(string name)
                

                
                This remove removes an option associated with the club room.
                
                • Parameters:
                  name - the name of the optoin
                • Returns:
                  1 on success, 0 on failure
                  save_me

                  void save_me()
                  

                  
                  This method saves all the data to the save file.
                  set_board_associated

                  void set_board_associated(int board_associated)
                  

                  
                  This method sets if a board is associated with the club room set or not.
                  set_club

                  int set_club(string club)
                  

                  
                  This method sets the club that currently owns the set of rooms.
                  
                  • Parameters:
                    club - the club that owns the rooms
                  • Returns:
                    1 on success, 0 on failure
                    set_controlled_ownership_owner

                    int set_controlled_ownership_owner(string controlled,
                                                       string owner,
                                                       int type)
                    

                    
                    This method sets the owner of the controlled ownership type.
                    
                    • Parameters:
                      controlled - the item being controlled
                      owner - the owner of the item
                      type - the type of the owner
                    • Returns:
                      1 on success, 0 on failure
                      set_option

                      int set_option(string name,
                                     mixed value)
                      

                      
                      This method sets the value of the option associated with the club room.
                      
                      • Parameters:
                        name - the name of the option
                        value - the new value for the option
                      • Returns:
                        1 on success, 0 on failure
                        set_save_directory

                        void set_save_directory(string save_directory)
                        

                        
                        This method sets the save directory for the club room controller.
                        
                        • Parameters:
                          save_file - the new save file

                          Classes

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

                            class ownership {
                                              string name;
                                              int type;
                                              int control_type;
                            }