net.citizensnpcs.npc.ai.speech

Class TalkableEntity

java.lang.Object

net.citizensnpcs.npc.ai.speech.TalkableEntity

All Implemented Interfaces:

Comparable<Object>, Talkable

public class TalkableEntity
extends Object
implements Talkable

Constructor Summary

Constructors

Constructor and Description
TalkableEntity(Entity entity)
TalkableEntity(NPC npc)
TalkableEntity(Player player)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o) Used to compare a LivingEntity to this TalkableEntity
Entity	getEntity() Gets the LivingEntity associated with this Talkable
String	getName() Gets the name of the Talkable LivingEntity
void	talkNear(SpeechContext context, String text, VocalChord vocalChord) Called by a VocalChord when talking near this Talkable Entity to provide a universal method to getting an event/output.
void	talkTo(SpeechContext context, String text, VocalChord vocalChord) Called by a VocalChord when talking to this Talkable Entity to provide a universal method to getting an event/output.

Methods inherited from class java.lang.Object

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

Constructor Detail

TalkableEntity

public TalkableEntity(Entity entity)

TalkableEntity

public TalkableEntity(NPC npc)

TalkableEntity

public TalkableEntity(Player player)

Method Detail

compareTo

public int compareTo(Object o)

Used to compare a LivingEntity to this TalkableEntity

Specified by:

compareTo in interface Comparable<Object>

Returns:

0 if the Entities are the same, 1 if they are not, -1 if the object compared is not a valid LivingEntity

getEntity

public Entity getEntity()

Description copied from interface: Talkable

Gets the LivingEntity associated with this Talkable

Specified by:

getEntity in interface Talkable

Returns:

a LivingEntity

getName

public String getName()

Description copied from interface: Talkable

Gets the name of the Talkable LivingEntity

Specified by:

getName in interface Talkable

Returns:

name

talkNear

public void talkNear(SpeechContext context,
                     String text,
                     VocalChord vocalChord)

Description copied from interface: Talkable

Called by a VocalChord when talking near this Talkable Entity to provide a universal method to getting an event/output.

Specified by:

talkNear in interface Talkable

Parameters:

context - the Speech context

text - The message to send

vocalChord - The chord to use

talkTo

public void talkTo(SpeechContext context,
                   String text,
                   VocalChord vocalChord)

Description copied from interface: Talkable

Called by a VocalChord when talking to this Talkable Entity to provide a universal method to getting an event/output.

Specified by:

talkTo in interface Talkable

Parameters:

context - the Speech context

text - The message to send

vocalChord - The chord to use