GetScenarioVal

Category: Get*Val
Since engine version: 4.9.1.0 GWE

Description

Returns the property value of the scenario by its name and section in the Scenario.txt

Syntax

any GetScenarioVal (string strEntry, string strSection, int iEntryNr);

Parameters

strEntry:
Name of the entry to be retrieved
strSection:
[opt] Section of the entry to be retrieved. If 0, all sections will be searched for an entry of the specified name.
iEntryNr:
[opt] Index of the value to be retrieved if an entry contains multiple values.

Remarks

Warning: the retrieved values may differ from computer to computer and thus cause synchronization problems in network games.
Most useful applications for strEntry are already implemented in System.c4g/GetXVal.c

Example

Log("You are playing \"%s\"!", GetScenTitle());
Displays the scenario title.
See also: GetActMapVal, GetDefCoreVal, GetObjectInfoCoreVal, GetObjectVal, GetPlayerInfoCoreVal, GetPlayerVal
PeterW, April 2002