Response menu controls for DaikonForgeDialogueUI. More...

Inheritance diagram for PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeResponseMenuControls:

Collaboration diagram for PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeResponseMenuControls:

[legend]

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

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

override void	SetActive (bool value)
	Sets the controls active/inactive, except this method never activates the timer. More...

override void	StartTimer (float timeout)
	Starts the timer. More...

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

Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls
virtual void	ShowResponses (Subtitle subtitle, Response[] responses, Transform target)
	Shows the subtitle reminder and response buttons. More...

Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractUIControls
void	Show ()
	Shows the controls by setting them active. More...

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

Public Attributes
dfPanel	panel
	The panel containing the controls. More...

dfTextureSprite	pcImage
	The PC portrait image. More...

dfLabel	pcName
	The PC portrait name. More...

DaikonForgeSubtitleControls	subtitleReminder
	The reminder of the last subtitle. More...

dfProgressBar	timerBar
	The (optional) timer. More...

DaikonForgeResponseButton[]	buttons
	The response buttons. More...

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

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

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

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

Properties
override AbstractUISubtitleControls	SubtitleReminder `[get]`
	The response button alignment – that is, whether to align them to the first or the last button. More...

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

Detailed Description

Response menu controls for DaikonForgeDialogueUI.

Member Function Documentation

◆ ClearResponseButtons()

override void PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeResponseMenuControls.ClearResponseButtons ( )

protectedvirtual

Clears the response buttons.

Implements PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.

◆ OnTimeout()

void PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeResponseMenuControls.OnTimeout ( )

This method is called if the timer runs out.

It selects the first response.

◆ SetActive()

override void PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeResponseMenuControls.SetActive ( bool value )

virtual

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

Implements PixelCrushers.DialogueSystem.AbstractUIControls.

◆ SetActorPortraitTexture()

override void PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeResponseMenuControls.SetActorPortraitTexture	(	string	actorName,
		Texture2D	portraitTexture
	)

virtual

Sets the portrait texture 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 texture.

Parameters

actorName	Actor name in database.
portraitTexture	Portrait texture.

Reimplemented from PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.

◆ SetPCPortrait()

override void PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeResponseMenuControls.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 from PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.

◆ SetResponseButtons()

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

protectedvirtual

Sets the response buttons.

Parameters

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

Implements PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.

◆ StartTimer()

override void PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeResponseMenuControls.StartTimer ( float timeout )

virtual

Starts the timer.

Parameters

timeout Timeout duration in seconds.

Implements PixelCrushers.DialogueSystem.AbstractUIResponseMenuControls.

Member Data Documentation

◆ buttons

DaikonForgeResponseButton [] PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeResponseMenuControls.buttons

The response buttons.

◆ panel

dfPanel PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeResponseMenuControls.panel

The panel containing the controls.

A panel is optional, but you may want one so you can include additional controls.

◆ pcImage

dfTextureSprite PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeResponseMenuControls.pcImage

The PC portrait image.

◆ pcName

dfLabel PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeResponseMenuControls.pcName

The PC portrait name.

◆ subtitleReminder

DaikonForgeSubtitleControls PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeResponseMenuControls.subtitleReminder

The reminder of the last subtitle.

◆ timerBar

dfProgressBar PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeResponseMenuControls.timerBar

The (optional) timer.

Property Documentation

◆ SubtitleReminder

override AbstractUISubtitleControls PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeResponseMenuControls.SubtitleReminder

get

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

Defaults to the first button.

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.

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

D:/Documents/Unity Projects/Dialogue System/Dev/Integration/DFGUI Integration/Assets/Dialogue System/Third Party Support/Daikon Forge GUI/Daikon Forge Dialogue UI/Daikon Forge Dialogue Controls/DaikonForgeResponseMenuControls.cs

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ ClearResponseButtons()

◆ OnTimeout()

◆ SetActive()

◆ SetActorPortraitTexture()

◆ SetPCPortrait()

◆ SetResponseButtons()

◆ StartTimer()

Member Data Documentation

◆ buttons

◆ panel

◆ pcImage

◆ pcName

◆ subtitleReminder

◆ timerBar

Property Documentation

◆ SubtitleReminder