com.pixelmonmod.pixelmon.api.dialogue

Class Dialogue

java.lang.Object

com.pixelmonmod.pixelmon.api.dialogue.Dialogue

public class Dialogue
extends java.lang.Object

Represents a page of dialogue. This is capable of offering choices for the player to select, most easily implemented through the use of a Dialogue.DialogueBuilder. To add smooth handling of choices, the Choice.ChoiceBuilder provides a builder setter for the handler of the eventual DialogueChoiceEvent.

After constructing a list of Dialogues to show to a player, sending this data to players is best performed by setPlayerDialogueData(ServerPlayerEntity, List, boolean).

Since:

November 20, 2017

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Dialogue.DialogueBuilder Builder for Dialogue objects.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.ArrayList<Choice>	choices Optional list of choices to be displayed underneath the dialogue.
java.lang.String	name The name to display at the top of the dialogue box.
QuestProgressClient	quest

Constructor Summary

Constructors

Constructor and Description
Dialogue(net.minecraft.network.PacketBuffer buffer) Deprecated.
Dialogue(net.minecraft.network.PacketBuffer buffer, boolean localized) Deprecated.
Dialogue(net.minecraft.network.PacketBuffer buffer, java.util.UUID quest)
Dialogue(java.lang.String name, java.lang.String text, java.lang.String localizedText, boolean escapeCloses, java.util.ArrayList<Choice> choices)

Method Summary

Modifier and Type	Method and Description
static Dialogue.DialogueBuilder	builder()
boolean	escapeCloses()
java.lang.String	getText()
void	open(net.minecraft.entity.player.ServerPlayerEntity... players) Opens this dialogue on the players' screens.
void	open(java.util.UUID quest, net.minecraft.entity.player.ServerPlayerEntity... players)
static void	setPlayerDialogueData(net.minecraft.entity.player.ServerPlayerEntity player, java.util.List<Dialogue> dialogues, boolean openGui) Server-oriented method to send new dialogue data to a player, and optionally order the GUI to open.
static void	setPlayerDialogueData(java.util.UUID quest, net.minecraft.entity.player.ServerPlayerEntity player, java.util.List<Dialogue> dialogues, boolean openGui)
void	writeToBytes(net.minecraft.network.PacketBuffer buffer) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

name

public final java.lang.String name

The name to display at the top of the dialogue box.

choices

public final java.util.ArrayList<Choice> choices

Optional list of choices to be displayed underneath the dialogue.

quest

public QuestProgressClient quest

Constructor Detail

Dialogue

@Deprecated
public Dialogue(net.minecraft.network.PacketBuffer buffer)

Deprecated.

Dialogue

@Deprecated
public Dialogue(net.minecraft.network.PacketBuffer buffer,
                            boolean localized)

Deprecated.

Dialogue

public Dialogue(net.minecraft.network.PacketBuffer buffer,
                java.util.UUID quest)

Dialogue

public Dialogue(java.lang.String name,
                java.lang.String text,
                java.lang.String localizedText,
                boolean escapeCloses,
                java.util.ArrayList<Choice> choices)

Method Detail

writeToBytes

@Deprecated
public void writeToBytes(net.minecraft.network.PacketBuffer buffer)

Deprecated.

getText

public java.lang.String getText()

open

public void open(net.minecraft.entity.player.ServerPlayerEntity... players)

Opens this dialogue on the players' screens.

open

public void open(java.util.UUID quest,
                 net.minecraft.entity.player.ServerPlayerEntity... players)

escapeCloses

public boolean escapeCloses()

setPlayerDialogueData

public static void setPlayerDialogueData(net.minecraft.entity.player.ServerPlayerEntity player,
                                         java.util.List<Dialogue> dialogues,
                                         boolean openGui)

Server-oriented method to send new dialogue data to a player, and optionally order the GUI to open.

Parameters:

player - - The player to send it to.

dialogues - - The list of Dialogues that will be shown to the player sequentially.

openGui - - Whether or not the Dialogue GUI should be opened upon receiving the data.

setPlayerDialogueData

public static void setPlayerDialogueData(java.util.UUID quest,
                                         net.minecraft.entity.player.ServerPlayerEntity player,
                                         java.util.List<Dialogue> dialogues,
                                         boolean openGui)

builder

public static Dialogue.DialogueBuilder builder()