PixelCrushers.DialogueSystem.ConversationTrigger Class Reference

The conversation trigger component starts a conversation between an actor and this game object when the game object receives a specified dialogue trigger. More...

Inheritance diagram for PixelCrushers.DialogueSystem.ConversationTrigger:
Collaboration diagram for PixelCrushers.DialogueSystem.ConversationTrigger:

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 OnTriggerExit (Collider other)
 
void OnTriggerExit2D (Collider2D other)
 
void OnCollisionEnter (Collision collision)
 
void OnCollisionEnter2D (Collision2D collision)
 
void OnCollisionExit (Collision collision)
 
void OnCollisionExit2D (Collision2D collision)
 
void OnTriggerEnter2D (Collider2D other)
 
void Start ()
 
void OnEnable ()
 
void OnDisable ()
 
void OnLevelWillBeUnloaded ()
 
void OnApplicationQuit ()
 
void OnDestroy ()
 
- Public Member Functions inherited from PixelCrushers.DialogueSystem.ConversationStarter
void TryStartConversation (Transform actor)
 If the condition is true, starts the conversation between the specified actor and the character that this component is attached to. More...
 
void TryStartConversation (Transform actor, Transform interactor)
 If the condition is true, starts the conversation between the specified actor and the character that this component is attached to. More...
 

Public Attributes

Transform actor
 The actor to converse with. More...
 
DialogueTriggerEvent trigger = DialogueTriggerEvent.OnUse
 The trigger that starts the conversation. More...
 
bool stopConversationOnTriggerExit = false
 Set true to stop the conversation if the actor leaves the trigger area. More...
 
- Public Attributes inherited from PixelCrushers.DialogueSystem.ConversationStarter
string conversation
 The title of the conversation to start. More...
 
Condition condition
 The condition required for the conversation to start. More...
 
bool skipIfNoValidEntries
 If this is true<c/c> and no valid entries currently link from the start entry, don't start the conversation. More...
 
bool exclusive = false
 Only start if no other conversation is active. More...
 
Transform conversant
 The conversant of the conversation. More...
 
bool useConversationTitlePicker = true
 
DialogueDatabase selectedDatabase = null
 
- 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 conversation trigger component starts a conversation between an actor and this game object when the game object receives a specified dialogue trigger.

For example, you can use this component to start a conversation as soon as a game object or level is loaded by choosing the OnStart event.

Member Function Documentation

◆ OnApplicationQuit()

void PixelCrushers.DialogueSystem.ConversationTrigger.OnApplicationQuit ( )

◆ OnBarkEnd()

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

◆ OnCollisionEnter()

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

◆ OnCollisionEnter2D()

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

◆ OnCollisionExit()

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

◆ OnCollisionExit2D()

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

◆ OnConversationEnd()

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

◆ OnDestroy()

void PixelCrushers.DialogueSystem.ConversationTrigger.OnDestroy ( )

◆ OnDisable()

void PixelCrushers.DialogueSystem.ConversationTrigger.OnDisable ( )

◆ OnEnable()

void PixelCrushers.DialogueSystem.ConversationTrigger.OnEnable ( )

◆ OnLevelWillBeUnloaded()

void PixelCrushers.DialogueSystem.ConversationTrigger.OnLevelWillBeUnloaded ( )

◆ OnSequenceEnd()

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

◆ OnTriggerEnter()

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

◆ OnTriggerEnter2D()

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

◆ OnTriggerExit()

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

◆ OnTriggerExit2D()

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

◆ OnUse() [1/3]

void PixelCrushers.DialogueSystem.ConversationTrigger.OnUse ( )

◆ OnUse() [2/3]

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

◆ OnUse() [3/3]

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

◆ Start()

void PixelCrushers.DialogueSystem.ConversationTrigger.Start ( )

Member Data Documentation

◆ actor

Transform PixelCrushers.DialogueSystem.ConversationTrigger.actor

The actor to converse with.

If not set, the game object that triggered the event.

◆ stopConversationOnTriggerExit

bool PixelCrushers.DialogueSystem.ConversationTrigger.stopConversationOnTriggerExit = false

Set true to stop the conversation if the actor leaves the trigger area.

◆ trigger

DialogueTriggerEvent PixelCrushers.DialogueSystem.ConversationTrigger.trigger = DialogueTriggerEvent.OnUse

The trigger that starts the conversation.


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