mirror of
https://github.com/pmmp/PocketMine-MP.git
synced 2025-07-11 12:27:51 +00:00
Player: added API documentation for some functions
This commit is contained in:
parent
481bda8cd5
commit
7804172846
@ -418,6 +418,15 @@ class Player extends Human implements CommandSender, ChunkListener, IPlayer{
|
|||||||
return $this->lastPlayed - $this->firstPlayed > 1; // microtime(true) - microtime(true) may have less than one millisecond difference
|
return $this->lastPlayed - $this->firstPlayed > 1; // microtime(true) - microtime(true) may have less than one millisecond difference
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets whether the player is allowed to toggle flight mode.
|
||||||
|
*
|
||||||
|
* If set to false, the player will be locked in its current flight mode (flying/not flying), and attempts by the
|
||||||
|
* player to enter or exit flight mode will be prevented.
|
||||||
|
*
|
||||||
|
* Note: Setting this to false DOES NOT change whether the player is currently flying. Use
|
||||||
|
* {@link Player::setFlying()} for that purpose.
|
||||||
|
*/
|
||||||
public function setAllowFlight(bool $value) : void{
|
public function setAllowFlight(bool $value) : void{
|
||||||
if($this->allowFlight !== $value){
|
if($this->allowFlight !== $value){
|
||||||
$this->allowFlight = $value;
|
$this->allowFlight = $value;
|
||||||
@ -425,10 +434,24 @@ class Player extends Human implements CommandSender, ChunkListener, IPlayer{
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns whether the player is allowed to toggle its flight state.
|
||||||
|
*
|
||||||
|
* If false, the player is locked in its current flight mode (flying/not flying), and attempts by the player to
|
||||||
|
* enter or exit flight mode will be prevented.
|
||||||
|
*/
|
||||||
public function getAllowFlight() : bool{
|
public function getAllowFlight() : bool{
|
||||||
return $this->allowFlight;
|
return $this->allowFlight;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets whether the player's movement may be obstructed by blocks with collision boxes.
|
||||||
|
* If set to false, the player can move through any block unobstructed.
|
||||||
|
*
|
||||||
|
* Note: Enabling flight mode in conjunction with this is recommended. A non-flying player will simply fall through
|
||||||
|
* the ground into the void.
|
||||||
|
* @see Player::setFlying()
|
||||||
|
*/
|
||||||
public function setHasBlockCollision(bool $value) : void{
|
public function setHasBlockCollision(bool $value) : void{
|
||||||
if($this->blockCollision !== $value){
|
if($this->blockCollision !== $value){
|
||||||
$this->blockCollision = $value;
|
$this->blockCollision = $value;
|
||||||
@ -436,6 +459,10 @@ class Player extends Human implements CommandSender, ChunkListener, IPlayer{
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns whether blocks may obstruct the player's movement.
|
||||||
|
* If false, the player can move through any block unobstructed.
|
||||||
|
*/
|
||||||
public function hasBlockCollision() : bool{
|
public function hasBlockCollision() : bool{
|
||||||
return $this->blockCollision;
|
return $this->blockCollision;
|
||||||
}
|
}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user