C# Class Aurora.Modules.CityBuilder.CityMap

Describes a base layer for a city map, contains: cityRegion A link that denotes which region (scene) is being used for this map in the server instance. age The age of the city (simulated) in years, future to allow for the city to change dynamically with age. multiRegion A flag used to represent whether or not the city is in a single region (scene) or spread over multiple regions. cityBuildings A list of buildings that are within the city limits. cityPlots A list of plots used in the city map, note that a plot can contain other things apart from buildings. cityClaims An array of values indicating the type of claim on the land, part of a complex, transport etc. estateIdent UUID of owning estate. cityMapOwner UUID of owning avatar. cityLandData Parcel settings for all regions contained within the city. cityEstateSettings Estate settings for all regions in the city.
Mostra file Open project: CobraElDiablo/CityModule Class Usage Examples

Public Properties

Property Type Description
centralRegions List
cityBuildings List
cityPlots List
cityRegions ].Scene[
plotArray ].int[

Public Methods

Method Description
AddScene ( Scene scene, bool central ) : bool
CityMap ( ) : System
CityMap ( uint regionCount, UUID estateOwner, UUID avatar, List centers, List regionDensities, uint mapSeed ) : System
ClaimPlot ( BuildingPlot plot ) : bool

This method will lay claim to a plot of land in the city map. Find the associated plot in the internal plot list and claim it, if the plot is not found then add it to the list.
FindPlot ( int x, int y, int w, int d, PlotClaimType &type ) : int

Finds which building plot is occupying the point of land specified.
GetBuilding ( UUID ident ) : CityBuilding
GetBuilding ( int idx ) : CityBuilding
GetBuilding ( string buildingName ) : CityBuilding
GetPlot ( int idx ) : BuildingPlot
MakePlot ( int x, int y, int w, int d, PlotClaimType flags ) : BuildingPlot

Constructs a building plot for a given position, size and claim type, does not alter any internal properties, this is just a helper method that allows you to create building plots quickly for use as parameters to other internal/external methods that the class provides.
RemoveScene ( Scene scene ) : bool
isPlotClaimed ( BuildingPlot plot ) : bool

Determines if the plot specified has been claimed already or not.
this ( int rx, int ry ) : Scene

Method Details

AddScene() public method

public AddScene ( Scene scene, bool central ) : bool
scene OpenSim.Region.Framework.Scenes.Scene
central bool
return bool

CityMap() public method

public CityMap ( ) : System
return System

CityMap() public method

public CityMap ( uint regionCount, UUID estateOwner, UUID avatar, List centers, List regionDensities, uint mapSeed ) : System
regionCount uint
estateOwner UUID
avatar UUID
centers List
regionDensities List
mapSeed uint
return System

ClaimPlot() public method

This method will lay claim to a plot of land in the city map. Find the associated plot in the internal plot list and claim it, if the plot is not found then add it to the list.
public ClaimPlot ( BuildingPlot plot ) : bool
plot BuildingPlot
return bool

FindPlot() public method

Finds which building plot is occupying the point of land specified.
public FindPlot ( int x, int y, int w, int d, PlotClaimType &type ) : int
x int
y int
w int
d int
type PlotClaimType
return int

GetBuilding() public method

public GetBuilding ( UUID ident ) : CityBuilding
ident UUID
return CityBuilding

GetBuilding() public method

public GetBuilding ( int idx ) : CityBuilding
idx int
return CityBuilding

GetBuilding() public method

public GetBuilding ( string buildingName ) : CityBuilding
buildingName string
return CityBuilding

GetPlot() public method

public GetPlot ( int idx ) : BuildingPlot
idx int
return BuildingPlot

MakePlot() public method

Constructs a building plot for a given position, size and claim type, does not alter any internal properties, this is just a helper method that allows you to create building plots quickly for use as parameters to other internal/external methods that the class provides.
public MakePlot ( int x, int y, int w, int d, PlotClaimType flags ) : BuildingPlot
x int
y int
w int
d int
flags PlotClaimType
return BuildingPlot

RemoveScene() public method

public RemoveScene ( Scene scene ) : bool
scene OpenSim.Region.Framework.Scenes.Scene
return bool

isPlotClaimed() public method

Determines if the plot specified has been claimed already or not.
public isPlotClaimed ( BuildingPlot plot ) : bool
plot BuildingPlot
return bool

this() public method

public this ( int rx, int ry ) : Scene
rx int
ry int
return OpenSim.Region.Framework.Scenes.Scene

Property Details

centralRegions public_oe property

public List centralRegions
return List

cityBuildings public_oe property

public List cityBuildings
return List

cityPlots public_oe property

public List cityPlots
return List

cityRegions public_oe property

public Scene[,] cityRegions
return ].Scene[

plotArray public_oe property

public int[,] plotArray
return ].int[