Eden Editor: Scenario Attributes: Difference between revisions
Jump to navigation
Jump to search
(→General: fixed init attribute description) |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
(2 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
'''Scenario Attributes''' are used to set, customize and define numerous scenario settings. | '''Scenario Attributes''' are used to set, customize and define numerous scenario settings. | ||
== Attributes == | == Attributes == | ||
<onlyinclude> | <onlyinclude> | ||
==== General==== | ==== General==== | ||
Line 18: | Line 20: | ||
| Presentation | | Presentation | ||
| Scenario name. Appears in the scenarios menu, multiplayer lobby and loading screens. Use @STR_ prefix to link to localization keys. | | Scenario name. Appears in the scenarios menu, multiplayer lobby and loading screens. Use @STR_ prefix to link to localization keys. | ||
| <small> | | <small>{{hl|IntelBriefingName}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 24: | Line 26: | ||
| Presentation | | Presentation | ||
| Scenario author. Appears in the scenarios menu and in loading screens. | | Scenario author. Appears in the scenarios menu and in loading screens. | ||
| <small> | | <small>{{hl|Author}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 30: | Line 32: | ||
| Overview | | Overview | ||
| Path to overview picture visible in the scenarios menu. When no loading screen picture is defined, this will be used in loading screen instead. | | Path to overview picture visible in the scenarios menu. When no loading screen picture is defined, this will be used in loading screen instead. | ||
| <small> | | <small>{{hl|OverviewPicture}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 36: | Line 38: | ||
| Overview | | Overview | ||
| Short overview text visible in the scenarios menu. When no loading screen text is defined, this will be used in loading screens instead. Use @STR_ prefix to link to localization keys. | | Short overview text visible in the scenarios menu. When no loading screen text is defined, this will be used in loading screens instead. Use @STR_ prefix to link to localization keys. | ||
| <small> | | <small>{{hl|OverviewText}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 42: | Line 44: | ||
| Overview | | Overview | ||
| When set, the overview image will be overlaid with a DLC frame indicating the scenario belongs to the DLC. | | When set, the overview image will be overlaid with a DLC frame indicating the scenario belongs to the DLC. | ||
| <small> | | <small>{{hl|AppId}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 48: | Line 50: | ||
| Overview | | Overview | ||
| Sets if the DLC is required. When checked, the player will not be able to play the scenario if the DLC is not owned. | | Sets if the DLC is required. When checked, the player will not be able to play the scenario if the DLC is not owned. | ||
| <small> | | <small>{{hl|AssetType}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 54: | Line 56: | ||
| Overview (Locked) | | Overview (Locked) | ||
| Path to the overview picture visible in the scenarios menu. When no loading screen picture is defined, this will be used in the loading screen instead. | | Path to the overview picture visible in the scenarios menu. When no loading screen picture is defined, this will be used in the loading screen instead. | ||
| <small> | | <small>{{hl|OverviewPictureLocked}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 60: | Line 62: | ||
| Overview (Locked) | | Overview (Locked) | ||
| Short overview text visible in the scenarios menu when the scenario is locked (see 'Unlock' category for more details). Use @STR_ prefix to link to localization keys. | | Short overview text visible in the scenarios menu when the scenario is locked (see 'Unlock' category for more details). Use @STR_ prefix to link to localization keys. | ||
| <small> | | <small>{{hl|OverviewTextLocked}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 66: | Line 68: | ||
| Loading Screen | | Loading Screen | ||
| Path to the picture visible in the loading screens before and during the scenario. | | Path to the picture visible in the loading screens before and during the scenario. | ||
| <small> | | <small>{{hl|LoadScreen}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 72: | Line 74: | ||
| Loading Screen | | Loading Screen | ||
| Short text visible in loading screens before and during the scenario. Use @STR_ prefix to link to localization keys. | | Short text visible in loading screens before and during the scenario. Use @STR_ prefix to link to localization keys. | ||
| <small> | | <small>{{hl|OnLoadMission}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 78: | Line 80: | ||
| States | | States | ||
| When disabled, the scenario will start automatically after the loading, without showing the briefing. Valid only for singleplayer scenarios. | | When disabled, the scenario will start automatically after the loading, without showing the briefing. Valid only for singleplayer scenarios. | ||
| <small> | | <small>{{hl|Briefing}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 84: | Line 86: | ||
| States | | States | ||
| When disabled, the debriefing screen will not be shown when the scenario is completed. | | When disabled, the debriefing screen will not be shown when the scenario is completed. | ||
| <small> | | <small>{{hl|Debriefing}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 90: | Line 92: | ||
| States | | States | ||
| When disabled, the 'SAVE' option in the pause menu will be disabled and scripted autosaves will not do anything. | | When disabled, the 'SAVE' option in the pause menu will be disabled and scripted autosaves will not do anything. | ||
| <small> | | <small>{{hl|Saving}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 96: | Line 98: | ||
| States | | States | ||
| When disabled, a black screen is shown instead of the map. Tasks, notes and other information will remain accessible. Can also be achieved by removing the map from the player's inventory. | | When disabled, a black screen is shown instead of the map. Tasks, notes and other information will remain accessible. Can also be achieved by removing the map from the player's inventory. | ||
| <small> | | <small>{{hl|ShowMap}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 102: | Line 104: | ||
| States | | States | ||
| When disabled, the compass will not be available either on the map, or in the scene after pressing the 'Compass' key. Can also be achieved by removing the compass from the player's inventory. | | When disabled, the compass will not be available either on the map, or in the scene after pressing the 'Compass' key. Can also be achieved by removing the compass from the player's inventory. | ||
| <small> | | <small>{{hl|ShowCompass}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 108: | Line 110: | ||
| States | | States | ||
| When disabled, the watch will not be available in the scene after pressing the 'Watch' key. Can also be achieved by removing the watch from the player's inventory. | | When disabled, the watch will not be available in the scene after pressing the 'Watch' key. Can also be achieved by removing the watch from the player's inventory. | ||
| <small> | | <small>{{hl|ShowWatch}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 114: | Line 116: | ||
| States | | States | ||
| When disabled, the GPS minimap will not be available in the scene after pressing the 'GPS' key. Can also be achieved by removing the GPS from the player's inventory. | | When disabled, the GPS minimap will not be available in the scene after pressing the 'GPS' key. Can also be achieved by removing the GPS from the player's inventory. | ||
| <small> | | <small>{{hl|ShowGPS}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 120: | Line 122: | ||
| States | | States | ||
| When disabled, on-screen information such as weapon information or the command menu will be hidden. | | When disabled, on-screen information such as weapon information or the command menu will be hidden. | ||
| <small> | | <small>{{hl|ShowHUD}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 126: | Line 128: | ||
| States | | States | ||
| When disabled, the UAV feed will not be available in the scene after pressing the 'AV Camera' key. | | When disabled, the UAV feed will not be available in the scene after pressing the 'AV Camera' key. | ||
| <small> | | <small>{{hl|ShowUAVFeed}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 132: | Line 134: | ||
| States | | States | ||
| When enabled, all player controlled helicopters will use the advanced flight model. | | When enabled, all player controlled helicopters will use the advanced flight model. | ||
| <small> | | <small>{{hl|ForceRotorLibSimulation}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 143: | Line 145: | ||
* '''Available for everyone''' | * '''Available for everyone''' | ||
| <small> | | <small>{{hl|EnableDebugConsole}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 149: | Line 151: | ||
| Unlock | | Unlock | ||
| Keys needed to mark the scenario as completed in the scenarios menu. Can be multiple words divided by a semicolon. Key can be activated using 'activateKey' scripting command. Does not affect the multiplayer and campaign scenarios, and the scenarios downloaded from Steam. | | Keys needed to mark the scenario as completed in the scenarios menu. Can be multiple words divided by a semicolon. Key can be activated using 'activateKey' scripting command. Does not affect the multiplayer and campaign scenarios, and the scenarios downloaded from Steam. | ||
| <small> | | <small>{{hl|DoneKeys}}</small> | ||
| [[Array]] | | [[Array]] | ||
|- | |- | ||
Line 155: | Line 157: | ||
| Unlock | | Unlock | ||
| Keys required for mission to be available for playing from the scenarios menu. Can be multiple words divided by a semicolon. Does not affect the multiplayer and campaign scenarios. | | Keys required for mission to be available for playing from the scenarios menu. Can be multiple words divided by a semicolon. Does not affect the multiplayer and campaign scenarios. | ||
| <small> | | <small>{{hl|Keys}}</small> | ||
| [[Array]] | | [[Array]] | ||
|- | |- | ||
Line 161: | Line 163: | ||
| Unlock | | Unlock | ||
| The number of required keys to be active for the mission to be unlocked. | | The number of required keys to be active for the mission to be unlocked. | ||
| <small> | | <small>{{hl|KeysLimit}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 167: | Line 169: | ||
| Init | | Init | ||
| Expression called upon at start. In multiplayer, it is called on every machine and for each player who joins in the progress. The variable 'this' refers to the affected object. {{Feature|warning|Despite the tooltip saying that 'this' refers to the affected object, it does not. There are no arguments passed to this attribute!}} This attribute behaves similar to the [[Event Scripts|init.sqf]]. | | Expression called upon at start. In multiplayer, it is called on every machine and for each player who joins in the progress. The variable 'this' refers to the affected object. {{Feature|warning|Despite the tooltip saying that 'this' refers to the affected object, it does not. There are no arguments passed to this attribute!}} This attribute behaves similar to the [[Event Scripts|init.sqf]]. | ||
| <small> | | <small>{{hl|Init}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 173: | Line 175: | ||
| Misc | | Misc | ||
| Sets who the Independent side will be friendly to. The value is shared across all scenario phases. | | Sets who the Independent side will be friendly to. The value is shared across all scenario phases. | ||
| <small> | | <small>{{hl|IntelIndepAllegiance}}</small> | ||
| [[Array]] in format [west:[[Number]],east:[[Number]]] | | [[Array]] in format [west:[[Number]],east:[[Number]]] | ||
|- | |- | ||
Line 179: | Line 181: | ||
| Misc | | Misc | ||
| When true, the *.sqm file will be binarized. The process saves loading time, but makes the file uneditable in a text editor. | | When true, the *.sqm file will be binarized. The process saves loading time, but makes the file uneditable in a text editor. | ||
| <small> | | <small>{{hl|SaveBinarized}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|} | |} | ||
Line 198: | Line 200: | ||
| Date | | Date | ||
| Starting date. | | Starting date. | ||
| <small> | | <small>{{hl|IntelDate}}</small> | ||
| [[Array]] in format [year, month, day] | | [[Array]] in format [year, month, day] | ||
|- | |- | ||
Line 204: | Line 206: | ||
| Date | | Date | ||
| Starting time of the day. Please note that the sunrise and sunset times are influenced by the date (e.g., days are shorter in winter) and the longitude and latitude of the terrain. | | Starting time of the day. Please note that the sunrise and sunset times are influenced by the date (e.g., days are shorter in winter) and the longitude and latitude of the terrain. | ||
| <small> | | <small>{{hl|IntelTime}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 210: | Line 212: | ||
| Weather Forecast | | Weather Forecast | ||
| Delay until all forecasted weather values take effect. | | Delay until all forecasted weather values take effect. | ||
| <small> | | <small>{{hl|IntelTimeOfChanges}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 216: | Line 218: | ||
| Overcast | | Overcast | ||
| Initial cloud cover. Unless set manually, this value also affects rain, lightning, waves, wind and gusts values. | | Initial cloud cover. Unless set manually, this value also affects rain, lightning, waves, wind and gusts values. | ||
| <small> | | <small>{{hl|IntelWeatherStart}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 222: | Line 224: | ||
| Overcast | | Overcast | ||
| Forecasted cloud cover. | | Forecasted cloud cover. | ||
| <small> | | <small>{{hl|IntelWeatherForecast}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 228: | Line 230: | ||
| Fog | | Fog | ||
| Initial fog. Strength affects not only how far player can see, but also limits the sight of AI entities. | | Initial fog. Strength affects not only how far player can see, but also limits the sight of AI entities. | ||
| <small> | | <small>{{hl|IntelFogStart}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 234: | Line 236: | ||
| Fog | | Fog | ||
| Forecasted fog. | | Forecasted fog. | ||
| <small> | | <small>{{hl|IntelFogForecast}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 240: | Line 242: | ||
| Rain | | Rain | ||
| Enables manual settings in this category. When disabled, the engine will calculate the values automatically. | | Enables manual settings in this category. When disabled, the engine will calculate the values automatically. | ||
| <small> | | <small>{{hl|IntelRainIsForced}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 246: | Line 248: | ||
| Rain | | Rain | ||
| Initial rain strength. Applied only when the cloud cover is already bad, i.e., a high value is ignored when the weather is sunny. | | Initial rain strength. Applied only when the cloud cover is already bad, i.e., a high value is ignored when the weather is sunny. | ||
| <small> | | <small>{{hl|IntelRainStart}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 252: | Line 254: | ||
| Rain | | Rain | ||
| Forecasted rain strength. | | Forecasted rain strength. | ||
| <small> | | <small>{{hl|IntelRainForecast}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 258: | Line 260: | ||
| Lightnings | | Lightnings | ||
| Enables manual settings in this category. When disabled, the engine will calculate the values automatically. | | Enables manual settings in this category. When disabled, the engine will calculate the values automatically. | ||
| <small> | | <small>{{hl|IntelLightningIsForced}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 264: | Line 266: | ||
| Lightnings | | Lightnings | ||
| Initial frequency of lightning. Applied only when the cloud cover is already bad, i.e., a high value is ignored when the weather is sunny. | | Initial frequency of lightning. Applied only when the cloud cover is already bad, i.e., a high value is ignored when the weather is sunny. | ||
| <small> | | <small>{{hl|IntelLightningStart}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 270: | Line 272: | ||
| Lightnings | | Lightnings | ||
| Forecasted frequency of lightning. | | Forecasted frequency of lightning. | ||
| <small> | | <small>{{hl|IntelLightningForecast}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 276: | Line 278: | ||
| Waves | | Waves | ||
| Enables manual settings in this category. When disabled, the engine will calculate the values automatically. | | Enables manual settings in this category. When disabled, the engine will calculate the values automatically. | ||
| <small> | | <small>{{hl|IntelWavesIsForced}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 282: | Line 284: | ||
| Waves | | Waves | ||
| Initial waves size. Applied independently of cloud cover settings. | | Initial waves size. Applied independently of cloud cover settings. | ||
| <small> | | <small>{{hl|IntelWavesStart}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 288: | Line 290: | ||
| Waves | | Waves | ||
| Forecasted waves size. | | Forecasted waves size. | ||
| <small> | | <small>{{hl|IntelWavesForecast}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 294: | Line 296: | ||
| Wind | | Wind | ||
| Enables manual settings in this category. When disabled, the engine will calculate the values automatically. | | Enables manual settings in this category. When disabled, the engine will calculate the values automatically. | ||
| <small> | | <small>{{hl|IntelWindIsForced}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 300: | Line 302: | ||
| Wind | | Wind | ||
| Initial wind strength. Together with wind direction, it influences how clouds, smoke, vegetation or flags are moving. | | Initial wind strength. Together with wind direction, it influences how clouds, smoke, vegetation or flags are moving. | ||
| <small> | | <small>{{hl|IntelWindStart}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 306: | Line 308: | ||
| Wind | | Wind | ||
| Forecasted wind strength. | | Forecasted wind strength. | ||
| <small> | | <small>{{hl|IntelWindForecast}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 312: | Line 314: | ||
| Wind | | Wind | ||
| Initial gusts strength. Gusts are randomly changing wind direction. The worse the cloud cover, the stronger and more frequent the changes. | | Initial gusts strength. Gusts are randomly changing wind direction. The worse the cloud cover, the stronger and more frequent the changes. | ||
| <small> | | <small>{{hl|IntelWindGustStart}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 318: | Line 320: | ||
| Wind | | Wind | ||
| Forecasted gusts value. | | Forecasted gusts value. | ||
| <small> | | <small>{{hl|IntelWindGustForecast}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 324: | Line 326: | ||
| Wind | | Wind | ||
| Initial wind direction. | | Initial wind direction. | ||
| <small> | | <small>{{hl|IntelWindDirectionStart}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 330: | Line 332: | ||
| Wind | | Wind | ||
| Forecasted wind direction. | | Forecasted wind direction. | ||
| <small> | | <small>{{hl|IntelWindDirectionForecast}}</small> | ||
| [[Number]] | | [[Number]] | ||
|} | |} | ||
Line 349: | Line 351: | ||
| Type | | Type | ||
| Scenario type shown in the server browser and in the loading screen. | | Scenario type shown in the server browser and in the loading screen. | ||
| <small> | | <small>{{hl|GameType}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 355: | Line 357: | ||
| Type | | Type | ||
| Minimum number of required players. | | Minimum number of required players. | ||
| <small> | | <small>{{hl|MinPlayers}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 361: | Line 363: | ||
| Type | | Type | ||
| Minimum number of allowed players. | | Minimum number of allowed players. | ||
| <small> | | <small>{{hl|MaxPlayers}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 367: | Line 369: | ||
| Lobby | | Lobby | ||
| Short summary shown in the scenario lobby. | | Short summary shown in the scenario lobby. | ||
| <small> | | <small>{{hl|IntelOverviewText}}</small> | ||
| [[Text]] | | [[Structured Text]] | ||
|- | |- | ||
| '''Enable AI''' | | '''Enable AI''' | ||
Line 375: | Line 377: | ||
When AI is disabled, a new character is created for each connecting player. | When AI is disabled, a new character is created for each connecting player. | ||
Server host can disable AI even when it is allowed by default. | Server host can disable AI even when it is allowed by default. | ||
| <small> | | <small>{{hl|DisabledAI}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 381: | Line 383: | ||
| Lobby | | Lobby | ||
| When enabled, arriving players will be first assigned to the side with the lowest number of players. Valid only for scenarios with multiple playable sides involved. | | When enabled, arriving players will be first assigned to the side with the lowest number of players. Valid only for scenarios with multiple playable sides involved. | ||
| <small> | | <small>{{hl|JoinUnassigned}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 401: | Line 403: | ||
* '''Switch to Spectator''' - Spectate the scenario without being directly involved. | * '''Switch to Spectator''' - Spectate the scenario without being directly involved. | ||
| <small> | | <small>{{hl|Respawn}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 407: | Line 409: | ||
| Respawn | | Respawn | ||
| Specific respawn rulesets based on currently selected 'Respawn'. | | Specific respawn rulesets based on currently selected 'Respawn'. | ||
| <small> | | <small>{{hl|RespawnTemplates}}</small> | ||
| [[Array]] | | [[Array]] | ||
|- | |- | ||
Line 413: | Line 415: | ||
| Respawn | | Respawn | ||
| Time in seconds after which players respawn. | | Time in seconds after which players respawn. | ||
| <small> | | <small>{{hl|RespawnDelay}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 419: | Line 421: | ||
| Respawn | | Respawn | ||
| Time in seconds after which vehicles respawn. | | Time in seconds after which vehicles respawn. | ||
| <small> | | <small>{{hl|RespawnVehicleDelay}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 425: | Line 427: | ||
| Respawn | | Respawn | ||
| When enabled, the scoreboard is shown while waiting for respawn. May be subdued by some respawn rulesets. | | When enabled, the scoreboard is shown while waiting for respawn. May be subdued by some respawn rulesets. | ||
| <small> | | <small>{{hl|RespawnDialog}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 431: | Line 433: | ||
| Respawn | | Respawn | ||
| When enabled, players will have the option to manually respawn in the pause menu. | | When enabled, players will have the option to manually respawn in the pause menu. | ||
| <small> | | <small>{{hl|RespawnButton}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 437: | Line 439: | ||
| Respawn | | Respawn | ||
| When enabled, players will be able to manually switch to any other playable character in the scenario not controlled by another player. | | When enabled, players will be able to manually switch to any other playable character in the scenario not controlled by another player. | ||
| <small> | | <small>{{hl|EnableTeamSwitch}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 443: | Line 445: | ||
| Respawn | | Respawn | ||
| When enabled, the score of playable characters controlled by AI will appear on the scoreboard. | | When enabled, the score of playable characters controlled by AI will appear on the scoreboard. | ||
| <small> | | <small>{{hl|AIKills}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 454: | Line 456: | ||
* '''Enabled with Task Propagation''' - Tasks assigned by friendlies are marked to player, but only group leaders can assign and unassign tasks. Task assignment changes are automatically propagated to subordinates. | * '''Enabled with Task Propagation''' - Tasks assigned by friendlies are marked to player, but only group leaders can assign and unassign tasks. Task assignment changes are automatically propagated to subordinates. | ||
| <small> | | <small>{{hl|SharedObjectives}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 465: | Line 467: | ||
* '''Controlled by player Attributes''' - Only players with Revive enabled in their Attributes are effected. | * '''Controlled by player Attributes''' - Only players with Revive enabled in their Attributes are effected. | ||
| <small> | | <small>{{hl|ReviveMode}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 475: | Line 477: | ||
* '''Medic''' - Only players with the 'Medic' trait can revive. | * '''Medic''' - Only players with the 'Medic' trait can revive. | ||
| <small> | | <small>{{hl|ReviveRequiredTrait}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 486: | Line 488: | ||
* '''First Aid Kit / Medikit''' - 'Medikit' or 'First Aid Kit' items are required in order to revive. | * '''First Aid Kit / Medikit''' - 'Medikit' or 'First Aid Kit' items are required in order to revive. | ||
| <small> | | <small>{{hl|ReviveRequiredItems}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 492: | Line 494: | ||
| Revive | | Revive | ||
| Controls the time it takes to revive someone. | | Controls the time it takes to revive someone. | ||
| <small> | | <small>{{hl|ReviveDelay}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 498: | Line 500: | ||
| Revive | | Revive | ||
| Controls how much faster a medic revives someone. | | Controls how much faster a medic revives someone. | ||
| <small> | | <small>{{hl|ReviveMedicSpeedMultiplier}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 504: | Line 506: | ||
| Revive | | Revive | ||
| Controls how long it takes to force respawn while incapacitated. | | Controls how long it takes to force respawn while incapacitated. | ||
| <small> | | <small>{{hl|ReviveForceRespawnDelay}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 514: | Line 516: | ||
* '''Advanced''' - Extensive wounds will kill players instantly. | * '''Advanced''' - Extensive wounds will kill players instantly. | ||
| <small> | | <small>{{hl|ReviveUnconsciousStateMode}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 520: | Line 522: | ||
| Revive | | Revive | ||
| Controls how long it takes an incapacitated unit to bleed out. | | Controls how long it takes an incapacitated unit to bleed out. | ||
| <small> | | <small>{{hl|ReviveBleedOutDelay}}</small> | ||
| [[String]] | | [[String]] | ||
|} | |} | ||
Line 539: | Line 541: | ||
| Garbage Collection | | Garbage Collection | ||
| The minimum distance from any player. Set the value to 0 to remove the min. distance. | | The minimum distance from any player. Set the value to 0 to remove the min. distance. | ||
| <small> | | <small>{{hl|MinPlayerDistance}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 545: | Line 547: | ||
| Garbage Collection | | Garbage Collection | ||
| | | | ||
| <small> | | <small>{{hl|AttributeSystemSubcategory}}</small> | ||
| | | | ||
|- | |- | ||
Line 557: | Line 559: | ||
* '''Only objects that cannot respawn''' | * '''Only objects that cannot respawn''' | ||
| <small> | | <small>{{hl|CorpseManagerMode}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 563: | Line 565: | ||
| Garbage Collection | | Garbage Collection | ||
| Maximum allowed number of dead bodies in the scenario. | | Maximum allowed number of dead bodies in the scenario. | ||
| <small> | | <small>{{hl|CorpseLimit}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 569: | Line 571: | ||
| Garbage Collection | | Garbage Collection | ||
| Time in seconds before a dead body is removed when the number of dead bodies exceeds the 'Limit'. | | Time in seconds before a dead body is removed when the number of dead bodies exceeds the 'Limit'. | ||
| <small> | | <small>{{hl|CorpseRemovalMinTime}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 575: | Line 577: | ||
| Garbage Collection | | Garbage Collection | ||
| Time in seconds before a dead body is removed when the number of dead bodies is below or equals the 'Limit'. | | Time in seconds before a dead body is removed when the number of dead bodies is below or equals the 'Limit'. | ||
| <small> | | <small>{{hl|CorpseRemovalMaxTime}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 581: | Line 583: | ||
| Garbage Collection | | Garbage Collection | ||
| | | | ||
| <small> | | <small>{{hl|AttributeSystemSubcategory}}</small> | ||
| | | | ||
|- | |- | ||
Line 593: | Line 595: | ||
* '''Only objects that cannot respawn''' | * '''Only objects that cannot respawn''' | ||
| <small> | | <small>{{hl|WreckManagerMode}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 599: | Line 601: | ||
| Garbage Collection | | Garbage Collection | ||
| Maximum allowed number of dead bodies in the scenario. | | Maximum allowed number of dead bodies in the scenario. | ||
| <small> | | <small>{{hl|WreckLimit}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 605: | Line 607: | ||
| Garbage Collection | | Garbage Collection | ||
| Time in seconds before a dead body is removed when the number of dead bodies exceeds the 'Limit'. | | Time in seconds before a dead body is removed when the number of dead bodies exceeds the 'Limit'. | ||
| <small> | | <small>{{hl|WreckRemovalMinTime}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 611: | Line 613: | ||
| Garbage Collection | | Garbage Collection | ||
| Time in seconds before a dead body is removed when the number of dead bodies is below or equals the 'Limit'. | | Time in seconds before a dead body is removed when the number of dead bodies is below or equals the 'Limit'. | ||
| <small> | | <small>{{hl|WreckRemovalMaxTime}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 617: | Line 619: | ||
| Dynamic Simulation | | Dynamic Simulation | ||
| Turns on the 'Dynamic Simulation' system. Only entities and groups with the 'Dynamic Simulation' will be affected. | | Turns on the 'Dynamic Simulation' system. Only entities and groups with the 'Dynamic Simulation' will be affected. | ||
| <small> | | <small>{{hl|DynSimEnabled}}</small> | ||
| | | | ||
|- | |- | ||
Line 623: | Line 625: | ||
| Dynamic Simulation | | Dynamic Simulation | ||
| | | | ||
| <small> | | <small>{{hl|DynSimDistGroup}}</small> | ||
| | | | ||
|- | |- | ||
Line 629: | Line 631: | ||
| Dynamic Simulation | | Dynamic Simulation | ||
| | | | ||
| <small> | | <small>{{hl|DynSimDistVehicle}}</small> | ||
| | | | ||
|- | |- | ||
Line 635: | Line 637: | ||
| Dynamic Simulation | | Dynamic Simulation | ||
| | | | ||
| <small> | | <small>{{hl|DynSimDistProp}}</small> | ||
| | | | ||
|- | |- | ||
Line 641: | Line 643: | ||
| Dynamic Simulation | | Dynamic Simulation | ||
| | | | ||
| <small> | | <small>{{hl|DynSimDistEmptyVehicle}}</small> | ||
| | | | ||
|- | |- | ||
Line 647: | Line 649: | ||
| Dynamic Simulation | | Dynamic Simulation | ||
| Multiplies activation distance of non-static entity by set value. | | Multiplies activation distance of non-static entity by set value. | ||
| <small> | | <small>{{hl|DynSimMovingCoef}}</small> | ||
| | | | ||
|- | |- | ||
Line 653: | Line 655: | ||
| Dynamic Simulation | | Dynamic Simulation | ||
| Limits all activation distances to player's object view distance. Dynamically simulated entities beyond the object view distance will be disabled. | | Limits all activation distances to player's object view distance. Dynamically simulated entities beyond the object view distance will be disabled. | ||
| <small> | | <small>{{hl|DynSimSaturateByObjDist}}</small> | ||
| | | | ||
|} | |} | ||
</onlyinclude> | |||
[[Category:Eden Editor: Editing|Scenario Atttributes]] | [[Category:Eden Editor: Editing|Scenario Atttributes]] |
Latest revision as of 10:25, 25 June 2024
Scenario Attributes are used to set, customize and define numerous scenario settings.
Attributes
General
Info | Development | |||
---|---|---|---|---|
Name | Category | Description | Property | Type |
Title | Presentation | Scenario name. Appears in the scenarios menu, multiplayer lobby and loading screens. Use @STR_ prefix to link to localization keys. | IntelBriefingName | String |
Author | Presentation | Scenario author. Appears in the scenarios menu and in loading screens. | Author | String |
Picture | Overview | Path to overview picture visible in the scenarios menu. When no loading screen picture is defined, this will be used in loading screen instead. | OverviewPicture | String |
Text | Overview | Short overview text visible in the scenarios menu. When no loading screen text is defined, this will be used in loading screens instead. Use @STR_ prefix to link to localization keys. | OverviewText | String |
DLC | Overview | When set, the overview image will be overlaid with a DLC frame indicating the scenario belongs to the DLC. | AppId | Number |
Require DLC | Overview | Sets if the DLC is required. When checked, the player will not be able to play the scenario if the DLC is not owned. | AssetType | String |
Picture | Overview (Locked) | Path to the overview picture visible in the scenarios menu. When no loading screen picture is defined, this will be used in the loading screen instead. | OverviewPictureLocked | String |
Text | Overview (Locked) | Short overview text visible in the scenarios menu when the scenario is locked (see 'Unlock' category for more details). Use @STR_ prefix to link to localization keys. | OverviewTextLocked | String |
Picture | Loading Screen | Path to the picture visible in the loading screens before and during the scenario. | LoadScreen | String |
Text | Loading Screen | Short text visible in loading screens before and during the scenario. Use @STR_ prefix to link to localization keys. | OnLoadMission | String |
Show Briefing | States | When disabled, the scenario will start automatically after the loading, without showing the briefing. Valid only for singleplayer scenarios. | Briefing | Boolean |
Show Debriefing | States | When disabled, the debriefing screen will not be shown when the scenario is completed. | Debriefing | Boolean |
Enable Saving | States | When disabled, the 'SAVE' option in the pause menu will be disabled and scripted autosaves will not do anything. | Saving | Boolean |
Show Map | States | When disabled, a black screen is shown instead of the map. Tasks, notes and other information will remain accessible. Can also be achieved by removing the map from the player's inventory. | ShowMap | Boolean |
Show Compass | States | When disabled, the compass will not be available either on the map, or in the scene after pressing the 'Compass' key. Can also be achieved by removing the compass from the player's inventory. | ShowCompass | Boolean |
Show Watch | States | When disabled, the watch will not be available in the scene after pressing the 'Watch' key. Can also be achieved by removing the watch from the player's inventory. | ShowWatch | Boolean |
Show GPS | States | When disabled, the GPS minimap will not be available in the scene after pressing the 'GPS' key. Can also be achieved by removing the GPS from the player's inventory. | ShowGPS | Boolean |
Show HUD | States | When disabled, on-screen information such as weapon information or the command menu will be hidden. | ShowHUD | Boolean |
Show UAV Feed | States | When disabled, the UAV feed will not be available in the scene after pressing the 'AV Camera' key. | ShowUAVFeed | Boolean |
Advanced Flight Model | States | When enabled, all player controlled helicopters will use the advanced flight model. | ForceRotorLibSimulation | Boolean |
Debug Console | States | Determines debug console availability
Available options:
|
EnableDebugConsole | Number |
Unlocked Keys | Unlock | Keys needed to mark the scenario as completed in the scenarios menu. Can be multiple words divided by a semicolon. Key can be activated using 'activateKey' scripting command. Does not affect the multiplayer and campaign scenarios, and the scenarios downloaded from Steam. | DoneKeys | Array |
Required Keys | Unlock | Keys required for mission to be available for playing from the scenarios menu. Can be multiple words divided by a semicolon. Does not affect the multiplayer and campaign scenarios. | Keys | Array |
Required Keys Limit | Unlock | The number of required keys to be active for the mission to be unlocked. | KeysLimit | Number |
Init | Init | Expression called upon at start. In multiplayer, it is called on every machine and for each player who joins in the progress. The variable 'this' refers to the affected object. init.sqf. | This attribute behaves similar to theInit | String |
Independents Allegiance | Misc | Sets who the Independent side will be friendly to. The value is shared across all scenario phases. | IntelIndepAllegiance | Array in format [west:Number,east:Number] |
Binarize the Scenario File | Misc | When true, the *.sqm file will be binarized. The process saves loading time, but makes the file uneditable in a text editor. | SaveBinarized | Boolean |
Environment
Info | Development | |||
---|---|---|---|---|
Name | Category | Description | Property | Type |
Date | Date | Starting date. | IntelDate | Array in format [year, month, day] |
Time | Date | Starting time of the day. Please note that the sunrise and sunset times are influenced by the date (e.g., days are shorter in winter) and the longitude and latitude of the terrain. | IntelTime | Number |
Time of Changes | Weather Forecast | Delay until all forecasted weather values take effect. | IntelTimeOfChanges | Number |
Overcast Start | Overcast | Initial cloud cover. Unless set manually, this value also affects rain, lightning, waves, wind and gusts values. | IntelWeatherStart | Number |
Overcast Forecast | Overcast | Forecasted cloud cover. | IntelWeatherForecast | Number |
Fog Start | Fog | Initial fog. Strength affects not only how far player can see, but also limits the sight of AI entities. | IntelFogStart | Number |
Fog Forecast | Fog | Forecasted fog. | IntelFogForecast | Number |
Manual Override | Rain | Enables manual settings in this category. When disabled, the engine will calculate the values automatically. | IntelRainIsForced | Boolean |
Rain Start | Rain | Initial rain strength. Applied only when the cloud cover is already bad, i.e., a high value is ignored when the weather is sunny. | IntelRainStart | Number |
Rain Forecast | Rain | Forecasted rain strength. | IntelRainForecast | Number |
Manual Override | Lightnings | Enables manual settings in this category. When disabled, the engine will calculate the values automatically. | IntelLightningIsForced | Boolean |
Lightnings Start | Lightnings | Initial frequency of lightning. Applied only when the cloud cover is already bad, i.e., a high value is ignored when the weather is sunny. | IntelLightningStart | Number |
Lightnings Forecast | Lightnings | Forecasted frequency of lightning. | IntelLightningForecast | Number |
Manual Override | Waves | Enables manual settings in this category. When disabled, the engine will calculate the values automatically. | IntelWavesIsForced | Boolean |
Waves Start | Waves | Initial waves size. Applied independently of cloud cover settings. | IntelWavesStart | Number |
Waves Forecast | Waves | Forecasted waves size. | IntelWavesForecast | Number |
Manual Override | Wind | Enables manual settings in this category. When disabled, the engine will calculate the values automatically. | IntelWindIsForced | Boolean |
Wind Start | Wind | Initial wind strength. Together with wind direction, it influences how clouds, smoke, vegetation or flags are moving. | IntelWindStart | Number |
Wind Forecast | Wind | Forecasted wind strength. | IntelWindForecast | Number |
Gusts Start | Wind | Initial gusts strength. Gusts are randomly changing wind direction. The worse the cloud cover, the stronger and more frequent the changes. | IntelWindGustStart | Number |
Gusts Forecast | Wind | Forecasted gusts value. | IntelWindGustForecast | Number |
Direction Start | Wind | Initial wind direction. | IntelWindDirectionStart | Number |
Direction Forecast | Wind | Forecasted wind direction. | IntelWindDirectionForecast | Number |
Multiplayer
Info | Development | |||
---|---|---|---|---|
Name | Category | Description | Property | Type |
Game Type | Type | Scenario type shown in the server browser and in the loading screen. | GameType | String |
Min Players | Type | Minimum number of required players. | MinPlayers | Number |
Max Players | Type | Minimum number of allowed players. | MaxPlayers | Number |
Summary | Lobby | Short summary shown in the scenario lobby. | IntelOverviewText | Structured Text |
Enable AI | Lobby | When AI is enabled, all playable characters are created at the scenario start, controlled by AI. Upon joining, a player takes control of an existing character.
When AI is disabled, a new character is created for each connecting player. Server host can disable AI even when it is allowed by default. |
DisabledAI | Boolean |
Auto Assign Slots | Lobby | When enabled, arriving players will be first assigned to the side with the lowest number of players. Valid only for scenarios with multiple playable sides involved. | JoinUnassigned | Boolean |
Respawn | Respawn | Character respawn type. Defines what happens to players and playable characters after they die in multiplayer scenarios. Has no effect in singleplayer scenarios.
Available options:
|
Respawn | Number |
Rulesets | Respawn | Specific respawn rulesets based on currently selected 'Respawn'. | RespawnTemplates | Array |
Respawn Delay | Respawn | Time in seconds after which players respawn. | RespawnDelay | Number |
Vehicle Respawn Delay | Respawn | Time in seconds after which vehicles respawn. | RespawnVehicleDelay | Number |
Show Scoreboard | Respawn | When enabled, the scoreboard is shown while waiting for respawn. May be subdued by some respawn rulesets. | RespawnDialog | Boolean |
Allow Manual Respawn | Respawn | When enabled, players will have the option to manually respawn in the pause menu. | RespawnButton | Boolean |
Enable Team Switch | Respawn | When enabled, players will be able to manually switch to any other playable character in the scenario not controlled by another player. | EnableTeamSwitch | Boolean |
Allow AI Score | Respawn | When enabled, the score of playable characters controlled by AI will appear on the scoreboard. | AIKills | Boolean |
Shared Objectives | Tasks | Sets if tasks assigned to friendlies are visualized to player and who can assign/unassign tasks.
Available options:
|
SharedObjectives | String |
Revive Mode | Revive | Controls who can be incapacitated and who can revive others.
Available options:
|
ReviveMode | String |
Required Trait | Revive | Controls the specialty required to revive others.
Available options:
|
ReviveRequiredTrait | String |
Required Items | Revive | Controls the item required to revive others.
Available options:
|
ReviveRequiredItems | String |
Revive Duration | Revive | Controls the time it takes to revive someone. | ReviveDelay | String |
Medic Speed Multiplier | Revive | Controls how much faster a medic revives someone. | ReviveMedicSpeedMultiplier | String |
Force Respawn Duration | Revive | Controls how long it takes to force respawn while incapacitated. | ReviveForceRespawnDelay | String |
Incapacitation Mode | Revive | Controls the level of simulation involved in triggering incapacitation.
Available options:
|
ReviveUnconsciousStateMode | String |
Bleed Out Duration | Revive | Controls how long it takes an incapacitated unit to bleed out. | ReviveBleedOutDelay | String |
Garbage Collection
Info | Development | |||
---|---|---|---|---|
Name | Category | Description | Property | Type |
Minimum distance | Garbage Collection | The minimum distance from any player. Set the value to 0 to remove the min. distance. | MinPlayerDistance | Number |
Character Corpses | Garbage Collection | AttributeSystemSubcategory | ||
Mode | Garbage Collection | Garbage collecting mode.
Available options:
|
CorpseManagerMode | Number |
Limit | Garbage Collection | Maximum allowed number of dead bodies in the scenario. | CorpseLimit | Number |
Min Delay | Garbage Collection | Time in seconds before a dead body is removed when the number of dead bodies exceeds the 'Limit'. | CorpseRemovalMinTime | Number |
Max Delay | Garbage Collection | Time in seconds before a dead body is removed when the number of dead bodies is below or equals the 'Limit'. | CorpseRemovalMaxTime | Number |
Vehicle Wrecks | Garbage Collection | AttributeSystemSubcategory | ||
Mode | Garbage Collection | Garbage collecting mode.
Available options:
|
WreckManagerMode | Number |
Limit | Garbage Collection | Maximum allowed number of dead bodies in the scenario. | WreckLimit | Number |
Min Delay | Garbage Collection | Time in seconds before a dead body is removed when the number of dead bodies exceeds the 'Limit'. | WreckRemovalMinTime | Number |
Max Delay | Garbage Collection | Time in seconds before a dead body is removed when the number of dead bodies is below or equals the 'Limit'. | WreckRemovalMaxTime | Number |
Enable Dynamic Simulation | Dynamic Simulation | Turns on the 'Dynamic Simulation' system. Only entities and groups with the 'Dynamic Simulation' will be affected. | DynSimEnabled | |
Characters | Dynamic Simulation | DynSimDistGroup | ||
Manned Vehicles | Dynamic Simulation | DynSimDistVehicle | ||
Props | Dynamic Simulation | DynSimDistProp | ||
Empty Vehicles | Dynamic Simulation | DynSimDistEmptyVehicle | ||
Is Moving | Dynamic Simulation | Multiplies activation distance of non-static entity by set value. | DynSimMovingCoef | |
Limit by View Distance | Dynamic Simulation | Limits all activation distances to player's object view distance. Dynamically simulated entities beyond the object view distance will be disabled. | DynSimSaturateByObjDist |