Hamster2k/Sandbox – User
< Hamster2k
Categories:
(Created page with "==Properties== You can modify your sector and it is behaviour by changing the following attributes. Those names do not represent the module's internal variables. If you want to modify a sector after it has been created you have to take a look at BIS_fnc_moduleSector. *'''name''' - The name of the sector that will be shown on the map or in the task description. (Default: ''Alpha'') *'''designation''' - A single letter that represents the sector. (Default: ''First lett...") |
|||
| Line 94: | Line 94: | ||
|"DefaultOwner" | |"DefaultOwner" | ||
|[[Number]] | |[[Number]] | ||
|Default sector owner, even if he has no units in the sector. | |Default sector owner, even if he has no units in the sector (see [[BIS_fnc_sideID]]). | ||
|"-1" | |"-1" | ||
|- | |- | ||
| Line 100: | Line 100: | ||
|"TaskOwner" | |"TaskOwner" | ||
|[[Number]] | |[[Number]] | ||
|Sides which will receive the tasks. | |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 | |0 | ||
|- | |- | ||
Revision as of 19:17, 11 September 2025
Properties
You can modify your sector and it is behaviour by changing the following attributes. Those names do not represent the module's internal variables. If you want to modify a sector after it has been created you have to take a look at BIS_fnc_moduleSector.
- name - The name of the sector that will be shown on the map or in the task description. (Default: Alpha)
- designation - A single letter that represents the sector. (Default: First letter of the sector's name)
- repuation - The amount of points the team gets if it holds the sector. (Default: 0)
- statement - Code that will be executed when the ownerside of the sector changes. The following arguments will be passed: [module, ownerSide, previousOwnerSide]. (Default: Nothing)
- ownerLimit - The relation of players which are needed to capture the sector. This value has to be between 0 and 1. For example 0.5 means one team needs at least twice the amount of players than the other team to control the sector. (Default: 1)
- owner - The fraction that owns the sector first. (Default: Nobody)
- taskOwner - The fraction that can see the created task for the sector. (Default: Nobody)
- taskTitle - The title of the task that will be created. If this value is empty, no task will be created. %1 contains the name. For example "Catpure the sector with the name %1". (Default: Empty)
- taskDescription - The description of the task. %1 contains the name of the sector (like for taskTitle, see above). (Default: Empty)
- costInfantery - The amount of one infantry unit within the sector while capturing it. (Default: 1)
- costVehicle - The amount of one wheeled vehicle unit within the sector while capturing it. (Default: 2)
- costTracked - The amount of one heavy vehicle unit within the sector while capturing it. (Default: 4)
- costWater - The amount of one water vehicle unit within the sector while capturing it. (Default: 0)
- costAir - The amount of one air vehicle unit within the sector while capturing it. (Default: 2)
- costPlayer - The amount of one unit controlled by a player within the sector while capturing it. (Default: 2)
| 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. | 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 |