GainScenarioAchievement

Category: Player
Since engine version: 4.0 OC

Description

Gain a scenario achievement. Gained achievements are represented as small symbols beside the scenario name in the selection screen.

bool GainScenarioAchievement(string id, value int, player int, string scenario_name);

id:: ID of achievement to gain. Must be defined as a custom scenario parameter for the scenario.
int:: [opt] Value to set for this achievement. Defaults to 1.
int:: [opt] Value to set for this achievement. If nil or NO_OWNER, the achievement is gained for all player currently in the game.
scenario_name:: [opt] Can be set to the filename of another scenario to gain an achievement for that scenario. Scenario paths contain all .oc* paths, e.g. "Missions.ocf\Raid.ocs". Defaults to the filename of the current scenario or its origin.

Make sure the gain the achievement before players are saved, i.e. before the game is evaluated. Otherwise, gained achievements are not stored.

See also: GainScenarioAccess

See also: Scenario parameter definitions

Sven2, 2014-09