CityBuilderCore.StructureRemoval Class Reference

Detailed Description

IUndoRedoAction that represents points being removed to a structure

Inheritance diagram for CityBuilderCore.StructureRemoval:

Public Member Functions
	StructureRemoval (IStructure structure, IEnumerable< Vector2Int > points)
override void	Undo ()
	undoes the action
override void	Redo ()
	redoes the action after it has been undone
Public Member Functions inherited from CityBuilderCore.UndoRedoActionStructureBase
	UndoRedoActionStructureBase (IStructure structure, IEnumerable< Vector2Int > points)
override IEnumerable< Vector2Int >	GetPoints ()
	determines and returns the map points affected by this action used, for example, to spawn particles at these points
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.UndoRedoActionBase
void	Undo ()
	undoes the action
void	Redo ()
	redoes the action after it has been undone
string	SaveData ()
	serializes the objects state(usually to json) and returns it
void	LoadData (string json)
	deserializes the serialized json data and loads the data as its new state

Properties
override string	Name [get]
	name of the action to be displayed in the ui(tooltip)
Properties inherited from CityBuilderCore.UndoRedoActionStructureBase
IStructure	Structure [get]
Properties inherited from CityBuilderCore.UndoRedoActionBase
string	Name [get]
	name of the action to be displayed in the ui(tooltip)
virtual bool	CanUndo [get]
	whether the action is currently valid to be undone for example building a hut cannot be undone if that hut has since been destroyed
virtual bool	CanRedo [get]
	whether the action is currently valid to be redone
Properties inherited from CityBuilderCore.IUndoRedoAction

Additional Inherited Members
Protected Member Functions inherited from CityBuilderCore.UndoRedoActionStructureBase
virtual void	add ()
virtual void	remove ()

Member Function Documentation

Redo()

override void CityBuilderCore.StructureRemoval.Redo

(

)

redoes the action after it has been undone

Implements CityBuilderCore.IUndoRedoAction.

Undo()

override void CityBuilderCore.StructureRemoval.Undo

(

)

undoes the action

Implements CityBuilderCore.IUndoRedoAction.

Property Documentation

Name

override string CityBuilderCore.StructureRemoval.Name

get

name of the action to be displayed in the ui(tooltip)

Implements CityBuilderCore.IUndoRedoAction.