View source for Introduction to Arma Scripting

{{SideTOC}}
== Introduction ==

This page should give beginners an overview of how to begin with scripting and where to find most of the information they need in the beginning. Some information might not be complete and can be found on other wiki pages.

During [[ArmA: Mission Editing|mission editing]] and [[ArmA: Addon Editing|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 [[ArmA: Mission Editor|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-engine's ability to call on an even more advanced feature known as [[Scripting|scripting]]. '''Arma''''s '''scripting language''' gives you a more direct control of core game features. With any combination of these '''[[:Category: Scripting Commands|commands]]''' and '''[[:Category: Functions|functions]]''' you can create custom processes that meet the specific needs of your mission or addon.


== Before anything ==

=== Is your idea necessary? ===

* Will players even notice or use what you want to script? Just because you can doesn’t mean you should. Sometimes less is more!

=== Is it possible to do this in the editor? ===

* [[Eden Editor]] is an incredibly powerful tool and with it alone one can achive a lot of things, even without writing a single line of [[SQF syntax|SQF]].
* ''Poorly written'' scripts are often the reason for poor performance both in singleplayer and multiplayer scenarios.

=== Can it be scripted using SQF? ===

* This might be hard to answer, especially for beginners. Try to get as much information about what you want to do and what [[:Category: Scripting Commands|commands]] and [[:Category: Functions|functions]] there are before spending time on writing a script, just to find out it is ''not'' possible in the end.


Should any question above be answered with '''"Yes"''', you may want to rethink your approach.

{{Informative | '''Scripting''' is <u>not</u> a solution to everything.}}


== Terms ==

Before getting started, you should understand the meaning of these terms.

'''Data Types''':
See [[Data Types]]

'''Algorithm''':
In mathematics and computer science, an algorithm is an explicit specification of how to solve a class of problems. Algorithms can perform calculation, data processing and automated reasoning tasks.

'''Interpreter''':
Reads your code from a script file and translates it into instructions for you to achieve your desired outcome/effect in the game.

'''Control Structures''':
See [[Control Structures]]

'''Syntax''':
* See [[SQF syntax]]
* See [[SQS syntax]] (obsolete)

'''Script''':
When speaking about a [[Script (File)|script]], we usually mean a .sqs or .sqf file.

'''Game Engine''':
The core program of the game which reads and executes your scripting commands at run time.

'''Function''':
See [[Function]]

'''Variables''':
See [[Variables]]

'''Operators''':
See [[Operators]]


== Recommended programs ==

'''Code Edition''' programs can be found on the [[:Category:Community Tools#Code Edition|Community Tools - Code Edition]] page section.


== Must-read articles ==

=== Best Practices ===

* [[Code Best Practices]]

=== Debugging ===

* [[Debugging Techniques]]
* [[:Category:Community_Tools#Debug_Console.2FSystem|Community Tools - Debug Console/System]]

=== Optimisation ===

* [[Code Optimisation]]
* [[Mission Optimisation]]


== Useful Links ==

These links offer a great deal of information about [[Scripting]]:
* [[:Category:Example Code|Example Code]]
* [[Control Structures]]
* [[Multiplayer Scripting]]
* [[Exception handling]]
* [[Script (File)]]
* [[Function]]
* [[SQS to SQF conversion]]

Additionally, the following are more resources for more general learning:
* [[6thSense.eu/EG|6thSense.eu Editing Guide]]
* [http://www.armaholic.com/page.php?id=20465 Fockers Arma 3 Scripting Guide]
* [http://www.armaholic.com/page.php?id=4847 Mr-Murray's Armed Assault Editing Guide - Deluxe Edition]
* [https://www.youtube.com/watch?v=WmEBN-RbK44 Excellent German SQF tutorial (YouTube)]


[[Category:Scripting Topics]]
[[Category:Operation Flashpoint: Editing]]
[[Category:ArmA: Editing]]
[[Category:ArmA 2: Editing]]
[[Category:Arma 3: Editing]]
[[Category:Take On Helicopters: Editing]]