changed file headers & added AUTHORS file
[PHP-P10.git] / Bots / ExampleBot.class.php
index b9f685d95354b25e195139c084841775e6ffdb88..d01e5cace5363c9bab18d5942f17819cb7b0665c 100644 (file)
@@ -1,22 +1,19 @@
 <?php
-/********************************* PHP-P10 ******************************
- *    P10 uplink class by pk910   (c)2011 pk910                         *
- ************************************************************************
- *                          Version 2 (OOP)                             *
+/******************************* PHP-P10 v2 *****************************
+ * Copyright (C) 2011  Philipp Kreil (pk910)                            *
  *                                                                      *
- * PHP-P10 is free software; you can redistribute it and/or modify      *
+ * This program is free software: you can redistribute it and/or modify *
  * it under the terms of the GNU General Public License as published by *
- * the Free Software Foundation; either version 2 of the License, or    *
+ * the Free Software Foundation, either version 3 of the License, or    *
  * (at your option) any later version.                                  *
- *                                                                      *
+ *                                                                      * 
  * This program is distributed in the hope that it will be useful,      *
  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  * GNU General Public License for more details.                         *
  *                                                                      *
  * You should have received a copy of the GNU General Public License    *
- * along with PHP-P10; if not, write to the Free Software Foundation,   *
- * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.       *
+ * along with this program. If not, see <http://www.gnu.org/licenses/>. *
  *                                                                      *
  ************************************************************************
  * 
@@ -54,7 +51,8 @@ class {$_NAME} extends Bot {  // {$_NAME} will be replaced by our script later ;
                                $this->uplink->join($this->example_bot, "#test");
                                //now we want to say something...
                                //but note: thats the startup procedure! the p10 server is not connected to an uplink, yet - so noone would recive our message (only the other bots on this server)
-                       }   
+                       }
+                       
                } else {
                        $this->example_bot = $old; //We've saved out Bot reference in $old so we can simply use it again...
                }
@@ -71,6 +69,14 @@ class {$_NAME} extends Bot {  // {$_NAME} will be replaced by our script later ;
                //please don't trigger any blocking functions here... that would cause an extreme lagg!
        }
        
+       public function unload($rehash = false) { //this function is triggered, when the Bot is unloaded... If it's just a rehash the return value of this method is passed to $old in the load method.
+               if($rehash) {
+                       return $this->example_bot;
+               } else {
+                       $this->uplink->delUser($this->example_bot, "Bye.");
+               }
+       }
+       
        public function recive_privmsg($user, $channel, $message) {
                //We've got a privmsg...
                $exp=explode(" ",$message);