Matrix Games Forums

Method:

VP_GetScenario()
Exposes current scenario information.

Returns Scenario (wrapper)

Wrapper:
Scenario

Details of the current scenario
Note the mixed case of the field names

Fields:
FileName string Name of the scenario file (.scen/.save)
Title string Title
ScenSetting string The setting of the scenario
ScenDate number Year of setting
Difficulty number Difficulty rating
Complexity number Complexity rating
StartTime datetime Starting time
Duration time Length of scenario as days:hours:minutes:seconds
CurrentTime datetime Current scenario time
DBUsed string Name of database being used
SaveVersion string Game version last saved under
CampaignScore number Current campaign score
CampaignSessionID string Current campaign session id
CampaignID string Campaign guid
InCampaignMode boolean Currently in standalone or campaign mode
StartTimeNum number Starting time as a number (of seconds) equivalent
DurationNum time Length of scenario as a number (of seconds) equivalent
CurrentTime datetime Current scenario time as a number (of seconds) equivalent
guid string Scenario GUID
PlayerSide string Current player GUID
HasStarted boolean Scenario in play
TimeCompression number Compression mode
Sides number Number of sides in scenario

* Added: [Lua] VP_GetScenario method (Exposes some scenario data such as duration, start time, complexity & difficulty, DB file used etc)