PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls Class Reference

Abstract response menu controls. More...

Inheritance diagram for PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls:

Collaboration diagram for PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls:

Public Member Functions
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 (Sprite sprite, string portraitName)
	Sets the PC portrait name and sprite to use in the response menu.
virtual void	SetPCPortrait (Texture2D texture, string portraitName)
virtual void	SetActorPortraitSprite (string actorName, Sprite sprite)
	Sets the portrait sprite to use in the response menu if the named actor is the player.
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
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
void	ClearResponseButtons ()
	Clears the response buttons.
void	SetResponseButtons (Response[] responses, Transform target)
	Sets the response buttons.

Properties
AbstractUISubtitleControls	subtitleReminderControls [get]
	Gets the subtitle reminder controls.

Detailed Description

Abstract response menu controls.

Each GUI system implementation derives its own subclass from this.

Member Function Documentation

ClearResponseButtons()

void PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.ClearResponseButtons ( )

abstractprotected

Clears the response buttons.

SetActorPortraitSprite()

virtual void PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.SetActorPortraitSprite ( string  actorName, Sprite  sprite  )

inlinevirtual

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

Parameters

actorName	Actor name in database.
sprite	Portrait sprite.

Reimplemented in PixelCrushers.DialogueSystem.NGUISupport.NGUIResponseMenuControls, PixelCrushers.DialogueSystem.TextMeshProSupport.TextMeshProResponseMenuControls, PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls, PixelCrushers.DialogueSystem.StandardUIResponseMenuControls, and PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.

SetActorPortraitTexture()

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

inlinevirtual

SetPCPortrait() [1/2]

virtual void PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.SetPCPortrait ( Sprite  sprite, string  portraitName  )

inlinevirtual

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

Parameters

sprite	Portrait sprite.
portraitName	Portrait name.

Reimplemented in PixelCrushers.DialogueSystem.NGUISupport.NGUIResponseMenuControls, PixelCrushers.DialogueSystem.TextMeshProSupport.TextMeshProResponseMenuControls, PixelCrushers.DialogueSystem.UnityGUI.UnityResponseMenuControls, PixelCrushers.DialogueSystem.StandardUIResponseMenuControls, and PixelCrushers.DialogueSystem.UnityUIResponseMenuControls.

SetPCPortrait() [2/2]

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

inlinevirtual

Reimplemented in PixelCrushers.DialogueSystem.TK2DSupport.TK2DResponseMenuControls.

SetResponseButtons()

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

abstractprotected

Sets the response buttons.

Parameters

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

ShowResponses()

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

inlinevirtual

Shows the subtitle reminder and response buttons.

Parameters

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

Reimplemented in PixelCrushers.DialogueSystem.StandardUIResponseMenuControls.

StartTimer()

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

abstract

Starts the timer.

Parameters

timeout

Timeout duration in seconds.

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

subtitleReminderControls

AbstractUISubtitleControls PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.subtitleReminderControls

getabstract

Gets the subtitle reminder controls.

The subtitle reminder controls.

---

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/Abstract/Dialogue/AbstractUIResponseMenuControls.cs