a - b
Typy zmiennych:
a: liczba
b: liczba
Typ Zwracanej wartości:
liczba
Opis:
a minus b
Przykład:
licznik - 1
-a
Typy zmiennych:
a: liczba
Typ Zwracanej wartości:
liczba
Opis:
zero minus a
Przykład:
- - 3 , wynik to 3
arrayA - arrayB
Typy zmiennych:
arrayA: wektor
arrayB: wektor
Typ Zwracanej wartości:
wektor
Opis:
Usuwa z wektora arrayA wszystkie elementy, które występują również w wektorze arrayB
Przykład:
[0, 1, 2, 4, 0, 1, 2, 3, 4, 5] - [1, 2, 3] , wynik to [0, 4, 0, 4, 5]
-a
Typy zmiennych:
a: wartość logiczna
Typ Zwracanej wartości:
wartość logiczna
Opis:
nie a
Przykład:
!true , wynik to false
grp1 != grp2
Typy zmiennych:
grp1: grupa
grp2: grupa
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy dwie grupy są różne. Jeżeli jedna z nich jest pusta(grpNull)zwraca true
Przykład:
group player != group soldierOne
side1 != side2
Typy zmiennych:
side1: strona
side2: strona
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy strony są różne
Przykład:
side player != west
a != b
Typy zmiennych:
a: łańcuch znaków
b: łańcuch znaków
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy łańcuchy znaków są różne
Przykład:
nameOfPlayer != "John Doe"
obj1 != obj2
Typy zmiennych:
obj1: obiekt
obj2: obiekt
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy obiekty są różne. Jeżeli jeden z nich jest obiektem pustym (objNull) zwraca true.
Przykład:
vehicle player != player
a != b
Typy zmiennych:
a: liczba
b: liczba
Typ Zwracanej wartości:
wartość logiczna
Opis:
a nie równa się b
Przykład:
counter != 4
a % b
Typy zmiennych:
a: liczba
b: liczba
Typ Zwracanej wartości:
liczba
Opis:
Iloraz z dzielenia a przez b. Uwaga-wynik z dzielenia jest liczbą rzeczywistą.
Przykład:
4.5 % 3 , result is 1.5
a && b
Typy zmiennych:
a: wartość logiczna
b: wartość logiczna
Typ Zwracanej wartości:
wartość logiczna
Opis:
a i b
Przykład:
alive player && alive leader player
a * b
Typy zmiennych:
a: liczba
b: liczba
Typ Zwracanej wartości:
liczba
Opis:
a pomnożone przez b
Przykład:
iCounter*3
a / b
Typy zmiennych:
a: liczba
b: liczba
Typ Zwracanej wartości:
liczba
Opis:
a podzielone przez b
Przykład:
enemyStrenght/3
a ^ b
Typy zmiennych:
a: liczba
b: liczba
Typ Zwracanej wartości:
liczba
Opis:
a podniesione do potęgi b
Przykład:
count^4
a || b
Typy zmiennych:
a: wartość logiczna
b: wartość logiczna
Typ Zwracanej wartości:
wartość logiczna
Opis:
a lub b
Przykład:
!alive player || !alive leader player
+a
Typy zmiennych:
a: wektor
Typ Zwracanej wartości:
wektor
Opis:
Zwraca kopię wektora
Przykład:
+ [0, 1, 2] , wynik to [0, 1, 2]
+a
Typy zmiennych:
a: liczba
Typ Zwracanej wartości:
liczba
Opis:
Zwraca liczbę
Przykład:
+4 , wynik to 4
stringA + stringB
Typy zmiennych:
stringA: łańcuch znaków
stringB: łańcuch znaków
Typ Zwracanej wartości:
łańcuch znaków
Opis:
Lączy łańcuchy znaków stringA i stringB.
Przykład:
"I" + " am" + " blind" , wynik to "I am blind"
a + b
Typy zmiennych:
a: liczba
b: liczba
Typ Zwracanej wartości:
liczba
Opis:
a plus b
Przykład:
counter + 1
arrayA + arrayB
Typy zmiennych:
arrayA: wektor
arrayB: wektor
Typ Zwracanej wartości:
wektor
Opis:
łączy wektory arrayA i arrayB
Przykład:
[0, 1, 2] + [1, 2, 3] , wynik to [0, 1, 2, 1, 2, 3]
a < b
Typy zmiennych:
a: liczba
b: liczba
Typ Zwracanej wartości:
wartość logiczna
Opis:
a mniejsze od b
Przykład:
counter < 4
a <= b
Typy zmiennych:
a: liczba
b: liczba
Typ Zwracanej wartości:
wartość logiczna
Opis:
a mniejsze lub równe b
Przykład:
player distance redCar <= 100
a == b
Typy zmiennych:
a: łańcuch znaków
b: łańcuch znaków
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy łańcuchy znaków są równe.
Przykład:
nameOfPlayer == "John Doe"
side1 == side2
Typy zmiennych:
side1: strona
side2: strona
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy strony są takie same.
Przykład:
side player = west
a == b
Typy zmiennych:
a: liczba
b: liczba
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy liczby są równe.
Przykład:
counter == 4
grp1 == grp2
Typy zmiennych:
grp1: grupa
grp2: grupa
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy dwie grupy są takie same. Jeżeli jedna z nich jest pusta(grpNull)zwraca false
Przykład:
group player == group soldierOne
obj1 == obj2
Typy zmiennych:
obj1: obiekt
obj2: obiekt
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy obiekty są takie same. Jeżeli jeden z nich jest obiektem pustym (objNull) zwraca false.
Przykład:
vehicle player != player
a < b
Typy zmiennych:
a: liczba
b: liczba
Typ Zwracanej wartości:
wartość logiczna
Opis:
a większe od b
Przykład:
counter > 4
a >= b
Typy zmiennych:
a: liczba
b: liczba
Typ Zwracanej wartości:
wartość logiczna
Opis:
a większe lub równe b
Przykład:
player distance redCar >= 100
abs x
Typy zmiennych:
a: liczba
Typ Zwracanej wartości:
liczba
Opis:
wartość bezwzględna (moduł) z a
Przykład:
abs -3 , result is 3
AccTime
Typ zwracanej wartości:
liczba
Opis:
Zwraca aktualne przyspieszenie upływu czasu. Domyślna prędkość upływu czasu to 1.
acos x
Typy zmiennych:
x: liczba
Typ Zwracanej wartości:
kąt (w stopniach)
Opis:
arcus cosinus z x
Przykład:
acos 0.5 , wynik to 60
unit Action action
Typy zmiennych:
unit: obiekt
action: akcja
Typ Zwracanej wartości:
nie zwraca
Opis:
Powoduje wykonanie przez jednostkę zadanej akcji. Akcja ma format [typ, cel, parametr1, parametr2, parametr3]. Tylko typ jest wymagany. Cel jest przypisany do jednostki. Parametry są specyficzne dla danej akcji.
Przykład:
soldierOne action ["eject", vehicle soldierOne]
unit AddAction action
Typy zmiennych:
unit: obiekt
action: wektor
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.1
Opis:
Tworzy akcję. Identyfikator akcji powinien być zwracany, ale nie jest z powodu błędu. By określić Identyfikator akcji (ID) użyj następującego algorytmu: pierwsza akcja dodana obiektowi ma Identyfikator 0, druga akcja dodana obiektowi ma Identyfikator 1, itd..
Przykład:
player addAction ["Hello", "hello.sqs"]
unit AddMagazine weaponName
Typy zmiennych:
unit: obiekt
weaponName: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Dodaje magazynek do określonej broni obiektowi. Uwaga!-Jeśli przekroczysz limit amunicji jaką może posiadać jednostka, efekt działania aplikacji jest nieprzewidywalny.
Przykład:
player addMagazine "M16"
unit AddMagazineCargo magazines
Typy zmiennych:
unit: obiekt
magazines: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Dodaje magazyneki określonej broni do przestrzeni załadunkowej (cargo space). Używane w stosunku do broni piechoty. Format wektora magazines to [magazineName,count].
Przykład:
rearmTruckOne addMagazineCargo ["M16", 10]
unit AddRating number
Typy zmiennych:
unit: obiekt
number: liczba
Typ Zwracanej wartości:
nie zwraca
Opis:
Dodaje wartość do oceny jednostki (unit rating). Używane do nagradzania z wykonanie celów misji. Wartość oceny za wyeliminowanych wrogów dodawana jest automatycznie. Kiedy ocena jednostki spadnie poniżej zera (np. w wyniku weliminowania jednostek swojej strony) staje się renegatem, i jest uważana za wroga dla wszystkich.
Przykład:
player addRating 1000
unit AddScore number
Typy zmiennych:
unit: obiekt
number: liczba
Typ Zwracanej wartości:
nie zwraca
Opis:
Używane tylko w misjach MP. Dodaje punkty (score) jednostce. Jest to pokazywane na statystyce MP "I" jako total.
Przykład:
player addScore 10
unit AddWeapon weaponName
Typy zmiennych:
unit: obiekt
weaponName: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Dodaje określoną broń obiektowi. Uwaga!-Można tworzyć niedozwolone kombinacje podając nazwę broni.Efekt działania aplikacji jest wtedy nieprzewidywalny.
Przykład:
player addWeapon "AK74"
unit AddWeaponCargo weapons
Typy zmiennych:
unit: obiekt
weapons: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Dodaje określone bronie do przestrzeni załadunkowej (cargo space). Używane w stosunku do broni piechoty. Format wektora weapons to [weaponName,count].
Przykład:
rearmTruckOne addWeaponCargo ["M16", 10]
Alive object
Typy zmiennych:
object: obiekt
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy dany obiekt (jednostka,pojazd,budynek) nie jest martwy/zniszczony.
Przykład:
alive player
object AllowDammage allow
Typy zmiennych:
object: obiekt
allow: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Komenda już nie działająca.
unit AllowFleeing courage
Typy zmiennych:
unit: obiekt lub grupa
courage: liczba
Typ Zwracanej wartości:
nie zwraca
Opis:
Ustawia "odwagę" jednostki/grupy. Im niższa "odwaga" tym łatwiej jednostka/grupa zaczyna wycofywać się. Wartość 0 oznacza maksymalną odwagę, a 1 że jednostka zawsze się wycofuje.
Przykład:
soldierOne allowFleeing 0
unitArray AllowGetIn allow
Typy zmiennych:
unitArray: wektor
allow: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Zezwala wszystkim jednostką z wektora na wsiadanie do pojazdów.
Przykład:
[unitOne, unitTwo] allowGetIn false
unit Ammo magazine
Typy zmiennych:
unit: obiekt
magazine: łańcuch znaków
Typ Zwracanej wartości:
liczba
Opis:
Sprawdza jak wiele nabojów pozostało jednostce w magazynku określonego typu. Uwaga!-sprawdza jedynie zawartość załadowanego magazynka.
Przykład:
player ammo "M16"
a AND b
Typy zmiennych:
a: wartość logiczna
b: wartość logiczna
Typ Zwracanej wartości:
wartość logiczna
Opis:
"a i b" czyli koniunkcja
Przykład:
alive player and alive leader player
object Animate [animation, phase]
Typy zmiennych:
object: obiekt
[animation, phase]: wektor
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.75
Opis:
Powoduje wykonanie animacji przez obiekt. Animacje są zdefiniowane w pliku konfiguracyjnym (config file). Rządaną fazę animacji ustalamy za pomocą parametru phase.
Przykład:
house animate ["doors1", 1]
object AnimationPhase animation
Typy zmiennych:
object: obiekt
animation: łańcuch znaków
Typ Zwracanej wartości:
liczba
Wymagana wersja OFP:
1.75
Opis:
Zwraca numer fazy animacji wykonywanej przez obiekt.
Przykład:
house animationPhase "doors1"
asin x
Typy zmiennych:
x: liczba
Typ Zwracanej wartości:
kąt (w stopniach)
Opis:
arcus sinus z x
Przykład:
asin 0.5 , wynik to 30
soldier AssignAsCargo vehicle
Typy zmiennych:
soldier: obiekt
vehicle: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Przypisuje żołnierza jako pasażera do danego pojazdu.
Przykład:
player assignAsCargo heliOne
soldier AssignAsCommander vehicle
Typy zmiennych:
soldier: obiekt
vehicle: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Przypisuje żołnierza jako dowódcę do danego pojazdu.
Przykład:
player assignAsCommander TankOne
soldier AssignAsDriver vehicle
Typy zmiennych:
soldier: obiekt
vehicle: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Przypisuje żołnierza jako kierowcę/pilota do danego pojazdu.
Przykład:
player assignAsCommander planeOne
soldier AssignAsGunner vehicle
Typy zmiennych:
soldier: obiekt
vehicle: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Przypisuje żołnierza jako strzelca do danego pojazdu.
Przykład:
player assignAsCommander M2gunOne
atan x
Typy zmiennych:
x: liczba
Typ Zwracanej wartości:
kąt (w stopniach)
Opis:
arcus tangens z x
Przykład:
atan 1 , wynik to 45
x atan2 y
Typy zmiennych:
x: liczba
y: liczba
Typ Zwracanej wartości:
kąt (w stopniach)
Opis:
arcus tangens z x/y. Zwraca wartość w stopnich z zakresu -180/+180, używając znaków obu parametrów do określenia ćwiartki do której należy otrzymany kąt.
Przykład:
5 atan2 3 , result is 59.0362
atgx
Typy zmiennych:
x: liczba
Typ Zwracanej wartości:
kąt (w stopniach)
Opis:
arcus tangens z x
Przykład:
atg 1 , result is 45
Behaviour unit
Typy zmiennych:
unit: obiekt
Typ Zwracanej wartości:
łańcuch znaków
Opis:
Zwraca tryb zachowania ("CARELESS","SAFE","AWARE","COMBAT","STEALTH") w jakim znajduje się jednostka.
Przykład:
behaviour player
Benchmark
Typ Zwracanej wartości:
liczba
Opis:
Zwraca wartość "3D Performance" ustawioną w preferencjach OFP, co może być użyte do oceny możliwości komputera. Funkcja ta pozwala tworzyć misje zdolne adoptować się do możliwości sprzętu na jakim są uruchamiane.
Przykład:
? benchmark>2000 : setviewdistance 2000
BuildingPos [building,index]
Typy zmiennych:
building: obiekt
index: numer
Typ Zwracanej wartości:
wektor
Opis:
Zwraca współrzędne indeksowanej pozycji w budynku.
Przykład:
buildingPos [buildingOne, 1]
ButtonAction idc
Typy zmiennych:
idc: obiekt
Typ Zwracanej wartości:
łańcuch znaków
Wymagana wersja OFP:
1.5
Opis:
Zwraca akcję przypisaną za pomocą identyfikatora idc do najwyższego dialogu użytkownika. Akcją jest każde wyrażenie w języku skryptowym. Może być używana wobec przycisków i aktywnych tekstów.
Przykład:
_action = buttonAction 100
ButtonSetAction [idc, action]
Typy zmiennych:
[idc,action]: wektor
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.5
Opis:
Przypisuje akcję za pomocą identyfikatora idc do najwyższego dialogu użytkownika. Akcją jest każde wyrażenie w języku skryptowym. Może być używana wobec przycisków i aktywnych tekstów.
Przykład:
buttonSetAction [100, player exec "reply.sqs"]
CadetMode
Typ Zwracanej wartości:
wartość logiczna
Opis:
Zwraca true gdy misja rozgrywana jest przy poziomie trudności "Cadet", false gdy rozgrywana jest przy poziomie trudności "Veteran".
camera CamCommand command
Typy zmiennych:
camera: obiekt
command: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Wykonuje komendę na danej kamerze/obiekcie. Zarówno wobec pierwszego jak i drugiego typu działają komendy "MANUAL ON" i "MANUAL OFF". Ponadto wobec kamery(camera) działają komendy "INTERIA ON" i "INTERIA OFF, a względem mewy (seagull) komendy "LANDED" i "AIRBORNE".
Przykład:
camera camCommand "Manual on"
camera CamCommit time
Typy zmiennych:
camera: obiekt
time: czas (w sekundach)
Typ Zwracanej wartości:
nie zwraca
Opis:
Wykonuje polecenia zadane kamerze płynnie w odcinku czasu zadanej długości. Czas równy 0 powoduje natychmiastowe wykonanie polecenia.
Przykład:
_camera camCommit 5
CamCommitted camera
Typy zmiennych:
camera: obiekt
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy kamera wykonała zadane jej polecenia.
Przykład:
camCommited _camera
type CamCreate position
Typy zmiennych:
type: łańcuch znaków
position: wektor
Typ Zwracanej wartości:
obiekt
Opis:
Tworzy kamerę lub obiekt danego typu na określonej pozycji na mapie. Typy kamery to "CAMERA" i "SEAGULL".
Przykład:
_camera = camCreate getPos player
CamDestroy camera
Typy zmiennych:
camera: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Niszczy kamerę.
camera CameraEffect effect
Typy zmiennych:
camera: obiekt
effect: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Przełącza kamerę w dany tryb działania. Format wektora effect to [name,position]. Name przyjmuje wartości "INTERNAL", "EXTERNAL", "FIXED" albo "FIXED WITH ZOOM". Position przyjmuje wartości "TOP", "LEFT", "RIGHT", "FRONT", "BACK".
Przykład:
cameraEffect ["External", "Back"]
camera CamSetBank bank
Typy zmiennych:
camera: obiekt
bank: kąt (w stopnich)
Typ Zwracanej wartości:
nie zwraca
Opis:
Ustawia kąt nachylenia kamery. Wymaga potwierdzenia komendą CamCommit.
Przykład:
_camera camSetBank -0.1
camera CamSetDir dir
Typy zmiennych:
camera: obiekt
dir: kąt (w stopnich)
Typ Zwracanej wartości:
nie zwraca
Opis:
Ustawia kierunek w jakim zwrócona jest kamera. Wymaga potwierdzenia komendą CamCommit.
Przykład:
_camera camSetDir 150
camera CamSetDive dive
Typy zmiennych:
camera: obiekt
dive: kąt (w stopnich)
Typ Zwracanej wartości:
nie zwraca
Opis:
Ustawia kąt nurkowania kamery. Wymaga potwierdzenia komendą CamCommit.
Przykład:
_camera camSetDive -0.1
camera CamSetFOV fieldOfView
Typy zmiennych:
camera: obiekt
fieldOfView: liczba
Typ Zwracanej wartości:
nie zwraca
Opis:
Ustawia zbliżenie widoku z kamery (zoom). Wymaga potwierdzenia komendą CamCommit.
Przykład:
_camera camSetFov 0.1
camera CamSetFOVRange fovRange
Typy zmiennych:
camera: obiekt
fovRange: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Ustawia zbliżenie widoku z kamery (zoom) dla automatycznego zbliżania (auto-zooming). Wymaga potwierdzenia komendą CamCommit.
Przykład:
_camera camSetFovRange [0.1, 0.5]
camera CamSetPos position
Typy zmiennych:
camera: obiekt
position: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Ustawia kamerę na zadanej pozycji (na mapie). Wymaga potwierdzenia komendą CamCommit.
Przykład:
_camera camSetPos getPos player
camera CamSetRelPos position
Typy zmiennych:
camera: obiekt
position: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Ustawia kamerę na pozycji przesuniętej o wektor względem pozycji celu wyznaczonego komendą CamSetTarget. Wymaga potwierdzenia komendą CamCommit.
Przykład:
_camera camSetRelPos [10,5,0]
camera CamSetTarget position
Typy zmiennych:
camera: obiekt
position: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Wyznacza pozycję (na mapie) na jaką ma być zwrócona kamera. Wymaga potwierdzenia komendą CamCommit.
Przykład:
_camera camSetTarget getPos player
camera CamSetTarget target
Typy zmiennych:
camera: obiekt
target: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Wyznacza obiekt na jaki ma być zwrócona kamera. Wymaga potwierdzenia komendą CamCommit.
Przykład:
_camera camSetTarget player
CanFire vehicle
Typy zmiennych:
vehicle: pojazd
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy pojazd jest w stanie strzelać (sprawdzanie dotyczy uszkodzeń, a nie posiadanej amunicji).
Przykład:
canFire vehicle player
CanMove vehicle
Typy zmiennych:
vehicle: pojazd
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy pojazd jest w stanie poruszać się (sprawdzanie dotyczy uszkodzeń, a nie posiadanego paliwa).
Przykład:
canMove vehicle player
CanStand soldier
Typy zmiennych:
soldier: osoba
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy osoba jest w stanie wstać.
Przykład:
canStand player
Captive unit
Typy zmiennych:
unit: obiekt
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy obiekt jest w niewoli (captive). Jeżeli sprawdzanie dotyczy pojazdu pod uwagę brany jest jego dowódca (commander).
Przykład:
captive player
Civilian
Typ Zwracanej wartości:
strona
Opis:
Strona cywilna (zastrzeżone wyrażenie).
ClearMagazineCargo unit
Typy zmiennych:
unit: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Usuwa wszystkie magazynki z przestrzeni załadunkowej (cargo space) obiektu.
Przykład:
clearMagazineCargo jeepOne
ClearWeaponCargo unit
Typy zmiennych:
unit: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Usuwa wszystkie bronie z przestrzeni załadunkowej (cargo space) obiektu.
Przykład:
clearWeaponCargo crateOne
CloseDialog idc
Typy zmiennych:
idc: liczba
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.5
Opis:
Zamyka najwyższy dialog użytkownika tak jakby przycisk określony identyfikatorem idc został naciśnięty.
Przykład:
closeDialog 1
CombatMode grp
Typy zmiennych:
grp: obiekt albo grupa
Typ Zwracanej wartości:
łańcuch znaków
Opis:
Sprawdza tryb bojowy w jakim znajduje się jednostka albo grupa. Możliwe wyniki to "RED","YELLOW","GREEN","BLUE".
Przykład:
combatMode group player
Commander vehicle
Typy zmiennych:
vehicle: obiekt
Typ Zwracanej wartości:
obiekt
Opis:
Sprawdza kto jest dowódcą (commander) pojazdu. Jeżeli sprawdzany nie jest pojazd lecz osoba, ta osoba jest zwracana.
Przykład:
commander vehicle player
unit CommandFire target
Typy zmiennych:
unit: obiekt
target: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Powoduje wydanie rozkazu (za pomocą radia, przez dowódce grupy) otwarcia ognia do danego celu. Jeżeli celem jest "obiekt pusty" (ObjNull) nakazuje otwarcie ognia do obecnie namierzonych celów (ustawionych za pomocą DoTarget albo CommandTarget).
Przykład:
soldierOne commandFire player
unit CommandFollow formationLeader
Typy zmiennych:
unit: obiekt
formationLeader: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Powoduje wydanie rozkazu (za pomocą radia, przez dowódce grupy) podążania za dowódcą (tj. powrotu do szyku).
Przykład:
soldierOne commandFollow player
unit CommandMove position
Typy zmiennych:
unit: obiekt
position: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Powoduje wydanie rozkazu (za pomocą radia, przez dowódce grupy) zajęcia podanej pozycji.
Przykład:
soldierOne commandMove getMarkerPos "MarkerMoveOne"
CommandStop unit
Typy zmiennych:
unit: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Powoduje wydanie rozkazu zatrzymania się (za pomocą radia, przez dowódce grupy). Uwaga! - komenda CommandStop nigdy nie ulega zakończeniu tj. jednostka nigdy nie będzie gotowa (komenda UnitReady da wynik: false)
Przykład:
commandStop unitOne
unit CommandTarget object
Typy zmiennych:
unit: obiekt
object: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Powoduje wydanie rozkazu (za pomocą radia, przez dowódce grupy) wzięcia na cel obiektu.
Przykład:
soldierOne commandTarget player
unit CommandWatch object
Typy zmiennych:
unit: obiekt
object: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Powoduje wydanie rozkazu (za pomocą radia, przez dowódce grupy) obserwowania obiektu.
Przykład:
soldierOne commandWatch player
unit CommandWatch position
Typy zmiennych:
unit: obiekt
position: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Powoduje wydanie rozkazu (za pomocą radia, przez dowódce grupy) obserwowania punktu o podanych współrzędnych.
Przykład:
soldierOne commandWatch getMarkerPos "MarkerMoveOne"
cos x
Typy zmiennych:
x: liczba
Typ Zwracanej wartości:
kąt (w stopniach)
Opis:
cosinus z x
Przykład:
cos 60 , wynik to 0.5
condition Count array
Typy zmiennych:
condition: łańcuch znaków
array: wektor
Typ Zwracanej wartości:
liczba
Opis:
Ustala liczbę elementów wektora spełniających zadany warunek. Zliczanie przebiega następująco: 1) ustawia licznik na 0, 2) każdy element wektora trktuje jako zmienną lokalną _x i sprawdza czy spełnia ona zadany warunek - jeśli wynik jest true to zwiększa licznik o jeden.
Przykład:
"_x > 2" count [0, 1, 1, 2, 3, 3] , wynik to 2
Count array
Typy zmiennych:
array: wektor
Typ Zwracanej wartości:
liczba
Opis:
Ustala liczbę elementów wektora.
Przykład:
count [0,0,1,2] , wynik to 4
unit CountEnemy array
Typy zmiennych:
unit: obiekt
array: wektor
Typ Zwracanej wartości:
liczba
Opis:
Ustala liczbę elementów wektora traktowanych przez obiekt jako wrogie.
Przykład:
player countEnemy list triggerOne
unit CountFriendly array
Typy zmiennych:
unit: obiekt
array: wektor
Typ Zwracanej wartości:
liczba
Opis:
Ustala liczbę elementów wektora traktowanych przez obiekt jako przyjazne.
Przykład:
player countFriendly list triggerOne
side CountSide array
Typy zmiennych:
side: strona
array: wektor
Typ Zwracanej wartości:
liczba
Opis:
Ustala liczbę elementów wektora należących do zadanej strony.
Przykład:
west coundSide list triggerOne
typeName CountType array
Typy zmiennych:
typeName: łańcuch znaków
array: wektor
Typ Zwracanej wartości:
liczba
Opis:
Ustala liczbę elementów wektora będących obiektami zadanego typu.
Przykład:
"Tank" countType list triggerOne
unit CountUnknown array
Typy zmiennych:
unit: obiekt
array: wektor
Typ Zwracanej wartości:
liczba
Opis:
Ustala liczbę elementów wektora traktowanych przez obiekt jako nierozpoznane.
Przykład:
player countUnknown list triggerOne
CreateDialog name
Typy zmiennych:
name: łańcuch znaków
Typ Zwracanej wartości:
wartość logiczna
Wymagana wersja OFP:
1.5
Opis:
Tworzy dialog użytkownika (user dialog) z zasobu szablonu nazw (resource template name). Jeżeli dialog użytkownika już istnieje tworzy poddialog "potomny" (child dialog) na szczycie dialogu użytkownika. Klasa name (Class name) jest szukana w pliku description.ext misji lub description.ext kampanii oraz w globalnym pliku resource.cpp .Zwraca true w przypadku poprawnego wykonania komendy.
Przykład:
_ok = createDialog "RscDisplayGame"
type CreateUnit unitInfo
Typy zmiennych:
type: łańcuch znaków
unitInfo: wektor
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.34
Opis:
Tworzy jednostkę danego typu. Format wektora unitInfo jest nastepujący: [pos(: wektor-współrzędne na mapie),group(: grupa-grupa do której należy),init(: łańcuch znaków-pole inicjacji),skill(: liczba-predyspozycje),rank(: łańcuch znaków-stopień)]. Uwaga! - wartości init, skill i rank nie są konieczne tj. jeżeli nie zostana podane przyjmują wartości domyślne: "",0.5,"PRIVATE".
Przykład:
"SoldierWB" createUnit [getMarkerPos "barracks", groupAlpha]
type CreateVehicle pos
Typy zmiennych:
type: łańcuch znaków
pos: wektor
Typ Zwracanej wartości:
obiekt
Wymagana wersja OFP:
1.34
Opis:
Tworzy pusty pojazd danego typu na zadanych współrzędnych.
Przykład:
_tank = "M1Abrams" createVehicle getmarkerpos "tankFactory"
Crew vehicle
Typy zmiennych:
vehicle: obiekt
Typ Zwracanej wartości:
wektor
Opis:
Zwraca wektor zawierający wszystkie jednostki znajdujące się w danym pojeździe (również pasażerów). Jeżeli sprawdzany nie jest pojazd lecz osoba, ta zwracany jest wektor zawierający tą osobę.
Przykład:
crew vehicle player
CtrlEnable [idc, enable]
Typy zmiennych:
[idc, enable]: wektor
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.5
Opis:
Daje/odbiera kontrolę nad najwyższym dialogiem użytkownika (topmost user dialog) o identyfikatorze idc.
Przykład:
ctrlEnable [100, false]
CtrlEnabled idc
Typy zmiennych:
idc: liczba
Typ Zwracanej wartości:
wartość logiczna
Wymagana wersja OFP:
1.5
Opis:
Zwraca true jeżeli dana jest kontrola nad najwyższym dialogiem użytkownika (topmost user dialog) o identyfikatorze idc.
Przykład:
_enabled = ctrlEnabled 100
CtrlSetText [idc, text]
Typy zmiennych:
[idc, text]: wektor
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.5
Opis:
Umieszcza tekst w "kontrolce" związanej z najwyższym dialogiem użytkownika (topmost user dialog) o identyfikatorze idc. Może być użyte do tworzenia statycznego tekstu, przycisków, lini edycji (edit lines) i aktywnych tekstów (active texts).
Przykład:
ctrlSetText [100, "Hello, world"]
CtrlShow [idc, shown]
Typy zmiennych:
[idc, shown]: wektor
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.5
Opis:
Pokazuje/ukrywa "kontrolkę" związaną z najwyższym dialogiem użytkownika (topmost user dialog) o identyfikatorze idc. Może być użyte do tworzenia statycznego tekstu, przycisków, lini edycji (edit lines) i aktywnych tekstów (active texts).
Przykład:
ctrlShow [100, true]
CtrlText idc
Typy zmiennych:
idc: liczba
Typ Zwracanej wartości:
łańcuch znaków
Wymagana wersja OFP:
1.5
Opis:
Zwraca tekst pokazywany w "kontrolce" związanej z najwyższym dialogiem użytkownika (topmost user dialog) o identyfikatorze idc. Może być użyte do tworzenia statycznego tekstu, przycisków, lini edycji (edit lines) i aktywnych tekstów (active texts).
Przykład:
_message = ctrlText 100
CtrlVisible idc
Typy zmiennych:
idc: liczba
Typ Zwracanej wartości:
wartość logiczna
Wymagana wersja OFP:
1.5
Opis:
Zwraca true jeżeli "kontrolka" związana z najwyższym dialogiem użytkownika (topmost user dialog) o identyfikatorze idc, jest widoczna.
Przykład:
_visible = ctrlVisible 100
CutObj effect
Typy zmiennych:
effect: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Umieszcza "tło obiektowe" (object background). Wektor effect ma format ["name","type",speed] albo ["name","type"] (jeżeli prędkość nie jest podana przyjmuje wartość jeden). Obiekt może być zdefiniowany w pliku description.ext .
Przykład:
cutObj ["TVSet", "plain"]
CutRsc effect
Typy zmiennych:
effect: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Umieszcza "tło zasobowe" (resource background). Wektor effect ma format ["name","type",speed] albo ["name","type"] (jeżeli prędkość nie jest podana przyjmuje wartość jeden). Zasób może być zdefiniowany w pliku description.ext .
Przykład:
cutRsc ["binocular", "PLAIN"]
CutText effect
Typy zmiennych:
effect: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Umieszcza "tło tekstowe" (text background). Wektor effect ma format ["text","type",speed] albo ["text","type"] (jeżeli prędkość nie jest podana przyjmuje wartość jeden). Argument type przyjmuje wartości: "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT", "WHITE IN".
Przykład:
cutText ["Hello everybody!", "BLACK OUT"]
Dammage object
Typy zmiennych:
object: obiekt
Typ Zwracanej wartości:
liczba
Wymagana wersja OFP:
1.5
Opis:
Zwraca uszkodzenia jakie odniósł obiekt (wartość z przedziału <0,1>). Komenda ta działa identycznie jak GetDammage.
Przykład:
damage player
Daytime
Typ Zwracanej wartości:
liczba
Opis:
Zwraca aktualny czas (porę dnia) w godzinach tzn. 11.5 oznacza wpół do dwunastej.
DebugLog anything
Typy zmiennych:
anything: jakikolwiek
Typ Zwracanej wartości:
nie zwraca
Opis:
Zrzuca typ i wartość argumentu do "wyjścia kontrolnego" (debugging output).
Przykład:
debugLog player
deg x
Typy zmiennych:
x: liczba (kąt w stopniach)
Typ Zwracanej wartości:
liczba (kąt w radianach)
Opis:
Podaje wartość kąta w radianach dla danej wartości kąta w stopniach.
Przykład:
deg 1 , wynik to 57.295
DeleteIdentitiy identityName
Typy zmiennych:
identityName: łańcuch znaków
Typ Zwracanej wartości:
wartość logiczna
Wymagana wersja OFP:
1.75
Opis:
Usuwa osobowość (identity), utworzoną za pomocą komendy SaveIdentity, z pliku postępu kampanii (compaign progress file).
Przykład:
deleteIdentity "playerIdentity"
DeleteStatus statusName
Typy zmiennych:
statusName: łańcuch znaków
Typ Zwracanej wartości:
wartość logiczna
Wymagana wersja OFP:
1.75
Opis:
Usuwa status (status), utworzony za pomocą komendy SaveStatus, z pliku postępu kampanii (compaign progress file).
Przykład:
deleteStatus "playerState"
DeleteVehicle object
Typy zmiennych:
object: obiekt
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.34
Opis:
Usuwa dowolną jednostkę lub pojazd. Tylko obiekty umieszczone w edytorze lub stworzone za pomocą komend mogą być usunięte. Gracz nie może zostać usunięty.
Przykład:
deleteVehicle tank
Direction object
Typy zmiennych:
object: obiekt
Typ Zwracanej wartości:
liczba (kąt w stopniach)
Wymagana wersja OFP:
1.5
Opis:
Zwraca azymut w jakim zwrócny jest obiekt (w stopniach). Komenda ta działa identycznie jak GetDir.
Przykład:
direction player
unit DisableAI section
Typy zmiennych:
unit: obiekt
section: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Dezaktywuje część "Sztucznej inteligencji" (AI), dzięki czmu zyskuje się pewną kontrolę nad jednostką. Elementy (sections), które możemy zdezaktywować to: "TARGET" (dezaktywuje obserwację wyznaczonych celów), "AUTOTARGET" (dezaktywuje samodzielne wyznaczanie i obserwację celów), "MOVE" (dezaktywuje zdolność ruchu).
Przykład:
soldierOne disableAI "Move"
DisableUserInput disable
Typy zmiennych:
disable: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Uniemożliwia kontrolę (za pomocą klawiatury, myszy itp..) nad jednostką gracza. Zazwyczaj stosowane podczas przerywników filmowych (CutScenes).
obj1 Distance obj2
Typy zmiennych:
obj1: obiekt
obj2: obiekt
Typ Zwracanej wartości:
liczba (odległość w metrach)
Opis:
Zwraca odległość między dwoma podanymi obiektami.
Przykład:
player distance leader player
unit DoFire target
Typy zmiennych:
unit: obiekt
target: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Nakazuje (bez komunikatu radiowego) otwarcie ognia do danego celu. Jeżeli celem jest "obiekt pusty" (ObjNull) nakazuje otwarcie ognia do obecnie namierzonych celów (ustawionych za pomocą DoTarget albo CommandTarget).
Przykład:
soldierOne DoFire player
unit DoFollow formationLeader
Typy zmiennych:
unit: obiekt
formationLeader: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Nakazuje (bez komunikatu radiowego) podążać za dowódcą (tj. powrot do szyku).
Przykład:
soldierOne DoFollow player
unit DoMove position
Typy zmiennych:
unit: obiekt
position: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Nakazuje (bez komunikatu radiowego) zająć podaną pozycje.
Przykład:
soldierOne DoMove getMarkerPos "MarkerMoveOne"
DoStop unit
Typy zmiennych:
unit: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Nakazuje zatrzymać się (bez komunikatu radiowego). Uwaga! - komenda CommandStop nigdy nie ulega zakończeniu tj. jednostka nigdy nie będzie gotowa (komenda UnitReady da wynik: false)
Przykład:
DoStop unitOne
unit DoTarget object
Typy zmiennych:
unit: obiekt
object: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Nakazuje (bez komunikatu radiowego) wziąść na cel obiekt.
Przykład:
soldierOne DoTarget player
unit DoWatch object
Typy zmiennych:
unit: obiekt
object: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Nakazuje (bez komunikatu radiowego) obserwować obiekt.
Przykład:
soldierOne DoWatch player
unit DoWatch position
Typy zmiennych:
unit: obiekt
position: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Nakazuje (bez komunikatu radiowego) obserwować punkt o podanych współrzędnych.
Przykład:
soldierOne DoWatch getMarkerPos "MarkerMoveOne"
Driver vehicle
Typy zmiennych:
vehicle: obiekt
Typ Zwracanej wartości:
obiekt
Opis:
Sprawdza kto jest kierowcą (driver) pojazdu. Jeżeli sprawdzany nie jest pojazd lecz osoba, ta osoba jest zwracana.
Przykład:
driver vehicle player
Drop array
Typy zmiennych:
array: wektor
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.5
Opis:
Umieszcza cząsteczki (particle) w scenie. Wektor array jest w formacie ParticleArray.
East
Typ Zwracanej wartości:
strona
Opis:
Strona wschód (zastrzeżone wyrażenie).
EnableEndDialog
Typ Zwracanej wartości:
nie zwraca
Opis:
Powoduje, że przyciski dialogowe (dialog buttons) stają się widoczne podczas trwania zewnętrznego skryptu OnPlayerKilled.
EnableRadio enable
Typy zmiennych:
enable: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Powoduje, że komunikaty radiowe przestają być (lub stają się) słyszalne i widoczne na ekranie .
Przykład:
EnableRadio false
EstimatedTimeLeft timeLeft
Typy zmiennych:
timeLeft: liczba
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.34
Opis:
Ustawia limit czasowy w grze (estimated time left). Używając tej funkcji twórca misji może umieścić wskaźnik "time left" na ekranie "Game in Progress" lub w głównym podglądzie "Master browser". Dla misji z ograniczeniem czasowym ustawionym przez Parametr1 następujący przykład może być użyty w pliku Init.sqs .
Przykład:
estimatedTimeLeft Parametr1
argument Exec script
Typy zmiennych:
argument : wektor
script: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Uruchamia skrypt zewnętrzny. Argumenty są przekazywane do skryptu przez zmienną lokalną _this. Skrypt jest najpierw szukany w folderze z misją, następnie w podfolderze skryptów kampanii i ostatecznie w globalnym folderze skryptów.
Przykład:
[player, jeepOne] exec "getIn.sqs"
Exit
Typ Zwracanej wartości:
nie zwraca
Opis:
Kończy działanie skryptu zewnętrznego.
exp x
Typy zmiennych:
x: liczba
Typ Zwracanej wartości:
liczba
Opis:
Zwraca wartość exponenta z x (e do potęgi x).
Przykład:
exp 1 , wynik to 2.7182
time FadeMusic volume
Typy zmiennych:
time: liczba
volume: liczba
Typ Zwracanej wartości:
nie zwraca
Opis:
Płynnie zmienia głośność odtwarzanej muzyki. Czas zmiany okeśla zmienna time, a docelowa głośność określa zminnna volume. Domyślnie głośność ustawiona jest na poziomie 0.5 .
Przykład:
5 fadeMusic 0
time FadeSound volume
Typy zmiennych:
time: liczba
volume: liczba
Typ Zwracanej wartości:
nie zwraca
Opis:
Płynnie zmienia głośność odtwarzanych dźwięków. Czas zmiany okeśla zmienna time, a docelowa głośność określa zminnna volume. Domyślnie głośność ustawiona jest na poziomie 1 .
Przykład:
5 fadeSound 0
false
Typ Zwracanej wartości:
zmienna logiczna
Opis:
fałsz (zastrzeżone wyrażenie).
FillWeaponsFromPool person
Typy zmiennych:
person: obiekt
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.75
Opis:
Dodaje określonej osobie magazynki do posiadanej przez nią broni z puli uzupełnień kampanii (campaign pool).
Przykład:
fillWeaponsFromPool victor
unit Fire weaponName
Typy zmiennych:
unit: obiekt
weaponName: String
Typ Zwracanej wartości:
nie zwraca
Opis:
Powoduje oddanie przez jednostkę strzału z danej broni.
Przykład:
soldierOne fire "HandGrenade"
unit Fire array
Typy zmiennych:
unit: obiekt
array: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Powoduje oddanie przez jednostkę strzału z danej broni. Format wektora array to [muzzel,mode,magazine] albo [muzzle,mode].
Przykład:
soldierOne fire ["throw","SmokeShell","SmokeShell"]
Flag unit
Typy zmiennych:
unit: obiekt
Typ Zwracanej wartości:
obiekt
Opis:
Zwraca flagę jeżeli jednostka ją posiada jeśli nie zwraca "obiekt pusty" (ObjNull).
Przykład:
flag player
FlagOwner flag
Typy zmiennych:
flag: obiekt
Typ Zwracanej wartości:
obiekt
Opis:
Zwraca osobę posiadającą daną flagę. Użyte wobec obiektu nie będącego flagą, zwraca "obiekt pusty" (ObjNull).
Przykład:
flagowner flagOne
Fleeing unit
Typy zmiennych:
unit: obiekt lub grupa
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy jednostka wycofuje się (fleeing). Dla martwych lub pustych jednostek zwraca fałsz.
Przykład:
fleeing eastReconGroup
helicopter FlyInHeight height
Typy zmiennych:
helicopter: obiekt
height: liczba
Typ Zwracanej wartości:
nie zwraca
Opis:
Ustawia wysokość lotu dla śmigłowca. Dopuszczalne wartości należą do przedziału <50,1000>.
Przykład:
cobraOne flyInHeight 150
ForceEnd
Typ Zwracanej wartości:
nie zwraca
Opis:
Kończy misję w momencie użycia komendy.
ForceMap show
Typy zmiennych:
show: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.27
Opis:
Wymusza pojawienie się mapy.
Przykład:
forceMap true
command ForEach array
Typy zmiennych:
command: łańcuch znaków
array: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Wykonuje daną komendę dla każdego elementu wektora. Każdy element wektora jest kolejno przypisywany do zmiennej lokalnej _x i wykonywana jest na nim zadana komenda.
Przykład:
"_x setdammage 1" forEach units group player
Format format
Typy zmiennych:
format: wektor
Typ Zwracanej wartości:
łańcuch znaków
Opis:
Pierwszym elementem wektora jest łańcuch znaków formatu (format string). Zawiera on znaki oraz "odnośniki" do pozostałych argumentów wektora w postaci %1, %2 itd... Każdy "odnośnik" %n zostaje zastąpiony przez odpowiedni w kolejności element wektora ("odnośniki" mogą być umieszczane w łańcuchu znaków formatu w dowolnej kolejności).
Przykład:
format ["Grupa - %2 straciła %1 ludzi", 3, "alpha"] , wynik to "Grupa alpha straciła 3 ludzi"
Formation grp
Typy zmiennych:
grp: obiekt lub grupa
Typ Zwracanej wartości:
łańcuch znaków
Opis:
Zwraca formację jaką przyjeła dana grupa. Możliwe wyniki to "COLUMN", "STAG COLUMN", "WEDGE", "ECH LEFT", "ECH RIGHT", "VEE", "LINE".
Przykład:
formation group player
FormLeader unit
Typy zmiennych:
unit: obiekt
Typ Zwracanej wartości:
obiekt
Opis:
Zwraca dowódcę formacji (formation leader). Zwykle jest to ta sama jednostka co dowódca grupy (group leader). Dla martwych jednostek zwraca obiekt pusty (ObjNull).
Przykład:
formLeader player != leader player
Fuel vehicle
Typy zmiennych:
vehicle: obiekt
Typ Zwracanej wartości:
liczba
Opis:
Zwraca wartość z przedziału <0,1> określającą jak wiele paliwa posiada dany pojazd (1 oznacza pełne zbiorniki).
Przykład:
fuel vehicle player
GetDammage object
Typy zmiennych:
object: obiekt
Typ Zwracanej wartości:
liczba
Opis:
Zwraca wartość z przedziału <0,1> określającą jak wiele uszkodzeń odniósł dany pojazd (0 oznacza brak uszkodzeń). Komenda Damage działa identycznie.
Przykład:
GetDammage player
GetDir object
Typy zmiennych:
object: obiekt
Typ Zwracanej wartości:
liczba (kąt w stopniach)
Opis:
Zwraca azymut w jakim zwrócny jest obiekt (w stopniach). Komenda ta działa identycznie jak Direction.
Przykład:
GetDir player
GetMarkerColor marker
Typy zmiennych:
marker: łańcuch znaków
Typ Zwracanej wartości:
łańcuch znaków
Wymagana wersja OFP:
1.21
Opis:
Zwraca kolor znaku (marker'a).
Przykład:
GetMarkerColor "MarkerOne"
GetMarkerPos marker
Typy zmiennych:
marker: łańcuch znaków
Typ Zwracanej wartości:
wektor
Opis:
Zwraca pozycję (współrzędne [x,y,z]) znaku (marker'a) na mapie .
Przykład:
GetMarkerPos "MarkerOne"
GetMarkerSize marker
Typy zmiennych:
marker: łańcuch znaków
Typ Zwracanej wartości:
wektor
Wymagana wersja OFP:
1.21
Opis:
Zwraca rozmiar znaku (marker'a) na mapie (format wektora rozmiaru to [oś a,oś b]).
Przykład:
GetMarkerSize "MarkerOne"
GetMarkerType marker
Typy zmiennych:
marker: łańcuch znaków
Typ Zwracanej wartości:
łańcuch znaków
Wymagana wersja OFP:
1.21
Opis:
Zwraca typ znaku (marker'a). Możliwe typy to: "Flag", "Flag1", "Dot", "Destroy", "Start", "End", "Warning", "Join", "Pickup", "Unknown", "Marker", "Arrow", "Empty".
Przykład:
GetMarkerType "MarkerOne"
GetPos object
Typy zmiennych:
object: obiekt
Typ Zwracanej wartości:
wektor
Opis:
Zwraca pozycję (współrzędne) obiektu na mapie.
Przykład:
getPos player
GetWPPos waypoint
Typy zmiennych:
waypoint: wektor
Typ Zwracanej wartości:
wektor
Wymagana wersja OFP:
1.21
Opis:
Zwraca pozycję punktu trasy (waypoint'a). Format wektora waypoint to: [grupa,numer].
Przykład:
getWPPos [groupOne, 0]
unit GlobalChat chatText
Typy zmiennych:
unit: obiekt
chatText: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Wysyła komunikat tekstowy do globalnego kanału radiowego (global radio channel).
Przykład:
soldierOne globalChat "Show this text"
unit GlobalRadio radioName
Typy zmiennych:
unit: obiekt
radioName: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Wysyła komunikat do globalnego kanału radiowego (global radio channel). Komunikat musi być zdefiniowany w pliku description.ext
Przykład:
soldierOne globalRadio "messageOne"
Goto label
Typy zmiennych:
label: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Instrukcja skoku bezwarunkowego używana w skryptach zewnętrznych. Powoduje skok do miejsca oznaczonego etykietą (label).
Przykład:
goto "Loop"
Group object
Typy zmiennych:
object: obiekt
Typ Zwracanej wartości:
grupa
Opis:
Zwraca grupę do której należy jednostka. W przypadku martwych jednostek zwraca grupę pustą (GrpNull)
Przykład:
group player == group leader player
unit GroupChat chatText
Typy zmiennych:
unit: obiekt
chatText: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Wysyła komunikat tekstowy (wyłącznie tekst) do kanału radiowego grupy (group radio channel).
Przykład:
soldierOne GroupChat "Show this text"
unit GroupRadio radioName
Typy zmiennych:
unit: obiekt
radioName: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Wysyła komunikat (tekst i dźwięk) do kanału radiowego grupy (group radio channel). Komunikat musi być zdefiniowany w pliku description.ext
Przykład:
soldierOne GroupRadio "messageOne"
GrpNull
Typ Zwracanej wartości:
grupa
Opis:
Nie istniejąca grupa. Ta wartość nie jest niczemu równa (nawet sobie samej)
Przykład:
group player == GrpNull , wynik to false
Gunner vehicle
Typy zmiennych:
vehicle: obiekt
Typ Zwracanej wartości:
obiekt
Opis:
Sprawdza kto jest operatorem broni (gunner) pojazdu. Jeżeli sprawdzany nie jest pojazd lecz osoba, ta osoba jest zwracana.
Przykład:
Gunner vehicle player
HandsHit soldier
Typy zmiennych:
soldier: obiekt
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy ręce żołnierza zostały zranione (co ujemnie wpływa na celowanie).
Przykład:
handsHit leader player
unit HasWeapon weaponName
Typy zmiennych:
unit: obiekt
weaponName: łańcuch znaków
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy żołnierz posiada broń danego typu.
Przykład:
player hasWeapon "M16"
Hint text
Typy zmiennych:
text: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Wyświetla okno ze wskazówką (hint). Tekst może składać się z wielu linii (wpisz \n by zaznaczyć koniec linii).
Przykład:
hint "Press W to move forward"
HintC text
Typy zmiennych:
text: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Wyświetla okno ze wskazówką (hint) i wstrzymuje akcję do momentu potwierdzenia. Tekst może składać się z wielu linii (wpisz \n by zaznaczyć koniec linii).
Przykład:
hintC "Press W to move forward"
HintCadet text
Typy zmiennych:
text: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Wyświetla okno ze wskazówką (hint), gdy ustawiony jest stopień trudności gry "Kadet". Tekst może składać się z wielu linii (wpisz \n by zaznaczyć koniec linii).
Przykład:
hintCadet "Press W to move forward"
x In array
Typy zmiennych:
x: dowolny
array: wektor
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy x jest równe któremuś z elementów wektora array.
Przykład:
1 In [0, 1, 2] , wynik to true
soldier In vehicle
Typy zmiennych:
soldier: obiekt
vehicle: obiekt
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy jednostka znajduje się w pojeździe.
Przykład:
player in jeepOne
fireplace InFlame burn
Typy zmiennych:
fireplace: obiekt
burn: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Komenda kontrolująca zapalanie i gaśnięcie ognia.
Przykład:
fireplaceOne inflame true
InFlamed fireplace
Typy zmiennych:
fireplace: obiekt
Typ Zwracanej wartości:
wartość logiczna
Wymagana wersja OFP:
1.04
Opis:
Komenda kontrolująca zapalanie i gaśnięcie ognia.
Przykład:
inflamed fireplaceOne
IsNull grp
Typy zmiennych:
grp: grupa
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sparwdza czy grupa jest grupą pustą (grpNull). Wyrażenie groupOne==grpNull nie zadziała, gdyż grpNull nie jest niczemu równe, nawet sobie samemu.
Przykład:
isNull group player , wynik to false
IsNull obj
Typy zmiennych:
obj: obiekt
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sparwdza czy obiekt jest obiektem pustym (objNull). Wyrażenie soldierOne==objNull nie zadziała, gdyż objNull nie jest niczemu równe, nawet sobie samemu.
Przykład:
isNull objNull , wynik to true
unitArray Join group
Typy zmiennych:
unitArray: wektor
group: obiekt lub grupa
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.33 dla misji MultiPlayer
Opis:
Powoduje przyłacznie się jednostek będących elementami wektora unitArray do grupy group (lub do grupy do której należy podana jednostka). Liczba jednostek w grupie nie może przekroczyć 12.
Przykład:
[unitOne, unitTwo] Join player
unit KnowsAbout target
Typy zmiennych:
unit: obiekt
target: obiekt
Typ Zwracanej wartości:
liczba
Opis:
Sprawdza czy i ile jednostka unit wie jednostce target. Jeżeli jednostka unit jest pojazdem pod uwagę brany jest jej dowódca (commander).
Przykład:
soldierOne KnowsAbout jeepOne
helicopter Land land
Typy zmiennych:
helicopter: obiekt
land: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Zmusza helikopter do lądowania. Helikopter może lądować na trzy sposoby:
"LAND" - lądowanie i wyłączenie silnika, "GET IN" - lądowanie i oczekiwanie na załadunek desantu(z włączonym silnikiem), "GET OUT" - lądowanie i oczekiwanie na rozładunek desantu (z włączonym silnikiem).
Przykład:
cobraOne land "LAND"
LbAdd [idc, text]
Typy zmiennych:
[idc, text]: wektor
Typ Zwracanej wartości:
liczba
Wymagana wersja OFP:
1.5
Opis:
Dodaje przedmiot (item) opatrzony danym tekstem do "pudełka listowego" (listbox) lub "pudełka podręcznego" (combobox) z identyfikatorem idc najwyższego dialogu użytkownika (topmost user dialog). Zwraca index dodanego przedmiotu.
Przykład:
_index = lbAdd [101, "First item"]
LbClear idc
Typy zmiennych:
idc: liczba
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.5
Opis:
Usuwa wszystkie przedmioty (items) z "pudełka listowego" (listbox) lub "pudełka podręcznego" (combobox) z identyfikatorem idc najwyższego dialogu użytkownika (topmost user dialog).
Przykład:
lbClear 101
LbColor [idc, index]
Typy zmiennych:
[idc, index]: wektor
Typ Zwracanej wartości:
wektor
Wymagana wersja OFP:
1.5
Opis:
Zwraca kolor tekstu lub przedmiotu, określonego indeksem index, z "pudełka listowego" (listbox) lub "pudełka podręcznego" (combobox) z identyfikatorem idc najwyższego dialogu użytkownika (topmost user dialog). Kolor jest w formacie [r,b,g,a], gdzie pierwsze trzy elementy wektora to parametry RGB (red-green-blue), a ostatni to "przezroczystość" (alpha) - wszystkie przyjmują warości z przedziału <0,1>.
Przykład:
_color = lbColor [101, 0]
LbCurSel idc
Typy zmiennych:
idc: liczba
Typ Zwracanej wartości:
liczba
Wymagana wersja OFP:
1.5
Opis:
Zwraca indeks wybranego przedmiotu (item) z "pudełka listowego" (listbox) lub "pudełka podręcznego" (combobox) z identyfikatorem idc najwyższego dialogu użytkownika (topmost user dialog).
Przykład:
_index = lbCurSel 101
LbData [idc, index]
Typy zmiennych:
[idc, index]: wektor
Typ Zwracanej wartości:
łańcuch znaków
Wymagana wersja OFP:
1.5
Opis:
Zwraca dodatkowy tekst (niewidoczny), którym opatrzony jest przedmiot, określony indeksem index, z "pudełka listowego" (listbox) lub "pudełka podręcznego" (combobox) z identyfikatorem idc najwyższego dialogu użytkownika (topmost user dialog). .
Przykład:
_data = lbData [101, 0]
LbDelete [idc, index]
Typy zmiennych:
[idc, index]: wektor
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.5
Opis:
Usuwa przedmiot (item), określony indeksem index, z "pudełka listowego" (listbox) lub "pudełka podręcznego" (combobox) z identyfikatorem idc najwyższego dialogu użytkownika (topmost user dialog).
Przykład:
lbDelete [101, 0]
LbPicture [idc, index]
Typy zmiennych:
[idc, index]: wektor
Typ Zwracanej wartości:
łańcuch znaków
Wymagana wersja OFP:
1.5
Opis:
Zwraca nazwę obrazka umieszczonego na przedmiocie (item), określonym indeksem index, z "pudełka listowego" (listbox) lub "pudełka podręcznego" (combobox) z identyfikatorem idc najwyższego dialogu użytkownika (topmost user dialog).
Przykład:
_picture = lbPicture [101, 0]
LbSetColor [idc, index, color]
Typy zmiennych:
[idc, index, color]: wektor
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.5
Opis:
Ustawia kolor przedmiotu, określonego indeksem index, z "pudełka listowego" (listbox) lub "pudełka podręcznego" (combobox) z identyfikatorem idc najwyższego dialogu użytkownika (topmost user dialog). Kolor jest w formacie [r,b,g,a], gdzie pierwsze trzy elementy wektora to parametry RGB (red-green-blue), a ostatni to "przezroczystość" (alpha) - wszystkie przyjmują warości z przedziału <0,1>.
Przykład:
lbSetColor [101, 0, [0, 1, 0, 0.5]]
LbSetCurSel [idc, index]
Typy zmiennych:
[idc, index]: wektor
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.5
Opis:
Wybiera przedmiot (item), określony indeksem index, z "pudełka listowego" (listbox) lub "pudełka podręcznego" (combobox) z identyfikatorem idc najwyższego dialogu użytkownika (topmost user dialog).
Przykład:
lbSetCurSel [101, 0]
LbSetData [idc, index, data]
Typy zmiennych:
[idc, index, data]: wektor
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.5
Opis:
Dodaje dodatkowy tekst (niewidoczny), którym opatrzony jest przedmiot, określony indeksem index, z "pudełka listowego" (listbox) lub "pudełka podręcznego" (combobox) z identyfikatorem idc najwyższego dialogu użytkownika (topmost user dialog).
Przykład:
lbSetData [101, 1, "#1"]
LbSetPicture [idc, index, name]
Typy zmiennych:
[idc, index, name]: wektor
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.5
Opis:
Dodaje obrazek do przedmiotu (item), określonego indeksem index, z "pudełka listowego" (listbox) lub "pudełka podręcznego" (combobox) z identyfikatorem idc najwyższego dialogu użytkownika (topmost user dialog). Obrazek o nazwie określonej przez element wektora name jest szukany kolejno w: folderze misji, podkatalogu dtaExt w katalogu kampanii i w globalnym katalogu Data.
Przykład:
lbSetPicture [101, 0, "iskoda"]
LbSetValue [idc, index, value]
Typy zmiennych:
[idc, index, value]: wektor
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.5
Opis:
Dodaje dodatkową wartość liczbową do przedmiotu (item), określonego indeksem index, z "pudełka listowego" (listbox) lub "pudełka podręcznego" (combobox) z identyfikatorem idc najwyższego dialogu użytkownika (topmost user dialog).
Przykład:
lbSetValue [101, 0, 1]
LbSize idc
Typy zmiennych:
idc: liczba
Typ Zwracanej wartości:
liczba
Wymagana wersja OFP:
1.5
Opis:
Zwraca ilość przedmiotów (items) w "pudełku listowym" (listbox) lub "pudełku podręcznym" (combobox) z identyfikatorem idc najwyższego dialogu użytkownika (topmost user dialog).
Przykład:
_n = lbSize 101
LbText [idc, index]
Typy zmiennych:
[idc, index]: wektor
Typ Zwracanej wartości:
łańcuch znaków
Wymagana wersja OFP:
1.5
Opis:
Zwraca tekst którym opatrzony jest przedmiot (item), określony indeksem index, z "pudełka listowego" (listbox) lub "pudełka podręcznego" (combobox) z identyfikatorem idc najwyższego dialogu użytkownika (topmost user dialog). Zwraca index dodanego przedmiotu.
Przykład:
_text = lbText [101, 0]
LbValue [idc, index]
Typy zmiennych:
[idc, index]: wektor
Typ Zwracanej wartości:
liczba
Wymagana wersja OFP:
1.5
Opis:
Zwraca dodatkową wartość liczbową dodaną do przedmiotu (item), określonego indeksem index, z "pudełka listowego" (listbox) lub "pudełka podręcznego" (combobox) z identyfikatorem idc najwyższego dialogu użytkownika (topmost user dialog).
Przykład:
_value = lbValue [101, 0]
LbValue [idc, index]
Typy zmiennych:
[idc, index]: wektor
Typ Zwracanej wartości:
liczba
Wymagana wersja OFP:
1.5
Opis:
Zwraca dodatkową wartość liczbową dodaną do przedmiotu (item), określonego indeksem index, z "pudełka listowego" (listbox) lub "pudełka podręcznego" (combobox) z identyfikatorem idc najwyższego dialogu użytkownika (topmost user dialog).
Przykład:
_value = lbValue [101, 0]
Leader unit
Typy zmiennych:
unit: obiekt
Typ Zwracanej wartości:
obiekt
Opis:
Zwraca dowódcę grupy (group leader) do której należy jednostka unit. Dla martwej jednostki zwraca obiekt pusty (ObjNull)
Przykład:
leader player
Leader grp
Typy zmiennych:
grp: grupa
Typ Zwracanej wartości:
obiekt
Opis:
Zwraca dowódcę grupy (group leader). Dla grupy już nieistniejącej zwraca grupę pustą (GrpNull)
Przykład:
leader group player == leader player
group LeaveVehicle vehicle
Typy zmiennych:
group: vehicle
vehicle: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Nakazuje jednostkom, należącym do grupy group, opuścić pojazd vehicle i odwołuje ich przypisanie (UnAssign) do niego.
Przykład:
groupOne leaveVehicle jeepOne
unit LeaveVehicle vehicle
Typy zmiennych:
unit: obiekt
vehicle: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Nakazuje jednostce unit opuścić pojazd vehicle i odwołuje jej przypisanie (UnAssign) do niego.
Przykład:
soldierOne leaveVehicle jeepOne
LightIsOnlampPost
Typy zmiennych:
lampPost: obiekt
Typ Zwracanej wartości:
łańcuch znaków
Wymagana wersja OFP:
1.04
Opis:
Sprawdza czy latarnia jest włączona (świeci). Zwraca trzy rodzaje łańcuchów znaków: "ON", "OFF", "AUTO" (auto oznacza domyślny tryb tj. świecenie w nocy).
Przykład:
lightIsOn nearestObject [player, "StreetLamp"] != "OFF"
List trigger
Typy zmiennych:
trigger: obiekt
Typ Zwracanej wartości:
wektor
Opis:
Zwraca listę jednostek, które aktywowały wyzwalacz trigger.
Przykład:
list triggerOne
ln x
Typy zmiennych:
x: liczba
Typ Zwracanej wartości:
liczba
Opis:
logarytm naturalny z x (logarytm o podstawie e z liczby x)
Przykład:
ln 10 , wynik to 2.302
person LoadIdentity name
Typy zmiennych:
person: obiekt
name: łańcuch znaków
Typ Zwracanej wartości:
wartość logiczna
Wymagana wersja OFP:
1.75
Opis:
Nadaje obiektowi person osobowość (person's' identity), określoną nazwą name, z pliku object.sav znajdującego się w folderze kampanii.
Przykład:
player loadIdentity "playerIdentity"
person LoadStatus name
Typy zmiennych:
person: obiekt
name: łańcuch znaków
Typ Zwracanej wartości:
wartość logiczna
Wymagana wersja OFP:
1.75
Opis:
Nadaje obiektowi person cechy (object's properties), określone nazwą name, z pliku object.sav znajdującego się w folderze kampanii.
Przykład:
player loadStatus "playerState"
Local obj
Typy zmiennych:
obj: obiekt
Typ Zwracanej wartości:
wartość logiczna
Opis:
Stosowane w misjach MultiPlayer. Sprawdza czy jednostka jest typu lokalnego (local) na komputerze. Komenda może być użyta np. w polach aktywacji (activation fields) lub w skryptach które mają być wykonywane tylko na jednym komputerze. W misjach SinglePlayer wszystkie obiekty są typu lokalnego. Obiekty statyczne są wszędzie lokalne.
Przykład:
local unitName
Localize stringName
Typy zmiennych:
stringName: łańcuch znaków
Typ Zwracanej wartości:
łańcuch znaków
Opis:
Zastępuje łańcuch znaków, o nazwie stringName, odpowiadającym mu łańcuchem znaków z pliku stringtable.csv (poszukiwanie pliku zaczyna od folderu z misją), w języku wykrytej wersji OFP. Służy do tworzenia misji, które mogą być używane na obco języcznych wersjach OFP.
Przykład:
localize "STR_DN_FROG"
vehicle Lock lock
Typy zmiennych:
vehicle: obiekt
lock: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Aktywuje/dezaktywuje zamek pojazdu, który uniemożliwia graczowi wsiadanie i wysiadanie z niego.
Przykład:
jeepOne lock true
Locked vehicle
Typy zmiennych:
vehicle: obiekt
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy zamek pojazdu jest aktywny. Jeżeli zamek jest aktywny gracz nie może wsiadać/wysiadać z pojazdu bez otrzymania uprzednio rozkazu.
Przykład:
locked jeepOne
group LockWP lock
Typy zmiennych:
group: grupa albo obiekt
lock: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Uniemożliwia przejście do następnego punktu trasy (waypoint).Obecny punkt trasy nie będzie traktowany jako ukończony tak długo jak komenda pozostanie aktywna. Komenda używana czasem podczas przerywników filmowych.
Przykład:
groupOne lockWP true
log x
Typy zmiennych:
x: liczba
Typ Zwracanej wartości:
liczba
Opis:
logarytm dziesiętny z x (logarytm o podstawie 10 z liczby x)
Przykład:
log 100 , wynik to 2
Magazine vehicle
Typy zmiennych:
vehicle: obiekt
Typ Zwracanej wartości:
wektor
Wymagana wersja OFP:
1.75
Opis:
Zwraca wektor, którego elementami są nazwy broni posiadanych przez obiekt.
Przykład:
magazines player
MapAnimAdd frame
Typy zmiennych:
frame: wektor
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.27
Opis:
Dodaje następną klatkę (frame) do animacji mapy (map animation). Format wektora frame to [time,zoom,[x,y]].
Przykład:
mapAnimAdd [1, 0.1, getMarkerPos "anim1"]
MapAnimClear
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.27
Opis:
usuwa animację mapy (map animation).
MapAnimCommit
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.27
Opis:
Odtwarza animację mapy (map animation).
MapAnimDone
Typ Zwracanej wartości:
wartość logiczna
Wymagana wersja OFP:
1.27
Opis:
Sprawdza czy animacja mapy (map animation) została wykonana.
MarkerColor markerName
Typy zmiennych:
markerzName: łańcuch znaków
Typ Zwracanej wartości:
łańcuch znaków
Wymagana wersja OFP:
1.5
Opis:
Zwraca kolor znaku (marker'a). Komenda działa identycznie jak komenda GetMarkerColor (zastępuje ją).
Przykład:
MarkerColor "MarkerOne"
MarkerPos markerName
Typy zmiennych:
markerName: łańcuch znaków
Typ Zwracanej wartości:
wektor
Wymagana wersja OFP:
1.5
Opis:
Zwraca pozycję (współrzędne [x,y,z]) znaku (marker'a) na mapie. Komenda działa identycznie jak komendaGetMarkerPos (zastępuje ją).
Przykład:
MarkerPos "MarkerOne"
MarkerSize markerName
Typy zmiennych:
markerName: łańcuch znaków
Typ Zwracanej wartości:
wektor
Wymagana wersja OFP:
1.5
Opis:
Zwraca rozmiar znaku (marker'a) na mapie (format wektora rozmiaru to [oś a,oś b]). Komenda działa identycznie jak komenda GetMarkerSize (zastępuje ją).
Przykład:
MarkerSize "MarkerOne"
MarkerType markerName
Typy zmiennych:
markerName: łańcuch znaków
Typ Zwracanej wartości:
łańcuch znaków
Wymagana wersja OFP:
1.5
Opis:
Zwraca typ znaku (marker'a). Możliwe typy to: "Flag", "Flag1", "Dot", "Destroy", "Start", "End", "Warning", "Join", "Pickup", "Unknown", "Marker", "Arrow", "Empty". Komenda działa identycznie jak komenda GetMarkerType (zastępuje ją).
Przykład:
MarkerType "MarkerOne"
a mod b
Typy zmiennych:
a: liczba
b: liczba
Typ Zwracanej wartości:
liczba
Opis:
Reszta z dzielenia a przez b. Zwrócona przez komendę liczba jest liczbą rzeczywistą.
Przykład:
3 mod 2 , wynik to 1
group Move pos
Typy zmiennych:
group: grupa albo obiekt
pos: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Tworzy dla grupy punkt trasy (waypoint) na podanej pozycji i czyni go aktualnym tj. następnym do którego grupa się uda.
Przykład:
groupOne move getPos player
soldier MoveInCargo vehicle
Typy zmiennych:
soldier: obiekt
vehicle: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Przenosi osobę na miejsce pasażera (Cargo) w pojeździe (natychmiast tj. bez animacji).
Przykład:
soldierOne moveInCargo jeepOne
soldier MoveInCommander vehicle
Typy zmiennych:
soldier: obiekt
vehicle: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Przenosi osobę na miejsce dowódcy (Commander) w pojeździe (natychmiast tj. bez animacji).
Przykład:
soldierOne moveInCommander TankOne
soldier MoveInDriver vehicle
Typy zmiennych:
soldier: obiekt
vehicle: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Przenosi osobę na miejsce kierowcy (Driver) w pojeździe (natychmiast tj. bez animacji).
Przykład:
soldierOne moveInDriver TankOne
soldier MoveInGunner vehicle
Typy zmiennych:
soldier: obiekt
vehicle: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Przenosi osobę na miejsce operatora broni (Gunner) w pojeździe (natychmiast tj. bez animacji).
Przykład:
soldierOne moveInGunner TankOne
MusicVolume
Typ Zwracanej wartości:
liczba
Opis:
Zwraca aktualną głośność odtwarzania muzyki jako liczbę z przedziału <0,1>.
Name object
Typy zmiennych:
object: obiekt
Typ Zwracanej wartości:
łańcuch znaków
Opis:
Zwraca nazwę zmiennej przypisanej do danego obiektu w edytorze misji. Gdy użyta jest w stosunku do pojazdu zwraca nazwę pierwszego członka jego załogi (w kolejności: commander, driver, gunner).
Przykład:
name vehicle player
NearestBuilding object
Typy zmiennych:
object: obiekt
Typ Zwracanej wartości:
obiekt
Opis:
Zwraca budynek znajdujący się najbliżej obiektu.
Przykład:
neareastBuilding player
NearestObject array
Typy zmiennych:
array: wektor
Typ Zwracanej wartości:
obiekt
Opis:
Zwraca budynek danego typu, znajdujący się najbliżej podanych wspórzędnych albo obiektu. Wektor może być w formacie [x,y,z,"type"] albo [object,"type"].
Przykład:
nearestObject [player, "StreetLamp"]
nil
Typ Zwracanej wartości:
dowolna
Opis:
Wartość "zerowa", która może zostać użyta do "czyszczenia" istniejących zmiennych.
Przykład:
variableToDestroy = nil
NOT a
Typy zmiennych:
a: wartość logiczna
Typ Zwracanej wartości:
wartość logiczna
Opis:
"Nie a" czyli negacja.
Przykład:
not false , wynik to true
Object id
Typy zmiennych:
id: liczba
Typ Zwracanej wartości:
obiekt
Wymagana wersja OFP:
1.75
Opis:
Zwraca obiekt określony identyfikatorem id. Identyfikatory obiektów mogą być sprawdzone w edytorze misji (w wersji 1.75 OFP lub wyższej).
Przykład:
object 1
ObjNull
Typ Zwracanej wartości:
obiekt
Opis:
Nie istniejący obiekt. ObjNull nie jest niczemu równy, nawet sobie samemu.
Przykład:
player == objNull , wynik to false
objective ObjStatus status
Typy zmiennych:
objective: łańcuch znaków
status: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Ustawia stan wykonania celów misji (objectives) podanych podczas odprawy (Briefing). Możeliwe do ustawienia wartości to: "ACTIVE"(widoczny i nie wykonany), "FAILED" (niepowodzenie), "DONE"(wykonany),"HIDDEN"(ukryty).
Przykład:
"obj_1" objStatus "FAILED"
OnBriefingGear sound
Typy zmiennych:
sound: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.75
Opis:
Określa dźwięk jaki zostanie odegrany, gdy sekcja ekwipunek (gear) podczas odprawy (Briefing), zostanie po raz pierwszy wybrana.
Przykład:
onBriefingGear "GearVoiceOver"
OnBriefingGroup sound
Typy zmiennych:
sound: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.75
Opis:
Określa dźwięk jaki zostanie odegrany, gdy sekcja grupa (group) podczas odprawy (Briefing), zostanie po raz pierwszy wybrana.
Przykład:
onBriefingGroup "GroupVoiceOver"
OnBriefingNotes sound
Typy zmiennych:
sound: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.75
Opis:
Określa dźwięk jaki zostanie odegrany, gdy sekcja notatki (notes) podczas odprawy (Briefing), zostanie po raz pierwszy wybrana.
Przykład:
onBriefingNotes "NotesVoiceOver"
OnBriefingPlan sound
Typy zmiennych:
sound: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.75
Opis:
Określa dźwięk jaki zostanie odegrany, gdy sekcja plan (Plan) podczas odprawy (Briefing), zostanie po raz pierwszy wybrana.
Przykład:
onBriefingPlan "PlanVoiceOver"
a OR b
Typy zmiennych:
a: wartość logiczna
b: wartość logiczna
Typ Zwracanej wartości:
wartość logiczna
Opis:
"a lub b" czyli alternatywa
Przykład:
not alive player or not alive leader player
unitArray OrderGetIn order
Typy zmiennych:
unitArray: wektor
order: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Nakazuje wsiąść do przypisanego im pojazdu(za pomocom komendy AssignAs...) wszystkim jednostkom będącym elemntami wektora unitArray.
Przykład:
[unitOne, unitTwo] orderGetIn true
Pi
Typ Zwracanej wartości:
obiekt
Opis:
Liczba Pi (180 stopni wyrażone w radianach).
Przykład:
pi , wynik to 3.1415
Player
Typ Zwracanej wartości:
obiekt
Opis:
Wyrażenie zastrzeżone. Osoba kontrolowana przez gracza. W MultiPlayer'rze zwraca różne wartości na różnych komputerach.
Przykład:
alive player
soldier PlayMove moveName
Typy zmiennych:
soldier: obiekt
moveName: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Powoduje, że osoba soldier wykonuje animacje określonego typu.
Przykład:
soldierOne playMove "Stand"
PlayMusic musicName
Typy zmiennych:
musicName: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Powoduje odegranie ścieżki dźwiękowej zdefiniowanej w pliku description.ext .
Przykład:
playMusic "musicname"
PlayMusic nameAndPos
Typy zmiennych:
nameAndPos: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Powoduje odegranie ścieżki dźwiękowej zdefiniowanej w pliku description.ext od określonego miejsca w utworze. Format wektora nameAndPos to: [name, position], gdzie position to długość fragmentu w sekundach jaka ma być pominięta.
Przykład:
playMusic ["Track13", 30]
PlaySound soundName
Typy zmiennych:
soundName: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Powoduje odegranie dźwięku zdefiniowanego w pliku description.ext .
Przykład:
playMusic "musicname"
Position object
Typy zmiennych:
object: obiekt
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.5
Opis:
Zwraca pozycję (współrzędne) obiektu na mapie. Komenda ta działa identycznie jak komenda GetPos (zastępuje ją).
Przykład:
position player
PrimaryWeapon vehicle
Typy zmiennych:
vehicle: obiekt
Typ Zwracanej wartości:
łańcuch znaków
Wymagana wersja OFP:
1.75
Opis:
Zwraca nazwę głównej broni (primary weapon) obiektu. Jeżeli obiekt nie posiada uzbrojenia zwraca pusty łańcuch znaków.
Przykład:
primaryWeapon player
PublicVariable varName
Typy zmiennych:
varName: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Wysyła wartość zmiennej do wszystkich komputerów w rozgrywce MultiPlayer. Dopuszczalne formaty zmiennej to: liczba (w wersji OFP 1.33 i wcześniejszych) oraz wartość logiczna, obiekt, grupa (w wersji OFP 1.34 i późniejszych).
Przykład:
publicVariable "CTFscoreOne"
Rad x
Typy zmiennych:
x: liczba (kąt w stopniach)
Typ Zwracanej wartości:
liczba
Opis:
Zwraca miarę kąta w radianach dla podanej miary kąta w stopniach.
Przykład:
rad 180 , result is 3.1415
Random x
Typy zmiennych:
x: liczba
Typ Zwracanej wartości:
liczba
Opis:
Zwraca losową rzeczywistą liczbę z przdziału <0,x>.
Przykład:
random 1
Rating unit
Typy zmiennych:
unit: obiekt
Typ Zwracanej wartości:
liczba
Opis:
Zwraca wartość oceny jednostki (unit rating). Może być modyfikowna przez twórcę misji za pomocą komendy AddRating. Używane do nagradzania z wykonanie celów misji. Wartość oceny za wyeliminowanych wrogów dodawana jest automatycznie. Kiedy ocena jednostki spadnie poniżej zera (np. w wyniku weliminowania jednostek swojej strony) staje się renegatem, i jest uważana za wroga dla wszystkich.
Przykład:
rating player
unit RemoveAction index
Typy zmiennych:
unit: obiekt
index: liczba
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.11
Opis:
Usuwa akcję o danym identyfikatorze index z menu akcji jednostki unit.
Przykład:
player removeAction 0
RemoveAllWeapons unit
Typy zmiennych:
unit: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Usuwa wszystkie bronie posiadane przez jednostkę.
Przykład:
removeAllWeapons player
unit RemoveMagazine weaponName
Typy zmiennych:
unit: obiekt
weaponName: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Usuwa magazynek, do okreslonej broni, posiadany przez jednostkę. Uwaga!-Można tworzyć niedozwolone kombinacje podając nazwę broni. Efekt działania aplikacji jest wtedy nieprzewidywalny.
Przykład:
player removeMagazine "M16"
unit RemoveMagazines weaponName
Typy zmiennych:
unit: obiekt
weaponName: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Usuwa wszystkie magazynki, do okreslonej broni, posiadane przez jednostkę. Uwaga!-Można tworzyć niedozwolone kombinacje podając nazwę broni. Efekt działania aplikacji jest wtedy nieprzewidywalny.
Przykład:
player removeMagazines "M16"
unit RemoveWeapon weaponName
Typy zmiennych:
unit: obiekt
weaponName: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Usuwa broń, określonego typu, posiadaną przez jednostkę. Uwaga!-Można tworzyć niedozwolone kombinacje podając nazwę broni. Efekt działania aplikacji jest wtedy nieprzewidywalny.
Przykład:
player removeWeapon "M16"
RequiredVersion version
Typy zmiennych:
version: łańcuch znaków
Typ Zwracanej wartości:
wartość logiczna
Wymagana wersja OFP:
1.21
Opis:
Sprawdza czy jest uruchomiona dana wersja OFP. Jeśli nie wyświetla komunikat ostrzegawczy i zwraca false.
Przykład:
requiredVersion "1.30"
Resistance
Typ Zwracanej wartości:
strona
Opis:
Strona partyzanci (zastrzeżone wyrażenie).
array Resize count
Typy zmiennych:
array: wektor
count: liczba
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.75
Opis:
Zmienia rozmiar wektora. Może być użyte do dodawania albo usuwania elementów wektora.
Przykład:
array resize 2
group Reveal unit
Typy zmiennych:
group: grupa lub obiekt
unit: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Ujawnia obecność jednostki bez względu na to czy obserwator może ją widzieć czy nie.
Przykład:
soldierOne reveal soldierTwo
SaveGame
Typ Zwracanej wartości:
nie zwraca
Opis:
Zapisuje stan gry.
person SaveIdentity name
Typy zmiennych:
person: obiekt
name: łańcuch znaków
Typ Zwracanej wartości:
wartość logiczna
Wymagana wersja OFP:
1.75
Opis:
Zapisuje osobowość obiektu person (person's' identity), określoną nazwą name, w pliku object.sav znajdującym się w folderze kampanii.
Przykład:
player SaveIdentity "playerIdentity"
person SaveStatus name
Typy zmiennych:
person: obiekt
name: łańcuch znaków
Typ Zwracanej wartości:
wartość logiczna
Wymagana wersja OFP:
1.75
Opis:
Zapisuje cechy obiektu person (object's properties), określone nazwą name, w pliku object.sav znajdującym się w folderze kampanii.
Przykład:
player SaveStatus "playerState"
SaveVar varName
Typy zmiennych:
varName: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Zapisuje wartość zmiennej do "przestrzeni" kampanii (campaign space). Zmienna ta jest dostępna we wszystkich kolejnych misjach tej kampanii.
Przykład:
saveVar "varOne"
unit Say speechName
Typy zmiennych:
unit: obiekt
speechName: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
powoduje, że obiekt odegra dany dźwięk. Jeżeli obiekt jest osobą odtworzy skojarzony z dźwiękiem ruch warg (lipsync effect). Dźwięki muszą być zdefiniowane w pliku description.ext .
Przykład:
soldierOne say "speechId"
unit Say speechArray
Typy zmiennych:
unit: obiekt
speechArray: wektor
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.75
Opis:
powoduje, że obiekt odegra dany dźwięk. Jeżeli obiekt jest osobą odtworzy skojarzony z dźwiękiem ruch warg (lipsync effect). Dźwięki muszą być zdefiniowane w pliku description.ext. Format wektora speechArray to: [sound, maxTitlesDistance], gdzie sound to nazwa dźwięku, a maxTitlesDistance określa odległość, od źródła dżwięku, w promieniu której napisy towarzyszące (titles) będą wyświetlne.
Przykład:
soldierOne say "speechId"
Score unit
Typy zmiennych:
unit: obiekt
Typ Zwracanej wartości:
liczba
Opis:
Sprawdza punktację (score) jednostki w rozgrywce MultiPlayer.
Przykład:
score unitOne
ScudState scud
Typy zmiennych:
scud: obiekt
Typ Zwracanej wartości:
liczba
Wymagana wersja OFP:
1.28
Opis:
Zwraca liczbę rzeczywistę określającą stan przygotowania wyrzutni Scud do odpalenia rakiety. Następujące stany są rozróżniane: 0 - brak przygotowań, 1 - przygotowanie do odpalenia, 2 - gotowość do odpalenia, 3 - zapłon, 4 - odpalenie. Wartości nie całkowite są używane, by podkreślić płynne przejście między stanami.
Przykład:
scudState scudOne>=4
SecondaryWeapon vehicle
Typy zmiennych:
vehicle: obiekt
Typ Zwracanej wartości:
łańcuch znaków
Wymagana wersja OFP:
1.75
Opis:
Zwraca nazwę pomocniczej broni (secondary weapon) danego pojazdu. Jeżeli pojazd jej nie posiada zwraca pusty łańcuch znaków.
Przykład:
secondaryWeapon player
array Select index
Typy zmiennych:
array: wektor
index: wartość logiczna
Typ Zwracanej wartości:
dowolny
Opis:
Zwraca pierwszy element wektora jeżeli index jest równy false albo drugi element wektora jeżeli index jest równy true.
array Select index
Typy zmiennych:
array: wektor
index: liczba
Typ Zwracanej wartości:
dowolny
Opis:
Zwraca określony element wektora. Zmienna index równa 0 wskazuje na pierwszy element, równa 1 na drugi itd..
Przykład:
[1, 2, 3] select 1 , wynik to 2
unit SelectWeapon weapon
Typy zmiennych:
unit: obiekt
weapon: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.27
Opis:
nakazuje jednostce wybrać daną broń.
Przykład:
soldierOne selectWeapon "LAWLauncher"
array Set element
Typy zmiennych:
array: wektor
element: wektor
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.75
Opis:
Zmienia określony element wektora. Jeżeli wskazany element nie istnieje, tworzy go i dodaje na koniec wektora.
Przykład:
array set [0, "Hello"]
SetAccTime accFactor
Typy zmiennych:
accFactor: liczba
Typ Zwracanej wartości:
nie zwraca
Opis:
Zmienia prędkość z jaką upływa czas w grze. Domyślenie zmienna accFactor ma wartość 1.
Przykład:
setAccTime 0.5 zwolni dwukrotnie upływ czasu.
vehicle SetAmmoCargo ammoCargo
Typy zmiennych:
vehicle: obiekt
ammoCargo: liczba
Typ Zwracanej wartości:
nie zwraca
Opis:
Zmienia wielkość zasobów amunicji (amount of ammo resources) w danym pojeździe wsparcia. Zasoby amunicji używane są jedynie do zaopatrywania pojazdów. Zmienna ammoCargo równa 1 oznacza pełen zapas.
Przykład:
rearmTruckOne setAmmoCargo 0
group SetBehaviour behaviour
Typy zmiennych:
group: grupa albo obiekt
behaviour: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Ustawia tryb zachowania (behaviour mode) grupy. Możliwe tryby to:"CARELESS" (Beztrosko), "SAFE" (Bezpiecznie), "AWARE" (Ostrożnie), "COMBAT" (Bojowo), "STEALTH" (Ukradkiem).
Przykład:
groupOne setBehaviour "SAFE"
person SetCaptive captive
Typy zmiennych:
person: obiekt
captive: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Oznacza jednostkę jako jeńca (captive). Jeżeli jednostką jest pojazd, jego dowódca zostaje oznaczony. Jednostka oznaczona jako jeniec, traktowana jest przez wszystkich jako neutralna. Komenda ta nie wpływa na zachowanie samej jednostki.
Przykład:
setCaptive player
group SetCombatMode mode
Typy zmiennych:
group: grupa albo obiekt
mode: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Ustawia tryb bojowy (combat mode) grupy. Możliwe tryby to:"BLUE" (Nigdy nie strzelaj), "GREEN" (Wstrzymaj ogień), "WHITE" (Wstrzymaj ogień, atakuj do woli), "YELLOW" (Otwórz ogień), "RED" (Otwórz ogień, atakuj do woli).
Przykład:
groupOne setCombatMode "BLUE"
object SetDamage damage
Typy zmiennych:
object: obiekt
damage: liczba
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.5
Opis:
Uszkadza/naprawia dany obiekt. Zmienna damage równa 0 oznacza obiekt bez uszkodzeń/obrażeń, a równa 1 obiekt zniszczony/martwy. Ta komenda jest identyczna z SetDammage - została wprowadzona, by poprawić błąd jaki wkradł się w nazwie tej poprzedniej.
Przykład:
player setdamage 1
object SetDammage dammage
Typy zmiennych:
object: obiekt
dammage: liczba
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.5
Opis:
Uszkadza/naprawia dany obiekt. Zmienna dammage równa 0 oznacza obiekt bez uszkodzeń/obrażeń, a równa 1 obiekt zniszczony/martwy..
Przykład:
player setdammage 0.5
object SetDir heading
Typy zmiennych:
object: obiekt
heading: liczba (azymut)
Typ Zwracanej wartości:
nie zwraca
Opis:
Obraca obiekt tak by był zwrócony w danym kierunku. Dopuszczalne wartości zmiennej heading należą do przedziału <0,360>.
Przykład:
player setDir 180
person SetFace faceName
Typy zmiennych:
person: obiekt
faceName: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Sprawia, że dana osoba ma określoną twarz.
Przykład:
soldierOne setFace "Face10"
person SetFaceAnimation blink
Typy zmiennych:
person: obiekt
blink: liczba
Typ Zwracanej wartości:
nie zwraca
Opis:
Sprawia, że dana osoba mruga oczami. Zmienna blink przyjmuje wartości z przedziału <0,1>.
Przykład:
soldierOne setFaceAnimation 0.5
flag SetFlagOwner owner
Typy zmiennych:
flag: obiekt
owner: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Przekazuje danej jednostce flagę (w rozgrywce MultiPlayer). Jeżeli jako jednostka podany jest obiekt pusty (ObjNull) zwraca flagę do bazy.
Przykład:
flagOne setFlagOwner objNull
flag SetFlagSide side
Typy zmiennych:
flag: obiekt
side: strona
Typ Zwracanej wartości:
nie zwraca
Opis:
Ustawia stronę do której należy dana flaga.
Przykład:
flagOne setFlagSide east
flag SetFlagTexture texture
Typy zmiennych:
flag: obiekt
texture: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Ustawia teksturę jaka ma znaleźć się na fladze. Jeżeli jako zmienną texture wpisazemy "" flaga nie zostanie narysowna.
Przykład:
flagOne setFlagTexture "usa_vlajka.pac"
time SetFog fog
Typy zmiennych:
time: liczba
fog: liczba
Typ Zwracanej wartości:
nie zwraca
Opis:
Zmienia gęstość mgły stopniowo w określonym czasie (w sekundach). Zmienna time równa 0 oznacza natychmiastową zmianę. Zmienna fog przyjmuje wartości z przedziału <0,1> gdzie 0 oznacza brak mgły.
Przykład:
1800 setFog 0.5
group SetFormation formation
Typy zmiennych:
group: grupa albo obiekt
formation: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Ustawia formację (formation) grupy. Możliwe formacje to:"COLUMN" (kolumna), "STAG COLUMN" (kolumna rozproszona), "WEDGE" (klin), "ECH LEFT" (tyraliera w lewo), "ECH RIGHT" (tyraliera w prawo), "VEE" (romb), "LINE" (tyraliera).
Przykład:
groupOne setFormation "LINE"
group SetFormDir heading
Typy zmiennych:
group: grupa albo obiekt
heading: liczba (azymut)
Typ Zwracanej wartości:
nie zwraca
Opis:
Nakazuje grupie zwrócić formację (formation) w kierunku określonym podanym azymutem. Zmienna heading może przyjmować wartości z przedziału <0,360>. Formacja grupy pozostaje zwrócona w podanym kierunku dopóki grupa nie wejdzie w kontakt z nieprzyjacielem. Podczas ruchu formacja grupy zaczyna przyjmować azymut pod wpływem ukształtowania terenu.
Przykład:
player setformdir 180
vehicle SetFuel amount
Typy zmiennych:
vehicle: obiekt
amount: liczba
Typ Zwracanej wartości:
nie zwraca
Opis:
Ustawia ilość paliwa w baku pojazdu. Zmienna amount równa 1 oznacza pełne zbiorniki.
Przykład:
jeepOne setFuel 0
vehicle SetFuelCargo amount
Typy zmiennych:
vehicle: obiekt
amount: liczba
Typ Zwracanej wartości:
nie zwraca
Opis:
Zmienia ilość paliwa w przestrzeni załadunkowej (fuel amount in cargo space) w danym pojeździe-cysternie. Zmienna amount równa 1 oznacza pełne zbiorniki.
Przykład:
refuelTruckOne setFuelCargo 0
group SetGroupId id
Typy zmiennych:
group: grupa albo obiekt
id: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Przypisuje określony identyfikator danej grupie. Wektor id ma format [litera,kolor,obrazek] albo [litera,kolor]. Możliwe litery to: "Alpha", "Bravo", "Charlie", "Delta", "Echo", "Foxtrot", "Golf", "Hotel", "Kilo". Kolor przyjmuje wartości od "GroupColor0" do "GroupColor7" (osiem możliwych kolorów).
Przykład:
setGroupId ["Alpha", "GroupColor0"]
person SetIdentity identity
Typy zmiennych:
person: obiekt
identity: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Przypisuje graczowi daną osobowość (identity). Osobowości muszą być zdefiniowane w pliku description.ext .
Przykład:
player setIdentity "JohnDoe"
marker SetMarkerColor color
Typy zmiennych:
marker: łańcuch znaków
color: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.21
Opis:
Ustawia kolor znaku (marker'a). Możliwe wartości zmiennej color to: "Default", "ColorBlack", "ColorRed", "ColorRedAlpha", "ColorGreen", "ColorGreenAlpha", "ColorBlue", "ColorYellow", "ColorWhite".
Przykład:
"MarkerOne" setMarkerColor "ColorBlack"
marker SetMarkerPos pos
Typy zmiennych:
marker: łańcuch znaków
pos: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Przesuwa znak (marker) na podaną pozycję (współrzędne [x,y,z]) na mapie.
Przykład:
"MarkerOne" setMarkerPos getMarkerPos "MarkerTwo"
marker SetMarkerSize size
Typy zmiennych:
marker: łańcuch znaków
size: wektor
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.21
Opis:
Ustawia rozmiar znaku (marker'a) na mapie (format wektora rozmiaru to [oś a,oś b]).
Przykład:
"MarkerOne" setMarkerSize [100, 200]
marker SetMarkerType markerType
Typy zmiennych:
marker: łańcuch znaków
markerType: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.21
Opis:
Ustawia typ znaku (marker'a). Możliwe typy to: "Flag", "Flag1", "Dot", "Destroy", "Start", "End", "Warning", "Join", "Pickup", "Unknown", "Marker", "Arrow", "Empty".
Przykład:
"MarkerOne" setMarkerType "Arrow"
person SetMimic mimic
Typy zmiennych:
person: obiekt
mimic: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Ustawia wyraz twarzy osoby. Możliwe wyrazy twarzy to: "Default", "Normal", "Smile", "Hurt", "Ironic", "Sad", "Cynic", "Surprised", "Agresive"(tak pisane!), "Angry".
Przykład:
soldierOne setMimic "Angry"
object SetObjectTexture texture
Typy zmiennych:
object: obiekt
texture: wektor
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.75
Opis:
Brak (BIS nie opisuje tej komendy).
time SetOvercast overcast
Typy zmiennych:
time: liczba
overcast: liczba
Typ Zwracanej wartości:
nie zwraca
Opis:
Zmienia stopień zachmurzenia stopniowo w określonym czasie (w sekundach). Zmienna time równa 0 oznacza natychmiastową zmianę. Zmienna overcast przyjmuje wartości z przedziału <0,1> gdzie 0 oznacza brak zachmurzenia.
Przykład:
1800 setOvercast 0.5
object SetPos pos
Typy zmiennych:
object: obiekt
pos: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Przenosi obiekt na pozycję (współrzędne [x,y,z]) na mapie.
Przykład:
player setPos [getpos player select 0, getpos player select 1 + 10]
index SetRadioMsg text
Typy zmiennych:
index: liczba
text: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Przypisuje danemu przekazowi radiowemu określony tekst, który zastąpi domyślną nazwę kanału ("Alpha", "Bravo" itd..). Użyj "NULL" by usunąć dany przekaz.
Przykład:
0 setRadioMsg "Pluton Yankee wybierz trasę zachodnią"
time SetRain rainDensity
Typy zmiennych:
time: liczba
rainDensity: liczba
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.75
Opis:
Zmienia intensywność opadów stopniowo w określonym czasie (w sekundach). Zmienna time równa 0 oznacza natychmiastową zmianę. Zmienna rainDensity przyjmuje wartości z przedziału <0,1> gdzie 0 oznacza brak opadów. Opady nie są możliwe jeżeli stopień zachmurzenia (overcast) jest mniejszy niż 0.7 .
Przykład:
60 rain 1
vehicle SetRepairCargo amount
Typy zmiennych:
vehicle: obiekt
amount: liczba
Typ Zwracanej wartości:
nie zwraca
Opis:
Zmienia wielkość zasobów naprawczych w przestrzeni załadunkowej (amount of repair resources in cargo space) w danym pojeździe naprawczym. Zmienna amount równa 1 oznacza maksymalną ilość zasobów.
Przykład:
repairTruckOne setRepairCargo 0
vehicle SetSkill skill
Typy zmiennych:
vehicle: obiekt
skill: liczba
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.75
Opis:
Zmienia predyspozycje dowódcy pojazdu (commander). Zmienna skill może przyjmować wartości z przedziału <0,1>.
Przykład:
hero setSkill 1
group SetSpeedMode mode
Typy zmiennych:
group: grupa albo obiekt
mode: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Ustawia tryb szybkości (speed mode) danej grupie. Możliwe wartości trybu mode to: "LIMITED" (połowa prędkości),"NORMAL" (pełna prędkość, utrzymuje formację),"FULL" (pełna prędkość, nie przywiązuje wagi do utrzymania formacji).
Przykład:
groupOne setSpeedMode "LIMITED"
SetTerrainGrid grid
Typy zmiennych:
grid: liczba
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.75
Opis:
Ustawia żądaną rozdzielczość terenu (terrain resolution) w metrach. Dla domyślnego krajobrazu (default landscape). Dopuszczalne rozdzielczości to: 50, 25, 12.5, 6.25, 3.125. W przypadku podania innej wartości wybierana jest, najbliższa jej, dopuszczalna wartość.
Przykład:
setTerrainGrid 12.5
unit SetUnitPos mode
Typy zmiennych:
unit: obiekt
mode: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Wymusza na jednostce przyjęcie danej pozycji. Możliwe wartości to: "DOWN" (zawsze leżąca), "UP" (zawsze stojąca), "AUTO" (zwraca AI możliwość decydowania o pozycji).
Przykład:
soldierOne setUnitPos "Down"
SetViewDistance distance
Typy zmiennych:
distance: liczba
Typ Zwracanej wartości:
nie zwraca
Opis:
Ustawia zasięg widoczności (generowania krajobrazu) w metrach. Domyślnie zasięg ten wynosi 900m. Dopuszczalne wartości należą do przedziału: <500,5000>.
Przykład:
setviewdistance 2000
waypoint SetWPPos position
Typy zmiennych:
waypoint: wektor
position: wektor
Typ Zwracanej wartości:
nie zwraca
Wymagana wersja OFP:
1.21
Opis:
Przenosi punkt trasy na podaną pozycję (współrzędne [x,y,z]) na mapie. Wektor waypoint ma format: [grupa, numer], gdzie pierwszy punkt trasy ma numer 0.
Przykład:
[groupOne, 1] setWPPos getMarkerPos "MarkerOne"
ShowCinemaBorder show
Typy zmiennych:
show: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Wymusza pojawienie się kinowego obramowania (cinema border). Zwykle jest to stosowane podczas przerywników filmowych (cutscenes) by podkreślić, że gracz nie ma kontroli.
ShowCompass show
Typy zmiennych:
show: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Daje/odbiera graczowi możliwość korzystania z kompasu. Domyślnie gracz może z niego korzystać.
ShowGPS show
Typy zmiennych:
show: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Daje/odbiera graczowi możliwość korzystania z GPS'u. Domyślnie gracz nie może z niego korzystać.
ShowMap show
Typy zmiennych:
show: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Daje/odbiera graczowi możliwość korzystania z Mapy. Domyślnie gracz może z niego korzystać.
ShownCompass
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy gracz ma możliwość korzystania z kompasu.
ShownGPS
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy gracz ma możliwość korzystania z GPS'u.
ShownMap
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy gracz ma możliwość korzystania z mapy.
ShownPad
Typy zmiennych:
show: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Sprawdza czy gracz ma możliwość korzystania z notatnika.
ShownRadio
Typy zmiennych:
show: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Sprawdza czy gracz ma możliwość korzystania z radia (z poziomu mapy).
ShownWarrant
Typy zmiennych:
show: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Sprawdza czy gracz ma możliwość korzystania z karty identyfikacyjnej (ID card).
ShownWatch
Typy zmiennych:
show: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Sprawdza czy gracz ma możliwość korzystania z zegarka.
ShowPad show
Typy zmiennych:
show: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Daje/odbiera graczowi możliwość korzystania z notatnika. Domyślnie gracz może z niego korzystać.
ShowRadio show
Typy zmiennych:
show: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Daje/odbiera graczowi możliwość korzystania z radia (z poziomu mapy). Domyślnie gracz nie może z niego korzystać.
ShowWarrant show
Typy zmiennych:
show: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Daje/odbiera graczowi możliwość korzystania z karty identyfikacyjnej (ID card). Domyślnie gracz nie może z niego korzystać.
ShowWatch show
Typy zmiennych:
show: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Daje/odbiera graczowi możliwość korzystania z zegarka. Domyślnie gracz może z niego korzystać.
Side unit
Typy zmiennych:
unit: obiekt lub grupa
Typ Zwracanej wartości:
strona
Opis:
Zwraca stronę do której należy dany obiekt.
Przykład:
side player == west
unit SideChat chatText
Typy zmiennych:
unit: obiekt
chatText: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Wysyła komunikat tekstowy (wyłącznie tekst) do kanału radiowego jednej ze stron (side radio channel).
Przykład:
soldierOne SideChat "Show this text"
unit SideRadio radioName
Typy zmiennych:
unit: obiekt
radioName: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Wysyła komunikat (tekst i dźwięk) do kanału radiowego jednej ze stron (side radio channel). Komunikat musi być zdefiniowany w pliku description.ext
Przykład:
soldierOne SideRadio "messageOne"
sin x
Typy zmiennych:
x: liczba
Typ Zwracanej wartości:
kąt (w stopniach)
Opis:
sinus z x
Przykład:
sin 30, wynik to 0.5
Skill person
Typy zmiennych:
person: obiekt
Typ Zwracanej wartości:
liczba
Wymagana wersja OFP:
1.75
Opis:
Zwraca predyspozycje (level of ability) danej osoby. Zwracana wartość należy do przedziału <0,1>.
Przykład:
skill player
SkipTime duration
Typy zmiennych:
duration: liczba
Typ Zwracanej wartości:
nie zwraca
Opis:
Natychmiast "przeskakuje" określoną liczbę godzin czasu gry. Zmianie ulega pora dnia i pogoda (jeżeli prognoza zakładała jakieś zmiany). Nie wpływa na położenie jednostek.
Przykład:
skipTime 2.5
SomeAmmo unit
Typy zmiennych:
unit: obiekt
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy jednostka posiada jeszcze amunicję.
Przykład:
someAmmo vehicle player
SoundVolume
Typ Zwracanej wartości:
liczba
Opis:
Zwraca aktualną głośność odtwarzania dźwięków jako liczbę z przedziału <0,1>.
Speed obj
Typy zmiennych:
obj: obiekt
Typ Zwracanej wartości:
liczba
Opis:
Zwraca prędkość z jaką porusza się obiekt (w kilometrach na godzinę).
Przykład:
speed player
SpeedMode grp
Typy zmiennych:
grp: obiekt albo grupa
Typ Zwracanej wartości:
liczba
Opis:
Zwraca tryb szybkości (speed mode) z jaką porusza się grupa. Możliwe wartości trybu mode to: "LIMITED" (połowa prędkości),"NORMAL" (pełna prędkość, utrzymuje formację),"FULL" (pełna prędkość, nie przywiązuje wagi do utrzymania formacji).
Przykład:
speedMode group player
sqrt x
Typy zmiennych:
x: liczba
Typ Zwracanej wartości:
liczba
Opis:
pierwiastek kwadratowy (square root) z x
Przykład:
sqrt 9, wynik to 3
unit Stop stop
Typy zmiennych:
unit: obiekt
stop: wartość logiczna
Typ Zwracanej wartości:
nie zwraca
Opis:
Zatrzymuje jednostkę AI do odwołania.
Przykład:
soldierOne stop true
Stopped unit
Typy zmiennych:
unit: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Sprawdza czy jednostka została "zatrzymana" komendą Stop.
Przykład:
stopped jeepOne
unit SwitchCamera mode
Typy zmiennych:
unit: obiekt
mode: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Przełącza, dla danego obiektu, tryb w jakim znajduje się kamera. Możliwe tryby pracy kamery to: "INTERNAL" (widok "pierwszej osoby"), "GUNNER" (optyka/celownik), "EXTERNAL" (widok "trzeciej osoby"), "GROUP" (grupa).
Przykład:
sniperOne switchCamera "gunner"
lamppost SwitchLight mode
Typy zmiennych:
lamppost: obiekt
mode: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Przełącza obiekt typu "latarnia" w dany tryb pracy. Możliwe tryby to: "ON", "OFF", "AUTO". "AUTO" jest domyślnym trybem (świecenie tylko w nocy).
Przykład:
nearestObject [player, "StreetLamp"] switchLight "Off"
soldier SwitchMove moveName
Typy zmiennych:
soldier: obiekt
moveName: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Powoduje, że osoba soldier natychmiast przechodzi do animacji określonego typu (nie ma płynnego przejścia). Użyj soldier SwitchMove "", jeżeli nie ma "animacji kończącej", by mogła znowu się swobodnie poruszać (w przeciwnym przypadku jednostka pozostanie w tej pozie).
Przykład:
soldierOne switchMove "FXStandDip"
tan x
Typy zmiennych:
x: liczba
Typ Zwracanej wartości:
kąt (w stopniach)
Opis:
tangens z x
Przykład:
tan 45 , wynik to 1
TextLog anything
Typy zmiennych:
anything: dowolny
Typ Zwracanej wartości:
nie zwraca
Opis:
Zrzuca wartość argumentu do wyjścia kontrolnego (debugging output).
Przykład:
textLog player
tg x
Typy zmiennych:
x: liczba
Typ Zwracanej wartości:
kąt (w stopniach)
Opis:
tangens z x
Przykład:
tg 45 , wynik to 1
Time
Typ Zwracanej wartości:
liczba
Opis:
Zwraca czas jaki upłynął, w sekundach, od rozpoczęcia misji.
TitleCut effect
Typy zmiennych:
effect: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Komenda już nie używana.
TitleObj effect
Typy zmiennych:
effect: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Umieszcza "planszę obiektową" (object title). Wektor effect ma format ["name","type",speed] albo ["name","type"] (jeżeli prędkość nie jest podana przyjmuje wartość jeden). Obiekt może być zdefiniowany w pliku description.ext .
Przykład:
titleObj ["BISLogo","plain"]
TitleRsc effect
Typy zmiennych:
effect: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Umieszcza "planszę zasobową" (resource title). Wektor effect ma format ["name","type",speed] albo ["name","type"] (jeżeli prędkość nie jest podana przyjmuje wartość jeden). Zasób może być zdefiniowany w pliku description.ext .
Przykład:
titleRsc ["BIS", "PLAIN"]
TitleText effect
Typy zmiennych:
effect: wektor
Typ Zwracanej wartości:
nie zwraca
Opis:
Umieszcza "planszę tekstową" (text title). Wektor effect ma format ["text","type",speed] albo ["text","type"] (jeżeli prędkość nie jest podana przyjmuje wartość jeden). Argument type przyjmuje wartości: "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT", "WHITE IN".
Przykład:
TitleText ["Hello everybody!", "BLACK OUT"]
true
Typ Zwracanej wartości:
wartość logiczna
Opis:
prawda (zastrzeżone wyrażenie).
UnAssignVehicle unit
Typy zmiennych:
unit: obiekt
Typ Zwracanej wartości:
nie zwraca
Opis:
Jednostka przestaje być przypisana do danego pojazdu. Jeżeli znajduje się wtedy w pojeździe otrzyma rozkaz jego opuszczenia od swojego dowódcy.
Przykład:
unassignVehicle player
UnitReady unit
Typy zmiennych:
unit: obiekt
Typ Zwracanej wartości:
wartość logiczna
Opis:
Sprawdza czy jednostka jest gotowa (ready) do przyjęcia kolejnych rozkazów. Jednostka nie jest "gotowa" jeżeli nie ukończyła wykonywania poprzedniego rozkazu wydanego przez dowódcę, na przykład takigo jak "Idź do...".
Przykład:
unitReady player
Units unit
Typy zmiennych:
unit: obiekt
Typ Zwracanej wartości:
wektor
Opis:
Zwraca wektor zawierający jednostki należące do grupy, w której znajduje się jednostka unit. Jeżeli jednostka unit nie żyje zwraca pusty wektor.
Przykład:
player in units alpha
Units grp
Typy zmiennych:
grp: grupa
Typ Zwracanej wartości:
wektor
Opis:
Zwraca wektor zawierający jednostki należące do danej grupy.
Przykład:
player in units GroupOne
Vehicle unit
Typy zmiennych:
unit: obiekt
Typ Zwracanej wartości:
obiekt
Opis:
Zwraca pojazd w którym znajduje się jednostka. Jeżeli nie znajduje się w żadnym pojeździe, zwraca jednostkę.
Przykład:
vehicle player != player
unit VehicleChat chatText
Typy zmiennych:
unit: obiekt
chatText: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Wysyła komunikat tekstowy (wyłącznie tekst) do kanału radiowego pojazdu (vehicle radio channel).
Przykład:
soldierOne VehicleChat "Show this text"
unit VehicleRadio radioName
Typy zmiennych:
unit: obiekt
radioName: łańcuch znaków
Typ Zwracanej wartości:
nie zwraca
Opis:
Wysyła komunikat (tekst i dźwięk) do kanału radiowego pojazdu (vehicle radio channel). Komunikat musi być zdefiniowany w pliku description.ext
Przykład:
soldierOne VehicleRadio "messageOne"
WayPointPosition waypoint
Typy zmiennych:
waypoint: wektor
Typ Zwracanej wartości:
wektor
Opis:
Zwraca pozycję (współrzędne [x,y,z]) punkt trasy na mapie. Wektor waypoint ma format: [grupa, numer], gdzie pierwszy punkt trasy ma numer 0.
Przykład:
waypointPosition [groupOne, 1]
Weapons vehicle
Typy zmiennych:
vehicle: obiekt
Typ Zwracanej wartości:
wektor
Opis:
Zwraca zwraca wektor z nazwami broni posiadanymi przez jednostkę.
Przykład:
weapons player
West
Typ Zwracanej wartości:
strona
Opis:
Strona zachód (zastrzeżone wyrażenie).
dowolny (Any)
Opis:
Zmienna dowolnego typu.
wektor (Array)
Opis:
Zmienna tabelaryczna składajaca się z przeliczalnej liczby elementów określonego typu (każdy element może być innego typu).
Przykład:
wektorOne = ["Alpha",alpha,25,[23,34,56]]
wartość logiczna (Boolean)
Opis:
Zmienna Bool'owska która może przyjąć tylko dwie wartości: true (prawda) albo false (fałsz).
Przykład:
CelWykonany = true
grupa (Group)
Opis:
Grupa (może się składać z jednej jednostki). Wyrażeniem identyfikującym grupę (jako zmienną) jest nazwa jej dowódcy (nawet jeśli już nie żyje).
Przykład:
Leader Group alpha SideChat "We're doomed!!!"
liczba (Number)
Opis:
Liczba rzeczywista.
Przykład:
dir = GetDir soldierOne
obiekt (Object)
Opis:
Obiekty występujące w grze. Zalicz się do nich: ludzi i pojazdy, budynki i przedmioty, wyzwalacze, elementy logiczne.
Przykład:
chief = Leader Group alpha
strona (Side)
Opis:
Strona konfliktu. Możliwe strony to: "WEST", "EAST", "RESISTANCE", "CIVILIAN".
łańcuch znaków (String)
Opis:
Łańcuch znaków alfanumerycznych (w kodzie ASCII), czyli liter i symboli. Łańcuch znaków umieszczamy zawsze w cudzysłowiu.
Przykład:
komunikat = "To All units. Prepare for the counterattack"
kolor (Color)
Format:
[r,g,b,a]
Opis:
Pierwsze trzy elementy wektora to parametry RGB (red-green-blue), a ostatni to "przezroczystość" (alpha) - wszystkie przyjmują warości z przedziału <0,1>.Określone wartości r,g,b daje odpowiedni kolor, a wartość alpha określa jak bardzo przezroczysty ma być kolor, gdzie a = 0 oznacza brak przezroczystości.
wektor cząsteczek (ParticleArray)
Format:
[ShapeName, AnimationName, Type, TimerPeriod, LifeTime, Position, MoveVelocity, RotationVelocity, Weight, Volume, Rubbing, Size, Color, AnimationPhase, RandomDirectionPeriod, RandomDirectionIntensity, OnTimer, BeforeDestroy, Object]
Opis:
Globalne parametry: ShapeName - Nazwa kształtu związanego z cząsteczkami. AnimationName - Nazwa animacji kształtu. Type - Typ cząsteczek ("Billboard" albo "SpaceObject"). TimerPeriod - okres wywołania wydarzenia (event) "OnTimer" (w sekundach). LifeTime - czas trwania cząsteczek (w sekundach). Parametry fizyczne: Position - współrzędne 3D ([x,y,z]) albo nazwa selekcji (name of the selection) - w drugim przypadku ustawione być muszą właściwości obiektu (the Object property). MoveVelocity - wektor 3D [(x,y,z)] który opisuje kierunek i prędkość (m/s) przemieszczania się cząsteczek. RotationVelocity - wartość która określa liczbę obrotów w czasie jednej sekundy. Weight - Waga cząsteczek (w kg). Volume - objętość cząsteczek (w metrach sześciennych). Rubbing - niemianowana wartość, która określa wpływ "gęstości" otoczenia na cząsteczki, gdzie 0 oznacza brak oddziaływania (przenikanie). Parametry odtwarzania (Render parameters): Zauważ, że wszystkie te wartości pokazują zmianę parametru w czasie.
Na przykład - jeżeli ustawisz wektor rozmiaru [1,2], wtedy na początku rozmiar cząsteczek będzie rowny 1, a na końcu czasu ich trwania (life time) będzie równy 2. Podczas czasu trwania cząteczek ich rozmiar będzie liniowo zmieniał się w podanym przedziale. Size - rozmiar cząsteczek w czasie odtwarzania (w metrach). Color - kolor cząsteczek w czasie odtwarzania (RGBA - format kolor). AnimationPhase - faza animacji w czasie. Parametry losowe (Random parameters): RandomDirectionPeriod - Okres trwania zmian wektora szybkości (velocity vector) w sekundach. RandomDirectionIntensity - Każdy komponent "MoveVelocity" będzie zmieniany o losową wartość z przedziału <0, RandomDirectionIntensity>. OnTimer - nazwa skryptu który ma być uruchamiany w odstępach czasu określonych przez właściwości "TimerPeriod". Pozycja cząsteczek jest przechowywana w zmiennej "this". BeforeDestroy - Nazwa skryptu, który ma byc uruchomony przed zniszczeniem cząsteczek. Pozycja cząsteczek jest przechowywana w zmiennej "this". Object -
Obiekt do którego mają być dołączone cząsteczki.
pozycja (Position)
Format:
[x,y,z]
Opis:
Wspórzędne na mapie x - to koordynaty wschód-zachód, y - to koordynaty północ-południe, z - określa wysokość nad powierzchnią gruntu (domyślnie 0).
pozycja 2D(Position2D)
Format:
[x,y]
Opis:
Wspórzędne na mapie x - to koordynaty wschód-zachód, y - to koordynaty północ-południe.
punkt trasy (WayPoint)
Format:
[group,index]
Opis:
Punkt trasy danej grupy. group - nazwa grupy, index - numer punktu trasy (index = 0 oznacza pierwszy punkt trasy, który jest zawsze tworzony w punkcie startowym grupy).
przypisywanie wektorów (Array assignement)
Przypisanie wektora do zmiennej za tworzy wskaźnik (pointer). Jeżeli b jest wektorem, to przypisanie a = b sprawia, że zarówna a jak i b reprezentują dany wektor (a staje się wskaźnikiem). Jeżeli b ulega zmianie, zmianie ulega również a. Jedną z przykładowych sytuacji obrazujących to postępowanie jest aList = List nazwa_wyzwalacza. Kopię wektora możesz otrzymać używając komendy +a.
skrypty bazujące na zdarzeniach (Event based scripts)
Istnieje możliwość umieszczenia w grze skryptów, które są uruchamiane gdy pewne określone zdarzenia mają miejsce. Niektóre z nich mają nazwy nadane przez twórce misji, a inne przez program.
init.sqs - Uruchamiany gdy misja jest rozpoczynana (przed odprawą) - bez argumentów.
initIntro.sqs - Uruchamiane gdy rozpoczyna się intro - bez argumentów. Wymaga wersji OFP 1.50 lub wyższej.
exit.sqs - Uruchamiany gdy misja się kończy (przed podsumowaniem) - argument: end # (liczba oznaczająca numer zakończenia). Wymaga wersji OFP 1.50 lub wyższej.
onFlare.sqs - Uruchamiany gdy wystrzelona zostaje flara - argumenty: [[r, g, b], gunner] - r, g, b określa kolor flary, a gunner strzelającego. Wymaga wersji OFP 1.45 lub wyższej.
składnia skryptów (Script syntax)
Jako elementy skryptu mogą być użyte:
Komentarz (Comment): linijka rozpoczynająca się średnikiem np. ;To jest komentarz
Etykieta (Label): linijka zaczynająca się znakiem # np. #Etykieta
Zatrzymanie warunkowe (Waiting for a condition): linijka zaczynająca się znakiem @ np. @(NOT Alive soldierOne)
Zatrzymanie czasowe (Waiting for a time): linijka zaczynająca się znakiem & np. &endTime jest odpowiednikiem @_time >= (endTime)
Opóźnienie (Delay): linijka zaczynająca się znakiem ~ np. ~delay jest odpowiednikiem __waitUntil = _time+(cas) ; &__waitUntil
Komenda (Command): Wyrażenie nie zwracające żadnej wartości np. _unit SetBehaviour "SAFE"
Przypisanie (Assignement): Przypisanie zmiennej dowolnej wartości np. _a = 10
Warunek (Conditional): Wyrażenie zwracające wartość logiczną poprzedzone znakiem ?, zawierające komendę po znaku : . Komenda zostaje wykonana tylko gdy warunek jest spełniony np. ?_condVar>10:_var=_var+2
Uwaga!: zmienna _time jest zastrzeżona (nie można jej uzywać). Przechowuje ona czas (w sekunadach) jaki upłynął od uruchomienia skryptu.
Zmienne lokalne (Local variables) mogą być używane, aby uniknąć konfliktu, który mógłby wystąpić, gdyby nazwy zmiennych użyte w skrypcie były takie same jak nazwy zmiennych użyte w misji. Nazwy zmiennych lokalnych zaczynają się od symbolu podkreślenia np. _licznik. Nie należy używać nazw zaczynających się od dwóch znaków podkreślenia.
wyzwalacze (Triggers)
Wyrażenie Condition musi zwracać wartość logiczną (Boolean) i jest używane by zdeterminować kiedy wyzwalacz się aktywuje. Wartość logiczna zmiennej this jest ustalana w oparciu o ustawienia jakie można poczynić nie zmieniając nic w polu warunku aktywacji (np. Wschód nieobecny itp.). Wektor thisList zawiera wszystkie jednostki, które aktywują dany wyzwalacz. Wyrażenia Przy aktywacji (On Activation) i Przy Dezaktywacji (On Deactivation) określają akcje, które mają miejsce, gdy warunek (Condition) wyzwalacza zmienia wartość (z false na true albo odwrotnie). Nazwę zmiennej za pomocą, której kojarzony będzie wyzwalacz wpisujemy w pole "Nazwa".
zmienne (Variables)
Zmienna musi zostać zainicjalizowana zanim zostanie użyta. Jeżeli niezainicjalizowana zmienna zostaje wykryta w wyrażeniu, wtedy całe wyrażenie zwraca nil (nieokreśloną wartość). Jeżeli niezainicjalizowana zmienna zostaje wykryta w polu w którym oczekiwana jest wartość logiczna, to rezultatem jest fałsz (false). Zmienne mogą zostać odinicjalizowane przez przypisanie im wartości nil - to niszczy zmienne tak jakby nigdy nie istniały.
punkty trasy (Waypoints)
Wyrażenie Condition musi zwracać wartość logiczną (Boolean) i jest używane, by zdeterminować kiedy punkt trasy przestaje być aktywny (domyślnie gdy wszystkie jednostki grupy wykonają polecenie określone typem punktu trasy). Wartość logiczna zmiennej this jest ustalana w oparciu typ punktu trasy. Wektor thisList zawiera wszystkie jednostki grupy, do której przypisany jest ten punkt trasy. Wyrażenie Przy aktywacji (On Activation) określają akcje, które mają miejsce, gdy punkt trasy przestaje być aktywny (warunek punktu trasy przyjmuje wartość false).