The Alert Trigger component shows a gameplay alert when a trigger event occurs. More...

Inheritance diagram for PixelCrushers.DialogueSystem.AlertTrigger:

Collaboration diagram for PixelCrushers.DialogueSystem.AlertTrigger:

[legend]

Public Member Functions
void	OnBarkEnd (Transform actor)

void	OnConversationEnd (Transform actor)

void	OnSequenceEnd (Transform actor)

void	OnUse (Transform actor)

void	OnUse (string message)

void	OnUse ()

void	OnTriggerEnter (Collider other)

void	OnTriggerEnter2D (Collider2D other)

void	OnTriggerExit (Collider other)

void	OnTriggerExit2D (Collider2D other)

void	OnCollisionEnter (Collision collision)

void	OnCollisionEnter2D (Collision2D collision)

void	OnCollisionExit (Collision collision)

void	OnCollisionExit2D (Collision2D collision)

void	Start ()

void	OnEnable ()

void	OnDisable ()

void	OnLevelWillBeUnloaded ()

void	OnApplicationQuit ()

void	OnDestroy ()

void	TryStart (Transform actor)
	Show the alert if the condition is true. More...

Public Attributes
DialogueTriggerEvent	trigger = DialogueTriggerEvent.OnUse
	The trigger that shows the alert. More...

LocalizedTextTable	localizedTextTable
	If localizedTextTable is assigned, message is the field name of a field in the localized text table. More...

string	message
	The message to show. More...

float	duration = 5f
	The duration to show the message. More...

Condition	condition
	The condition required for the alert. More...

Public Attributes inherited from PixelCrushers.DialogueSystem.DialogueEventStarter
bool	once = false
	Set `true` if this event should only happen once. More...

Additional Inherited Members
Protected Member Functions inherited from PixelCrushers.DialogueSystem.DialogueEventStarter
void	DestroyIfOnce ()

Detailed Description

The Alert Trigger component shows a gameplay alert when a trigger event occurs.

If a LocalizedTextTable has been asssigned to the Dialogue Manager, it will use localized version of the alert message.

Member Function Documentation

◆ OnApplicationQuit()

void PixelCrushers.DialogueSystem.AlertTrigger.OnApplicationQuit ( )

◆ OnBarkEnd()

void PixelCrushers.DialogueSystem.AlertTrigger.OnBarkEnd ( Transform actor )

◆ OnCollisionEnter()

void PixelCrushers.DialogueSystem.AlertTrigger.OnCollisionEnter ( Collision collision )

◆ OnCollisionEnter2D()

void PixelCrushers.DialogueSystem.AlertTrigger.OnCollisionEnter2D ( Collision2D collision )

◆ OnCollisionExit()

void PixelCrushers.DialogueSystem.AlertTrigger.OnCollisionExit ( Collision collision )

◆ OnCollisionExit2D()

void PixelCrushers.DialogueSystem.AlertTrigger.OnCollisionExit2D ( Collision2D collision )

◆ OnConversationEnd()

void PixelCrushers.DialogueSystem.AlertTrigger.OnConversationEnd ( Transform actor )

◆ OnDestroy()

void PixelCrushers.DialogueSystem.AlertTrigger.OnDestroy ( )

◆ OnDisable()

void PixelCrushers.DialogueSystem.AlertTrigger.OnDisable ( )

◆ OnEnable()

void PixelCrushers.DialogueSystem.AlertTrigger.OnEnable ( )

◆ OnLevelWillBeUnloaded()

void PixelCrushers.DialogueSystem.AlertTrigger.OnLevelWillBeUnloaded ( )

◆ OnSequenceEnd()

void PixelCrushers.DialogueSystem.AlertTrigger.OnSequenceEnd ( Transform actor )

◆ OnTriggerEnter()

void PixelCrushers.DialogueSystem.AlertTrigger.OnTriggerEnter ( Collider other )

◆ OnTriggerEnter2D()

void PixelCrushers.DialogueSystem.AlertTrigger.OnTriggerEnter2D ( Collider2D other )

◆ OnTriggerExit()

void PixelCrushers.DialogueSystem.AlertTrigger.OnTriggerExit ( Collider other )

◆ OnTriggerExit2D()

void PixelCrushers.DialogueSystem.AlertTrigger.OnTriggerExit2D ( Collider2D other )

◆ OnUse() [1/3]

void PixelCrushers.DialogueSystem.AlertTrigger.OnUse ( )

◆ OnUse() [2/3]

void PixelCrushers.DialogueSystem.AlertTrigger.OnUse ( string message )

◆ OnUse() [3/3]

void PixelCrushers.DialogueSystem.AlertTrigger.OnUse ( Transform actor )

◆ Start()

void PixelCrushers.DialogueSystem.AlertTrigger.Start ( )

◆ TryStart()

void PixelCrushers.DialogueSystem.AlertTrigger.TryStart ( Transform actor )

Show the alert if the condition is true.

Member Data Documentation

◆ condition

Condition PixelCrushers.DialogueSystem.AlertTrigger.condition

The condition required for the alert.

◆ duration

float PixelCrushers.DialogueSystem.AlertTrigger.duration = 5f

The duration to show the message.

◆ localizedTextTable

LocalizedTextTable PixelCrushers.DialogueSystem.AlertTrigger.localizedTextTable

If localizedTextTable is assigned, message is the field name of a field in the localized text table.

◆ message

string PixelCrushers.DialogueSystem.AlertTrigger.message

The message to show.

◆ trigger

DialogueTriggerEvent PixelCrushers.DialogueSystem.AlertTrigger.trigger = DialogueTriggerEvent.OnUse

The trigger that shows the alert.

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

D:/Documents/Unity Projects/Dialogue System/Dev/Source/Assets/Dialogue System/Scripts/Supplemental/Triggers/Starters/AlertTrigger.cs

Public Member Functions

Public Attributes

Additional Inherited Members