PMC Editing Wiki

User Tools

Site Tools

Trace:
arma:scripting

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
arma:scripting [2009/04/01 00:27] – fixed code formatting. added live execVM tip. snakemanarma:scripting [2024/08/01 10:46] (current) – links added. snakeman
Line 1: Line 1:
-====== Scripting ======+====== ArmA 1 Scripting ====== 
 + 
 +[[https://www.pmctactical.org/forum/viewforum.php?f=42|ArmA 1 Forum]], [[:arma|ArmA 1 Home]], [[arma:config|ArmA 1 Config]], [[arma:tools|ArmA 1 Tools]], [[arma:file_formats|ArmA 1 File Formats]], [[arma:missions|ArmA 1 Missions]], [[arma:modeling|ArmA 1 3D Modeling]], [[arma:terrain|ArmA 1 Terrain]], [[arma:texturing|ArmA 1 Texturing]], [[arma:scripting|ArmA 1 Scripting]] 
 + 
 +**ArmA 1** aka Armed Assault (ArmA)
  
 Scripting in ArmA is changed somewhat from OFP times. Scripting in ArmA is changed somewhat from OFP times.
Line 6: Line 10:
  
 In a nutshell you never ever should create ArmA SQS content anymore, always create only SQF scripts. In a nutshell you never ever should create ArmA SQS content anymore, always create only SQF scripts.
 +
 +
 +====== Introduction To ArmA Scripting ======
 +
 +During mission editing and addon editing you may come across situations where actions or features you would like to have in your mission or addon cannot be accomplished using the basic (or even the more advanced) capabilities of the mission editor or within config files (in the case of addons). Some examples of this might be really cinematic cutscenes in missions or special animations for an addon.
 +
 +The solution to this is to take advantage of the game-engines ability to call on an even more advanced feature known as scripting. Armed Assault's scripting language gives you more direct control of core game commands. With any combination of these scripting commands you can then create custom processes that meet the specific needs of your mission or addon.
 +
 +
 +===== Terms =====
 +
 +Before getting started, you should understand the meaning of some of these terms.
 +
 +**Script**
 +
 +When speaking about a script, it is generally considered a .sqs file, the same can be said for functions, since functions are a kind of script as well, the file ends with a .sqf. Both file types can be edited as a plain text file.
 +
 +**Game Engine**
 +
 +The core program of the game which reads and executes your scripting commands at run time.
  
  
Line 19: Line 43:
 </code> </code>
  
-Argument is passed to the script as local variable _this. +Argument is passed to the script as local variable _this.
 The Script is first searched for in the mission folder, then in the campaign scripts folder and finally in the global scripts folder. The Script is first searched for in the mission folder, then in the campaign scripts folder and finally in the global scripts folder.
  
Line 42: Line 66:
 {if (condition) then {DoSomething1; DoSomething2; DoSomething3; DoSomething4; DoSomething5;};} foreach array; {if (condition) then {DoSomething1; DoSomething2; DoSomething3; DoSomething4; DoSomething5;};} foreach array;
 </code> </code>
 +
  
 ====== Comments ====== ====== Comments ======
Line 68: Line 93:
 Quotes are no longer a valid substitute for braces. Quotes are no longer a valid substitute for braces.
  
-====== Some SQF things ======+ 
 +====== Some SQF Things ======
  
 Some misc SQF things here ;) Some misc SQF things here ;)
Line 99: Line 125:
 // valid, but RETURN_VALUE is not saved anywhere // valid, but RETURN_VALUE is not saved anywhere
 </code> </code>
 +
  
 ====== Private ====== ====== Private ======
Line 109: Line 136:
 Is to make the _local variables really a private ones in the SQF script. Is to make the _local variables really a private ones in the SQF script.
  
-====== Exit while loop ======+ 
 +====== Exit While Loop ======
  
 <code cpp> <code cpp>
Line 127: Line 155:
 player sideChat "Complete"; player sideChat "Complete";
 </code> </code>
 +
  
 ====== Switch ====== ====== Switch ======
Line 189: Line 218:
 </code> </code>
  
-====== Script to nil ======+ 
 +====== Script To Nil ======
  
 When you have script like this When you have script like this
Line 201: Line 231:
 MyScript = nil; MyScript = nil;
 </code> </code>
 +
  
 ====== Dynamic Variables ====== ====== Dynamic Variables ======
Line 219: Line 250:
 call compile format ["%1 = createTrigger [....]", _name]; call compile format ["%1 = createTrigger [....]", _name];
 </code> </code>
 +
  
 ====== Misc PMC Example Scripts ====== ====== Misc PMC Example Scripts ======
Line 232: Line 264:
  
 You can now run a long mission and always bring new scripts into the play and so on. Imagine how many times have you play tested a mission and had to wrote down notes that "in this and that part you need to add XYZ", but now... you can just write a quick script (or use existing one) and add that to the runme.sqf and just call it up... script is run and you can proceed with the mission. Great. You can now run a long mission and always bring new scripts into the play and so on. Imagine how many times have you play tested a mission and had to wrote down notes that "in this and that part you need to add XYZ", but now... you can just write a quick script (or use existing one) and add that to the runme.sqf and just call it up... script is run and you can proceed with the mission. Great.
 +
 +
 +====== Global Scripts Dir ======
 +
 +Global scripts dir means that you can place your scripts under one single directory which all mission editor missions can read.
 +
 +In OFP you could place a directory in your OFP root dir called "Scripts", ie d:\ofp\scripts\ and when you ran a mission, if you called a script it would be first searched from the mission dir and if not found then in this directory. The usefulness of this is that if you have a campaign or similar where you use same script over and over again, its very cool to place it on this one "common" dir instead of each and every mission dir. In campaigns it worked from <campaign>\scripts\ the same way.
 +
 +However in ArmA it appears it will not work from d:\arma\Scripts\ anymore, BIS changed it a bit and now it can be found on:
 +<code>
 +<your_profile_path>\Users\<your_nickname>\Scripts\
 +</code>
 +
arma/scripting.1238545638.txt.gz · Last modified: 2009/04/01 00:27 by snakeman
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki

All PMC web site download services are temporarily suspended until web site yearly fees have been recovered, want to download addons/mods? Then Support PMC.

If you are grateful for all the work PMC has done in the past 25 years, use Support PMC page.