Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_MissionHeader Interface Reference
Inheritance diagram for SCR_MissionHeader:
MissionHeader SCR_MissionHeaderCampaign SCR_MissionHeaderScenarioFramework SCR_MissionHeaderCombatOps SCR_MissionHeaderSequence

Public Member Functions

bool IsMultiplayer ()
 Returns whether mission can be played in multiplayer or not.
 
map< string, int > GetFactionLimitMap ()
 Returns map of player limits per faction.
 
- Public Member Functions inherited from MissionHeader
proto external ResourceName GetHeaderResourceName ()
 Returns the resource name of the mission.
 
proto external ResourceName GetWorldResourceName ()
 Returns the path to the world file.
 
proto external ResourceName GetWorldSystemsConfig ()
 Returns the resource name of the used system configuration.
 
proto external string GetWorldPath ()
 Returns the path to the world file.
 

Static Public Member Functions

static SCR_MissionHeader GetMissionHeader (notnull MissionWorkshopItem item, bool blockFromAddons=false)
 Get mission header from a MissionWorkshopItem.
 
- Static Public Member Functions inherited from MissionHeader
static proto ref MissionHeader ReadMissionHeader (string path)
 Reads mission header object from given file.
 

Public Attributes

string m_sName
 
string m_sAuthor
 
string m_sPath
 
string m_sDescription
 
string m_sDetails
 
ResourceName m_sIcon
 
ResourceName m_sLoadingScreen
 
ResourceName m_sPreviewImage
 
string m_sGameMode
 
int m_iPlayerCount
 
ESaveGameType m_eSaveTypes
 
EGameFlags m_eEditableGameFlags
 
EGameFlags m_eDefaultGameFlags
 
bool m_bShowInScenarioMenu
 
ResourceName m_sBriefingConfig
 
bool m_bOverrideScenarioTimeAndWeather
 
int m_iStartingHours
 
int m_iStartingMinutes
 
bool m_bRandomStartingDaytime
 
float m_fDayTimeAcceleration
 
float m_fNightTimeAcceleration
 
bool m_bRandomStartingWeather
 
bool m_bRandomWeatherChanges
 
float m_fXpMultiplier
 
bool m_bMapMarkerEnableDeleteByAnyone
 
int m_iMapMarkerLimitPerPlayer
 
ref array< ref SCR_FactionLimitm_aFactionLimits
 
bool m_bIsArmavisionAllowedInMP
 
bool m_bLoadOnStart
 
string m_sOwner
 

Member Function Documentation

◆ GetFactionLimitMap()

map< string, int > SCR_MissionHeader.GetFactionLimitMap ( )

Returns map of player limits per faction.

◆ GetMissionHeader()

static SCR_MissionHeader SCR_MissionHeader.GetMissionHeader ( notnull MissionWorkshopItem item,
bool blockFromAddons = false )
static

Get mission header from a MissionWorkshopItem.

Returns
File name

◆ IsMultiplayer()

bool SCR_MissionHeader.IsMultiplayer ( )

Returns whether mission can be played in multiplayer or not.

Member Data Documentation

◆ m_aFactionLimits

ref array<ref SCR_FactionLimit> SCR_MissionHeader.m_aFactionLimits

◆ m_bIsArmavisionAllowedInMP

bool SCR_MissionHeader.m_bIsArmavisionAllowedInMP

◆ m_bLoadOnStart

bool SCR_MissionHeader.m_bLoadOnStart

◆ m_bMapMarkerEnableDeleteByAnyone

bool SCR_MissionHeader.m_bMapMarkerEnableDeleteByAnyone

◆ m_bOverrideScenarioTimeAndWeather

bool SCR_MissionHeader.m_bOverrideScenarioTimeAndWeather

◆ m_bRandomStartingDaytime

bool SCR_MissionHeader.m_bRandomStartingDaytime

◆ m_bRandomStartingWeather

bool SCR_MissionHeader.m_bRandomStartingWeather

◆ m_bRandomWeatherChanges

bool SCR_MissionHeader.m_bRandomWeatherChanges

◆ m_bShowInScenarioMenu

bool SCR_MissionHeader.m_bShowInScenarioMenu

◆ m_eDefaultGameFlags

EGameFlags SCR_MissionHeader.m_eDefaultGameFlags

◆ m_eEditableGameFlags

EGameFlags SCR_MissionHeader.m_eEditableGameFlags

◆ m_eSaveTypes

ESaveGameType SCR_MissionHeader.m_eSaveTypes

◆ m_fDayTimeAcceleration

float SCR_MissionHeader.m_fDayTimeAcceleration

◆ m_fNightTimeAcceleration

float SCR_MissionHeader.m_fNightTimeAcceleration

◆ m_fXpMultiplier

float SCR_MissionHeader.m_fXpMultiplier

◆ m_iMapMarkerLimitPerPlayer

int SCR_MissionHeader.m_iMapMarkerLimitPerPlayer

◆ m_iPlayerCount

int SCR_MissionHeader.m_iPlayerCount

◆ m_iStartingHours

int SCR_MissionHeader.m_iStartingHours

◆ m_iStartingMinutes

int SCR_MissionHeader.m_iStartingMinutes

◆ m_sAuthor

string SCR_MissionHeader.m_sAuthor

◆ m_sBriefingConfig

ResourceName SCR_MissionHeader.m_sBriefingConfig

◆ m_sDescription

string SCR_MissionHeader.m_sDescription

◆ m_sDetails

string SCR_MissionHeader.m_sDetails

◆ m_sGameMode

string SCR_MissionHeader.m_sGameMode

◆ m_sIcon

ResourceName SCR_MissionHeader.m_sIcon

◆ m_sLoadingScreen

ResourceName SCR_MissionHeader.m_sLoadingScreen

◆ m_sName

string SCR_MissionHeader.m_sName

◆ m_sOwner

string SCR_MissionHeader.m_sOwner

◆ m_sPath

string SCR_MissionHeader.m_sPath

◆ m_sPreviewImage

ResourceName SCR_MissionHeader.m_sPreviewImage

The documentation for this interface was generated from the following file: