Package net.citizensnpcs.trait.text
Class Text
java.lang.Object
net.citizensnpcs.api.trait.Trait
net.citizensnpcs.trait.text.Text
Persists text metadata, i.e. text that will be said by an NPC on certain triggers.
-
Field Summary
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds a piece of text that will be said by the NPC.voidEdit the text at a given index to a new text.Builds a text editor in game for the suppliedPlayer.getTexts()booleanhasIndex(int index) booleanvoidLoads a trait.voidonSpawn()Called when anNPCis spawned.voidremove(int index) Remove text at a given index.voidrun()Called every tick if overridden.voidSaves a trait.booleanvoidsetDelay(int delay) Set the text delay between messages.voidsetItemInHandPattern(String pattern) Sets the item in hand pattern required to talk to NPCs, if enabled.voidsetRange(double range) Set the range in blocks before text will be sent.voidsetSpeechBubbleDuration(Duration duration) booleanbooleanToggles talking at random intervals.booleanToggles requiring line of sight before talking.booleanToggles sending text through chatbooleanToggles using speech bubbles instead of messages.booleanToggles talking to nearby Players.booleanboolean
-
Constructor Details
-
Text
public Text()
-
-
Method Details
-
add
Adds a piece of text that will be said by the NPC.- Parameters:
string- the text to say
-
edit
Edit the text at a given index to a new text.- Parameters:
index- the text's indexnewText- the new text to use
-
getEditor
Builds a text editor in game for the suppliedPlayer. -
getTexts
- Returns:
- The list of all texts
-
hasIndex
public boolean hasIndex(int index) - Returns:
- whether there is text at a certain index
-
isRandomTalker
public boolean isRandomTalker() -
load
Description copied from class:TraitLoads a trait. -
onSpawn
public void onSpawn()Description copied from class:TraitCalled when anNPCis spawned.NPC.getEntity()will return null until this is called. This is also called onAttach when the NPC is already spawned. -
remove
public void remove(int index) Remove text at a given index. -
run
public void run()Description copied from class:TraitCalled every tick if overridden. -
save
Description copied from class:TraitSaves a trait. -
sendTextToChat
public boolean sendTextToChat() -
setDelay
public void setDelay(int delay) Set the text delay between messages.- Parameters:
delay- the delay in ticks
-
setItemInHandPattern
Sets the item in hand pattern required to talk to NPCs, if enabled.- Parameters:
pattern- The new pattern
-
setRange
public void setRange(double range) Set the range in blocks before text will be sent.- Parameters:
range-
-
setSpeechBubbleDuration
-
shouldTalkClose
public boolean shouldTalkClose()- Returns:
- Whether talking close is enabled.
-
toggleRandomTalker
public boolean toggleRandomTalker()Toggles talking at random intervals. -
toggleRealisticLooking
public boolean toggleRealisticLooking()Toggles requiring line of sight before talking. -
toggleSendTextToChat
public boolean toggleSendTextToChat()Toggles sending text through chat -
toggleSpeechBubbles
public boolean toggleSpeechBubbles()Toggles using speech bubbles instead of messages. -
toggleTalkClose
public boolean toggleTalkClose()Toggles talking to nearby Players. -
useRealisticLooking
public boolean useRealisticLooking() -
useSpeechBubbles
public boolean useSpeechBubbles()
-