Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Properties | List of all members
PixelCrushers.QuestMachine.UnityUIBaseUI Class Referenceabstract

Base functionality for Unity UI quest UIs. More...

Inheritance diagram for PixelCrushers.QuestMachine.UnityUIBaseUI:
Inheritance graph
[legend]
Collaboration diagram for PixelCrushers.QuestMachine.UnityUIBaseUI:
Collaboration graph
[legend]

Public Member Functions

void RefreshNavigableSelectables ()
 
virtual void Show ()
 
virtual void Hide ()
 

Protected Member Functions

virtual void Awake ()
 
virtual void InitializeTemplates ()
 
virtual UnityUITextTemplate GetHeadingTemplate (int level)
 
virtual void SetContents (QuestParticipantTextInfo speaker, List< QuestContent > contents)
 
virtual void SetContents (string displayName, Sprite image, List< QuestContent > contents)
 
virtual void AddContents (List< QuestContent > contents)
 
virtual void AddContent (QuestContent content)
 
virtual void AddHeadingContent (HeadingTextQuestContent headingContent)
 
virtual void AddBodyContent (BodyTextQuestContent bodyContent)
 
virtual void AddBodyContent (string bodyContentString)
 
virtual void AddIconContent (IconQuestContent iconContent)
 
virtual void PrepareIconList ()
 
virtual UnityUIIconListTemplate AddIconList ()
 
virtual void AddButtonContent (ButtonQuestContent buttonContent)
 
virtual void PrepareButtonList ()
 
virtual UnityUIButtonListTemplate AddButtonList ()
 
virtual void AddAudioContent (AudioClipQuestContent audioContent)
 
virtual void AddGenericContent (QuestContent content)
 If you're defining new content types, you may want to override this method to handle your new content types specially.
 
virtual void ClearContent ()
 

Properties

bool isVisible [get]
 
RectTransform mainPanel [get, set]
 
UITextField entityName [get, set]
 
UnityEngine.UI.Image entityImage [get, set]
 
UIPanel uiPanel [get, set]
 
UnityUIIconListTemplate currentIconList [get, set]
 
UnityUIButtonListTemplate currentButtonList [get, set]
 
RectTransform currentContentContainer [get]
 
UnityUIInstancedContentManager currentContentManager [get]
 
UnityUITextTemplate currentHeadingTemplate [get]
 
UnityUITextTemplate[] currentSubheadingTemplates [get]
 
UnityUITextTemplate currentBodyTemplate [get]
 
UnityUIIconListTemplate currentIconListTemplate [get]
 
UnityUIButtonListTemplate currentButtonListTemplate [get]
 

Detailed Description

Base functionality for Unity UI quest UIs.

Member Function Documentation

◆ AddAudioContent()

virtual void PixelCrushers.QuestMachine.UnityUIBaseUI.AddAudioContent ( AudioClipQuestContent  audioContent)
inlineprotectedvirtual

◆ AddBodyContent() [1/2]

virtual void PixelCrushers.QuestMachine.UnityUIBaseUI.AddBodyContent ( BodyTextQuestContent  bodyContent)
inlineprotectedvirtual

◆ AddBodyContent() [2/2]

virtual void PixelCrushers.QuestMachine.UnityUIBaseUI.AddBodyContent ( string  bodyContentString)
inlineprotectedvirtual

◆ AddButtonContent()

virtual void PixelCrushers.QuestMachine.UnityUIBaseUI.AddButtonContent ( ButtonQuestContent  buttonContent)
inlineprotectedvirtual

◆ AddButtonList()

virtual UnityUIButtonListTemplate PixelCrushers.QuestMachine.UnityUIBaseUI.AddButtonList ( )
inlineprotectedvirtual

◆ AddContent()

virtual void PixelCrushers.QuestMachine.UnityUIBaseUI.AddContent ( QuestContent  content)
inlineprotectedvirtual

Reimplemented in PixelCrushers.QuestMachine.UnityUIQuestAlertUI.

◆ AddContents()

virtual void PixelCrushers.QuestMachine.UnityUIBaseUI.AddContents ( List< QuestContent >  contents)
inlineprotectedvirtual

◆ AddGenericContent()

virtual void PixelCrushers.QuestMachine.UnityUIBaseUI.AddGenericContent ( QuestContent  content)
inlineprotectedvirtual

If you're defining new content types, you may want to override this method to handle your new content types specially.

◆ AddHeadingContent()

virtual void PixelCrushers.QuestMachine.UnityUIBaseUI.AddHeadingContent ( HeadingTextQuestContent  headingContent)
inlineprotectedvirtual

◆ AddIconContent()

virtual void PixelCrushers.QuestMachine.UnityUIBaseUI.AddIconContent ( IconQuestContent  iconContent)
inlineprotectedvirtual

◆ AddIconList()

virtual UnityUIIconListTemplate PixelCrushers.QuestMachine.UnityUIBaseUI.AddIconList ( )
inlineprotectedvirtual

◆ Awake()

virtual void PixelCrushers.QuestMachine.UnityUIBaseUI.Awake ( )
inlineprotectedvirtual

Reimplemented in PixelCrushers.QuestMachine.UnityUIQuestAlertUI, PixelCrushers.QuestMachine.UnityUIQuestDialogueUI, PixelCrushers.QuestMachine.UnityUIQuestHUD, and PixelCrushers.QuestMachine.UnityUIQuestJournalUI.

◆ ClearContent()

virtual void PixelCrushers.QuestMachine.UnityUIBaseUI.ClearContent ( )
inlineprotectedvirtual

◆ GetHeadingTemplate()

virtual UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIBaseUI.GetHeadingTemplate ( int  level)
inlineprotectedvirtual

◆ Hide()

virtual void PixelCrushers.QuestMachine.UnityUIBaseUI.Hide ( )
inlinevirtual

Reimplemented in PixelCrushers.QuestMachine.UnityUIQuestJournalUI.

◆ InitializeTemplates()

virtual void PixelCrushers.QuestMachine.UnityUIBaseUI.InitializeTemplates ( )
inlineprotectedvirtual

Reimplemented in PixelCrushers.QuestMachine.UnityUIQuestJournalUI.

◆ PrepareButtonList()

virtual void PixelCrushers.QuestMachine.UnityUIBaseUI.PrepareButtonList ( )
inlineprotectedvirtual

◆ PrepareIconList()

virtual void PixelCrushers.QuestMachine.UnityUIBaseUI.PrepareIconList ( )
inlineprotectedvirtual

◆ RefreshNavigableSelectables()

void PixelCrushers.QuestMachine.UnityUIBaseUI.RefreshNavigableSelectables ( )
inline

◆ SetContents() [1/2]

virtual void PixelCrushers.QuestMachine.UnityUIBaseUI.SetContents ( QuestParticipantTextInfo  speaker,
List< QuestContent >  contents 
)
inlineprotectedvirtual

◆ SetContents() [2/2]

virtual void PixelCrushers.QuestMachine.UnityUIBaseUI.SetContents ( string  displayName,
Sprite  image,
List< QuestContent >  contents 
)
inlineprotectedvirtual

◆ Show()

virtual void PixelCrushers.QuestMachine.UnityUIBaseUI.Show ( )
inlinevirtual

Reimplemented in PixelCrushers.QuestMachine.UnityUIQuestAlertUI.

Property Documentation

◆ currentBodyTemplate

UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIBaseUI.currentBodyTemplate
getabstractprotected

◆ currentButtonList

UnityUIButtonListTemplate PixelCrushers.QuestMachine.UnityUIBaseUI.currentButtonList
getsetprotected

◆ currentButtonListTemplate

UnityUIButtonListTemplate PixelCrushers.QuestMachine.UnityUIBaseUI.currentButtonListTemplate
getabstractprotected

◆ currentContentContainer

RectTransform PixelCrushers.QuestMachine.UnityUIBaseUI.currentContentContainer
getabstractprotected

◆ currentContentManager

UnityUIInstancedContentManager PixelCrushers.QuestMachine.UnityUIBaseUI.currentContentManager
getabstractprotected

◆ currentHeadingTemplate

UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIBaseUI.currentHeadingTemplate
getabstractprotected

◆ currentIconList

UnityUIIconListTemplate PixelCrushers.QuestMachine.UnityUIBaseUI.currentIconList
getsetprotected

◆ currentIconListTemplate

UnityUIIconListTemplate PixelCrushers.QuestMachine.UnityUIBaseUI.currentIconListTemplate
getabstractprotected

◆ currentSubheadingTemplates

UnityUITextTemplate [] PixelCrushers.QuestMachine.UnityUIBaseUI.currentSubheadingTemplates
getabstractprotected

◆ entityImage

UnityEngine.UI.Image PixelCrushers.QuestMachine.UnityUIBaseUI.entityImage
getset

◆ entityName

UITextField PixelCrushers.QuestMachine.UnityUIBaseUI.entityName
getset

◆ isVisible

bool PixelCrushers.QuestMachine.UnityUIBaseUI.isVisible
get

◆ mainPanel

RectTransform PixelCrushers.QuestMachine.UnityUIBaseUI.mainPanel
getset

◆ uiPanel

UIPanel PixelCrushers.QuestMachine.UnityUIBaseUI.uiPanel
getsetprotected
The documentation for this class was generated from the following file: