Differences

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

--- arma:scripting [2008/04/30 15:24] – added bunch of info to the scripting. snakeman
+++ arma: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.
@@ Line 6: / Line 10: @@
 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 15: / Line 39: @@
 Example:
-<code>
+<code cpp>
 var = [player] execVM "test.sqf";
 </code>
 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.
 ArmA has "" quotes for STRINGS only and {} curled braces for CODE only. Script commands doesn’t have to be in one line now with the curled braces. Command lines always end with ; instead of a ; *or* carriage return. So you can format code to be more readable
-<code>
+<code cpp>
 {
     if (condition) then
@@ Line 39: / Line 63: @@
 Instead of the terrible ofp classic
-<code>
+<code cpp>
 {if (condition) then {DoSomething1; DoSomething2; DoSomething3; DoSomething4; DoSomething5;};} foreach array;
 </code>
 ====== Comments ======
@@ Line 47: / Line 72: @@
 Comments are no longer the same character as the end of command character.
-<code>
+<code cpp>
 // my comment
 instead of
@@ Line 55: / Line 80: @@
 You can use block comments now.
-<code>
+<code cpp>
 /*
 Comment line 1
@@ Line 68: / Line 93: @@
 Quotes are no longer a valid substitute for braces.
-====== Some SQF things ======
+====== Some SQF Things ======
 Some misc SQF things here ;)
-<code>
+<code cpp>
 _resultArray = [0,""];
 _handle = [_resultArray] execVM "resultScript.sqf";
@@ Line 82: / Line 108: @@
 And
-<code>
+<code cpp>
 myFunction1 = compile loadFile "myFunction1.sqf";
 myFunction2 = compile preprocessFile "myFunction2.sqf";
@@ Line 92: / Line 118: @@
 Return value?
-<code>
+<code cpp>
 value = call compile preprocessFile "return.sqf";
 // value is now RETURN_VALUE
@@ Line 99: / Line 125: @@
 // valid, but RETURN_VALUE is not saved anywhere
 </code>
 ====== Private ======
@@ Line 104: / Line 131: @@
 Using the private list.
-<code>
+<code cpp>
-private ["_t","_p","_yea"];
+private ["_t", "_p", "_yea"];
 </code>
 Is to make the _local variables really a private ones in the SQF script.
-====== Exit while loop ======
-<code>
+====== Exit While Loop ======
+<code cpp>
 if (condition) exitWith {Code}
@@ Line 117: / Line 145: @@
 </code>
-and
+And
-<code>
+<code cpp>
 for "_j" from 1 to 10 do
 {
@@ Line 127: / Line 155: @@
 player sideChat "Complete";
 </code>
 ====== Switch ======
@@ Line 133: / Line 162: @@
 Example 1
-<code>
+<code cpp>
 switch (_a) do
 {
@@ Line 152: / Line 181: @@
 Example 2
-<code>
+<code cpp>
 switch (_a) do
 {
@@ Line 171: / Line 200: @@
 Example 3
-<code>
+<code cpp>
 switch (_a) do
 {
@@ Line 189: / Line 218: @@
 </code>
-====== Script to nil ======
+====== Script To Nil ======
 When you have script like this
-<code>
+<code cpp>
 MyScript = compile preProcessFile "myScript.sqf";
 </code>
@@ Line 198: / Line 228: @@
 When you want to unload the script, set MyScript equal to nil.
-<code>
+<code cpp>
 MyScript = nil;
 </code>
 ====== Dynamic Variables ======
-Dynamic variables are very cool, sometimes on those random/comples missions you want to make variables later in the mission, which you cannot specify at mission start (hardcode).
+Dynamic variables are very cool, sometimes on those random / complex missions you want to make variables later in the mission, which you cannot specify at mission start (hardcoded).
-<code>
+<code cpp>
 _MyVariable = 20;
 _MyVariableContent = "MyContent";
@@ Line 215: / Line 246: @@
 Another example
-<code>
+<code cpp>
 _name = format ["mytrigger%1", triggerIndex];
 call compile format ["%1 = createTrigger [....]", _name];
 </code>
 ====== Misc PMC Example Scripts ======
 Place random vehicles + some units on all found **pmc_** gamelogics script, [[arma:scripting:pmc_logic1|here]].
+====== Running Scripts "Live" ======
+When you start your mission in mission editor, you can go and edit your scripts and then they are called the next time, they will be reloaded at the same time so your edits to them will be usable.
+This is very nice feature to have, just run ArmA in window mode as you should always do when mission editing, then edit away and for example keep a "runme.sqf" script in the dir executed from radio alpha (or action menu) repeatedly, then you can edit the runme.sqf and add any additional script there what you want to run.
+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>