Table of Contents

Class BuildingPlacementAdapter

Namespace
Root
Assembly
SPZGameAssembly.dll
public class BuildingPlacementAdapter : IEntityPlacementAdapter<BuildingPlacement, BuildingDescriptor, GlobalTileTransform, GlobalTileCoordinate>, IEntityDescriptorAdapter<BuildingDescriptor, GlobalTileTransform>, IEntityPlacementAdapter<BuildingPlacement, BuildingDescriptor>
Inheritance
object
BuildingPlacementAdapter
Implements
Extension Methods

Constructors

BuildingPlacementAdapter()

public BuildingPlacementAdapter()

Methods

AddEntity(IPlacementData, BuildingPlacement)

public void AddEntity(IPlacementData placementData, BuildingPlacement placement)

Parameters

placementData IPlacementData
placement BuildingPlacement

CreateDescriptor(IEntityDefinition, GlobalTileTransform, IEntityConfiguration, SimulationStateContainer)

public BuildingDescriptor CreateDescriptor(IEntityDefinition entityDefinition, GlobalTileTransform transform, IEntityConfiguration configuration, SimulationStateContainer state)

Parameters

entityDefinition IEntityDefinition
transform GlobalTileTransform
configuration IEntityConfiguration
state SimulationStateContainer

Returns

BuildingDescriptor

CreatePlacement(BuildingDescriptor, PlacementAllowability, int)

public BuildingPlacement CreatePlacement(BuildingDescriptor descriptor, PlacementAllowability allowability, int placementIndex)

Parameters

descriptor BuildingDescriptor
allowability PlacementAllowability
placementIndex int

Returns

BuildingPlacement

EntityCount(IPlacementData)

public int EntityCount(IPlacementData placementData)

Parameters

placementData IPlacementData

Returns

int

FlagError(IPlacementErrors, Exception, GlobalTileCoordinate)

public void FlagError(IPlacementErrors placementErrors, Exception exception, GlobalTileCoordinate position)

Parameters

placementErrors IPlacementErrors
exception Exception
position GlobalTileCoordinate

GetAllEntities(IPlacementData, List<BuildingPlacement>, out IReadOnlyList<BuildingPlacement>)

public void GetAllEntities(IPlacementData placementData, List<BuildingPlacement> allocatedCollection, out IReadOnlyList<BuildingPlacement> filledCollection)

Parameters

placementData IPlacementData
allocatedCollection List<BuildingPlacement>
filledCollection IReadOnlyList<BuildingPlacement>

GetAllInvalidEntities(IPlacementData, ICollection<BuildingPlacement>)

public void GetAllInvalidEntities(IPlacementData placementData, ICollection<BuildingPlacement> entitiesDescriptors)

Parameters

placementData IPlacementData
entitiesDescriptors ICollection<BuildingPlacement>

GetInvalidEntitiesAt(IPlacementData, GlobalTileCoordinate, ICollection<BuildingPlacement>)

public void GetInvalidEntitiesAt(IPlacementData placementData, GlobalTileCoordinate position, ICollection<BuildingPlacement> entities)

Parameters

placementData IPlacementData
position GlobalTileCoordinate
entities ICollection<BuildingPlacement>

GetValidEntitiesAt(IPlacementData, GlobalTileCoordinate, ICollection<BuildingPlacement>)

public void GetValidEntitiesAt(IPlacementData placementData, GlobalTileCoordinate position, ICollection<BuildingPlacement> entities)

Parameters

placementData IPlacementData
position GlobalTileCoordinate
entities ICollection<BuildingPlacement>

HasAnyEntityAt(IPlacementData, GlobalTileCoordinate)

public bool HasAnyEntityAt(IPlacementData placementData, GlobalTileCoordinate coordinate)

Parameters

placementData IPlacementData
coordinate GlobalTileCoordinate

Returns

bool

NextIndex(IPlacementData)

public int NextIndex(IPlacementData placementData)

Parameters

placementData IPlacementData

Returns

int

RemoveEntity(IPlacementData, BuildingPlacement)

public void RemoveEntity(IPlacementData placementData, BuildingPlacement placement)

Parameters

placementData IPlacementData
placement BuildingPlacement

RemoveExtraMapEntity(IPlacementData, GlobalTileCoordinate)

public void RemoveExtraMapEntity(IPlacementData placementData, GlobalTileCoordinate position)

Parameters

placementData IPlacementData
position GlobalTileCoordinate

ReplaceEntity(IPlacementData, BuildingPlacement)

public void ReplaceEntity(IPlacementData placementData, BuildingPlacement placement)

Parameters

placementData IPlacementData
placement BuildingPlacement

TryGetFirstInvalidEntityAt(IPlacementData, GlobalTileCoordinate, out BuildingPlacement)

public bool TryGetFirstInvalidEntityAt(IPlacementData placementData, GlobalTileCoordinate position, out BuildingPlacement placement)

Parameters

placementData IPlacementData
position GlobalTileCoordinate
placement BuildingPlacement

Returns

bool

TryGetFirstValidEntityAt(IPlacementData, GlobalTileCoordinate, out BuildingPlacement)

public bool TryGetFirstValidEntityAt(IPlacementData placementData, GlobalTileCoordinate position, out BuildingPlacement placement)

Parameters

placementData IPlacementData
position GlobalTileCoordinate
placement BuildingPlacement

Returns

bool