CityBuilderCore.UndoRedoStack Class Reference

Detailed Description

manages and executes IUndoRedoActions

https://citybuilder.softleitner.com/manual

Inheritance diagram for CityBuilderCore.UndoRedoStack:

Classes
class	UndoRedoStackData

Public Member Functions
void	Push (IUndoRedoAction action)
	puts an action into the stack it is now the next action that will be undone
void	Undo ()
	undoes the top action in the undo stack
void	Redo ()
	redoes the last action that has been undone
override string	SaveData ()
	serializes the objects state(usually to json) and returns it
override void	LoadData (string json)
	deserializes the serialized json data and loads the data as its new state
Public Member Functions inherited from CityBuilderCore.ExtraDataBehaviour
void	LoadData (string json)
	deserializes the serialized json data and loads the data as its new state
string	SaveData ()
	serializes the objects state(usually to json) and returns it

Public Attributes
int	Size = 10
Button	UndoButton
Button	RedoButton
TooltipArea	UndoArea
TooltipArea	RedoArea
UnityEvent< IUndoRedoAction >	Undone
UnityEvent< IUndoRedoAction >	Redone
Public Attributes inherited from CityBuilderCore.KeyedBehaviour
string	Key

Properties
bool	CanUndo [get]
	an action that can be undone is present and valid
bool	CanRedo [get]
	an action that can be redone is present and valid
Properties inherited from CityBuilderCore.IKeyed
Properties inherited from CityBuilderCore.IUndoRedoStack

Member Function Documentation

LoadData()

override void CityBuilderCore.UndoRedoStack.LoadData ( string json )

inline

deserializes the serialized json data and loads the data as its new state

Parameters

json

Implements CityBuilderCore.ISaveData.

Push()

void CityBuilderCore.UndoRedoStack.Push ( IUndoRedoAction action )

inline

puts an action into the stack
it is now the next action that will be undone

Parameters

action

the action representing some process just performed by the player

Implements CityBuilderCore.IUndoRedoStack.

Redo()

void CityBuilderCore.UndoRedoStack.Redo ( )

inline

redoes the last action that has been undone

Implements CityBuilderCore.IUndoRedoStack.

SaveData()

override string CityBuilderCore.UndoRedoStack.SaveData ( )

inline

serializes the objects state(usually to json) and returns it

Returns

serialized save data

Implements CityBuilderCore.ISaveData.

Undo()

void CityBuilderCore.UndoRedoStack.Undo ( )

inline

undoes the top action in the undo stack

Implements CityBuilderCore.IUndoRedoStack.

Property Documentation

CanRedo

bool CityBuilderCore.UndoRedoStack.CanRedo

get

an action that can be redone is present and valid

Implements CityBuilderCore.IUndoRedoStack.

CanUndo

bool CityBuilderCore.UndoRedoStack.CanUndo

get

an action that can be undone is present and valid

Implements CityBuilderCore.IUndoRedoStack.