Package net.citizensnpcs.trait

Class Controllable

java.lang.Object

net.citizensnpcs.api.trait.Trait

net.citizensnpcs.trait.Controllable

All Implemented Interfaces:

Runnable, Listener

public class Controllable
extends Trait

Persists the controllable status for /npc controllable A controllable NPC can be mounted by a Player using right click or /npc mount and moved around using e.g. arrow keys.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Controllable.BuiltInControls
static class	Controllable.GroundController
static class	Controllable.JumplessGroundController
static class	Controllable.LookAirController
static interface	Controllable.MovementController
static class	Controllable.PlayerInputAirController

Field Summary

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

npc

Constructor Summary

Constructors

Constructor	Description
Controllable()

Method Summary

Modifier and Type	Method	Description
boolean	isEnabled()
boolean	mount(Player toMount)	Attempts to mount the Player onto the NPC.
void	onSpawn()	Called when an NPC is spawned.
void	run()	Called every tick if overridden.
void	setControls(Controllable.BuiltInControls controls)
boolean	setEnabled(boolean enabled)
void	setOwnerRequired(boolean ownerRequired)	Sets whether the Player attempting to mount the NPC must actually own the NPC to mount it.
boolean	toggle()

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

getName, getNPC, isRunImplemented, linkToNPC, load, onAttach, onCopy, onDespawn, onDespawn, onPreSpawn, onRemove, onRemove, save

Methods inherited from class java.lang.Object

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

Constructor Details

Controllable

public Controllable()

Method Details

isEnabled

public boolean isEnabled()

mount

public boolean mount(Player toMount)

Attempts to mount the Player onto the NPC.

Parameters:

toMount - the player to mount

Returns:

whether the mount was successful

onSpawn

public void onSpawn()

Description copied from class: Trait

Called when an NPC is spawned. NPC.getEntity() will return null until this is called. This is also called onAttach when the NPC is already spawned.

Overrides:

onSpawn in class Trait

run

public void run()

Description copied from class: Trait

Called every tick if overridden.

Specified by:

run in interface Runnable

Overrides:

run in class Trait

setControls

public void setControls(Controllable.BuiltInControls controls)

setEnabled

public boolean setEnabled(boolean enabled)

setOwnerRequired

public void setOwnerRequired(boolean ownerRequired)

Sets whether the Player attempting to mount the NPC must actually own the NPC to mount it.

See Also:

• Owner.isOwnedBy(org.bukkit.command.CommandSender)

toggle

public boolean toggle()