File /std/basic/club_insignia.c

Written by Pinkfish

Started Sun Oct 4 04:23:52 EDT 1998

Inherits

Includes

Method index

• add_club_commands(object)
  This method will add the club commands from the player.
• add_elected_commands(object)
  This method will add the club commands from the player.
• club_chat(string, int)
  The says something wonderful and exciting to all the other club members.
• confirm_disbar(string, string)
  THis method confirms the disbar request from the player.
• confirm_resign(string, string)
  This method checks to make sure they really wish to resign.
• do_announcement()
  This method will print out any announcements associated with the club.
• do_brief_mode(int)
  This method sets the brief mode of the badge.
• do_brief_string(string)
  This method sets the brief message to use for the channel messages.
• do_channel_off(int)
  This method handles setting the flag and printing all the happy success messages.
• do_disbar(string)
  This method allows the founders and presidents/vice presidents to disbar people from the club.
• do_history()
  This method prints out the history of the channel.
• do_recruit(object *, string)
  This is the method to use when recruiting people.
• do_resign()
  This method starts the resignation process.
• do_resign_position(string)
  This method resigns as a position in the club.
• event_channel_message(object, string, mixed *)
  The method is called when the channel is triggered.
• event_club_changed(object, string)
  This method is called when the club type is changed.
• event_joined_club(object, string)
  This is the event generated when the person joins the club.
• query_brief_mode()
  This method tells us if the badge is in brief mode or not.
• query_brief_string()
  This method returns the short name for the channel string.
• query_channel_off()
  This method returns the status of the channel off flag.
• query_club()
  This method returns the club associated with the badge.
• set_club(string)
  This method sets the club associated with the badge.

Public Functions

These are functions that everyone can access.

.

event_channel_message

void event_channel_message(object ob,
                           string channel,
                           mixed * data)


The method is called when the channel is triggered.

• Parameters:
  ob - the person who talked
  channel - the name of the channel
  message - the pmessage top print
• See also:
  club_chat() and do_history()

event_club_changed

void event_club_changed(object person,
                        string club_name)


This method is called when the club type is changed. It will add on the elected club commands, if that is what we have changed too.
event_joined_club

void event_joined_club(object person,
                       string club_name)


This is the event generated when the person joins the club.

• Parameters:
  person - the person doing the joining
  club_name - the name of the club being joined
  query_brief_mode

  int query_brief_mode()
  

  
  This method tells us if the badge is in brief mode or not.
  
  • Returns:
    the current brief mode
    query_brief_string

    string query_brief_string()
    

    
    This method returns the short name for the channel string.
    
    • Returns:
      the short name for the channel
      query_channel_off

      int query_channel_off()
      

      
      This method returns the status of the channel off flag.
      
      • Returns:
        the current value of the channel off flag
      • See also:
        club_chat() and event_channel_message()
        query_club

        string query_club()
        

        
        This method returns the club associated with the badge.
        
        • Returns:
          the club associated with the badge
        • See also:
          set_club()
          set_club

          void set_club(string club)
          

          
          This method sets the club associated with the badge.
          
          • Parameters:
            club - the name of the club
          • See also:
            query_club()

            Protected Functions

            These are functions that only objects inheriting the class can access.
            add_club_commands

            void add_club_commands(object per)
            

            
            This method will add the club commands from the player.
            add_elected_commands

            void add_elected_commands(object per)
            

            
            This method will add the club commands from the player.
            club_chat

            int club_chat(string str,
                          int emote)
            

            
            The says something wonderful and exciting to all the other club members.
            
            • Parameters:
              str - the exciting comment I know they will say
              confirm_disbar

              void confirm_disbar(string str,
                                  string name)
              

              
              THis method confirms the disbar request from the player.
              
              • Parameters:
                str - the response string
                name - the name of the person to disbar
              • See also:
                do_disbar()
                confirm_resign

                void confirm_resign(string str,
                                    string position)
                

                
                This method checks to make sure they really wish to resign.
                
                • Parameters:
                  str - the response
                • See also:
                  do_resign()
                  do_announcement

                  int do_announcement()
                  

                  
                  This method will print out any announcements associated with the club.
                  
                  • Returns:
                    1 on success
                    do_brief_mode

                    int do_brief_mode(int mode)
                    

                    
                    This method sets the brief mode of the badge.
                    
                    • Parameters:
                      mode - the brief mode]
                    • Returns:
                      1 on success, 0 on failure
                      do_brief_string

                      int do_brief_string(string str)
                      

                      
                      This method sets the brief message to use for the channel messages.
                      
                      • Parameters:
                        str - the channel message short
                      • Returns:
                        1 on success, 0 on failure
                        do_channel_off

                        int do_channel_off(int flag)
                        

                        
                        This method handles setting the flag and printing all the happy success messages.
                        
                        • Parameters:
                          flag - the new flag
                          do_disbar

                          int do_disbar(string name)
                          

                          
                          This method allows the founders and presidents/vice presidents to disbar people from the club.
                          
                          • Parameters:
                            name - the name of the person to disbar
                            do_history

                            int do_history()
                            

                            
                            This method prints out the history of the channel.
                            
                            • See also:
                              club_chat() and event_channel_message()
                              do_recruit

                              int do_recruit(object * obs,
                                             string club)
                              

                              
                              This is the method to use when recruiting people.
                              
                              • Parameters:
                                obs - the people to recruit
                              • Returns:
                                1 on success, 0 on failure
                              • See also:
                                /obj/handlers/club_handler.c
                                do_resign

                                int do_resign()
                                

                                
                                This method starts the resignation process.
                                
                                • Returns:
                                  1 on succes, 0 on failure
                                • See also:
                                  confirm_resign()
                                  do_resign_position

                                  int do_resign_position(string position)
                                  

                                  
                                  This method resigns as a position in the club.
                                  
                                  • Returns:
                                    1 on succes, 0 on failure
                                  • See also:
                                    confirm_resign()