com.datasiqn.commandcore.command.source

Class EntityCommandSource

java.lang.Object

com.datasiqn.commandcore.command.source.EntityCommandSource

All Implemented Interfaces:

CommandSource

Direct Known Subclasses:

PlayerCommandSource

public class EntityCommandSource
extends Object
implements CommandSource

Represents a CommandSource where the sender is an Entity.

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

Constructor Summary

Constructors

Constructor and Description
EntityCommandSource(org.bukkit.entity.Entity sender) Creates a new EntityCommandSource with the internal sender of sender.

Method Summary

Modifier and Type	Method and Description
@NotNull com.datasiqn.resultapi.Result<org.bukkit.entity.Entity,String>	getEntityChecked() Same as CommandSource.getEntity(), except checks if the sender is an entity and returns a Result
@NotNull com.datasiqn.resultapi.Result<LocatableCommandSender,String>	getLocatableChecked() Same as CommandSource.getLocatable(), except checks if the sender is locatable and returns a Result
@NotNull org.bukkit.command.CommandSender	getSender() Gets the sender of the command

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, getPlayerChecked, hasPermission, hasPermission, sendMessage

Constructor Detail

EntityCommandSource

public EntityCommandSource(org.bukkit.entity.Entity sender)

Creates a new EntityCommandSource 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

getEntityChecked

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

Description copied from interface: CommandSource

Same as CommandSource.getEntity(), except checks if the sender is an entity and returns a Result

Specified by:

getEntityChecked in interface CommandSource

Returns:

A result describing the entity. If the command link requiresEntity, use CommandSource.getEntity() instead

getLocatableChecked

@NotNull
public @NotNull com.datasiqn.resultapi.Result<LocatableCommandSender,String> getLocatableChecked()

Description copied from interface: CommandSource

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

Specified by:

getLocatableChecked in interface CommandSource

Returns:

A result describing the locatable sender. If the command link CommandLink.requiresLocatable() requiresCommandBlock}, use CommandSource.getLocatable() instead

getSender

@NotNull
public @NotNull org.bukkit.command.CommandSender getSender()

Description copied from interface: CommandSource

Gets the sender of the command

Specified by:

getSender in interface CommandSource

Returns:

The sender