Response menu controls for UnityUIDialogueUI. More...

Inheritance diagram for PixelCrushers.DialogueSystem.UnityUIResponseMenuControls:

[legend]

Collaboration diagram for PixelCrushers.DialogueSystem.UnityUIResponseMenuControls:

[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.

void	SetupTemplateButtonNavigation ()

void	DestroyInstantiatedButtons ()

void	NotifyContentChanged ()

override void	StartTimer (float timeout)
	Starts the timer.

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

void	DefaultTimeoutHandler ()

void	AutoFocus (GameObject lastSelection=null, bool allowStealFocus=true)
	Auto-focuses the first response.

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
UnityEngine.UI.Graphic	panel
	The panel containing the response menu controls.

UnityEngine.UI.Image	pcImage
	The PC portrait image to show during the response menu.

UnityEngine.UI.Text	pcName
	The label that will show the PC name.

UnityUISubtitleControls	subtitleReminder
	The reminder of the last subtitle.

UnityEngine.UI.Slider	timer
	The (optional) timer.

bool	selectCurrentOnTimeout = false
	If ticked, then select the currently-focused response on timeout.

UnityUIResponseButton[]	buttons
	The response buttons, if you want to specify buttons at design time.

UnityUIResponseButton	buttonTemplate

UnityEngine.UI.Graphic	buttonTemplateHolder

UnityEngine.UI.Scrollbar	buttonTemplateScrollbar

float	buttonTemplateScrollbarResetValue = 1

bool	explicitNavigationForTemplateButtons = true

bool	loopExplicitNavigation = false

UIAutonumberSettings	autonumber = new UIAutonumberSettings()

UIAnimationTransitions	animationTransitions = new UIAnimationTransitions()

UnityEvent	onContentChanged = new UnityEvent()

List< GameObject >	instantiatedButtons = new List<GameObject>()
	The instantiated buttons.

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
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
bool	isVisible `[get]`

UIShowHideController	showHideController `[get]`

override AbstractUISubtitleControls	subtitleReminderControls `[get]`

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

Detailed Description

Response menu controls for UnityUIDialogueUI.

Member Function Documentation

◆ AutoFocus()

void PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.AutoFocus	(	GameObject	lastSelection = `null`,
		bool	allowStealFocus = `true`
	)

inline

Auto-focuses the first response.

Useful for gamepads.

◆ ClearResponseButtons()

override void PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.ClearResponseButtons ( )

inlineprotected

Clears the response buttons.

◆ DefaultTimeoutHandler()

void PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.DefaultTimeoutHandler ( )

inline

◆ DestroyInstantiatedButtons()

void PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.DestroyInstantiatedButtons ( )

inline

◆ NotifyContentChanged()

void PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.NotifyContentChanged ( )

inline

◆ OnTimeout()

virtual void PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.OnTimeout ( )

inlinevirtual

This method is called if the timer runs out.

It selects the first response.

◆ SetActive()

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

inlineprotected

Sets the response buttons.

Parameters

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

◆ SetupTemplateButtonNavigation()

void PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.SetupTemplateButtonNavigation ( )

inline

◆ StartTimer()

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

inline

Starts the timer.

Parameters

timeout Timeout duration in seconds.

Member Data Documentation

◆ animationTransitions

UIAnimationTransitions PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.animationTransitions = new UIAnimationTransitions()

◆ autonumber

UIAutonumberSettings PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.autonumber = new UIAutonumberSettings()

◆ buttons

UnityUIResponseButton [] PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.buttons

The response buttons, if you want to specify buttons at design time.

◆ buttonTemplate

UnityUIResponseButton PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.buttonTemplate

◆ buttonTemplateHolder

UnityEngine.UI.Graphic PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.buttonTemplateHolder

◆ buttonTemplateScrollbar

UnityEngine.UI.Scrollbar PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.buttonTemplateScrollbar

◆ buttonTemplateScrollbarResetValue

float PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.buttonTemplateScrollbarResetValue = 1

◆ explicitNavigationForTemplateButtons

bool PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.explicitNavigationForTemplateButtons = true

◆ instantiatedButtons

List<GameObject> PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.instantiatedButtons = new List<GameObject>()

The instantiated buttons.

These are only valid during a specific response menu, and only if you're using templates. Each showing of the response menu clears this list and re-populates it with new buttons.

◆ loopExplicitNavigation

bool PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.loopExplicitNavigation = false

◆ onContentChanged

UnityEvent PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.onContentChanged = new UnityEvent()

◆ panel

UnityEngine.UI.Graphic PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.panel

The panel containing the response menu controls.

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

◆ pcImage

UnityEngine.UI.Image PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.pcImage

The PC portrait image to show during the response menu.

◆ pcName

UnityEngine.UI.Text PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.pcName

The label that will show the PC name.

◆ selectCurrentOnTimeout

bool PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.selectCurrentOnTimeout = false

If ticked, then select the currently-focused response on timeout.

◆ subtitleReminder

UnityUISubtitleControls PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.subtitleReminder

The reminder of the last subtitle.

◆ TimeoutHandler

System.Action PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.TimeoutHandler = null

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

◆ timer

UnityEngine.UI.Slider PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.timer

The (optional) timer.

Property Documentation

◆ isVisible

bool PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.isVisible

get

◆ showHideController

UIShowHideController PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.showHideController

get

◆ subtitleReminderControls

override AbstractUISubtitleControls PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.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/Unity UI/Dialogue/UnityUIResponseMenuControls.cs

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AutoFocus()

◆ ClearResponseButtons()

◆ DefaultTimeoutHandler()

◆ DestroyInstantiatedButtons()

◆ NotifyContentChanged()

◆ OnTimeout()

◆ SetActive()

◆ SetActorPortraitSprite()

◆ SetPCPortrait()

◆ SetResponseButtons()

◆ SetupTemplateButtonNavigation()

◆ StartTimer()

Member Data Documentation

◆ animationTransitions

◆ autonumber

◆ buttons

◆ buttonTemplate

◆ buttonTemplateHolder

◆ buttonTemplateScrollbar

◆ buttonTemplateScrollbarResetValue

◆ explicitNavigationForTemplateButtons

◆ instantiatedButtons

◆ loopExplicitNavigation

◆ onContentChanged

◆ panel

◆ pcImage

◆ pcName

◆ selectCurrentOnTimeout

◆ subtitleReminder

◆ TimeoutHandler

◆ timer

Property Documentation

◆ isVisible

◆ showHideController

◆ subtitleReminderControls