PixelCrushers.DialogueSystem.ExtraDatabases Class Reference

Adds and removes extra dialogue databases. More...

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

Public Member Functions

void AddDatabases (bool immediate)
 
void RemoveDatabases (bool immediate)
 
IEnumerator Start ()
 
void OnEnable ()
 
void OnDisable ()
 
void OnDestroy ()
 
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)
 

Public Attributes

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

Events

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

Detailed Description

Adds and removes extra dialogue databases.

This script only adds one database per frame, so it may take several frames to add a list of databases.

Member Function Documentation

◆ AddDatabases()

void PixelCrushers.DialogueSystem.ExtraDatabases.AddDatabases ( bool  immediate)

◆ OnDestroy()

void PixelCrushers.DialogueSystem.ExtraDatabases.OnDestroy ( )

◆ OnDisable()

void PixelCrushers.DialogueSystem.ExtraDatabases.OnDisable ( )

◆ OnEnable()

void PixelCrushers.DialogueSystem.ExtraDatabases.OnEnable ( )

◆ OnTriggerEnter()

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

◆ OnTriggerEnter2D()

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

◆ OnTriggerExit()

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

◆ OnTriggerExit2D()

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

◆ OnUse() [1/3]

void PixelCrushers.DialogueSystem.ExtraDatabases.OnUse ( )

◆ OnUse() [2/3]

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

◆ OnUse() [3/3]

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

◆ RemoveDatabases()

void PixelCrushers.DialogueSystem.ExtraDatabases.RemoveDatabases ( bool  immediate)

◆ Start()

IEnumerator PixelCrushers.DialogueSystem.ExtraDatabases.Start ( )

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.

◆ 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: