Abstract response menu controls. More...

Inheritance diagram for PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls:

[legend]

Collaboration diagram for PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls:

Public Member Functions
abstract void	StartTimer (float timeout)
	Starts the timer. More...

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

virtual void	SetPCPortrait (Texture2D portraitTexture, string portraitName)
	Sets the PC portrait name and texture to use in the response menu. More...

virtual void	SetActorPortraitTexture (string actorName, Texture2D portraitTexture)
	Sets the portrait texture to use in the response menu if the named actor is the player. More...

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

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

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

Public Attributes
ResponseButtonAlignment	buttonAlignment = ResponseButtonAlignment.ToFirst
	The response button alignment – that is, whether to align them to the first or the last button. More...

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

Protected Member Functions
abstract void	ClearResponseButtons ()
	Clears the response buttons. More...

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

Properties
abstract AbstractUISubtitleControls	SubtitleReminder `[get]`
	Gets the subtitle reminder controls. More...

Detailed Description

Abstract response menu controls.

Each GUI system implementation derives its own subclass from this.

Member Function Documentation

◆ ClearResponseButtons()

abstract void PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.ClearResponseButtons ( )

protectedpure virtual

Clears the response buttons.

Implemented in PixelCrushers.DialogueSystem.UnityUIResponseMenuControls, PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProResponseMenuControls, PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeResponseMenuControls, PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls, PixelCrushers.DialogueSystem.NGUI.NGUIResponseMenuControls, and PixelCrushers.DialogueSystem.TK2D.TK2DResponseMenuControls.

◆ SetActorPortraitTexture()

virtual void PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.SetActorPortraitTexture	(	string	actorName,
		Texture2D	portraitTexture
	)

virtual

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

Parameters

actorName	Actor name in database.
portraitTexture	Portrait texture.

Reimplemented in PixelCrushers.DialogueSystem.UnityUIResponseMenuControls, PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProResponseMenuControls, PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls, PixelCrushers.DialogueSystem.NGUI.NGUIResponseMenuControls, and PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeResponseMenuControls.

◆ SetPCPortrait()

virtual void PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.SetPCPortrait	(	Texture2D	portraitTexture,
		string	portraitName
	)

virtual

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

Parameters

portraitTexture	Portrait texture.
portraitName	Portrait name.

Reimplemented in PixelCrushers.DialogueSystem.UnityUIResponseMenuControls, PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProResponseMenuControls, PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls, PixelCrushers.DialogueSystem.NGUI.NGUIResponseMenuControls, PixelCrushers.DialogueSystem.TK2D.TK2DResponseMenuControls, and PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeResponseMenuControls.

◆ SetResponseButtons()

abstract void PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.SetResponseButtons	(	Response[]	responses,
		Transform	target
	)

protectedpure virtual

Sets the response buttons.

Parameters

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

Implemented in PixelCrushers.DialogueSystem.UnityUIResponseMenuControls, PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProResponseMenuControls, PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls, PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeResponseMenuControls, PixelCrushers.DialogueSystem.NGUI.NGUIResponseMenuControls, and PixelCrushers.DialogueSystem.TK2D.TK2DResponseMenuControls.

◆ ShowResponses()

virtual void PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.ShowResponses	(	Subtitle	subtitle,
		Response[]	responses,
		Transform	target
	)

virtual

Shows the subtitle reminder and response buttons.

Parameters

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

◆ StartTimer()

abstract void PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.StartTimer ( float timeout )

pure virtual

Starts the timer.

Parameters

timeout Timeout duration in seconds.

Implemented in PixelCrushers.DialogueSystem.UnityUIResponseMenuControls, PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProResponseMenuControls, PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls, PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeResponseMenuControls, PixelCrushers.DialogueSystem.NGUI.NGUIResponseMenuControls, and PixelCrushers.DialogueSystem.TK2D.TK2DResponseMenuControls.

Member Data Documentation

◆ buttonAlignment

ResponseButtonAlignment PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.buttonAlignment = ResponseButtonAlignment.ToFirst

The response button alignment – that is, whether to align them to the first or the last button.

Defaults to the first button.

◆ showUnusedButtons

bool PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.showUnusedButtons = false

Specifies whether to show buttons that aren't assigned to any responses.

If you're using a "dialogue wheel," for example, you'll want to show unused buttons so the entire wheel structure is visible.

Property Documentation

◆ SubtitleReminder

abstract AbstractUISubtitleControls PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.SubtitleReminder

get

Gets the subtitle reminder controls.

The subtitle reminder controls.

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

D:/Documents/Unity Projects/Dialogue System/Dev/Source/Assets/Dialogue System/Scripts/Supplemental/Abstract UI/Abstract Dialogue UI/AbstractUIResponseMenuControls.cs

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ ClearResponseButtons()

◆ SetActorPortraitTexture()

◆ SetPCPortrait()

◆ SetResponseButtons()

◆ ShowResponses()

◆ StartTimer()

Member Data Documentation

◆ buttonAlignment

◆ showUnusedButtons

Property Documentation

◆ SubtitleReminder