PixelCrushers.DialogueSystem.ConversationStarter Class Reference

This is the base class for the ConversationOnXXX (e.g., ConversationOnUse) and BarkOnXXX (e.g., BarkOnUse) components. More...

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

Public Member Functions

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

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

This is the base class for the ConversationOnXXX (e.g., ConversationOnUse) and BarkOnXXX (e.g., BarkOnUse) components.

Member Function Documentation

◆ TryStartConversation() [1/2]

void PixelCrushers.DialogueSystem.ConversationStarter.TryStartConversation ( Transform  actor)

If the condition is true, starts the conversation between the specified actor and the character that this component is attached to.

Parameters
actorThe actor to converse with.

◆ TryStartConversation() [2/2]

void PixelCrushers.DialogueSystem.ConversationStarter.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.

Parameters
actorActor.
interactorInteractor to check the condition against.

Member Data Documentation

◆ condition

Condition PixelCrushers.DialogueSystem.ConversationStarter.condition

The condition required for the conversation to start.

◆ conversant

Transform PixelCrushers.DialogueSystem.ConversationStarter.conversant

The conversant of the conversation.

If not set, this game object. The actor is usually the entity that caused the trigger (for example, the player that hits the "Use" button on the conversant, thereby triggering OnUse).

◆ conversation

string PixelCrushers.DialogueSystem.ConversationStarter.conversation

The title of the conversation to start.

◆ exclusive

bool PixelCrushers.DialogueSystem.ConversationStarter.exclusive = false

Only start if no other conversation is active.

◆ selectedDatabase

DialogueDatabase PixelCrushers.DialogueSystem.ConversationStarter.selectedDatabase = null

◆ skipIfNoValidEntries

bool PixelCrushers.DialogueSystem.ConversationStarter.skipIfNoValidEntries

If this is true<c/c> and no valid entries currently link from the start entry, don't start the conversation.

◆ useConversationTitlePicker

bool PixelCrushers.DialogueSystem.ConversationStarter.useConversationTitlePicker = true

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