getMissionPath: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix the slashes used on the comment in Example 2.)
m (Text replacement - "‎" to "")
 
(24 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3dev |Game name=
|game1= arma3
|1.96|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.
|p1 = filename: [[String]]
Any leading "\" in the filename will be stripped as the mission root includes one already.
| [[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
|x1= <sqf>
// 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
</sqf>
|x2= <sqf>
// returns e.g "C:\Users\Username\Documents\Arma 3\missions\MissionName.Altis\" with the trailing \
private _root = getMissionPath "";
</sqf>
|seealso= [[missionConfigFile]] [[playSound3D]] [[drawIcon3D]] [[createSimpleObject]] [[Description.ext|description.ext]] [[playSoundUI]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Lou Montana
|timestamp= 20230418205440
|text=
Before the introduction of [[getMissionPath]], absolute mission directory could be obtained as follow in config:
<syntaxhighlight lang="cpp">
__EXEC(MISSION_DIRECTORY = __FILE__ select [0, count __FILE__ - 15])
// ...
texture = __EVAL(MISSION_DIRECTORY + "subDirectory\texture.paa");
</syntaxhighlight>


</dl>
}}
 
<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}}}}]]

Latest revision as of 12:54, 26 April 2023

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
Lou Montana - c
Posted on Apr 18, 2023 - 20:54 (UTC)
Before the introduction of getMissionPath, absolute mission directory could be obtained as follow in config:
__EXEC(MISSION_DIRECTORY = __FILE__ select [0, count __FILE__ - 15])
// ...
texture = __EVAL(MISSION_DIRECTORY + "subDirectory\texture.paa");