File /std/room/club_room.c

See also:
/std/room/controller/club_room_controller .c

Written by Pinkfish

Inherits

Includes

Method index

• force_player_leave(object)
  This method forces the player through the leave exit for whatever reason.
• query_allowed_in(string)
  This method checks to see if the specified person is allowed into the club room or not.
• query_leave_exit()
  This method sets the leave exit for the club room.
• set_leave_exit(string)
  This method sets the leave exit for the club room.
• throw_out_non_member(string)
  This method prints any messages needed to throw a non member out of the club room when this is detected.

Public Functions

These are functions that everyone can access.

.

force_player_leave

void force_player_leave(object player)


This method forces the player through the leave exit for whatever reason.

• Parameters:
  player - the player to make leave
• See also:
  query_leave_exit() and throw_out_non_member()

query_allowed_in

int query_allowed_in(string person)


This method checks to see if the specified person is allowed into the club room or not.

• Parameters:
  person - the person to check
• Returns:
  returns 1 if the person is allowed in and 0 if not
  query_leave_exit

  string query_leave_exit()
  

  
  This method sets the leave exit for the club room. This is the exit that is used when someone is ousted for any reason, like being thrown out of the club or some other reason.
  
  • Returns:
    the leave exit
  • See also:
    set_leave_exit()
    set_leave_exit

    void set_leave_exit(string exit)
    

    
    This method sets the leave exit for the club room. This is the exit that is used when someone is ousted for some reason.
    
    • Parameters:
      exit - the exit to leave
    • See also:
      query_leave_exit()
      throw_out_non_member

      void throw_out_non_member(string name)
      

      
      This method prints any messages needed to throw a non member out of the club room when this is detected.
      
      • Parameters:
        non_member - the non member to throw out
      • See also:
        set_leave_exit() and force_player_leave()