CityBuilderCore.IUndoRedoStack Interface Reference

Detailed Description

optional interface that manages undo redo in games that support it

Inheritance diagram for CityBuilderCore.IUndoRedoStack:

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

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

Member Function Documentation

Push()

void CityBuilderCore.IUndoRedoStack.Push

(

IUndoRedoAction

action

)

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

Implemented in CityBuilderCore.UndoRedoStack.

Redo()

void CityBuilderCore.IUndoRedoStack.Redo

(

)

redoes the last action that has been undone

Implemented in CityBuilderCore.UndoRedoStack.

Undo()

void CityBuilderCore.IUndoRedoStack.Undo

(

)

undoes the top action in the undo stack

Implemented in CityBuilderCore.UndoRedoStack.

Property Documentation

CanRedo

bool CityBuilderCore.IUndoRedoStack.CanRedo

get

an action that can be redone is present and valid

Implemented in CityBuilderCore.UndoRedoStack.

CanUndo

bool CityBuilderCore.IUndoRedoStack.CanUndo

get

an action that can be undone is present and valid

Implemented in CityBuilderCore.UndoRedoStack.