Response menu controls for UnityDialogueUI. More...

Inheritance diagram for PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls:

[legend]

Collaboration diagram for PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls:

[legend]

Public Member Functions
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)
	Sets the controls active/inactive, except this method never activates the timer.

override void	StartTimer (float timeout)
	Starts the timer.

void	OnTimeout ()
	This method is called if the timer runs out.

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

virtual void	ShowResponses (Subtitle subtitle, Response[] responses, Transform target)
	Shows the subtitle reminder and response buttons.

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
GUIControl	panel
	The alert panel.

GUILabel	pcImage
	The PC portrait image.

GUILabel	pcName
	The PC portrait name.

UnitySubtitleControls	subtitleReminder
	The reminder of the last subtitle.

GUIProgressBar	timer
	The (optional) timer.

GUIButton[]	buttons
	The response buttons.

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
override void	ClearResponseButtons ()
	Clears the response buttons.

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

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

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

Properties
override AbstractUISubtitleControls	subtitleReminderControls `[get]`

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

Detailed Description

Response menu controls for UnityDialogueUI.

Member Function Documentation

◆ ClearResponseButtons()

override void PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls.ClearResponseButtons ( )

inlineprotected

Clears the response buttons.

◆ OnTimeout()

void PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls.OnTimeout ( )

inline

This method is called if the timer runs out.

The Dialogue Manager can be configured to take different actions on timeout.

◆ SetActive()

override void PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls.SetActive ( bool value )

inline

Sets the controls active/inactive, except this method never activates the timer.

If the UI's display settings specify a timeout, then the UI will call StartTimer() to manually activate the timer.

Parameters

value Value (true for active; otherwise inactive).

◆ SetActorPortraitSprite()

override void PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls.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.UnityGUI.UnityResponseMenuControls.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.UnityGUI.UnityResponseMenuControls.SetResponseButtons	(	Response[]	responses,
		Transform	target
	)

inlineprotected

Sets the response buttons.

Parameters

responses	Responses.
target	Target that will receive OnClick events from the buttons.

◆ StartTimer()

override void PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls.StartTimer ( float timeout )

inline

Starts the timer.

Parameters

timeout Timeout duration in seconds.

Member Data Documentation

◆ buttons

GUIButton [] PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls.buttons

The response buttons.

◆ panel

GUIControl PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls.panel

The alert panel.

A panel is optional, but you may want one so you can include a background image, panel-wide effects, etc.

◆ pcImage

GUILabel PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls.pcImage

The PC portrait image.

◆ pcName

GUILabel PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls.pcName

The PC portrait name.

◆ subtitleReminder

UnitySubtitleControls PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls.subtitleReminder

The reminder of the last subtitle.

◆ timer

GUIProgressBar PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls.timer

The (optional) timer.

Property Documentation

◆ subtitleReminderControls

override AbstractUISubtitleControls PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls.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/Legacy/Dialogue/Controls/UnityResponseMenuControls.cs

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ ClearResponseButtons()

◆ OnTimeout()

◆ SetActive()

◆ SetActorPortraitSprite()

◆ SetPCPortrait()

◆ SetResponseButtons()

◆ StartTimer()

Member Data Documentation

◆ buttons

◆ panel

◆ pcImage

◆ pcName

◆ subtitleReminder

◆ timer

Property Documentation

◆ subtitleReminderControls