View source for Script/Sector

==class Sector==
Represents an RTS sector in the game world.
  
=== Class Methods ===
{| border='0' style ='border:solid 1px #eeeedd; color: black; width: 1200px;background-color: #ffffcc;' cellspacing='0' cellpadding='7'
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../LevelReference|LevelReference@]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetLevel''' ()
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get level in which the sector is located''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|uint]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetIndex''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get index of the sector''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|uint8]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetOwner''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get current owner of the sector''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''SetOwner''' (const [[../BasicDataTypes|uint8]] ''_Faction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set current owner of the sector''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|uint]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetBaseSupply''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get the supply (unit limit) provided by this sector''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''SetBaseSupply''' (const [[../BasicDataTypes|uint]] ''_uBaseSupply'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set the supply (unit limit) provided by this sector''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''IsBlocked''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''check whether the sector can(not) be conquered''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''SetBlocked''' (const [[../BasicDataTypes|bool]] ''_bBlocked'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set whether the sector is blocked from being conquered''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Building|Building]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetMainBuilding''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get current main building of the sector''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Building|Building[]@]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetBuildings''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get all buildings in the given sector (may include buildings not controlled by the current sector owner!)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''CreateMainBuilding''' (const [[../BasicDataTypes|uint8]] ''_uOwner'', const [[../BasicDataTypes|string]]&in ''_sDescriptionName'', const [[../BasicDataTypes|bool]] ''_bCompleteInstant'' = false, const [[../BasicDataTypes|bool]] ''_bFailIfExisting'' = true)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''create a specific main building in the center of this sector. returns true if the building was created successfully.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''CreateCapital''' (const [[../BasicDataTypes|uint8]] ''_uOwner'', const [[../BasicDataTypes|bool]] ''_bCompleteInstant'' = false, const [[../BasicDataTypes|bool]] ''_bFailIfExisting'' = true)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''create the faction's default town center in the center of this sector. returns true if the building was created successfully.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''CreateExpansion''' (const [[../BasicDataTypes|uint8]] ''_uOwner'', const [[../BasicDataTypes|bool]] ''_bCompleteInstant'' = false, const [[../BasicDataTypes|bool]] ''_bFailIfExisting'' = true)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''create the faction's default expansion building in the center of this sector. returns true if the building was created successfully.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|uint]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetTotalResourceAmount''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get total amount of resources in this sector''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|uint]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetResourceAmount''' (const [[../BasicDataTypes|string]]&in ''_sType'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get amount of the given resource in this sector''
|}