com.pixelmonmod.pixelmon.api.events.dialogue

Class DialogueChoiceEvent

java.lang.Object

net.minecraftforge.fml.common.eventhandler.Event

com.pixelmonmod.pixelmon.api.events.dialogue.DialogueChoiceEvent

public class DialogueChoiceEvent
extends net.minecraftforge.fml.common.eventhandler.Event

Event fired when there was a GUI choice and the server is expected to provide the next action. If DialogueNextAction.DialogueGuiAction.NEW_DIALOGUES or DialogueNextAction.DialogueGuiAction.INSERT_DIALOGUES is returned then there is an assumption that newDialogues is both non-null and non-empty.

By default, the response will be to continue with any remaining dialogue that has been queued on the client. If none remains, it behaves the same as a response with DialogueNextAction.DialogueGuiAction.CLOSE.

If dialogue choices were provided with handles during building, explicitly handling this event is unnecessary as the handles will execute automatically.

Created by Hiroku

Since:

November 20, 2017

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraftforge.fml.common.eventhandler.Event

net.minecraftforge.fml.common.eventhandler.Event.HasResult, net.minecraftforge.fml.common.eventhandler.Event.Result

Field Summary

Fields

Modifier and Type	Field and Description
Choice	choice The choice that was selected.
net.minecraft.entity.player.EntityPlayerMP	player The player who made the dialogue choice.

Constructor Summary

Constructors

Constructor and Description
DialogueChoiceEvent(net.minecraft.entity.player.EntityPlayerMP player, Choice choice)

Method Summary

Modifier and Type	Method and Description
DialogueChoiceEvent	addDialogue(Dialogue newDialogue)
DialogueNextAction.DialogueGuiAction	getAction()
java.util.ArrayList<Dialogue>	getNewDialogues()
void	reply(boolean insert, Dialogue... dialogues) Simple shortcut to send dialogues back to the player.
void	reply(Dialogue... dialogues) Simple shortcut to send dialogues back to the player.
void	reply(java.lang.String name, java.lang.String... texts) Simple shortcut to send dialogues back to the player.
void	setAction(DialogueNextAction.DialogueGuiAction action)
void	setNewDialogues(java.util.ArrayList<Dialogue> newDialogues)

Methods inherited from class net.minecraftforge.fml.common.eventhandler.Event

getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult, setup

Methods inherited from class java.lang.Object

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

Field Detail

player

public final net.minecraft.entity.player.EntityPlayerMP player

The player who made the dialogue choice.

choice

public final Choice choice

The choice that was selected. This can be identified using its choiceID, NOT by object comparison.

Constructor Detail

DialogueChoiceEvent

public DialogueChoiceEvent(net.minecraft.entity.player.EntityPlayerMP player,
                           Choice choice)

Method Detail

getAction

public DialogueNextAction.DialogueGuiAction getAction()

setAction

public void setAction(DialogueNextAction.DialogueGuiAction action)

addDialogue

public DialogueChoiceEvent addDialogue(Dialogue newDialogue)

setNewDialogues

public void setNewDialogues(java.util.ArrayList<Dialogue> newDialogues)

getNewDialogues

public java.util.ArrayList<Dialogue> getNewDialogues()

reply

public void reply(Dialogue... dialogues)

Simple shortcut to send dialogues back to the player. This will replace all previously planned dialogue. To insert dialogue instead, use the overload reply(boolean, Dialogue...).

reply

public void reply(boolean insert,
                  Dialogue... dialogues)

Simple shortcut to send dialogues back to the player.

Parameters:

insert - - Whether or not it should use insertion. If false, this will replace all previous dialogue. if true, this will put the given dialogue at the beginning of the queue.

reply

public void reply(java.lang.String name,
                  java.lang.String... texts)

Simple shortcut to send dialogues back to the player.