mirrors/PocketMine-MP
1
0
Fork 0
mirror of https://github.com/pmmp/PocketMine-MP.git synced 2025-04-20 16:00:20 +00:00
Code Issues Projects Releases Wiki Activity

Deleted documentation

Browse Source
This commit is contained in:
Shoghi Cervantes Pueyo 2013-01-12 11:01:34 +01:00
parent b2731261e5
commit b398b9daa2
2 changed files with 0 additions and 132 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
documentation/BlockAPI.txt
View File

@ -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

92
documentation/PlayerAPI.txt
View File

@ -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.