Inheritance diagram for SCR_MissionHeader:

[legend]

Public Member Functions
bool	IsMultiplayer ()
	Returns whether mission can be played in multiplayer or not.

string	GetSaveFileName ()
	Get name of the save file for this mission.

Public Member Functions inherited from MissionHeader
proto external string	GetWorldPath ()
	Returns the path to the world file.

proto external string	GetHeaderResourcePath ()
	Returns the path to this mission header.

proto ResourceName	GetHeaderResourceName ()

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

EGameFlags	m_eEditableGameFlags

EGameFlags	m_eDefaultGameFlags

bool	m_bIsSavingEnabled

string	m_sSaveFileName

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

bool	m_bLoadOnStart

string	m_sOwner

Member Function Documentation

◆ GetMissionHeader()

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

static

Get mission header from a MissionWorkshopItem.

Returns: File name

◆ GetSaveFileName()

string SCR_MissionHeader.GetSaveFileName ( )

Get name of the save file for this mission.

Returns: File name

◆ IsMultiplayer()

bool SCR_MissionHeader.IsMultiplayer ( )

Returns whether mission can be played in multiplayer or not.

Member Data Documentation

◆ m_bIsSavingEnabled

bool SCR_MissionHeader.m_bIsSavingEnabled

◆ 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_eDefaultGameFlags

EGameFlags SCR_MissionHeader.m_eDefaultGameFlags

◆ m_eEditableGameFlags

EGameFlags SCR_MissionHeader.m_eEditableGameFlags

◆ 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

◆ m_sSaveFileName

string SCR_MissionHeader.m_sSaveFileName

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

Game/Mission/SCR_MissionHeader.c

Public Member Functions

Static Public Member Functions

Public Attributes