Hamster2k/Sandbox – User
< Hamster2k
					
					
					Categories: 
No edit summary  | 
				|||
| Line 1: | Line 1: | ||
==Properties==  | ==Properties==  | ||
You can modify your sector and its behavior by changing the properties either in the module editor or by using setVariable on your sector variable. Use [[BIS_fnc_moduleSector]] to modify your sector after it has been created.  | You can modify your sector and its behavior by changing the properties either in the module editor or by using setVariable on your sector variable. Use [[BIS_fnc_moduleSector]] to modify your sector after it has been created.  | ||
{| class="wikitable"    | {| class="wikitable mw-sortable"    | ||
|-  | |-  | ||
!Property (Module Attributes)  | !Property (Module Attributes)  | ||
| Line 18: | Line 18: | ||
|"Designation"  | |"Designation"  | ||
|[[String]]  | |[[String]]  | ||
|Single letter visible in the sector icon (when empty, first letter of the name will be used).  | | Single letter visible in the sector icon (when empty, first letter of the name will be used).  | ||
|First letter of "Name"  | |First letter of "Name"  | ||
|-  | |-  | ||
| Line 36: | Line 36: | ||
|"CaptureCoef"  | |"CaptureCoef"  | ||
|[[Number]]  | |[[Number]]  | ||
|Speed at which any unit captures the zone.  | | Speed at which any unit captures the zone.  | ||
|"0.05"  | |"0.05"    | ||
|-  | |-  | ||
|Infantry cost  | |Infantry cost  | ||
| Line 43: | Line 43: | ||
|[[Number]]  | |[[Number]]  | ||
|Ratio of how fast infantry units will capture the sector.  | |Ratio of how fast infantry units will capture the sector.  | ||
|"1"  | | "1"  | ||
|-  | |-  | ||
|Wheeled vehicle cost  | | Wheeled vehicle cost  | ||
|"CostWheeled"  | |"CostWheeled"  | ||
|[[Number]]  | |[[Number]]  | ||
| Line 60: | Line 60: | ||
|"CostWater"  | |"CostWater"  | ||
|[[Number]]  | |[[Number]]  | ||
|Ratio of how fast naval vehicles will capture the sector.  | | Ratio of how fast naval vehicles will capture the sector.  | ||
|"1"  | |"1"  | ||
|-  | |-  | ||
| Line 82: | Line 82: | ||
|-  | |-  | ||
|Task Owners  | |Task Owners  | ||
|"TaskOwner"  | |"TaskOwner"    | ||
|[[Number]]  | |[[Number]]  | ||
|Sides which will receive the tasks. Values from 0 to 3 are accepted.  | |Sides which will receive the tasks. Values from 0 to 3 are accepted.  | ||
| Line 96: | Line 96: | ||
|-  | |-  | ||
|Task title  | |Task title  | ||
|"TaskTitle"  | |"TaskTitle"    | ||
|[[String]]  | |[[String]]  | ||
|Title of the automatically added task. Use %1 to add the sector name. When empty, no task will be added.  | |Title of the automatically added task. Use %1 to add the sector name. When empty, no task will be added.  | ||
| Line 104: | Line 104: | ||
|"TaskDescription"  | |"TaskDescription"  | ||
|[[String]]  | |[[String]]  | ||
|Description of automatically added task. Use %1 to insert the sector name, %2 to enter sector rewards (e.g. unlocked vehicles or respawn points), %3 to insert description of capturing costs.  | |Description of automatically added task. Use %1 to insert the sector name, %2 to enter sector rewards (e.g. unlocked vehicles or respawn points), %3 to insert description of capturing costs.    | ||
|"%1%2%3"  | |"%1%2%3"  | ||
|-  | |-  | ||
Revision as of 18:37, 11 September 2025
Properties
You can modify your sector and its behavior by changing the properties either in the module editor or by using setVariable on your sector variable. Use BIS_fnc_moduleSector to modify your sector after it has been created.
| Property (Module Attributes) | Variable Name | Variable Type | Description | Default Value | 
|---|---|---|---|---|
| Name | "Name" | String | Sector name visibile on a map, in a task and in a notification. | Next NATO Phonetic Alphabet Letter (see BIS_fnc_phoneticalWord) | 
| Designation | "Designation" | String | Single letter visible in the sector icon (when empty, first letter of the name will be used). | First letter of "Name" | 
| Ownership Limit | "OwnerLimit" | Number | How much a side needs to be dominant in order to capture a sector. Value is in range <0,1>, where 1 is full dominance. | "0" | 
| Expression | "OnOwnerChange" | Code | Code executed when the ownership changes. Passed arguments are:  | 
"true" | 
| "CaptureCoef" | Number | Speed at which any unit captures the zone. | "0.05" | |
| Infantry cost | "CostInfantry" | Number | Ratio of how fast infantry units will capture the sector. | "1" | 
| Wheeled vehicle cost | "CostWheeled" | Number | Ratio of how fast wheeled vehicles will capture the sector. | "1" | 
| Tracked vehicle cost | "CostTracked" | Number | Ratio of how fast tracked vehicles will capture the sector. | "1" | 
| Naval cost | "CostWater" | Number | Ratio of how fast naval vehicles will capture the sector. | "1" | 
| Aircraft cost | "CostAir" | Number | Ratio of how fast aircraft will capture the sector. | "1" | 
| Players cost | "CostPlayers" | Code | Ratio of how fast players will capture the sector, combined with other costs. | "1" | 
| Default Owner | "DefaultOwner" | Number | Default sector owner, even if he has no units in the sector (see BIS_fnc_sideID). | "-1" | 
| Task Owners | "TaskOwner" | Number | Sides which will receive the tasks. Values from 0 to 3 are accepted.
 0: No one 1: Everyone 2: Only default sector owner 3: Everyone except the default sector owner  | 
0 | 
| Task title | "TaskTitle" | String | Title of the automatically added task. Use %1 to add the sector name. When empty, no task will be added. | "%1" | 
| Task description | "TaskDescription" | String | Description of automatically added task. Use %1 to insert the sector name, %2 to enter sector rewards (e.g. unlocked vehicles or respawn points), %3 to insert description of capturing costs. | "%1%2%3" | 
| Seize Reward | "ScoreReward" | Number | Score awarded to the side which captured the sector. | 0 |