Difference between revisions of "getMissionPath"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| *(\[\[[a-zA-Z0-9]+\]\][^ ]+) *\|x1=" to " |r1= $1 |x1=")
m (Text replacement - "\|seealso= ([^ ]+)\]\], \[\[" to "|seealso= $1]] [[")
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{RV|type=command
 
{{RV|type=command
  
| arma3
+
|game1= arma3
 
+
|version1= 1.96
|1.96
 
  
 
|gr1= System
 
|gr1= System
Line 9: Line 8:
 
|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.
+
|descr= 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
+
|s1= [[getMissionPath]] filename
  
 
|p1= filename: [[String]]
 
|p1= filename: [[String]]
Line 17: Line 17:
 
|r1= [[String]] - absolute path
 
|r1= [[String]] - absolute path
  
|x1= <code>{{cc|would return e.g "C:\Users\Username\Documents\Arma 3\missions\MissionName.Altis\icons\myIcon.paa"}}
+
|x1= <sqf>
[[private]] _path = [[getMissionPath]] "icons\myIcon.paa";
+
// returns e.g "C:\Users\Username\Documents\Arma 3\missions\MissionName.Altis\icons\myIcon.paa"
[[private]] _path = [[getMissionPath]] "\icons\myIcon.paa"; {{cc|leading \ is also fine}}
+
private _path = getMissionPath "icons\myIcon.paa";
</code>
+
private _path = getMissionPath "\icons\myIcon.paa"; // leading \ is also fine
 +
</sqf>
  
|x2= <code>{{cc|would return e.g "C:\Users\Username\Documents\Arma 3\missions\MissionName.Altis\" with the trailing \}}
+
|x2= <sqf>
[[private]] _root = [[getMissionPath]] "";</code>
+
// returns e.g "C:\Users\Username\Documents\Arma 3\missions\MissionName.Altis\" with the trailing \
 +
private _root = getMissionPath "";
 +
</sqf>
  
| [[missionConfigFile]], [[playSound3D]], [[drawIcon3D]], [[createSimpleObject]], [[description.ext]]
+
|seealso= ‎[[missionConfigFile]] [[playSound3D]] [[drawIcon3D]] [[createSimpleObject]] [[Description.ext|description.ext]] [[playSoundUI]]
 
}}
 
}}

Latest revision as of 13:47, 1 July 2022

Hover & click on the images for description

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:
// returns 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:
// returns e.g "C:\Users\Username\Documents\Arma 3\missions\MissionName.Altis\" with the trailing \ private _root = getMissionPath "";

Additional Information

See also:
missionConfigFile playSound3D drawIcon3D createSimpleObject description.ext playSoundUI

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