Category: Get*Val
Since engine version: 1.0 OC
GetScenarioVal
Description
Returns the property value of the scenario by its name and section in the Scenario.txt.
Syntax
any GetScenarioVal(string entry, string section, int entry_number);
Parameters
- entry:
- Name of the entry to be retrieved.
- section:
- [opt] Section of the entry to be retrieved. If not specified, all sections will be searched for an entry of the specified name.
- entry_number:
- [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 entry are already implemented in System.ocg/GetXVal.c.
Example
Log("You are playing \"%s\"!", GetScenTitle());
Displays the scenario title.