This persistent data component keeps track of when the GameObject has been destroyed or disabled. More...

Inheritance diagram for PixelCrushers.DialogueSystem.PersistentDestructible:

Collaboration diagram for PixelCrushers.DialogueSystem.PersistentDestructible:

Public Types
enum	RecordOn { RecordOn.Destroy, RecordOn.Disable }

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

void	OnLevelWillBeUnloaded ()
	If the level is being unloaded, this GameObject will be destroyed. More...

void	OnApplicationQuit ()
	If the application is ending, don't listen, as this can log errors in the console. More...

void	OnDestroy ()
	If the GameObject is destroyed, set its Lua variable `true`. More...

void	OnDisable ()

Public Attributes
RecordOn	recordOn = RecordOn.Destroy

string	variableName = string.Empty
	Assign a Lua variable name to keep track of whether the GameObject has been destroyed. More...

GameObject	spawnWhenDestroyed

Protected Member Functions
virtual void	OnEnable ()
	Only listen for OnDestroy if the script has been enabled. More...

Protected Attributes
bool	listenForOnDestroy = false

Properties
string?	ActualVariableName `[get]`

Detailed Description

This persistent data component keeps track of when the GameObject has been destroyed or disabled.

The next time the level or game is loaded, if the GameObject has previously been destroyed/disabled, this script will destroy/deactivate it again.

Member Enumeration Documentation

◆ RecordOn

enum PixelCrushers.DialogueSystem.PersistentDestructible.RecordOn

strong

Enumerator
Destroy
Disable

Member Function Documentation

◆ OnApplicationQuit()

void PixelCrushers.DialogueSystem.PersistentDestructible.OnApplicationQuit ( )

If the application is ending, don't listen, as this can log errors in the console.

◆ OnApplyPersistentData()

void PixelCrushers.DialogueSystem.PersistentDestructible.OnApplyPersistentData ( )

When applying persistent data, check the variable.

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

◆ OnDestroy()

void PixelCrushers.DialogueSystem.PersistentDestructible.OnDestroy ( )

If the GameObject is destroyed, set its Lua variable true.

◆ OnDisable()

void PixelCrushers.DialogueSystem.PersistentDestructible.OnDisable ( )

◆ OnEnable()

virtual void PixelCrushers.DialogueSystem.PersistentDestructible.OnEnable ( )

protectedvirtual

Only listen for OnDestroy if the script has been enabled.

◆ OnLevelWillBeUnloaded()

void PixelCrushers.DialogueSystem.PersistentDestructible.OnLevelWillBeUnloaded ( )

If the level is being unloaded, this GameObject will be destroyed.

We don't want to count this in the variable, so disable the script.

Member Data Documentation

◆ listenForOnDestroy

bool PixelCrushers.DialogueSystem.PersistentDestructible.listenForOnDestroy = false

protected

◆ recordOn

RecordOn PixelCrushers.DialogueSystem.PersistentDestructible.recordOn = RecordOn.Destroy

◆ spawnWhenDestroyed

GameObject PixelCrushers.DialogueSystem.PersistentDestructible.spawnWhenDestroyed

◆ variableName

string PixelCrushers.DialogueSystem.PersistentDestructible.variableName = string.Empty

Assign a Lua variable name to keep track of whether the GameObject has been destroyed.

If this is blank, it uses the name of the GameObject for the variable name. If the variable is true, the GameObject has been destroyed.

Property Documentation

◆ ActualVariableName

string? PixelCrushers.DialogueSystem.PersistentDestructible.ActualVariableName

getprotected

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

D:/Documents/Unity Projects/Dialogue System/Dev/Release/Assets/Dialogue System/Scripts/Supplemental/Utility/PersistentDestructible.cs

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties