Difference between revisions of "getMissionPath"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Add example values)
Line 3: Line 3:
  
 
| arma3 |Game name=
 
| arma3 |Game name=
 +
 
|1.96|Game version=
 
|1.96|Game version=
 
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
Line 10: Line 10:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|'''getMissionPath''' filename|SYNTAX=
+
| [[getMissionPath]] filename |SYNTAX=
 +
 
 
|p1 = filename: [[String]]
 
|p1 = filename: [[String]]
 +
 
| [[String]] - absolute path |RETURNVALUE=
 
| [[String]] - absolute path |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
|x1 = <code>_path = [[getMissionPath]] "icons\myIcon.paa";</code> |EXAMPLE1=
 
|x2 = <code>_path = [[getMissionPath]] "\icons\myIcon.paa"; {{codecomment|// also fine}}</code> |EXAMPLE2=
 
  
 +
|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"; {{cc|leading \ is also fine}}
 +
</code> |EXAMPLE1=
 +
 +
|x2 = <code>{{cc|would return e.g "C:\Users\Username\Documents\Arma 3\missions\MissionName.Altis\" with the trailing \}}
 +
[[private]] _root = [[getMissionPath]] "";</code> |EXAMPLE2=
  
 
| [[missionConfigFile]], [[playSound3D]], [[drawIcon3D]], [[createSimpleObject]], [[description.ext]] |SEEALSO=
 
| [[missionConfigFile]], [[playSound3D]], [[drawIcon3D]], [[createSimpleObject]], [[description.ext]] |SEEALSO=
 
 
}}
 
}}
  
Line 28: Line 34:
  
 
<h3 style="display:none">Bottom Section</h3>
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 

Revision as of 19:38, 23 April 2020

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:
Uncategorised

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

See also:
missionConfigFileplaySound3DdrawIcon3DcreateSimpleObjectdescription.ext

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

Notes

Bottom Section