Crossfire JXClient, Trunk: com.realtime.crossfire.jxclient.quests.Quest Class Reference

Crossfire JXClient, Trunk

Collaboration diagram for com.realtime.crossfire.jxclient.quests.Quest:

Collaboration graph

Public Member Functions
void	addQuestListener (@NotNull final QuestListener listener)

int	getCode ()

int	getFace ()

String	getTitle ()

String	getTooltipText ()

boolean	isCompleted ()

	Quest (final int code, @NotNull final String title, final int face, final boolean replay, final int parent, final boolean end, @NotNull final String step)

void	removeQuestListener (@NotNull final QuestListener listener)

boolean	replayable ()

void	setStep (final boolean end, @NotNull final String step)

Private Member Functions
void	fireChanged ()

Private Attributes
final int	code

boolean	end

final int	face

final EventListenerList2< QuestListener >	listeners = new EventListenerList2<>()

final int	parent

final boolean	replay

String	step

final String	title

Detailed Description

Describes an in-game quest.

Author: Nicolas Weeger

Definition at line 32 of file Quest.java.

Constructor & Destructor Documentation

◆ Quest()

com.realtime.crossfire.jxclient.quests.Quest.Quest	(	final int	code,
		@NotNull final String	title,
		final int	face,
		final boolean	replay,
		final int	parent,
		final boolean	end,
		@NotNull final String	step
	)

Create a new quest.

Parameters

code	the quest internal code
title	the quest's title
face	the quest's face
replay	if 1 the quest can be replayed
parent	quest internal code of this quest's parent, 0 if no parent.
end	if 1 the quest is completed
step	current quest's step

Definition at line 88 of file Quest.java.

References com.realtime.crossfire.jxclient.quests.Quest.code, com.realtime.crossfire.jxclient.quests.Quest.end, com.realtime.crossfire.jxclient.quests.Quest.face, com.realtime.crossfire.jxclient.quests.Quest.parent, com.realtime.crossfire.jxclient.quests.Quest.replay, com.realtime.crossfire.jxclient.quests.Quest.step, and com.realtime.crossfire.jxclient.quests.Quest.title.

Member Function Documentation

◆ addQuestListener()

void com.realtime.crossfire.jxclient.quests.Quest.addQuestListener ( @NotNull final QuestListener listener )

Adds a QuestListener to be notified of changes.

Parameters

listener the listener to add

Definition at line 188 of file Quest.java.

References com.realtime.crossfire.jxclient.quests.Quest.listeners.

Referenced by com.realtime.crossfire.jxclient.gui.item.GUIItemQuest.setQuest().

Here is the caller graph for this function:

◆ fireChanged()

void com.realtime.crossfire.jxclient.quests.Quest.fireChanged ( )

private

Notifies all listeners.

Definition at line 178 of file Quest.java.

References com.realtime.crossfire.jxclient.quests.Quest.listeners.

Referenced by com.realtime.crossfire.jxclient.quests.Quest.setStep().

Here is the caller graph for this function:

◆ getCode()

int com.realtime.crossfire.jxclient.quests.Quest.getCode ( )

Get the quest's code.

Returns: code.

Definition at line 102 of file Quest.java.

References com.realtime.crossfire.jxclient.quests.Quest.code.

Referenced by com.realtime.crossfire.jxclient.gui.item.GUIItemQuest.button1Clicked(), and com.realtime.crossfire.jxclient.quests.QuestsManager.updateQuest().

Here is the caller graph for this function:

◆ getFace()

int com.realtime.crossfire.jxclient.quests.Quest.getFace ( )

Get the quest's face.

Returns: face index.

Definition at line 119 of file Quest.java.

References com.realtime.crossfire.jxclient.quests.Quest.face.

◆ getTitle()

String com.realtime.crossfire.jxclient.quests.Quest.getTitle ( )

Get the quest's title.

Returns: title.

Definition at line 111 of file Quest.java.

References com.realtime.crossfire.jxclient.quests.Quest.title.

◆ getTooltipText()

String com.realtime.crossfire.jxclient.quests.Quest.getTooltipText ( )

Returns a description for this spell to be used in tooltips.

Returns: the tooltip text

Definition at line 159 of file Quest.java.

References com.realtime.crossfire.jxclient.quests.Quest.end, com.realtime.crossfire.jxclient.quests.Quest.replay, com.realtime.crossfire.jxclient.quests.Quest.step, and com.realtime.crossfire.jxclient.quests.Quest.title.

◆ isCompleted()

boolean com.realtime.crossfire.jxclient.quests.Quest.isCompleted ( )

Definition at line 123 of file Quest.java.

References com.realtime.crossfire.jxclient.quests.Quest.end.

◆ removeQuestListener()

void com.realtime.crossfire.jxclient.quests.Quest.removeQuestListener ( @NotNull final QuestListener listener )

Removes a QuestListener to be notified of changes.

Parameters

listener the listener to remove

Definition at line 196 of file Quest.java.

References com.realtime.crossfire.jxclient.quests.Quest.listeners.

Referenced by com.realtime.crossfire.jxclient.gui.item.GUIItemQuest.dispose(), and com.realtime.crossfire.jxclient.gui.item.GUIItemQuest.setQuest().

Here is the caller graph for this function:

◆ replayable()

boolean com.realtime.crossfire.jxclient.quests.Quest.replayable ( )

Definition at line 127 of file Quest.java.

References com.realtime.crossfire.jxclient.quests.Quest.replay.

◆ setStep()

void com.realtime.crossfire.jxclient.quests.Quest.setStep	(	final boolean	end,
		@NotNull final String	step
	)

Update the quest's state.

Parameters

end	if true the quest is completed
step	step description

Definition at line 136 of file Quest.java.

References com.realtime.crossfire.jxclient.quests.Quest.end, com.realtime.crossfire.jxclient.quests.Quest.fireChanged(), and com.realtime.crossfire.jxclient.quests.Quest.step.

Referenced by com.realtime.crossfire.jxclient.quests.QuestsManager.addQuest(), and com.realtime.crossfire.jxclient.quests.QuestsManager.updateQuest().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ code

final int com.realtime.crossfire.jxclient.quests.Quest.code

private

Quest internal code.

Definition at line 43 of file Quest.java.

Referenced by com.realtime.crossfire.jxclient.quests.Quest.getCode(), and com.realtime.crossfire.jxclient.quests.Quest.Quest().

◆ end

boolean com.realtime.crossfire.jxclient.quests.Quest.end

private

If true, the quest is completed.

Definition at line 69 of file Quest.java.

Referenced by com.realtime.crossfire.jxclient.quests.Quest.getTooltipText(), com.realtime.crossfire.jxclient.quests.Quest.isCompleted(), com.realtime.crossfire.jxclient.quests.Quest.Quest(), and com.realtime.crossfire.jxclient.quests.Quest.setStep().

◆ face

final int com.realtime.crossfire.jxclient.quests.Quest.face

private

Quest face.

Definition at line 54 of file Quest.java.

Referenced by com.realtime.crossfire.jxclient.quests.Quest.getFace(), and com.realtime.crossfire.jxclient.quests.Quest.Quest().

◆ listeners

final EventListenerList2<QuestListener> com.realtime.crossfire.jxclient.quests.Quest.listeners = new EventListenerList2<>()

private

The QuestListeners to be notified of changes.

Definition at line 38 of file Quest.java.

Referenced by com.realtime.crossfire.jxclient.quests.Quest.addQuestListener(), com.realtime.crossfire.jxclient.quests.Quest.fireChanged(), and com.realtime.crossfire.jxclient.quests.Quest.removeQuestListener().

◆ parent

final int com.realtime.crossfire.jxclient.quests.Quest.parent

private

Quest internal code of this quest's parent, 0 if no parent.

Definition at line 64 of file Quest.java.

Referenced by com.realtime.crossfire.jxclient.quests.Quest.Quest().

◆ replay

final boolean com.realtime.crossfire.jxclient.quests.Quest.replay

private

If true, the quest can be replayed.

Definition at line 59 of file Quest.java.

Referenced by com.realtime.crossfire.jxclient.quests.Quest.getTooltipText(), com.realtime.crossfire.jxclient.quests.Quest.Quest(), and com.realtime.crossfire.jxclient.quests.Quest.replayable().

◆ step

String com.realtime.crossfire.jxclient.quests.Quest.step

private

Description of the current step.

Definition at line 75 of file Quest.java.

Referenced by com.realtime.crossfire.jxclient.quests.Quest.getTooltipText(), com.realtime.crossfire.jxclient.quests.Quest.Quest(), and com.realtime.crossfire.jxclient.quests.Quest.setStep().

◆ title

final String com.realtime.crossfire.jxclient.quests.Quest.title

private

Quest title.

Definition at line 49 of file Quest.java.

Referenced by com.realtime.crossfire.jxclient.quests.Quest.getTitle(), com.realtime.crossfire.jxclient.quests.Quest.getTooltipText(), and com.realtime.crossfire.jxclient.quests.Quest.Quest().

The documentation for this class was generated from the following file:

src/model/src/main/java/com/realtime/crossfire/jxclient/quests/Quest.java