playScriptedMission: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix formatting)
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(32 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
|version2= 1.50


|gr1= System |GROUP1=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| Load the given world, launch an empty mission and execute the given, expression.
|game4= arma3
Config (optional) can reference to the config entry, replacing [[Description.ext]] for this mission. |DESCRIPTION=
|version4= 0.50
____________________________________________________________________________________________


| '''playScriptedMission''' [world, expression, config, ignoreChildWindow] |SYNTAX=
|gr1= System


|p1= world: [[String]] |PARAMETER1=
|descr= Load the given world, launch an empty mission, and execute the given expression.
If provided, ''config'' can reference to the config entry, replacing [[Description.ext]] for this mission.


|p2= expression: [[Code]] |PARAMETER2=
|s1= [[playScriptedMission]] [world, expression, config, ignoreChildWindow]


|p3= config (Optional): [[Config]]|PARAMETER3=
|p1= world: [[String]]


|p4= ignoreChildWindow (Optional): [[Boolean]] |PARAMETER4=
|p2= expression: [[Code]]


| [[Nothing]] |RETURNVALUE=
|p3= config: [[Config]] - (Optional)


|x1= <code>[[playScriptedMission]]
|p4= ignoreChildWindow: [[Boolean]] - (Optional)
 
|r1= [[Nothing]]
 
|x1= <sqf>
playScriptedMission
[
[
"desert_e",
"desert_e",
{
{
[[execVM]] "\ca\missions_e\data\scenes\credits1\init.sqf";
execVM "\ca\missions_e\data\scenes\credits1\init.sqf";
},
},
[[configFile]] / "CfgMissions" / "Cutscenes" / "Credits"
configFile / "CfgMissions" / "Cutscenes" / "Credits"
];
];
</code> |EXAMPLE1=
</sqf>
____________________________________________________________________________________________


| [[hostMission]], [[playMission]] |SEEALSO=
|seealso= [[hostMission]] [[playMission]] [[createMissionDisplay]] [[createMPCampaignDisplay]]
}}
}}


<h3 style='display:none'>Notes</h3>
{{Note
<dl class='command_description'>
|user= SkaceKachna
<!-- Note Section BEGIN -->
|timestamp= 20151231175500
 
|text= For this command to work, you will need to:
<!-- Note Section END -->
</dl>
 
<h3 style='display:none'>Bottom Section</h3>
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on December 31, 2015 - 17:55 (UTC)</dd>
<dt class="note">[[User:SkaceKachna|SkaceKachna]]</dt>
<dd class="note">
For this command to work, you will need to:
 
# call command with ignoreChildWindow param set to true (in VBS docs its called fromMission)
# call command with ignoreChildWindow param set to true (in VBS docs its called fromMission)
# close any opened display (not sure about this part, but closing every display (but #0) seems to work):
# close any opened display (not sure about this part, but closing every display (but #0) seems to work):
#* If mission is run from 2D editor, you can just close RscDisplayArcadeMap display (idd 26) (because this was done from 2D editor, so RscDisplayArcadeMap is still active in background -- [[user:benargee|benargee]])
#* if mission is run from 2D editor, you can just close RscDisplayArcadeMap display (idd 26) (because this was done from 2D editor, so RscDisplayArcadeMap is still active in background -- [[user:benargee|benargee]])
#* If mission is run from single mission browser, you can just close RscDisplaySingleMission (idd 2)
#* if mission is run from single mission browser, you can just close RscDisplaySingleMission (idd 2)
# end mission
# end mission


Line 67: Line 57:


Command is a bit bugged:
Command is a bit bugged:
* Third (config) param doesn't seem to work
* third (config) param doesn't seem to work
* If you run this command in mission loaded from pbo, said pbo won't be writable until you close the game (you can't update it)
* if you run this command in mission loaded from pbo, said pbo won't be writable until you close the game (you can't update it)


Following code will change change island to Stratis and spawns player as basic soldier at [0,0,0] coordinates.
Following code will change change island to Stratis and spawns player as basic soldier at [0,0,0] coordinates.
<code>[[disableSerialization]];
<sqf>
[[playScriptedMission]] ['Stratis', {
disableSerialization;
[[private]] _grp = [[createGroup]] [[west]];
playScriptedMission ['Stratis', {
[[private]] _player = _grp [[createUnit]] ["B_Soldier_F", [0,0,0], [], 0, "NONE"];
private _grp = createGroup west;
[[selectPlayer]] _player;
private _player = _grp createUnit ["B_Soldier_F", [0,0,0], [], 0, "NONE"];
}, [[missionConfigFile]], [[true]]];<br>
selectPlayer _player;
{{cc|Close all displays that could be the background display ... this is essentialy [[forceEnd]] command}}
}, missionConfigFile, true];
{{cc|Closing #0 will cause game to fail}}
 
_zero = [[findDisplay]] 0;
// Close all displays that could be the background display ... this is essentially forceEnd command
// Closing #0 will cause game to fail
_zero = findDisplay 0;
{
{
[[if]] (_x != _zero) [[then]] {
if (_x != _zero) then {
_x [[closeDisplay]] 1;
_x closeDisplay 1;
};
};
} [[foreach]] [[allDisplays]];<br>
} foreach allDisplays;
[[failMission]] "END1";</code>
failMission "END1";
</sqf>
(tested in {{arma3}} 1.54.133741)
(tested in {{arma3}} 1.54.133741)
</dd>
}}
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 19:42, 3 September 2024

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Load the given world, launch an empty mission, and execute the given expression. If provided, config can reference to the config entry, replacing Description.ext for this mission.
Groups:
System

Syntax

Syntax:
playScriptedMission [world, expression, config, ignoreChildWindow]
Parameters:
world: String
expression: Code
config: Config - (Optional)
ignoreChildWindow: Boolean - (Optional)
Return Value:
Nothing

Examples

Example 1:
playScriptedMission [ "desert_e", { execVM "\ca\missions_e\data\scenes\credits1\init.sqf"; }, configFile / "CfgMissions" / "Cutscenes" / "Credits" ];

Additional Information

See also:
hostMission playMission createMissionDisplay createMPCampaignDisplay

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
SkaceKachna - c
Posted on Dec 31, 2015 - 17:55 (UTC)
For this command to work, you will need to:
  1. call command with ignoreChildWindow param set to true (in VBS docs its called fromMission)
  2. close any opened display (not sure about this part, but closing every display (but #0) seems to work):
    • if mission is run from 2D editor, you can just close RscDisplayArcadeMap display (idd 26) (because this was done from 2D editor, so RscDisplayArcadeMap is still active in background -- benargee)
    • if mission is run from single mission browser, you can just close RscDisplaySingleMission (idd 2)
  3. end mission
Debriefing will show and player will be moved to new mission after clicking on Continue.

Command is a bit bugged:
  • third (config) param doesn't seem to work
  • if you run this command in mission loaded from pbo, said pbo won't be writable until you close the game (you can't update it)
Following code will change change island to Stratis and spawns player as basic soldier at [0,0,0] coordinates.
disableSerialization; playScriptedMission ['Stratis', { private _grp = createGroup west; private _player = _grp createUnit ["B_Soldier_F", [0,0,0], [], 0, "NONE"]; selectPlayer _player; }, missionConfigFile, true]; // Close all displays that could be the background display ... this is essentially forceEnd command // Closing #0 will cause game to fail _zero = findDisplay 0; { if (_x != _zero) then { _x closeDisplay 1; }; } foreach allDisplays; failMission "END1";
(tested in Arma 3 1.54.133741)
Retrieved from "https://community.bistudio.com/wiki?title=playScriptedMission&oldid=369272"