| Environment:
|
Mission Scripting
|
|
|
| Function:
|
outPictureForCoalition
|
| Function Description:
|
Shows an image on the screen for all units belonging to a specific coalition (identified by its coalition number).
|
|
|
| File Location:
|
cmm.DCSFunctions.lua
|
|
|
| Syntax:
|
CMM.outPictureForCoalition( number Coal , 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
|
| Coal | Coalition number (e.g., 1 for blue, 2 for red). |
|---|
| fileName | Name of the image file located in l10n\DEFAULT. |
|---|
| 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 for that coalition 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.outPictureForCoalition(2, "Pic-target.png", 15, true, 0, 1, 1, 100, 1)
|
| Example Description:
|
Displays the image *Pic‑target.png* on every unit in coalition 2 for 15 seconds.
|
|
|
| Related Functions:
|
|
| Notes:
|
FILENAMES NEED TO BE IN THE mapResource file under l10n\DEFAULT in the mission file
|
