getMissionPath: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...) |
||
| Line 1: | Line 1: | ||
{{Command | {{Command | ||
| arma3 | | arma3 | ||
|1.96 | |1.96 | ||
|gr1= System | |gr1= System | ||
|gr2= Mission Information | |gr2= Mission Information | ||
| Returns mission root plus the filename in a form of filepath to be used with commands requiring absolute path such as [[playSound3D]], [[drawIcon3D]], [[createSimpleObject]], etc. Any leading "\" in the filename will be stripped as the mission root includes one already. | | Returns mission root plus the filename in a form of filepath to be used with commands requiring absolute path such as [[playSound3D]], [[drawIcon3D]], [[createSimpleObject]], etc. Any leading "\" in the filename will be stripped as the mission root includes one already. | ||
| [[getMissionPath]] filename | | [[getMissionPath]] filename | ||
|p1 = filename: [[String]] | |p1 = filename: [[String]] | ||
| [[String]] - absolute path | | [[String]] - absolute path | ||
|x1 = <code>{{cc|would return e.g "C:\Users\Username\Documents\Arma 3\missions\MissionName.Altis\icons\myIcon.paa"}} | |x1 = <code>{{cc|would return e.g "C:\Users\Username\Documents\Arma 3\missions\MissionName.Altis\icons\myIcon.paa"}} | ||
[[private]] _path = [[getMissionPath]] "icons\myIcon.paa"; | [[private]] _path = [[getMissionPath]] "icons\myIcon.paa"; | ||
[[private]] _path = [[getMissionPath]] "\icons\myIcon.paa"; {{cc|leading \ is also fine}} | [[private]] _path = [[getMissionPath]] "\icons\myIcon.paa"; {{cc|leading \ is also fine}} | ||
</code> | </code> | ||
|x2 = <code>{{cc|would return e.g "C:\Users\Username\Documents\Arma 3\missions\MissionName.Altis\" with the trailing \}} | |x2 = <code>{{cc|would return e.g "C:\Users\Username\Documents\Arma 3\missions\MissionName.Altis\" with the trailing \}} | ||
[[private]] _root = [[getMissionPath]] "";</code> | [[private]] _root = [[getMissionPath]] "";</code> | ||
| [[missionConfigFile]], [[playSound3D]], [[drawIcon3D]], [[createSimpleObject]], [[description.ext]] | | [[missionConfigFile]], [[playSound3D]], [[drawIcon3D]], [[createSimpleObject]], [[description.ext]] | ||
}} | }} | ||
Revision as of 00:41, 18 January 2021
Description
- Description:
- Returns mission root plus the filename in a form of filepath to be used with commands requiring absolute path such as playSound3D, drawIcon3D, createSimpleObject, etc. Any leading "\" in the filename will be stripped as the mission root includes one already.
- Groups:
- SystemMission Information
Syntax
- Syntax:
- getMissionPath filename
- Parameters:
- filename: String
- Return Value:
- String - absolute path
Examples
- Example 1:
// would return e.g "C:\Users\Username\Documents\Arma 3\missions\MissionName.Altis\icons\myIcon.paa" private _path = getMissionPath "icons\myIcon.paa"; private _path = getMissionPath "\icons\myIcon.paa"; // leading \ is also fine- Example 2:
// would return e.g "C:\Users\Username\Documents\Arma 3\missions\MissionName.Altis\" with the trailing \ private _root = getMissionPath "";
Additional Information
Notes
-
Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note