PocketMine-MP 5.15.1 git-fb9a74e8799c71ed8292cfa53abe7a4c9204629d
pocketmine\console\ConsoleCommandSender Class Reference
+ Inheritance diagram for pocketmine\console\ConsoleCommandSender:
+ Collaboration diagram for pocketmine\console\ConsoleCommandSender:

Public Member Functions

 __construct (private Server $server, private Language $language)
 
 addAttachment (Plugin $plugin, ?string $name=null, ?bool $value=null)
 
 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)
 

Protected Attributes

int $lineHeight = null
 

Detailed Description

Definition at line 39 of file ConsoleCommandSender.php.

Constructor & Destructor Documentation

◆ __construct()

pocketmine\console\ConsoleCommandSender::__construct ( private Server  $server,
private Language  $language 
)

Definition at line 45 of file ConsoleCommandSender.php.

Member Function Documentation

◆ addAttachment()

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

◆ getEffectivePermissions()

pocketmine\permission\Permissible::getEffectivePermissions ( )
inherited
Returns
PermissionAttachmentInfo[]

Implemented in pocketmine\permission\PermissibleInternal.

◆ getLanguage()

pocketmine\console\ConsoleCommandSender::getLanguage ( )

Implements pocketmine\command\CommandSender.

Definition at line 56 of file ConsoleCommandSender.php.

◆ getName()

pocketmine\console\ConsoleCommandSender::getName ( )

Implements pocketmine\command\CommandSender.

Definition at line 70 of file ConsoleCommandSender.php.

◆ 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\console\ConsoleCommandSender::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

Implements pocketmine\command\CommandSender.

Definition at line 74 of file ConsoleCommandSender.php.

◆ getServer()

pocketmine\console\ConsoleCommandSender::getServer ( )

Implements pocketmine\command\CommandSender.

Definition at line 52 of file ConsoleCommandSender.php.

◆ 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\console\ConsoleCommandSender::sendMessage ( Translatable|string  $message)

Implements pocketmine\command\CommandSender.

Definition at line 60 of file ConsoleCommandSender.php.

◆ 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\console\ConsoleCommandSender::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

Implements pocketmine\command\CommandSender.

Definition at line 78 of file ConsoleCommandSender.php.

◆ 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.

Member Data Documentation

◆ $lineHeight

int pocketmine\console\ConsoleCommandSender::$lineHeight = null
protected

@phpstan-var positive-int|null

Definition at line 43 of file ConsoleCommandSender.php.


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