com.datasiqn.commandcore.command.source

Class PlayerCommandSource

java.lang.Object

com.datasiqn.commandcore.command.source.EntityCommandSource

com.datasiqn.commandcore.command.source.PlayerCommandSource

All Implemented Interfaces:

CommandSource

public class PlayerCommandSource
extends EntityCommandSource

Represents a CommandSource where the sender is a Player.\

NOTE: Do not directly instantiate this class! Instead, use the factory method createSource

Constructor Summary

Constructors

Constructor and Description
PlayerCommandSource(org.bukkit.entity.Player sender) Creates a new CommandSource with the internal sender of sender.

Method Summary

Modifier and Type	Method and Description
@NotNull com.datasiqn.resultapi.Result<org.bukkit.entity.Player,String>	getPlayerChecked() Same as CommandSource.getPlayer(), except checks if the sender is a player and returns a Result

Methods inherited from class com.datasiqn.commandcore.command.source.EntityCommandSource

getEntityChecked, getLocatableChecked, getSender

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.datasiqn.commandcore.command.source.CommandSource

getBlock, getBlockChecked, getEntity, getLocatable, getPlayer, hasPermission, hasPermission, sendMessage

Constructor Detail

PlayerCommandSource

public PlayerCommandSource(org.bukkit.entity.Player sender)

Creates a new CommandSource with the internal sender of sender.

NOTE: Do not directly use this constructor! Instead, use the factory method createSource

Parameters:

sender - The sender

Method Detail

getPlayerChecked

@NotNull
public @NotNull com.datasiqn.resultapi.Result<org.bukkit.entity.Player,String> getPlayerChecked()

Description copied from interface: CommandSource

Same as CommandSource.getPlayer(), except checks if the sender is a player and returns a Result

Returns:

A result describing the player. If the command link requiresPlayer, use CommandSource.getPlayer() instead