net.citizensnpcs.api.ai.speech

Class SpeechContext

java.lang.Object

net.citizensnpcs.api.ai.speech.SpeechContext

All Implemented Interfaces:

Iterable<Talkable>

public class SpeechContext
extends Object
implements Iterable<Talkable>

SpeechContext contains information about a NPCSpeechEvent, including the Talkable talker, recipients, and message.

Constructor Summary

Constructors

Constructor and Description
SpeechContext()
SpeechContext(NPC talker, String message)
SpeechContext(NPC talker, String message, LivingEntity recipient)
SpeechContext(String message)
SpeechContext(String message, LivingEntity recipient)

Method Summary

Modifier and Type	Method and Description
SpeechContext	addRecipient(Entity entity) Adds a direct Talkable recipient.
SpeechContext	addRecipient(LivingEntity entity) Deprecated.
SpeechContext	addRecipients(List<Talkable> talkables) Adds a list of Talkable recipients.
String	getMessage() Gets the text message sent.
Talkable	getTalker() Gets the talker.
boolean	hasRecipients() Checks if there are any recipients.
Iterator<Talkable>	iterator() Gets direct recipients, if any.
void	setMessage(String message) Sets the text message sent.
void	setTalker(Entity entity) Sets the talker.
void	setTalker(LivingEntity entity) Deprecated.
int	size()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SpeechContext

public SpeechContext()

SpeechContext

public SpeechContext(NPC talker,
                     String message)

SpeechContext

public SpeechContext(NPC talker,
                     String message,
                     LivingEntity recipient)

SpeechContext

public SpeechContext(String message)

SpeechContext

public SpeechContext(String message,
                     LivingEntity recipient)

Method Detail

addRecipient

public SpeechContext addRecipient(Entity entity)

Adds a direct Talkable recipient. The VocalChord should use this information to correctly direct the message. Note: depending on the VocalChord, this list may not be inclusive as to who gets the message.

Parameters:

entity - Talkable entity

Returns:

the speech context

addRecipient

@Deprecated
public SpeechContext addRecipient(LivingEntity entity)

Deprecated.

addRecipients

public SpeechContext addRecipients(List<Talkable> talkables)

Adds a list of Talkable recipients. The VocalChord should use this information to correctly direct the message. Note: depending on the VocalChord, this list may not be inclusive as to who gets the message.

Parameters:

talkables - Talkable entities

Returns:

the Tongue

getMessage

public String getMessage()

Gets the text message sent.

getTalker

public Talkable getTalker()

Gets the talker.

Returns:

NPC doing the talking

hasRecipients

public boolean hasRecipients()

Checks if there are any recipients. If none, this SpeechContext is not targeted.

Returns:

true if recipients are specified.

iterator

public Iterator<Talkable> iterator()

Gets direct recipients, if any.

Specified by:

iterator in interface Iterable<Talkable>

Returns:

recipients Iterator

setMessage

public void setMessage(String message)

Sets the text message sent. Overrides text set with the constructor.

Parameters:

message - The text to send.

setTalker

public void setTalker(Entity entity)

Sets the talker.

Parameters:

entity - NPC doing the talking

setTalker

@Deprecated
public void setTalker(LivingEntity entity)

Deprecated.

size

public int size()

Returns:

number of recipients.