mirrors/PocketMine-MP
1
0
Fork 0
mirror of https://github.com/pmmp/PocketMine-MP.git synced 2025-07-23 11:26:37 +00:00
Code Issues Projects Releases Wiki Activity

Server: document the crazy behaviour of some innocent looking functions

Browse Source
This commit is contained in:
Dylan K. Taylor 2019-06-12 10:14:29 +01:00
parent 4c5f6eb1b7
commit 42954c1d72
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/pocketmine/Server.php
View File

@ -892,6 +892,11 @@ class Server{
} }
/** /**
* Returns an online player whose name begins with or equals the given string (case insensitive).
* The closest match will be returned, or null if there are no online matches.
*
* @see Server::getPlayerExact()
*
* @param string $name * @param string $name
* *
* @return Player|null * @return Player|null
@ -917,6 +922,8 @@ class Server{
} }
/** /**
* Returns an online player with the given name (case insensitive), or null if not found.
*
* @param string $name * @param string $name
* *
* @return Player|null * @return Player|null
@ -933,6 +940,9 @@ class Server{
} }
/** /**
* Returns a list of online players whose names contain with the given string (case insensitive).
* If an exact match is found, only that match is returned.
*
* @param string $partialName * @param string $partialName
* *
* @return Player[] * @return Player[]