CityBuilderCore.UndoRedoActionStructureBase Class Reference

Detailed Description

base class for IUndoRedoAction that adds or removes points from a structure

Inheritance diagram for CityBuilderCore.UndoRedoActionStructureBase:

Classes
class	UndoRedoStructureData

Public Member Functions
	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

Protected Member Functions
virtual void	add ()
virtual void	remove ()

Properties
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

Member Function Documentation

GetPoints()

override IEnumerable< Vector2Int > CityBuilderCore.UndoRedoActionStructureBase.GetPoints ( )

virtual

determines and returns the map points affected by this action
used, for example, to spawn particles at these points

Returns

points affected by the action

Reimplemented from CityBuilderCore.UndoRedoActionBase.

LoadData()

override void CityBuilderCore.UndoRedoActionStructureBase.LoadData ( string json )

inline

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

Parameters

json

Implements CityBuilderCore.ISaveData.

SaveData()

override string CityBuilderCore.UndoRedoActionStructureBase.SaveData ( )

inline

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

Returns

serialized save data

Implements CityBuilderCore.ISaveData.