CityBuilderCore.StructureDecorators Class Reference

Detailed Description

structure made up of different decorators, used for random map objects that will be removed when something is built in their place
the prefab that will be used for when the game is loaded is determined by the gameobjects name so this should at least start with the prefab name

https://citybuilder.softleitner.com/manual/structures

Inheritance diagram for CityBuilderCore.StructureDecorators:

Classes
class	StructureDecoratorData
class	StructureDecoratorsData

Public Member Functions
IEnumerable< Vector2Int >	GetChildPoints (IGridPositions positions)
IEnumerable< Vector2Int >	GetPoints ()
	retrieves all the points the structure occupies
bool	HasPoint (Vector2Int point)
	checks if the structure occupies a certain point
void	Add (IEnumerable< Vector2Int > points, UndoRedoActions undoRedoActions=null)
	adds points to a structure, for example a tree to a tree structure collection this may not be possible for structures with fixed points like buildings typically called in a structures Start method
IEnumerable< Vector2Int >	Remove (IEnumerable< Vector2Int > points, UndoRedoActions undoRedoActions=null)
	removes points from the structure, for some structures like buildings removing any point will remove the whole thing typically called in a structures OnDestroy method
void	Clear ()
string	GetName ()
	retrieves the name of the structure for display in the UI
StructureDecoratorsData	SaveData ()
void	LoadData (StructureDecoratorsData data)

Public Attributes
string	Name
StructureLevelMask	Level
GameObject[]	Prefabs
StructureRotationMode	RotationMode
float	ScaleMinimum = 1f
float	ScaleMaximum = 1f
Public Attributes inherited from CityBuilderCore.KeyedBehaviour
string	Key

Properties
StructureReference	StructureReference [get, set]
	reference to the structure that keeps working even if the structure is replaced
Properties inherited from CityBuilderCore.IKeyed
Properties inherited from CityBuilderCore.IStructure

Events
Action< PointsChanged< IStructure > >	PointsChanged
Events inherited from CityBuilderCore.IStructure
Action< PointsChanged< IStructure > >	PointsChanged
	has to be fired when a structures points changed so the manager can readjust paths only viable for structures that are stored in list form like underlying, collections and tiles other structures have to be reregistered

Additional Inherited Members
Static Public Member Functions inherited from CityBuilderCore.IStructure
static void	ReplacePoints (IStructure a, IStructure b, Vector2Int point, bool keepRandomization=true, bool keepVariant=true, UndoRedoActions undoRedoActions=null)
	removes a point from one structure and adds it to another while trying to carry over its look both structures need to be StructureCollectionFloat, StructureTerrainTrees or StructureTerrainTreeVariants)
static void	ReplacePoints (IStructure a, IStructure b, IEnumerable< Vector2Int > points, bool keepRandomization=true, bool keepVariant=true, UndoRedoActions undoRedoActions=null)
	removes points from one structure and adds them to another while trying to carry over its look both structures need to be StructureCollectionFloat, StructureTerrainTrees or StructureTerrainTreeVariants) used in town so bushes keep their look(size, rotation, color) when berries grown on them would also carry the variant index for trees in town if there were any

Member Function Documentation

Add()

void CityBuilderCore.StructureDecorators.Add ( IEnumerable< Vector2Int > points, UndoRedoActions undoRedoActions = null )

inline

adds points to a structure, for example a tree to a tree structure collection
this may not be possible for structures with fixed points like buildings
typically called in a structures Start method

Parameters

points

the points that will be added to the structure

Implements CityBuilderCore.IStructure.

GetName()

string CityBuilderCore.StructureDecorators.GetName

(

)

retrieves the name of the structure for display in the UI

Returns

name of the structure for UI

Implements CityBuilderCore.IStructure.

GetPoints()

IEnumerable< Vector2Int > CityBuilderCore.StructureDecorators.GetPoints

(

)

retrieves all the points the structure occupies

Returns

the points the structure occupies

Implements CityBuilderCore.IStructure.

HasPoint()

bool CityBuilderCore.StructureDecorators.HasPoint

(

Vector2Int

point

)

checks if the structure occupies a certain point

Parameters

point

a point on the map

Returns

true if the structure occupies that point

Implements CityBuilderCore.IStructure.

Remove()

IEnumerable< Vector2Int > CityBuilderCore.StructureDecorators.Remove ( IEnumerable< Vector2Int > points, UndoRedoActions undoRedoActions = null )

inline

removes points from the structure, for some structures like buildings removing any point will remove the whole thing
typically called in a structures OnDestroy method

Parameters

points

the points to remove

Returns

the actual removed points

Implements CityBuilderCore.IStructure.

Property Documentation

StructureReference

StructureReference CityBuilderCore.StructureDecorators.StructureReference

getset

reference to the structure that keeps working even if the structure is replaced

Implements CityBuilderCore.IStructure.