OutPicture
| Environment: | Mission Scripting | |
|---|---|---|
| Function: | outPicture | |
| Function Description: | Displays a PNG/JPG file from the mission’s l10n\DEFAULT folder on the player’s HUD for a specified duration, optionally clearing other images and delaying the start. The function supports alignment (left/middle/right, top/middle/bottom), scaling to screen size, and optional clearing of previously displayed pictures. | |
| File Location: | cmm.DCSFunctions.lua | |
| Syntax: | CMM.outPicture( string fileName , number or nil durationSeconds , boolean or nil clearView , number or nil startDelay , number or nil horizontalAlign , number or nil verticalAlign ,number or nil size , number or nil sizeUnits ) | |
| Return Value: | nil | |
| Parameters: | Name | Description |
| fileName | Name of the image file (e.g., "myMap.png"). The file must be present in l10n\DEFAULT of the mission. | |
| durationSeconds | How long, in seconds, the picture remains visible. If omitted or nil, it stays until cleared by another call. | |
| clearView | When true, removes all other images currently displayed before showing this one. | |
| startDelay | Seconds to wait after calling before the image appears (useful for sequencing). | |
| horizontalAlign | 0 = left, 1 = center, 2 = right. Defaults to 1 (center). | |
| verticalAlign | 0 = top, 1 = middle, 2 = bottom. Defaults to 1 (middle). | |
| size | Scale factor relative to screen width; 100 makes the image fill the screen. Default is 100. | |
| sizeUnits | Units for the size parameter (normally leave as 1). | |
| Example: | CMM.outPicture("battleMap.png", 30, true, 0, 1, 1, 100) | |
| Example Description: | shows "battleMap.png" centered on screen for 30 s, clearing any other images first | |
| Related Functions: | ||
| Notes: | FILENAMES NEED TO BE IN THE mapResource file under l10n\DEFAULT in the mission file | |