Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Events | List of all members
PixelCrushers.DialogueSystem.ExtraDatabases Class Reference

Adds and removes extra dialogue databases. More...

Inheritance diagram for PixelCrushers.DialogueSystem.ExtraDatabases:
Inheritance graph
[legend]
Collaboration diagram for PixelCrushers.DialogueSystem.ExtraDatabases:
Collaboration graph
[legend]

Public Member Functions

virtual void AddDatabases (bool onePerFrame)
 
virtual void RemoveDatabases (bool onePerFrame)
 
virtual void Start ()
 
virtual void OnEnable ()
 
virtual void OnDisable ()
 
virtual void OnDestroy ()
 
virtual void OnUse (Transform actor)
 
virtual void OnUse (string message)
 
virtual void OnUse ()
 
virtual void OnTriggerEnter (Collider other)
 
virtual void OnTriggerExit (Collider other)
 
virtual void OnTriggerEnter2D (Collider2D other)
 
virtual void OnTriggerExit2D (Collider2D other)
 

Public Attributes

DialogueTriggerEvent addTrigger = DialogueTriggerEvent.OnStart
 Add the databases when this trigger occurs.
 
DialogueTriggerEvent removeTrigger = DialogueTriggerEvent.None
 Remove the databases when this trigger occurs.
 
DialogueDatabase[] databases = new DialogueDatabase[0]
 The databases to add/remove.
 
Condition condition = new Condition()
 The condition that must be true for the trigger to fire.
 
bool once = false
 As soon as one event (add or remove) has occurred, destroy this component.
 
bool onePerFrame = false
 Add/remove one database per frame instead of adding them all at the same time.
 

Protected Member Functions

virtual void TryAddDatabases (Transform interactor, bool onePerFrame)
 
virtual void AddDatabasesImmediate ()
 
virtual IEnumerator AddDatabasesCoroutine ()
 
virtual void AddDatabase (DialogueDatabase database)
 
virtual void TryRemoveDatabases (Transform interactor, bool onePerFrame)
 
virtual void RemoveDatabasesImmediate ()
 
virtual IEnumerator RemoveDatabasesCoroutine ()
 
virtual void RemoveDatabase (DialogueDatabase database)
 
virtual IEnumerator DestroyCoroutine ()
 
virtual IEnumerator StartEndOfFrame ()
 

Protected Attributes

bool m_trying = false
 
Coroutine m_destroyCoroutine = null
 
int m_numActiveCoroutines = 0
 

Events

static System.Action addedDatabases = delegate { }
 This event is called after ExtraDatabases has finished adding its list of databases to the DialogueManager's MasterDatabase.
 
static System.Action removedDatabases = delegate { }
 This event is called after ExtraDatabases has finished removing its list of databases from the DialogueManager's MasterDatabase.
 

Detailed Description

Adds and removes extra dialogue databases.

Member Function Documentation

◆ AddDatabase()

virtual void PixelCrushers.DialogueSystem.ExtraDatabases.AddDatabase ( DialogueDatabase  database)
inlineprotectedvirtual

◆ AddDatabases()

virtual void PixelCrushers.DialogueSystem.ExtraDatabases.AddDatabases ( bool  onePerFrame)
inlinevirtual

◆ AddDatabasesCoroutine()

virtual IEnumerator PixelCrushers.DialogueSystem.ExtraDatabases.AddDatabasesCoroutine ( )
inlineprotectedvirtual

◆ AddDatabasesImmediate()

virtual void PixelCrushers.DialogueSystem.ExtraDatabases.AddDatabasesImmediate ( )
inlineprotectedvirtual

◆ DestroyCoroutine()

virtual IEnumerator PixelCrushers.DialogueSystem.ExtraDatabases.DestroyCoroutine ( )
inlineprotectedvirtual

◆ OnDestroy()

virtual void PixelCrushers.DialogueSystem.ExtraDatabases.OnDestroy ( )
inlinevirtual

◆ OnDisable()

virtual void PixelCrushers.DialogueSystem.ExtraDatabases.OnDisable ( )
inlinevirtual

◆ OnEnable()

virtual void PixelCrushers.DialogueSystem.ExtraDatabases.OnEnable ( )
inlinevirtual

◆ OnTriggerEnter()

virtual void PixelCrushers.DialogueSystem.ExtraDatabases.OnTriggerEnter ( Collider  other)
inlinevirtual

◆ OnTriggerEnter2D()

virtual void PixelCrushers.DialogueSystem.ExtraDatabases.OnTriggerEnter2D ( Collider2D  other)
inlinevirtual

◆ OnTriggerExit()

virtual void PixelCrushers.DialogueSystem.ExtraDatabases.OnTriggerExit ( Collider  other)
inlinevirtual

◆ OnTriggerExit2D()

virtual void PixelCrushers.DialogueSystem.ExtraDatabases.OnTriggerExit2D ( Collider2D  other)
inlinevirtual

◆ OnUse() [1/3]

virtual void PixelCrushers.DialogueSystem.ExtraDatabases.OnUse ( )
inlinevirtual

◆ OnUse() [2/3]

virtual void PixelCrushers.DialogueSystem.ExtraDatabases.OnUse ( string  message)
inlinevirtual

◆ OnUse() [3/3]

virtual void PixelCrushers.DialogueSystem.ExtraDatabases.OnUse ( Transform  actor)
inlinevirtual

◆ RemoveDatabase()

virtual void PixelCrushers.DialogueSystem.ExtraDatabases.RemoveDatabase ( DialogueDatabase  database)
inlineprotectedvirtual

◆ RemoveDatabases()

virtual void PixelCrushers.DialogueSystem.ExtraDatabases.RemoveDatabases ( bool  onePerFrame)
inlinevirtual

◆ RemoveDatabasesCoroutine()

virtual IEnumerator PixelCrushers.DialogueSystem.ExtraDatabases.RemoveDatabasesCoroutine ( )
inlineprotectedvirtual

◆ RemoveDatabasesImmediate()

virtual void PixelCrushers.DialogueSystem.ExtraDatabases.RemoveDatabasesImmediate ( )
inlineprotectedvirtual

◆ Start()

virtual void PixelCrushers.DialogueSystem.ExtraDatabases.Start ( )
inlinevirtual

◆ StartEndOfFrame()

virtual IEnumerator PixelCrushers.DialogueSystem.ExtraDatabases.StartEndOfFrame ( )
inlineprotectedvirtual

◆ TryAddDatabases()

virtual void PixelCrushers.DialogueSystem.ExtraDatabases.TryAddDatabases ( Transform  interactor,
bool  onePerFrame 
)
inlineprotectedvirtual

◆ TryRemoveDatabases()

virtual void PixelCrushers.DialogueSystem.ExtraDatabases.TryRemoveDatabases ( Transform  interactor,
bool  onePerFrame 
)
inlineprotectedvirtual

Member Data Documentation

◆ addTrigger

DialogueTriggerEvent PixelCrushers.DialogueSystem.ExtraDatabases.addTrigger = DialogueTriggerEvent.OnStart

Add the databases when this trigger occurs.

◆ condition

Condition PixelCrushers.DialogueSystem.ExtraDatabases.condition = new Condition()

The condition that must be true for the trigger to fire.

◆ databases

DialogueDatabase [] PixelCrushers.DialogueSystem.ExtraDatabases.databases = new DialogueDatabase[0]

The databases to add/remove.

◆ m_destroyCoroutine

Coroutine PixelCrushers.DialogueSystem.ExtraDatabases.m_destroyCoroutine = null
protected

◆ m_numActiveCoroutines

int PixelCrushers.DialogueSystem.ExtraDatabases.m_numActiveCoroutines = 0
protected

◆ m_trying

bool PixelCrushers.DialogueSystem.ExtraDatabases.m_trying = false
protected

◆ once

bool PixelCrushers.DialogueSystem.ExtraDatabases.once = false

As soon as one event (add or remove) has occurred, destroy this component.

◆ onePerFrame

bool PixelCrushers.DialogueSystem.ExtraDatabases.onePerFrame = false

Add/remove one database per frame instead of adding them all at the same time.

Useful to avoid stutter when adding several databases.

◆ removeTrigger

DialogueTriggerEvent PixelCrushers.DialogueSystem.ExtraDatabases.removeTrigger = DialogueTriggerEvent.None

Remove the databases when this trigger occurs.

Event Documentation

◆ addedDatabases

System.Action PixelCrushers.DialogueSystem.ExtraDatabases.addedDatabases = delegate { }
static

This event is called after ExtraDatabases has finished adding its list of databases to the DialogueManager's MasterDatabase.

◆ removedDatabases

System.Action PixelCrushers.DialogueSystem.ExtraDatabases.removedDatabases = delegate { }
static

This event is called after ExtraDatabases has finished removing its list of databases from the DialogueManager's MasterDatabase.

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