Manages response menus for StandardDialogueUI. More...

Inheritance diagram for PixelCrushers.DialogueSystem.StandardUIResponseMenuControls:

[legend]

Collaboration diagram for PixelCrushers.DialogueSystem.StandardUIResponseMenuControls:

[legend]

Public Member Functions
void	Initialize (StandardUIMenuPanel[] menuPanels, StandardUIMenuPanel defaultMenuPanel, bool useFirstResponseForMenuPortrait)

void	ClearCache ()

virtual void	SetActorMenuPanelNumber (DialogueActor dialogueActor, MenuPanelNumber menuPanelNumber)
	Changes a dialogue actor's menu panel for the current conversation.

void	ForceOverrideMenuPanel (StandardUIMenuPanel panel)
	Forces menus to use a specific panel regardless of any other default or override settings.

void	OverrideActorMenuPanel (Transform actorTransform, MenuPanelNumber menuPanelNumber, StandardUIMenuPanel customPanel)
	For speakers who do not have DialogueActor components, this method overrides the actor's default panel.

void	OverrideActorMenuPanel (Actor actor, MenuPanelNumber menuPanelNumber, StandardUIMenuPanel customPanel)
	For speakers who do not have a GameObject, this method overrides the actor's default panel.

virtual StandardUIMenuPanel	GetPanel (Subtitle lastSubtitle, Response[] responses)

override void	SetPCPortrait (Sprite portraitSprite, string portraitName)
	Sets the PC portrait name and sprite to use in the response menu.

override void	SetActorPortraitSprite (string actorName, Sprite portraitSprite)
	Sets the portrait sprite to use in the response menu if the named actor is the player.

override void	SetActive (bool value)

override void	ShowResponses (Subtitle lastSubtitle, Response[] responses, Transform target)
	Shows a response menu.

virtual void	MakeButtonsNonclickable ()
	Makes the current menu panel's buttons non-clickable.

void	Close ()
	Close all panels.

bool	AreAnyPanelsClosing ()

override void	StartTimer (float timeout)
	Starts the timer.

void	DefaultTimeoutHandler ()

Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls
void	StartTimer (float timeout)
	Starts the timer.

virtual void	SetPCPortrait (Texture2D texture, string portraitName)

virtual void	SetActorPortraitTexture (string actorName, Texture2D texture)

Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractUIControls
void	SetActive (bool value)
	Sets the controls active/inactive.

void	Show ()
	Shows the controls by setting them active.

void	Hide ()
	Hides the controls by setting them inactive.

Public Attributes
System.Action	timeoutHandler = null
	Assign this delegate if you want it to replace the default timeout handler.

Public Attributes inherited from PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls
ResponseButtonAlignment	buttonAlignment = ResponseButtonAlignment.ToFirst
	The response button alignment – that is, whether to align them to the first or the last button.

bool	showUnusedButtons = false
	Specifies whether to show buttons that aren't assigned to any responses.

Protected Member Functions
Transform	GetActorTransformFromID (int actorID)

StandardUIMenuPanel	GetDialogueActorPanel (DialogueActor dialogueActor)

StandardUIMenuPanel	GetPanelFromNumber (MenuPanelNumber menuPanelNumber, StandardUIMenuPanel customPanel)

override void	ClearResponseButtons ()

override void	SetResponseButtons (Response[] responses, Transform target)

Protected Member Functions inherited from PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls
void	ClearResponseButtons ()
	Clears the response buttons.

void	SetResponseButtons (Response[] responses, Transform target)
	Sets the response buttons.

Protected Attributes
List< StandardUIMenuPanel >	m_builtinPanels = new List<StandardUIMenuPanel>()

StandardUIMenuPanel	m_defaultPanel = null

Dictionary< Transform, StandardUIMenuPanel >	m_actorPanelCache = new Dictionary<Transform, StandardUIMenuPanel>()

Dictionary< int, StandardUIMenuPanel >	m_actorIdPanelCache = new Dictionary<int, StandardUIMenuPanel>()

StandardUIMenuPanel	m_currentPanel = null

StandardUIMenuPanel	m_forcedOverridePanel = null

Sprite	m_pcPortraitSprite = null

string	m_pcPortraitName = null

bool	useFirstResponseForPortrait = false

Properties
override AbstractUISubtitleControls	subtitleReminderControls `[get]`

StandardUIMenuPanel	defaultPanel `[get, set]`

virtual bool	allowDialogueActorCustomPanels = true `[get, set]`

Properties inherited from PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls
AbstractUISubtitleControls	subtitleReminderControls `[get]`
	Gets the subtitle reminder controls.

Detailed Description

Manages response menus for StandardDialogueUI.

Member Function Documentation

◆ AreAnyPanelsClosing()

bool PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.AreAnyPanelsClosing ( )

inline

◆ ClearCache()

void PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.ClearCache ( )

inline

◆ ClearResponseButtons()

override void PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.ClearResponseButtons ( )

inlineprotected

◆ Close()

void PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.Close ( )

inline

Close all panels.

◆ DefaultTimeoutHandler()

void PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.DefaultTimeoutHandler ( )

inline

◆ ForceOverrideMenuPanel()

void PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.ForceOverrideMenuPanel ( StandardUIMenuPanel panel )

inline

Forces menus to use a specific panel regardless of any other default or override settings.

◆ GetActorTransformFromID()

Transform PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.GetActorTransformFromID ( int actorID )

inlineprotected

◆ GetDialogueActorPanel()

StandardUIMenuPanel PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.GetDialogueActorPanel ( DialogueActor dialogueActor )

inlineprotected

◆ GetPanel()

virtual StandardUIMenuPanel PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.GetPanel	(	Subtitle	lastSubtitle,
		Response[]	responses
	)

inlinevirtual

◆ GetPanelFromNumber()

StandardUIMenuPanel PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.GetPanelFromNumber	(	MenuPanelNumber	menuPanelNumber,
		StandardUIMenuPanel	customPanel
	)

inlineprotected

◆ Initialize()

void PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.Initialize	(	StandardUIMenuPanel[]	menuPanels,
		StandardUIMenuPanel	defaultMenuPanel,
		bool	useFirstResponseForMenuPortrait
	)

inline

◆ MakeButtonsNonclickable()

virtual void PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.MakeButtonsNonclickable ( )

inlinevirtual

Makes the current menu panel's buttons non-clickable.

Typically called by the dialogue UI as soon as a button has been clicked to make sure the player can't click another one while the menu is playing its hide animation.

◆ OverrideActorMenuPanel() [1/2]

void PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.OverrideActorMenuPanel	(	Actor	actor,
		MenuPanelNumber	menuPanelNumber,
		StandardUIMenuPanel	customPanel
	)

inline

For speakers who do not have a GameObject, this method overrides the actor's default panel.

◆ OverrideActorMenuPanel() [2/2]

void PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.OverrideActorMenuPanel	(	Transform	actorTransform,
		MenuPanelNumber	menuPanelNumber,
		StandardUIMenuPanel	customPanel
	)

inline

For speakers who do not have DialogueActor components, this method overrides the actor's default panel.

◆ SetActive()

override void PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.SetActive ( bool value )

inline

◆ SetActorMenuPanelNumber()

virtual void PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.SetActorMenuPanelNumber	(	DialogueActor	dialogueActor,
		MenuPanelNumber	menuPanelNumber
	)

inlinevirtual

Changes a dialogue actor's menu panel for the current conversation.

◆ SetActorPortraitSprite()

override void PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.SetActorPortraitSprite	(	string	actorName,
		Sprite	portraitSprite
	)

inlinevirtual

Sets the portrait sprite to use in the response menu if the named actor is the player.

This is used to immediately update the GUI control if the SetPortrait() sequencer command changes the portrait sprite.

Parameters

actorName	Actor name in database.
portraitSprite	Portrait sprite.

Reimplemented from PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.

◆ SetPCPortrait()

override void PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.SetPCPortrait	(	Sprite	portraitSprite,
		string	portraitName
	)

inlinevirtual

Sets the PC portrait name and sprite to use in the response menu.

Parameters

portraitSprite	Portrait sprite.
portraitName	Portrait name.

Reimplemented from PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.

◆ SetResponseButtons()

override void PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.SetResponseButtons	(	Response[]	responses,
		Transform	target
	)

inlineprotected

◆ ShowResponses()

override void PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.ShowResponses	(	Subtitle	lastSubtitle,
		Response[]	responses,
		Transform	target
	)

inlinevirtual

Shows a response menu.

Parameters

lastSubtitle	The last subtitle shown. Used to determine which menu panel to use.
responses	Responses to show in menu panel.
target	Send OnClick events to this GameObject (the dialogue UI).

Reimplemented from PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.

◆ StartTimer()

override void PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.StartTimer ( float timeout )

inline

Starts the timer.

Parameters

timeout Timeout duration in seconds.

Member Data Documentation

◆ m_actorIdPanelCache

Dictionary<int, StandardUIMenuPanel> PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.m_actorIdPanelCache = new Dictionary<int, StandardUIMenuPanel>()

protected

◆ m_actorPanelCache

Dictionary<Transform, StandardUIMenuPanel> PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.m_actorPanelCache = new Dictionary<Transform, StandardUIMenuPanel>()

protected

◆ m_builtinPanels

List<StandardUIMenuPanel> PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.m_builtinPanels = new List<StandardUIMenuPanel>()

protected

◆ m_currentPanel

StandardUIMenuPanel PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.m_currentPanel = null

protected

◆ m_defaultPanel

StandardUIMenuPanel PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.m_defaultPanel = null

protected

◆ m_forcedOverridePanel

StandardUIMenuPanel PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.m_forcedOverridePanel = null

protected

◆ m_pcPortraitName

string PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.m_pcPortraitName = null

protected

◆ m_pcPortraitSprite

Sprite PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.m_pcPortraitSprite = null

protected

◆ timeoutHandler

System.Action PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.timeoutHandler = null

Assign this delegate if you want it to replace the default timeout handler.

◆ useFirstResponseForPortrait

bool PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.useFirstResponseForPortrait = false

protected

Property Documentation

◆ allowDialogueActorCustomPanels

virtual bool PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.allowDialogueActorCustomPanels = true

getset

◆ defaultPanel

StandardUIMenuPanel PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.defaultPanel

getset

◆ subtitleReminderControls

override AbstractUISubtitleControls PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.subtitleReminderControls

get

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

C:/Dev/Dialogue System/Dev/Release2/Assets/Plugins/Pixel Crushers/Dialogue System/Scripts/UI/Standard/Dialogue/StandardUIResponseMenuControls.cs

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ AreAnyPanelsClosing()

◆ ClearCache()

◆ ClearResponseButtons()

◆ Close()

◆ DefaultTimeoutHandler()

◆ ForceOverrideMenuPanel()

◆ GetActorTransformFromID()

◆ GetDialogueActorPanel()

◆ GetPanel()

◆ GetPanelFromNumber()

◆ Initialize()

◆ MakeButtonsNonclickable()

◆ OverrideActorMenuPanel() [1/2]

◆ OverrideActorMenuPanel() [2/2]

◆ SetActive()

◆ SetActorMenuPanelNumber()

◆ SetActorPortraitSprite()

◆ SetPCPortrait()

◆ SetResponseButtons()

◆ ShowResponses()

◆ StartTimer()

Member Data Documentation

◆ m_actorIdPanelCache

◆ m_actorPanelCache

◆ m_builtinPanels

◆ m_currentPanel

◆ m_defaultPanel

◆ m_forcedOverridePanel

◆ m_pcPortraitName

◆ m_pcPortraitSprite

◆ timeoutHandler

◆ useFirstResponseForPortrait

Property Documentation

◆ allowDialogueActorCustomPanels

◆ defaultPanel

◆ subtitleReminderControls