net.citizensnpcs.api.trait.trait

Class Owner

java.lang.Object

net.citizensnpcs.api.trait.Trait

net.citizensnpcs.api.trait.trait.Owner

All Implemented Interfaces:

Runnable, Listener

public class Owner
extends Trait

Represents the owner of an NPC.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVER

Fields inherited from class net.citizensnpcs.api.trait.Trait

npc

Constructor Summary

Constructors

Constructor and Description
Owner()

Method Summary

Modifier and Type	Method and Description
String	getOwner() Gets the owner.
UUID	getOwnerId()
boolean	isOwnedBy(CommandSender sender) Gets if the given CommandSender is the owner of an NPC.
boolean	isOwnedBy(String name)
void	load(DataKey key) Loads a trait.
void	save(DataKey key) Saves a trait.
void	setOwner(CommandSender sender)
void	setOwner(String owner) Sets the owner of an NPC.
void	setOwner(String owner, UUID uuid) Sets the owner of an NPC.
String	toString()

Methods inherited from class net.citizensnpcs.api.trait.Trait

getName, getNPC, isRunImplemented, linkToNPC, onAttach, onCopy, onDespawn, onRemove, onSpawn, run

Methods inherited from class java.lang.Object

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

Field Detail

SERVER

public static final String SERVER

See Also:

Constant Field Values

Constructor Detail

Owner

public Owner()

Method Detail

getOwner

public String getOwner()

Gets the owner.

Returns:

The owner's name

getOwnerId

public UUID getOwnerId()

Returns:

The owner's UUID, or null if the owner is the server or a UUID has not been collected for the owner.

isOwnedBy

public boolean isOwnedBy(CommandSender sender)

Gets if the given CommandSender is the owner of an NPC.

Parameters:

sender - Sender to check

Returns:

Whether the sender is the owner of an NPC

isOwnedBy

public boolean isOwnedBy(String name)

load

public void load(DataKey key)
          throws NPCLoadException

Description copied from class: Trait

Loads a trait.

Overrides:

load in class Trait

Parameters:

key - DataKey to load from

Throws:

NPCLoadException - Thrown if this trait failed to load properly

save

public void save(DataKey key)

Description copied from class: Trait

Saves a trait.

Overrides:

save in class Trait

Parameters:

key - DataKey to save to

setOwner

public void setOwner(CommandSender sender)

setOwner

public void setOwner(String owner)

Sets the owner of an NPC.

Parameters:

owner - Name of the player to set as owner of an NPC

setOwner

public void setOwner(String owner,
                     UUID uuid)

Sets the owner of an NPC.

Parameters:

owner - Name of the owner

uuid - UUID of the owner

toString

public String toString()

Overrides:

toString in class Object