pocketmine\command\CommandSender Interface Reference

Inheritance diagram for pocketmine\command\CommandSender:

Collaboration diagram for pocketmine\command\CommandSender:

Public Member Functions
	addAttachment (Plugin $plugin, ?string $name=null, ?bool $value=null)
	getCommandAliasMap ()
	getEffectivePermissions ()
	getLanguage ()
	getName ()
	getPermissionRecalculationCallbacks ()
	getScreenLineHeight ()
	getServer ()
	hasPermission (Permission|string $name)
	isPermissionSet (Permission|string $name)
	recalculatePermissions ()
	removeAttachment (PermissionAttachment $attachment)
	sendMessage (Translatable|string $message)
	setBasePermission (Permission|string $name, bool $grant)
	setScreenLineHeight (?int $height)
	unsetBasePermission (Permission|string $name)

Detailed Description

Definition at line 31 of file CommandSender.php.

Member Function Documentation

addAttachment()

pocketmine\permission\Permissible::addAttachment ( Plugin $plugin, ?string $name = null, ?bool $value = null )

inherited

Implemented in pocketmine\permission\PermissibleInternal.

getCommandAliasMap()

pocketmine\command\CommandSender::getCommandAliasMap

(

)

Returns the user's local alias map. This may contain special user-specific aliases that differ from the global command map's aliases.

Implemented in pocketmine\console\ConsoleCommandSender, pocketmine\player\Player, and pocketmine\utils\BroadcastLoggerForwarder.

Referenced by pocketmine\command\defaults\CommandAliasCommand\execute(), and pocketmine\command\defaults\HelpCommand\execute().

Here is the caller graph for this function:

getEffectivePermissions()

pocketmine\permission\Permissible::getEffectivePermissions ( )

inherited

Returns

PermissionAttachmentInfo[]

Implemented in pocketmine\permission\PermissibleInternal.

getName()

pocketmine\command\CommandSender::getName

(

)

Implemented in pocketmine\player\Player.

getPermissionRecalculationCallbacks()

pocketmine\permission\Permissible::getPermissionRecalculationCallbacks ( )

inherited

Returns

ObjectSet|\Closure[] @phpstan-return ObjectSet<\Closure(array<string, bool> $changedPermissionsOldValues) : void>

Implemented in pocketmine\permission\PermissibleInternal.

getScreenLineHeight()

pocketmine\command\CommandSender::getScreenLineHeight

(

)

Returns the line height of the command-sender's screen. Used for determining sizes for command output pagination such as in the /help command. @phpstan-return positive-int

Implemented in pocketmine\console\ConsoleCommandSender, pocketmine\player\Player, and pocketmine\utils\BroadcastLoggerForwarder.

Referenced by pocketmine\command\defaults\HelpCommand\execute().

Here is the caller graph for this function:

hasPermission()

pocketmine\permission\Permissible::hasPermission ( Permission|string $name )

inherited

Returns the permission value if overridden, or the default value if not

Implemented in pocketmine\permission\PermissibleInternal.

isPermissionSet()

pocketmine\permission\Permissible::isPermissionSet ( Permission|string $name )

inherited

Checks if this instance has a permission overridden

Implemented in pocketmine\permission\PermissibleInternal.

recalculatePermissions()

pocketmine\permission\Permissible::recalculatePermissions ( )

inherited

Returns

bool[] changed permission name => old value @phpstan-return array<string, bool>

Implemented in pocketmine\permission\PermissibleInternal.

sendMessage()

pocketmine\command\CommandSender::sendMessage

(

Translatable|string

$message

)

Implemented in pocketmine\player\Player.

setBasePermission()

pocketmine\permission\Permissible::setBasePermission ( Permission|string $name, bool $grant )

inherited

Assigns a baseline permission to the permissible. This is always calculated before anything else, which means that permissions set using addAttachment() will always override base permissions. You probably don't want to use this if you're not assigning (denying) operator permissions.

Implemented in pocketmine\permission\PermissibleInternal.

setScreenLineHeight()

pocketmine\command\CommandSender::setScreenLineHeight

(

?int

$height

)

Sets the line height used for command output pagination for this command sender. null will reset it to default. @phpstan-param positive-int|null $height

Implemented in pocketmine\console\ConsoleCommandSender, pocketmine\player\Player, and pocketmine\utils\BroadcastLoggerForwarder.

unsetBasePermission()

pocketmine\permission\Permissible::unsetBasePermission ( Permission|string $name )

inherited

Unsets a baseline permission previously set. If it wasn't already set, this will have no effect. Note that this might have different results than setting the permission to false.

Implemented in pocketmine\permission\PermissibleInternal.

---

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

• CommandSender.php