PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger Class Reference

The ICode Variable Trigger component sets an ICode variable when a trigger event such as "OnUse" occurs. More...

Inheritance diagram for PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger:
Collaboration diagram for PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger:

Public Types

enum  VariableType {
  VariableType.Bool, VariableType.Int, VariableType.Float, VariableType.String,
  VariableType.Color, VariableType.Vector2, VariableType.Vector3, VariableType.GameObject
}
 

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 TryStart (Transform actor)
 Set the variable if the condition is true. More...
 

Public Attributes

DialogueTriggerEvent trigger = DialogueTriggerEvent.OnUse
 The trigger. More...
 
Condition condition
 The condition required for the trigger to fire. More...
 
ICodeBehaviour iCodeBehaviour = null
 The ICodeBehaviour containing the variable to set (if it's not a global variable). More...
 
string variableName = string.Empty
 The variable to set. More...
 
bool globalVariable = false
 Set true if this is a global variable; otherwise it's a variable in the ICodeBehavior's state machine. More...
 
VariableType variableType = VariableType.Bool
 
bool boolValue
 
int intValue
 
float floatValue
 
string stringValue
 
Color colorValue
 
Vector2 vector2Value
 
Vector3 vector3Value
 
GameObject gameObjectValue
 
- 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 ICode Variable Trigger component sets an ICode variable when a trigger event such as "OnUse" occurs.

Member Enumeration Documentation

◆ VariableType

Enumerator
Bool 
Int 
Float 
String 
Color 
Vector2 
Vector3 
GameObject 

Member Function Documentation

◆ OnBarkEnd()

void PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.OnBarkEnd ( Transform  actor)

◆ OnConversationEnd()

void PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.OnConversationEnd ( Transform  actor)

◆ OnSequenceEnd()

void PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.OnSequenceEnd ( Transform  actor)

◆ OnTriggerEnter()

void PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.OnTriggerEnter ( Collider  other)

◆ OnTriggerEnter2D()

void PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.OnTriggerEnter2D ( Collider2D  other)

◆ OnUse() [1/3]

void PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.OnUse ( )

◆ OnUse() [2/3]

void PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.OnUse ( string  message)

◆ OnUse() [3/3]

void PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.OnUse ( Transform  actor)

◆ TryStart()

void PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.TryStart ( Transform  actor)

Set the variable if the condition is true.

Member Data Documentation

◆ boolValue

bool PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.boolValue

◆ colorValue

Color PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.colorValue

◆ condition

Condition PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.condition

The condition required for the trigger to fire.

◆ floatValue

float PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.floatValue

◆ gameObjectValue

GameObject PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.gameObjectValue

◆ globalVariable

bool PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.globalVariable = false

Set true if this is a global variable; otherwise it's a variable in the ICodeBehavior's state machine.

◆ iCodeBehaviour

ICodeBehaviour PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.iCodeBehaviour = null

The ICodeBehaviour containing the variable to set (if it's not a global variable).

◆ intValue

int PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.intValue

◆ stringValue

string PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.stringValue

◆ trigger

DialogueTriggerEvent PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.trigger = DialogueTriggerEvent.OnUse

The trigger.

◆ variableName

string PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.variableName = string.Empty

The variable to set.

◆ variableType

VariableType PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.variableType = VariableType.Bool

◆ vector2Value

Vector2 PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.vector2Value

◆ vector3Value

Vector3 PixelCrushers.DialogueSystem.ICode.ICodeVariableTrigger.vector3Value

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