PixelCrushers.DialogueSystem.NGUI.NGUIQuestLogWindow Class Reference

This is an implementation of the abstract QuestLogWindow class for NGUI. More...

Inheritance diagram for PixelCrushers.DialogueSystem.NGUI.NGUIQuestLogWindow:
Collaboration diagram for PixelCrushers.DialogueSystem.NGUI.NGUIQuestLogWindow:

Public Member Functions

override void OpenWindow (Action openedWindowHandler)
 Open the window by showing the main panel. More...
 
override void CloseWindow (Action closedWindowHandler)
 Close the window by hiding the main panel. More...
 
override void OnQuestListUpdated ()
 Whenever the quest list is updated, repopulate the scroll panel. More...
 
void OnClickQuestGroupFoldout (string group)
 
override void ConfirmAbandonQuest (string title, Action confirmAbandonQuestHandler)
 Opens the abandon confirmation popup. More...
 
void ClickConfirmAbandonQuestButton ()
 
void ClickCancelAbandonQuestButton ()
 
- Public Member Functions inherited from PixelCrushers.DialogueSystem.QuestLogWindow
virtual void Awake ()
 
virtual void Open ()
 Opens the quest window. More...
 
virtual void Close ()
 Closes the quest log window. More...
 
virtual string GetLocalizedText (string fieldName)
 Gets the localized text for a field name. More...
 
virtual bool IsSelectedQuest (QuestInfo questInfo)
 Determines whether the specified questInfo is for the currently-selected quest. More...
 
void ClickClose (object data)
 Your GUI close button should call this. More...
 
virtual void ClickShowActiveQuests (object data)
 Your GUI "show active quests" button should call this. More...
 
virtual void ClickShowCompletedQuests (object data)
 Your GUI "show completed quests" button should call this. More...
 
virtual void ClickQuest (object data)
 Your GUI should call this when the player clicks on a quest to expand or close it. More...
 
virtual void ClickAbandonQuest (object data)
 Your GUI should call this when the player clicks to abandon a quest. More...
 
virtual void ClickTrackQuest (object data)
 Your GUI should call this when the player clicks to toggle quest tracking. More...
 
virtual void ClickShowActiveQuestsButton ()
 
void ClickShowCompletedQuestsButton ()
 
void ClickCloseButton ()
 
void ClickAbandonQuestButton ()
 
void ClickTrackQuestButton ()
 
void UpdateTracker ()
 

Public Attributes

UIRoot uiRoot
 The UI Root containing the quest log window. More...
 
GameObject mainPanel
 The main quest log window panel. More...
 
UIButton activeQuestsButton
 The active quests button. More...
 
UIButton completedQuestsButton
 The completed quests button. More...
 
UITable questTable
 The quest table. More...
 
NGUIQuestGroupTemplate questGroupTemplate
 The quest group template. More...
 
NGUIQuestTemplate questTemplate
 The quest template. More...
 
GameObject abandonPopup
 The confirmation popup to use if the player clicks the abandon quest button. More...
 
UILabel abandonQuestTitle
 The quest title label to set in the abandon quest dialog popup. More...
 
- Public Attributes inherited from PixelCrushers.DialogueSystem.QuestLogWindow
LocalizedTextTable localizedText = null
 
QuestHeadingSource questHeadingSource = QuestHeadingSource.Name
 The quest title source. More...
 
QuestState abandonQuestState = QuestState.Unassigned
 The state to assign abandoned quests. More...
 
bool pauseWhileOpen = true
 If true, the window sets Time.timeScale = 0 to pause the game while displaying the quest log window. More...
 
bool unlockCursorWhileOpen = true
 If true, the cursor is unlocked while the quest log window is open. More...
 
bool useGroups = false
 If true, organize the quests by group. More...
 

Additional Inherited Members

- Public Types inherited from PixelCrushers.DialogueSystem.QuestLogWindow
enum  QuestHeadingSource { QuestHeadingSource.Name, QuestHeadingSource.Description }
 
- Protected Member Functions inherited from PixelCrushers.DialogueSystem.QuestLogWindow
virtual void OnOpenedWindow ()
 
virtual void OnClosedWindow ()
 
virtual void PauseGameplay ()
 
virtual void ResumeGameplay ()
 
virtual void ShowQuests (QuestState questStateMask)
 
virtual QuestInfo GetQuestInfo (string group, string title)
 
virtual string GetNoQuestsMessage (QuestState questStateMask)
 Gets the "no quests" message for a quest state (active or success|failure). More...
 
virtual void OnConfirmAbandonQuest ()
 Your GUI should call this when the player confirms abandonment of a quest. More...
 
- Protected Attributes inherited from PixelCrushers.DialogueSystem.QuestLogWindow
QuestState currentQuestStateMask = QuestState.Active
 The current quest state mask. More...
 
- Properties inherited from PixelCrushers.DialogueSystem.QuestLogWindow
bool IsOpen [get, protected set]
 Indicates whether the quest log window is currently open. More...
 
QuestInfo[] Quests [get, protected set]
 The current list of quests. More...
 
string[] Groups [get, protected set]
 The current list of quest groups. More...
 
string SelectedQuest [get, protected set]
 The title of the currently-selected quest. More...
 
string NoQuestsMessage [get, protected set]
 The message to show if Quests[] is empty. More...
 
bool IsShowingActiveQuests [get]
 Indicates whether the window is showing active quests or completed quests. More...
 

Detailed Description

This is an implementation of the abstract QuestLogWindow class for NGUI.

Member Function Documentation

◆ ClickCancelAbandonQuestButton()

void PixelCrushers.DialogueSystem.NGUI.NGUIQuestLogWindow.ClickCancelAbandonQuestButton ( )

◆ ClickConfirmAbandonQuestButton()

void PixelCrushers.DialogueSystem.NGUI.NGUIQuestLogWindow.ClickConfirmAbandonQuestButton ( )

◆ CloseWindow()

override void PixelCrushers.DialogueSystem.NGUI.NGUIQuestLogWindow.CloseWindow ( Action  closedWindowHandler)
virtual

Close the window by hiding the main panel.

Re-enable the bark UI.

Parameters
closedWindowHandlerClosed window handler.

Reimplemented from PixelCrushers.DialogueSystem.QuestLogWindow.

◆ ConfirmAbandonQuest()

override void PixelCrushers.DialogueSystem.NGUI.NGUIQuestLogWindow.ConfirmAbandonQuest ( string  title,
Action  confirmAbandonQuestHandler 
)
virtual

Opens the abandon confirmation popup.

Parameters
titleQuest title.
confirmAbandonQuestHandlerConfirm abandon quest handler.

Reimplemented from PixelCrushers.DialogueSystem.QuestLogWindow.

◆ OnClickQuestGroupFoldout()

void PixelCrushers.DialogueSystem.NGUI.NGUIQuestLogWindow.OnClickQuestGroupFoldout ( string  group)

◆ OnQuestListUpdated()

override void PixelCrushers.DialogueSystem.NGUI.NGUIQuestLogWindow.OnQuestListUpdated ( )
virtual

Whenever the quest list is updated, repopulate the scroll panel.

Reimplemented from PixelCrushers.DialogueSystem.QuestLogWindow.

◆ OpenWindow()

override void PixelCrushers.DialogueSystem.NGUI.NGUIQuestLogWindow.OpenWindow ( Action  openedWindowHandler)
virtual

Open the window by showing the main panel.

The bark UI may conflict with the quest log window, so temporarily disable it.

Parameters
openedWindowHandlerOpened window handler.

Reimplemented from PixelCrushers.DialogueSystem.QuestLogWindow.

Member Data Documentation

◆ abandonPopup

GameObject PixelCrushers.DialogueSystem.NGUI.NGUIQuestLogWindow.abandonPopup

The confirmation popup to use if the player clicks the abandon quest button.

It should send ClickConfirmAbandonQuest if the player confirms, or ClickCancelAbandonQuest if the player cancels.

◆ abandonQuestTitle

UILabel PixelCrushers.DialogueSystem.NGUI.NGUIQuestLogWindow.abandonQuestTitle

The quest title label to set in the abandon quest dialog popup.

◆ activeQuestsButton

UIButton PixelCrushers.DialogueSystem.NGUI.NGUIQuestLogWindow.activeQuestsButton

The active quests button.

◆ completedQuestsButton

UIButton PixelCrushers.DialogueSystem.NGUI.NGUIQuestLogWindow.completedQuestsButton

The completed quests button.

◆ mainPanel

GameObject PixelCrushers.DialogueSystem.NGUI.NGUIQuestLogWindow.mainPanel

The main quest log window panel.

◆ questGroupTemplate

NGUIQuestGroupTemplate PixelCrushers.DialogueSystem.NGUI.NGUIQuestLogWindow.questGroupTemplate

The quest group template.

◆ questTable

UITable PixelCrushers.DialogueSystem.NGUI.NGUIQuestLogWindow.questTable

The quest table.

◆ questTemplate

NGUIQuestTemplate PixelCrushers.DialogueSystem.NGUI.NGUIQuestLogWindow.questTemplate

The quest template.

◆ uiRoot

UIRoot PixelCrushers.DialogueSystem.NGUI.NGUIQuestLogWindow.uiRoot

The UI Root containing the quest log window.


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