Set the current drawable for the HUD map when a mission starts.

Scope

This command should be called between calls to SelectMission and CloseMission in a mission's initialisation script.

Syntax

SetHUDMapDrawable( drawable_name );

Game.SetHUDMapDrawable( drawable_name )

• drawable_name: The name of the drawable to use.

Examples

SelectMission("m1");
	// ...

    // This command should be used in the root of the mission.
	SetHUDMapDrawable("l4hudmapShape_alternate");

	AddStage();
    	// ...
	CloseStage();
CloseMission();

Game.SelectMission("m1")
	-- ...

    -- This command should be used in the root of the mission.
	Game.SetHUDMapDrawable("l4hudmapShape_alternate")

	Game.AddStage()
    	-- ...
	Game.CloseStage()
Game.CloseMission()

Notes

• Meshes are the type of drawable intended for use as a HUD Map though some other types of drawables are also supported.
  • By default, the game stores the mesh for the HUD Map in art\frontend\scrooby\resource\pure3d\lXhudmap.p3d.
• This will not revert when the mission ends, it is up to the mod to put the HUD Map drawable back when necessary.