Differences

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

--- arma2:scripting [2009/06/10 08:30] – added taskhint.sqf tip. snakeman
+++ arma2:scripting [2024/08/01 22:38] (current) – links added. snakeman
@@ Line 1: / Line 1: @@
-====== Scripting ======
+====== ArmA 2 Scripting ======
-**initJIPcompatible.sqf** is automatically started at unknown time, best guess would be when JIP player joins?
+[[https://www.pmctactical.org/forum/viewforum.php?f=50|ArmA 2 Forum]], [[:arma2|ArmA 2 Home]], [[arma2:config|ArmA 2 Config]], [[arma2:file_formats|ArmA 2 File Formats]], [[arma2:missions|ArmA 2 Missions]], [[arma2:modeling|ArmA 2 3D Modeling]], [[arma2:scripting|ArmA 2 Scripting]], [[arma2:terrain|ArmA 2 Terrain]], [[arma2:texturing|ArmA 2 Texturing]], [[arma2:tools|ArmA 2 Tools]]
+ArmA 2 will be largely compatible with Armed Assault. To make porting of content from ArmA as simple as possible, there are few important things:
-====== Scripting Commands ======
+  * using of undefined variable in scripts (nil value) will be in ArmA 2 strictly reported as an error. All variables used in any scripts must be initialized before first use.
-There's a lot of cool scripts (functions) available in Modules.pbo - especially under "Functions" and even an multiplayer Framework in "MP".
+  * in ArmA 2 namespaces will be introduced for user scripts and variables. There are many low level reasons to do this and most of the content will be not be affected by this in any negative way. However, in order to be prepared, it is very important to separate UI related scripts and code as much as possible and not simply share global variables between UI and missions as UI namespace needs to be handled differently.
-Since ArmA 2 you must first initialize a variable before you reference it in your scripts. In ArmA, it was not a problem, at least for conditions.
+  * in order to maintain smooth frame rate in real-time content, time limit for all scripts in each frame is enforced by the engine in ArmA 2. Generally speaking, in case of more demanding scripts, be prepared that their result may come way later and also there probably can suffer from significant latency. It is under evaluation if and how possibly allow user scripts to change how much time they may take from the CPU in every frame.
-<code cpp>
-// this will error if myBoolean was not previously defined.
-if (myBoolean) then { hint "test" };
-</code>
-Usage of isNil is still valid.
+  * SQS script format will be fully supported in ArmA 2 (but they should never be used).
-===== BIS fnc locations =====
+**initJIPcompatible.sqf** initJIPcompatible.sqf gets called from the MP mission framework (scripts in modules MP directory). A script waits until the player object is initialized and execs initJIPcompatible.sqf on clients (all clients, even those that were allready there at mission start as it is basically the same). Has nothing todo with init.sqf.
-BIS fnc locations
+[[arma2:scripting:basics_of_sqf|Basics of SQF]]
-Description: Creates or registers location logics (used in various modules, like [[arma2:editor_modules:alice|Ambient Civilians]], [[arma2:editor_modules:silvie|Ambient Civilian Vehicles]] or Warfare 2).
+Multiplayer [[arma2:scripting:dedicated_server_broadcasting|Dedicated server broadcasting]] to all clients.
-Upon registering, function will set following variables into location logic's variable space:
+Some [[arma2:scripting:code_optimization|Code optimization]] tips.
-  * "class" - unique class of location (either BIS_loc_<configname> or BIS_loc_custom_<ID>)
+[[arma2:scripting:zone_markers|Zone Markers]] creating script for warning zones.
-  * "name" - name of location from config or setName command. If none is defined, class is used
-  * "type" - config type
-  * "neighbors" - config defined neighbor locations
-If you're registering currently existing object and some of variables above is already stored in it, it won't be replaced.
+[[arma2:scripting:ied_usage|IED usage]] improvised explosive device usage through script.
-Syntax
+Few more [[arma2:scripting:comref|Scripting command reference]] items.
-Syntax: [type(s),area,debug] call BIS_fnc_locations
+[[arma2:scripting:common_scripting_errors|Common scripting errors]] help you to debug your code.
-Parameters: type(s): String or Array of strings\\
+[[arma2:scripting:group_in_vehicle|Group in Vehicle]] check.
-area: Array in format [center,distance]\\
-debug: (Optional): Boolean
-Return Value: Array - List of registered locations
+[[arma2:scripting:bis_fnc_spawngroup|BIS_fnc_spawnGroup]] how to create whole groups from CfgGroups class.
-Alternative Syntax
+[[arma2:scripting:bis_fnc_findsafepos|BIS_fnc_findSafePos]] how to find safe position with open ground etc.
-Syntax: [objects] call BIS_fnc_locations
+Global scripts dir or common scripts dir is very useful. This feature has been known since OFP, check out the details from [[arma:scripting#global_scripts_dir|ArmA: Scripting - Global scripts dir]], as same feature works in ArmA 2.
-Parameters: objects: Array of Objects or Locations - list of specific locations to be registered
+Howto create and use [[arma2:scripting:object-compositions|Object Compositions]] in missions.
-Return Value: Array - List of registered locations
+[[arma2:scripting:addpublicvariableeventhandler|addPublicVariableEventhandler]] examples.
-Examples
+[[arma2:scripting:benchmark-cutscene|Benchmark Cutscene]]
-Example 1:
+[[arma2:scripting:enablesaving|enableSaving]] and why its useful to disable.
-<code cpp>
-["CityCenter",[position player,1000]] call bis_fnc_locations;
-</code>
-Example 2:
-<code cpp>
-[["acityc_dolina"]] call bis_fnc_locations;
-</code>
-Example 3:
-<code cpp>
-[[myLocation1,myLocation2],[],true] call bis_fnc_locations;
-</code>
-See also:
-Functions Library (above hehe)
-===== allowDamage =====
-Description: Allow an object to be damaged (or injured, or killed).
-Syntax: object allowDamage allow
-Parameters: object: Object - allow: Boolean -
-Example 1:
-<code cpp>
-player allowDamage false
-</code>
-===== setVariable =====
-setVariable now has a 3rd parameter: Global.
-If you set the 3rd parameter to true, the variable will broadcast its value to every machine.
-<code cpp>
-_myObject setVariable ["myVariable", 1, true];
-</code>
-setVariable is now usable on any object, like groups for instance. This was not the case in ArmA.
-===== uiNameSpace =====
-Working with UI related scripting commands, is not accepted in global or private variable space, and needs to be done inside uiNameSpace by using setVariable.
-example:
-<code cpp>
-// set it
-uiNameSpace setVariable ["myVariable", ctrl...];
-// use it
-ctrl.... (uiNameSpace getVariable "myVariable");
-</code>
-===== createDiaryRecord =====
-createDiaryRecord
-<code cpp>
-_diary = player createDiaryRecord ["Diary", ["Technische Details", "Keine"]];
-</code>
-===== createSimpleTask =====
-createSimpleTask
-<code cpp>
-task1 = player createSimpleTask ["obj1"];
-</code>
-===== setSimpleTaskDescription =====
-setSimpleTaskDescription
-<code cpp>
-task1 setSimpleTaskDescription ["Description <marker name=""Start"">Start</marker> posit.","more text","more text"];
-</code>
-===== setSimpleTaskDestination =====
-setSimpleTaskDestination
-<code cpp>
-task1 setSimpleTaskDestination markerPos "Start";
-</code>
-===== setTaskState =====
-setTaskState
-<code cpp>
-task1 setTaskState "Created";
-</code>
-===== setCurrentTask =====
-setCurrentTask
-<code cpp>
-player setCurrentTask task1;
-</code>
-===== attachTo =====
-attachTo, see also detach.
-<code cpp>
-// Make player float exactly 2m above center of car, automatically changing vectordir + relative position as car moves.
-player attachTo [car, [0,0,2]];
-detach player;
-</code>
-===== diag_log =====
-diag_log writes any variable ([_fish, _frog] or "Hello, I'm starting to initialize myself") directly to the log, without needing to pass it via format/str and without any extra text.
-====== Changing nameSpace ======
-You can change namespace inside another namespace. Note that 1 misionNamespace refers to the normal global scope and 1 uiNamespace is the one where you are forced to store any control/display handles:
-<code cpp>
-fish = "Frog!";
-with uiNamespace do
-{
-	// Do some stuff with dialogs here.
-	with missionNamespace do
-	{
-		hint fish; // This sees the "regular" mission namespace.
-	};
-	// Do some more stuff with dialogs here.
-};
-</code>
-I have no idea what the purpose of 1 parsingNamespace is.
-===== Access nameSpace =====
-The command 1 with gives you a much nicer way to access namespaces and is especially cleaner when making multiple accesses:
-<code cpp>
-with uiNameSpace do
-{
-	// Any globals in this block are taken from uiNameSpace.
-	// Any locals are normal locals from current scope.
-	(fishDisplay displayCtrl 102) ctrlSetText _frog;
-	piesControl ctrlSetText _pies;
-	cheeseControl ctrlSetText _cheese;
-};
-</code>
-Rather than:
-<code cpp>
-((uiNameSpace getVariable "fishDisplay") displayCtrl 102) ctrlSetText _frog;
-(uiNameSpace getVariable "piesControl") ctrlSetText _pies;
-(uiNameSpace getVariable "cheeseControl") ctrlSetText _cheese;
-</code>
-====== taskHint.sqf ======
-How to make task hints
-taskHint is relatively useless itself (because it requires too much effort), but there is a script that makes it easier to use. So instead of executing a hint, do this:
-<code cpp>
-[objNull, objNull, tskExample1, "SUCCEEDED"] execVM "CA\Modules\MP\data\scriptCommands\taskHint.sqf";
-</code>
-The first 2 arguments are useless so i just send objNull, the 3rd is the task that you've created, and the 4th is the status.
-Supported task states: "CREATED", "CURRENT", "CANCELED", "SUCCEEDED" and "FAILED".
-  * This command does not set the state of the task, so you still need to do this command, and the setTaskState command in your trigger.
-  * It creates the hint in the middle of the screen, not at the right side (this means that taskHint and hint can be used at the same time).