Performs various actions when the GameObject receives the "Die" message. More...

Inheritance diagram for PixelCrushers.DialogueSystem.UFPS.DialogueSystemOnDie:

Collaboration diagram for PixelCrushers.DialogueSystem.UFPS.DialogueSystemOnDie:

Public Member Functions
void	OnEnable ()

void	OnDisable ()

virtual void	Die ()
	Run actions when the object receives the "Die" message. More...

void	OnApplyPersistentData ()
	When applying persistent data, check the variable. More...

Public Attributes
bool	destroy = false
	Set this `true` to destroy the object on "Die". More...

string	sequence = string.Empty
	The sequence to play on "Die". More...

string	luaCode = string.Empty
	The lua code to run on "Die". More...

string	variableToRecordDeath = string.Empty
	The variable to record when the object dies. More...

string	variableToIncrement = string.Empty
	The variable to increment on "Die" More...

int	increment = 1
	The increment amount. More...

int	min = 0
	The minimum value. More...

int	max = 100
	The maximum value. More...

Detailed Description

Performs various actions when the GameObject receives the "Die" message.

Member Function Documentation

◆ Die()

virtual void PixelCrushers.DialogueSystem.UFPS.DialogueSystemOnDie.Die ( )

virtual

Run actions when the object receives the "Die" message.

Increment variableToIncrement
Record death in variableToRecordDeath
Destroy the object if specified

◆ OnApplyPersistentData()

void PixelCrushers.DialogueSystem.UFPS.DialogueSystemOnDie.OnApplyPersistentData ( )

When applying persistent data, check the variable.

If it's true, the GameObject has been destroyed previously, so destroy it now.

◆ OnDisable()

void PixelCrushers.DialogueSystem.UFPS.DialogueSystemOnDie.OnDisable ( )

◆ OnEnable()

void PixelCrushers.DialogueSystem.UFPS.DialogueSystemOnDie.OnEnable ( )

Member Data Documentation

◆ destroy

bool PixelCrushers.DialogueSystem.UFPS.DialogueSystemOnDie.destroy = false

Set this true to destroy the object on "Die".

◆ increment

int PixelCrushers.DialogueSystem.UFPS.DialogueSystemOnDie.increment = 1

The increment amount.

To decrement, use a negative number.

◆ luaCode

string PixelCrushers.DialogueSystem.UFPS.DialogueSystemOnDie.luaCode = string.Empty

The lua code to run on "Die".

◆ max

int PixelCrushers.DialogueSystem.UFPS.DialogueSystemOnDie.max = 100

The maximum value.

◆ min

int PixelCrushers.DialogueSystem.UFPS.DialogueSystemOnDie.min = 0

The minimum value.

◆ sequence

string PixelCrushers.DialogueSystem.UFPS.DialogueSystemOnDie.sequence = string.Empty

The sequence to play on "Die".

The speaker is the Dialogue Manager object, and the listener is this object.

◆ variableToIncrement

string PixelCrushers.DialogueSystem.UFPS.DialogueSystemOnDie.variableToIncrement = string.Empty

The variable to increment on "Die"

◆ variableToRecordDeath

string PixelCrushers.DialogueSystem.UFPS.DialogueSystemOnDie.variableToRecordDeath = string.Empty

The variable to record when the object dies.

When the object is reloaded, if this variable is true then it will deactivate itself (or destroy itself if destroy is true).

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

D:/Documents/Unity Projects/Dialogue System/Dev/Integration/UFPS Integration/Assets/Dialogue System/Third Party Support/UFPS/Scripts/DialogueSystemOnDie.cs

Public Member Functions

Public Attributes