VanillaCommand Class Reference

Public Member Functions
	__construct ($name, $description="", $usageMessage=null, array $aliases=[])
Public Member Functions inherited from Command
	__construct ($name, $description="", $usageMessage=null, array $aliases=[])
	getDefaultCommandData ()
	generateCustomCommandData (Player $player)
	getOverloads ()
	execute (CommandSender $sender, $commandLabel, array $args)
	getName ()
	getPermission ()
	setPermission ($permission)
	testPermission (CommandSender $target)
	testPermissionSilent (CommandSender $target)
	getLabel ()
	setLabel ($name)
	register (CommandMap $commandMap)
	unregister (CommandMap $commandMap)
	isRegistered ()
	getAliases ()
	getPermissionMessage ()
	getDescription ()
	getUsage ()
	setAliases (array $aliases)
	setDescription ($description)
	setPermissionMessage ($permissionMessage)
	setUsage ($usage)
	__toString ()

Data Fields
const	MAX_COORD = 30000000
const	MIN_COORD = -30000000
Data Fields inherited from Command
	$timings

Protected Member Functions
	getInteger (CommandSender $sender, $value, $min=self::MIN_COORD, $max=self::MAX_COORD)
	getRelativeDouble ($original, CommandSender $sender, $input, $min=self::MIN_COORD, $max=self::MAX_COORD)
	getDouble (CommandSender $sender, $value, $min=self::MIN_COORD, $max=self::MAX_COORD)

Additional Inherited Members
Static Public Member Functions inherited from Command
static	generateDefaultData ()
static	broadcastCommandMessage (CommandSender $source, $message, $sendToSource=true)
Protected Attributes inherited from Command
	$commandData = null
	$description = ""
	$usageMessage

Constructor & Destructor Documentation

__construct()

__construct	(		$name,
			$description = "",
			$usageMessage = null,
		array	$aliases = []
	)

VanillaCommand constructor.

Parameters

string	$name
string	$description
null	$usageMessage
array	$aliases

                                                                                                    {
        parent::__construct($name, $description, $usageMessage, $aliases);
    }

Member Function Documentation

getDouble()

getDouble ( CommandSender  $sender,   $value,   $min = self::MIN_COORD,   $max = self::MAX_COORD  )

protected

Parameters

CommandSender	$sender
	$value
int	$min
int	$max

Returns

float|int

                                                                                                           {
        $i = (double) $value;

        if($i < $min){
            $i = $min;
        }elseif($i > $max){
            $i = $max;
        }

        return $i;
    }

getInteger()

getInteger ( CommandSender  $sender,   $value,   $min = self::MIN_COORD,   $max = self::MAX_COORD  )

protected

Parameters

CommandSender	$sender
	$value
int	$min
int	$max

Returns

int

                                                                                                            {
        $i = (int) $value;

        if($i < $min){
            $i = $min;
        }elseif($i > $max){
            $i = $max;
        }

        return $i;
    }

getRelativeDouble()

getRelativeDouble (   $original, CommandSender  $sender,   $input,   $min = self::MIN_COORD,   $max = self::MAX_COORD  )

protected

Parameters

	$original
CommandSender	$sender
	$input
int	$min
int	$max

Returns

float|int

                                                                                                                              {
        if($input{0} === "~"){
            $value = $this->getDouble($sender, substr($input, 1));

            return $original + $value;
        }

        return $this->getDouble($sender, $input, $min, $max);
    }

Field Documentation

MAX_COORD

const MAX_COORD = 30000000

MIN_COORD

const MIN_COORD = -30000000

---

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

• src/pocketmine/command/defaults/VanillaCommand.php