OfflinePlayer Class Reference

Public Member Functions
	__construct (Server $server, $name)
	isOnline ()
	getName ()
	getServer ()
	isOp ()
	setOp ($value)
	isBanned ()
	setBanned ($value)
	isWhitelisted ()
	setWhitelisted ($value)
	getPlayer ()
	getFirstPlayed ()
	getLastPlayed ()
	hasPlayedBefore ()
	setMetadata ($metadataKey, MetadataValue $metadataValue)
	getMetadata ($metadataKey)
	hasMetadata ($metadataKey)
	removeMetadata ($metadataKey, Plugin $plugin)

Constructor & Destructor Documentation

__construct()

__construct	(	Server	$server,
			$name
	)

Parameters

Server	$server
string	$name

                                                      {
        $this->server = $server;
        $this->name = $name;
        if(file_exists($this->server->getDataPath() . "players/" . strtolower($this->getName()) . ".dat")){
            $this->namedtag = $this->server->getOfflinePlayerData($this->name);
        }else{
            $this->namedtag = null;
        }
    }

Member Function Documentation

getFirstPlayed()

getFirstPlayed

(

)

Returns

null

Implements IPlayer.

                                    {
        return $this->namedtag instanceof CompoundTag ? $this->namedtag["firstPlayed"] : null;
    }

getLastPlayed()

getLastPlayed

(

)

Returns

null

Implements IPlayer.

                                   {
        return $this->namedtag instanceof CompoundTag ? $this->namedtag["lastPlayed"] : null;
    }

getMetadata()

getMetadata

(

$metadataKey

)

Parameters

string

$metadataKey

Returns

MetadataValue[]

Implements Metadatable.

                                             {
        return $this->server->getPlayerMetadata()->getMetadata($this, $metadataKey);
    }

getName()

getName

(

)

Returns

string

Implements IPlayer.

                              : string{
        return $this->name;
    }

getPlayer()

getPlayer

(

)

Returns

Player

Implements IPlayer.

                               {
        return $this->server->getPlayerExact($this->getName());
    }

getServer()

getServer

(

)

Returns

Server

                               {
        return $this->server;
    }

hasMetadata()

hasMetadata

(

$metadataKey

)

Parameters

string

$metadataKey

Returns

bool

Implements Metadatable.

                                             {
        return $this->server->getPlayerMetadata()->hasMetadata($this, $metadataKey);
    }

hasPlayedBefore()

hasPlayedBefore

(

)

Returns

bool

Implements IPlayer.

                                     {
        return $this->namedtag instanceof CompoundTag;
    }

isBanned()

isBanned

(

)

Returns

bool

Implements IPlayer.

                              {
        return $this->server->getNameBans()->isBanned(strtolower($this->getName()));
    }

isOnline()

isOnline

(

)

Returns

bool

Implements IPlayer.

                              {
        return $this->getPlayer() !== null;
    }

isOp()

isOp

(

)

Returns

bool

Implements ServerOperator.

                          {
        return $this->server->isOp(strtolower($this->getName()));
    }

isWhitelisted()

isWhitelisted

(

)

Returns

bool

Implements IPlayer.

                                   {
        return $this->server->isWhitelisted(strtolower($this->getName()));
    }

removeMetadata()

removeMetadata	(		$metadataKey,
		Plugin	$plugin
	)

Parameters

string	$metadataKey
Plugin	$plugin

Implements Metadatable.

                                                                {
        $this->server->getPlayerMetadata()->removeMetadata($this, $metadataKey, $plugin);
    }

setBanned()

setBanned

(

$value

)

Parameters

bool

$value

Implements IPlayer.

                                     {
        if($value === true){
            $this->server->getNameBans()->addBan($this->getName(), null, null, null);
        }else{
            $this->server->getNameBans()->remove($this->getName());
        }
    }

setMetadata()

setMetadata	(		$metadataKey,
		MetadataValue	$metadataValue
	)

Parameters

string	$metadataKey
MetadataValue	$metadataValue

Implements Metadatable.

                                                                           {
        $this->server->getPlayerMetadata()->setMetadata($this, $metadataKey, $metadataValue);
    }

setOp()

setOp

(

$value

)

Parameters

bool

$value

Implements ServerOperator.

                                 {
        if($value === $this->isOp()){
            return;
        }

        if($value === true){
            $this->server->addOp(strtolower($this->getName()));
        }else{
            $this->server->removeOp(strtolower($this->getName()));
        }
    }

setWhitelisted()

setWhitelisted

(

$value

)

Parameters

bool

$value

Implements IPlayer.

                                          {
        if($value === true){
            $this->server->addWhitelist(strtolower($this->getName()));
        }else{
            $this->server->removeWhitelist(strtolower($this->getName()));
        }
    }

---

The documentation for this class was generated from the following file:

• src/pocketmine/OfflinePlayer.php