Class CCMHistoryTracker

Namespace

BlazerTech.CharacterManagement.CharacterCreator

Assembly

Assembly-CSharp.dll

Tracks all modifications made to the ActiveCharacterDraft in the Character Creator.

public class CCMHistoryTracker : CCMBase

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

CCMBase

CCMHistoryTracker

Inherited Members

CCMBase.referenceHandler

CCMBase.characterCreationMenuManager

CCMBase.coreReferencesSet

CCMBase.Awake()

CCMBase.CharacterCreationMenuDisabled()

CCMBase.GetCharacterCreationMenuManagerReference()

CCMBase.GetCCReferenceHandler()

Properties

CanRedo

public bool CanRedo { get; }

Property Value

bool

CanUndo

public bool CanUndo { get; }

Property Value

bool

Current

public LayeredCharacterSnapshot Current { get; }

Property Value

LayeredCharacterSnapshot

CurrentIndex

public int CurrentIndex { get; }

Property Value

int

MaxSnapshots

public int MaxSnapshots { get; set; }

Property Value

int

PreserveFirstSnapshot

Prevent the first snapshot in the Snapshots list from being removed.

public bool PreserveFirstSnapshot { get; }

Property Value

bool

Snapshots

public IReadOnlyList<LayeredCharacterSnapshot> Snapshots { get; }

Property Value

IReadOnlyList<LayeredCharacterSnapshot>

Methods

ApplySnapshot(LayeredCharacterSnapshot)

public void ApplySnapshot(LayeredCharacterSnapshot snapshot)

Parameters

snapshot LayeredCharacterSnapshot

CharacterCreationMenuBeforeDisabled()

Called right before the Character Creation menu is disabled.

protected override void CharacterCreationMenuBeforeDisabled()

CharacterCreationMenuEnabled()

Called after the Character Creation Menu is enabled.

protected override void CharacterCreationMenuEnabled()

CreateNewSnapshot(string, bool)

Create a new snapshot of the LayeredCharacter currently being edited in the Character Creator.

public void CreateNewSnapshot(string noteOverride = "", bool dedupe = true)

Parameters

noteOverride string

dedupe bool

Redo()

Redo to the next snapshot, if available.

public void Redo()

ScheduleSnapshot()

Shcedule a snapshot to be created on the next frame.

public Task ScheduleSnapshot()

Returns

Task

Undo()

Undo to the previous snapshot, if available.

public void Undo()

Events

OnBulkSnapshotsRemoved

Called when multiple snapshots are removed from the Snapshots list at once.

public event EventHandler<List<LayeredCharacterSnapshot>> OnBulkSnapshotsRemoved

Event Type

EventHandler<List<LayeredCharacterSnapshot>>

Remarks

Most often called when the BlazerTech.CharacterManagement.CharacterCreator.CCMHistoryTracker.snapshots list is truncated.

OnCursorChanged

Called when the selected LayeredCharacterSnapshot in the Snapshots list is changed.

public event EventHandler OnCursorChanged

Event Type

EventHandler

OnHistoryChanged

Called when a snapshot is added to or removed from the Snapshots list.

public event EventHandler OnHistoryChanged

Event Type

EventHandler

OnSnapshotAdded

Called when a new snapshot is added to the Snapshots list.

public event EventHandler<LayeredCharacterSnapshot> OnSnapshotAdded

Event Type

EventHandler<LayeredCharacterSnapshot>

OnSnapshotRemoved

Called when a snapshot is removed from the Snapshots list.

public event EventHandler<LayeredCharacterSnapshot> OnSnapshotRemoved

Event Type

EventHandler<LayeredCharacterSnapshot>