Difference between revisions of "getMissionPath"

From Bohemia Interactive Community
Jump to navigation Jump to search
(Typo)
m (Text replacement - "description.ext" to "description.ext")
 
(21 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{RV|type=command
____________________________________________________________________________________________
 
  
| arma3dev |= Game name
+
|game1= arma3
|1.95|= Game version
+
|version1= 1.96
  
____________________________________________________________________________________________
+
|gr1= System
  
| 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. |DESCRIPTION=
+
|gr2= Mission Information
____________________________________________________________________________________________
 
  
|'''getMissionPath''' filename|SYNTAX=
+
|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.
|p1 = filename: [[String]]
 
| [[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=
 
  
 +
|s1= [[getMissionPath]] filename
  
| [[missionConfigFile]], [[playSound3D]], [[drawIcon3D]], [[createSimpleObject]], [[description.ext]] |SEEALSO=
+
|p1= filename: [[String]]
  
}}
+
|r1= [[String]] - absolute path
  
<h3 style="display:none">Notes</h3>
+
|x1= <code>{{cc|would return e.g "C:\Users\Username\Documents\Arma 3\missions\MissionName.Altis\icons\myIcon.paa"}}
<dl class="command_description">
+
[[private]] _path = [[getMissionPath]] "icons\myIcon.paa";
 +
[[private]] _path = [[getMissionPath]] "\icons\myIcon.paa"; {{cc|leading \ is also fine}}
 +
</code>
  
</dl>
+
|x2= <code>{{cc|would return e.g "C:\Users\Username\Documents\Arma 3\missions\MissionName.Altis\" with the trailing \}}
 +
[[private]] _root = [[getMissionPath]] "";</code>
  
<h3 style="display:none">Bottom Section</h3>
+
|seealso= ‎[[missionConfigFile]], [[playSound3D]], [[drawIcon3D]], [[createSimpleObject]], [[Description.ext|description.ext]]
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
+
}}
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 

Latest revision as of 10:58, 18 August 2021

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