From b398b9daa271f593cd721f749228da29734f76b0 Mon Sep 17 00:00:00 2001 From: Shoghi Cervantes Pueyo Date: Sat, 12 Jan 2013 11:01:34 +0100 Subject: [PATCH] Deleted documentation --- documentation/BlockAPI.txt | 40 ---------------- documentation/PlayerAPI.txt | 92 ------------------------------------- 2 files changed, 132 deletions(-) delete mode 100644 documentation/BlockAPI.txt delete mode 100644 documentation/PlayerAPI.txt diff --git a/documentation/BlockAPI.txt b/documentation/BlockAPI.txt deleted file mode 100644 index 69bedeaa7..000000000 --- a/documentation/BlockAPI.txt +++ /dev/null @@ -1,40 +0,0 @@ - - - / \ - / \ - / PocketMine \ -/ MP \ -|\ @shoghicp /| -|. \ / .| -| .. \ / .. | -| .. | .. | -| .. | .. | -\ | / - \ | / - \ | / - \ | / - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -#Authored By: sekjun9878 -#Author's Email: sekjun9878@gmail.com -# -#BlokAPI Function Documentation. -# -#Version Alpha -#Revision Alpha - -public function blockBreak($data, $event) - Description: - Breajs a block on the map. - Parameters: - $name = Array of - $data["x"] = x coordinate - $data["y"] = y coordinate - $data["z"] = z coordinate - $event // - Return Values: - true = If the block is unbreakable - \ No newline at end of file diff --git a/documentation/PlayerAPI.txt b/documentation/PlayerAPI.txt deleted file mode 100644 index bec7d8268..000000000 --- a/documentation/PlayerAPI.txt +++ /dev/null @@ -1,92 +0,0 @@ - - - / \ - / \ - / PocketMine \ -/ MP \ -|\ @shoghicp /| -|. \ / .| -| .. \ / .. | -| .. | .. | -| .. | .. | -\ | / - \ | / - \ | / - \ | / - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -#Authored By: sekjun9878 -#Author's Email: sekjun9878@gmail.com -# -#PlayerAPI Function Documentation. -# -#Version Alpha -#Revision Alpha - -public function teleport($name, $target) - Description: - Teleports a player to another player on the map. - Parameters: - $name = Name of the player to teleport. - $target = Name of the target player. - Return Values: - true = If teleported successfully - false = If teleporting failed. - -tppos// - -public function get($name) - Description: - Returns data about a player using a player's username. - Parameters: - $name = Username to return data about. - Return Values: - An array of data about a particular player. - -public function getAll() - Description: - Returns an two-dimentional array of data about all player on the server. - Parameters: - None - Return Values: - Two Dimentional Array of Data. - Examples: - foreach($this->api->player->getAll() as $c){ - //TODO: Do whatever you want with $c - //Example: $c->username will give you username of every player on the server. - } - -public function getByEID($eid) - Description: - Returns data about a player using a player's EID. - Parameters: - $eid = EID of a user to return data about. - Return Values: - An array of data about a particular player. - -public function getByClientID($clientID) - Description: - Returns data about a player using a player's ClientID. - Parameters: - $name = clientID of a user to return data about. - Return Values: - An array of data about a particular player. - -public function online() - Description: - Returns usernames all player on the server. - Parameters: - None - Return Values: - An array of strings containing usernames. - -public function getOffline($name) - Description: - Returns data about a player's last status before disconnecting using a player's username. - Parameters: - $name = name of a user to return data about. - Return Values: - An array of data about a particular player. \ No newline at end of file