Guest User

Untitled

a guest
Dec 4th, 2014
1,960
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 208.88 KB | None | 0 0
  1. Name: -
  2. Description: Extend expression
  3. Category: Simple expression
  4. Address: 0x123B090
  5. Arg1: val
  6. Arg2: expr
  7.  
  8.  
  9. Name: -
  10. Description: Extend expression
  11. Category: Simple expression
  12. Address: 0x123B090
  13. Arg1: val
  14. Arg2: expr
  15.  
  16.  
  17. Name: -
  18. Description: Extend expression
  19. Category: Simple expression
  20. Address: 0x12390F0
  21. Arg1: expr1
  22. Arg2: expr2
  23.  
  24.  
  25. Name: -
  26. Description: Extend expression
  27. Category: Simple expression
  28. Address: 0x1239120
  29. Arg1: expr
  30. Arg2: val
  31.  
  32.  
  33. Name: -
  34. Description: Extend expression
  35. Category: Simple expression
  36. Address: 0x1238ED0
  37. Example: -daylight
  38. Arg1: expr
  39.  
  40.  
  41. Name: -
  42. Description: Extend expression
  43. Category: Simple expression
  44. Address: 0x12390F0
  45. Arg1: expr1
  46. Arg2: expr2
  47.  
  48.  
  49. Name: -
  50. Description: Extend expression
  51. Category: Simple expression
  52. Address: 0x1239120
  53. Arg1: expr
  54. Arg2: val
  55.  
  56.  
  57. Name: *
  58. Description: Extend expression
  59. Category: Simple expression
  60. Address: 0x123AF20
  61. Arg1: val
  62. Arg2: expr
  63.  
  64.  
  65. Name: *
  66. Description: Extend expression
  67. Category: Simple expression
  68. Address: 0x1238EA0
  69. Arg1: expr
  70. Arg2: val
  71.  
  72.  
  73. Name: *
  74. Description: Extend expression
  75. Category: Simple expression
  76. Address: 0x1238E70
  77. Arg1: expr1
  78. Arg2: expr2
  79.  
  80.  
  81. Name: *
  82. Description: Extend expression
  83. Category: Simple expression
  84. Address: 0x1238E70
  85. Arg1: expr1
  86. Arg2: expr2
  87.  
  88.  
  89. Name: *
  90. Description: Extend expression
  91. Category: Simple expression
  92. Address: 0x1238EA0
  93. Arg1: expr
  94. Arg2: val
  95.  
  96.  
  97. Name: *
  98. Description: Extend expression
  99. Category: Simple expression
  100. Address: 0x123AF20
  101. Arg1: val
  102. Arg2: expr
  103.  
  104.  
  105. Name: /
  106. Description: Extend expression
  107. Category: Simple expression
  108. Address: 0x1238880
  109. Arg1: expr
  110. Arg2: val
  111.  
  112.  
  113. Name: /
  114. Description: Extend expression
  115. Category: Simple expression
  116. Address: 0x123AD60
  117. Arg1: val
  118. Arg2: expr
  119.  
  120.  
  121. Name: /
  122. Description: Extend expression
  123. Category: Simple expression
  124. Address: 0x123AD60
  125. Arg1: val
  126. Arg2: expr
  127.  
  128.  
  129. Name: /
  130. Description: Extend expression
  131. Category: Simple expression
  132. Address: 0x1238880
  133. Arg1: expr
  134. Arg2: val
  135.  
  136.  
  137. Name: /
  138. Description: Extend expression
  139. Category: Simple expression
  140. Address: 0x1238850
  141. Arg1: expr1
  142. Arg2: expr2
  143.  
  144.  
  145. Name: /
  146. Description: Extend expression
  147. Category: Simple expression
  148. Address: 0x1238850
  149. Arg1: expr1
  150. Arg2: expr2
  151.  
  152.  
  153. Name: +
  154. Description: Extend expression
  155. Category: Simple expression
  156. Address: 0x12387F0
  157. Arg1: expr1
  158. Arg2: expr2
  159.  
  160.  
  161. Name: +
  162. Description: Extend expression
  163. Category: Simple expression
  164. Address: 0x1238820
  165. Arg1: expr
  166. Arg2: val
  167.  
  168.  
  169. Name: +
  170. Description: Extend expression
  171. Category: Simple expression
  172. Address: 0x12387F0
  173. Arg1: expr1
  174. Arg2: expr2
  175.  
  176.  
  177. Name: +
  178. Description: Extend expression
  179. Category: Simple expression
  180. Address: 0x1238820
  181. Arg1: expr
  182. Arg2: val
  183.  
  184.  
  185. Name: +
  186. Description: Extend expression
  187. Category: Simple expression
  188. Address: 0x123AD30
  189. Arg1: val
  190. Arg2: expr
  191.  
  192.  
  193. Name: +
  194. Description: Extend expression
  195. Category: Simple expression
  196. Address: 0x1238FD0
  197. Example: +daylight
  198. Arg1: expr
  199.  
  200.  
  201. Name: +
  202. Description: Extend expression
  203. Category: Simple expression
  204. Address: 0x123AD30
  205. Arg1: val
  206. Arg2: expr
  207.  
  208.  
  209. Name: accTime
  210. Description: Returns the current time acceleration factor.
  211. Category: General
  212. Address: 0xC9FAD0
  213.  
  214.  
  215. Name: actionKeys
  216. Description: Returns a list of dikCodes of buttons assigned to the given user action.
  217. Category: General
  218. Address: 0xC9FB80
  219. Example: array = actionKeys "ReloadMagazine"
  220. Arg1: action
  221.  
  222.  
  223. Name: actionKeysImages
  224. Description: Returns a list of button images or names assigned to the given user action. A maximum of maxKeys keys is listed. You can find the action names in config class ControllerSchemes.
  225. Category: General
  226. Address: 0xC9FD10
  227. Example: text = actionKeysImages "ReloadMagazine"
  228. Arg1: action or [action, maxKeys]
  229.  
  230.  
  231. Name: actionKeysNames
  232. Description: Returns a string of button names assigned to the given user action. A maximum of maxKeys keys is listed, 0=maximum possible. Sorted by inputDevicePriority with values 'Mouse','Keyboard','Stick','Gamepad','Trackir','Combo' (mouse and keyboard combinations),'Controler' (any controller other then mouse or keyboard). Other values are considered as 'Unsorted'. You can find the action names in config class ControllerSchemes.
  233. Category: General
  234. Address: 0xCA0020
  235. Example: list = actionKeysNames "ReloadMagazine"
  236. Arg1: action or [action, maxKeys] or [action, maxKeys, inputDevicePriority]
  237.  
  238.  
  239. Name: actionKeysNamesArray
  240. Description: Returns a list of button names assigned to the given user action. A maximum of maxKeys keys is listed, 0=maximum possible. Sorted by inputDevicePriority with values 'Mouse','Keyboard','Stick','Gamepad','Trackir','Combo' (mouse and keyboard combinations),'Controler' (any controller other then mouse or keyboard). Other values are considered as 'Unsorted'. You can find the action names in config class ControllerSchemes.
  241. Category: General
  242. Address: 0xCA0370
  243. Example: list = actionKeysNames "ReloadMagazine"
  244. Arg1: action or [action, maxKeys] or [action, maxKeys, inputDevicePriority]
  245.  
  246.  
  247. Name: actionName
  248. Description: Returns localized name of action.
  249. Category: General
  250. Address: 0xCA0990
  251. Example: name = actionName "ReloadMagazine"
  252. Arg1: action
  253.  
  254.  
  255. Name: activateAddons
  256. Description: Activates the listed addons. The list of active addons is reinitialized during this function.
  257. Category: General
  258. Address: 0xC8F710
  259. Example: activateAddons ["BISOFP"]
  260. Arg1: [addon1, ...]
  261.  
  262.  
  263. Name: activatedAddons
  264. Category: General
  265. Address: 0xC8D7F0
  266.  
  267.  
  268. Name: activateKey
  269. Description: Activates the given key for the current user profile. The keys are used to unlock missions or campaigns. See keys, keysLimit and doneKeys in the description.ext file of the missions.
  270. Category: General
  271. Address: 0xD1EC30
  272. Example: activateKey "M04"
  273. Arg1: keyName
  274.  
  275.  
  276. Name: addCamShake
  277. Description: Adds camera shake source.
  278. Category: General
  279. Address: 0xC8DD80
  280. Arg1: [power, duration, frquency]
  281.  
  282.  
  283. Name: addForceGeneratorRTD
  284. Description: Add force generator to world. Returns force index.
  285. Category: General
  286. Address: 0xC8E980
  287. Arg1: [bool enabled, int type, vec3 strengh, vec3 position, vec3 radius, vec3 orientation, object AttachTo]
  288.  
  289.  
  290. Name: addItemPool
  291. Description: Adds count items of type name into the weapon pool (used in the campaign to transfer weapons to the next mission).
  292. Category: General
  293. Address: 0xF92D70
  294.  
  295.  
  296. Name: addMagazinePool
  297. Description: Adds count magazines of type name into the weapon pool (used in the campaign to transfer weapons to the next mission).
  298. Category: General
  299. Address: 0xF92EB0
  300.  
  301.  
  302. Name: addMissionEventHandler
  303. Description: Adds mission event handler. Every event will create an array named _this, which contains specific information about the particular event. The index of the currently added handler is returned.
  304. Category: General
  305. Address: 0xD28460
  306. Example: _id = addMissionEventHandler ["ended",{_this exec "missionEnded.sqs"}]
  307. Arg1: [type, command]
  308.  
  309.  
  310. Name: addMusicEventHandler
  311. Description: Add an music track event handler. Returns id of the handler or -1 when failed.
  312. Category: General
  313. Address: 0xD29600
  314. Example: _id = addMusicEventHandler ["MusicStart", "hint format['Sample %1 start', _this select 0]"]
  315. Arg1: [type, function]
  316.  
  317.  
  318. Name: addSwitchableUnit
  319. Description: Add a unit into the list of units available for team switch.
  320. Category: General
  321. Address: 0xC8F350
  322. Arg1: person
  323.  
  324.  
  325. Name: addToRemainsCollector
  326. Description: Flags given objects to me managed by unitRemove manager
  327. Category: General
  328. Address: 0xC8F470
  329. Example: addToRemainsCollector [unit1, unit2]
  330. Arg1: array
  331.  
  332.  
  333. Name: addWeaponPool
  334. Description: Adds count weapons of type name into the weapon pool (used in campaigns to transfer weapons to the next mission).
  335. Category: General
  336. Address: 0xF92FF0
  337. Arg1: [name, count]
  338.  
  339.  
  340. Name: agent
  341. Description: Return a person for given agent.
  342. Category: Agents
  343. Address: 0xD5E010
  344. Example: _person = agent _agent
  345. Arg1: agent
  346.  
  347.  
  348. Name: agents
  349. Description: Return a list of agents in the current mission.
  350. Category: Agents
  351. Address: 0xD5E0B0
  352. Example: _agents = agents
  353.  
  354.  
  355. Name: aimPos
  356. Description: Returns the position of the object other units can aim to in format <ar>PositionASL</ar>.
  357. Category: General
  358. Address: 0xD35760
  359. Example: aimPos player
  360. Arg1: obj
  361.  
  362.  
  363. Name: airDensityCurveRTD
  364. Description: Returns air density curve graph.
  365. Category: General
  366. Address: 0xCA0A80
  367.  
  368.  
  369. Name: airDensityRTD
  370. Description: Returns air density in given altitude.
  371. Category: General
  372. Address: 0xCA0DE0
  373. Arg1: altitude
  374.  
  375.  
  376. Name: airportSide
  377. Description: Checks a side of the airport.
  378. Category: General
  379. Address: 0xC8FF60
  380. Example: airportSide 0
  381. Ex. Returns: west
  382. Arg1: airportId
  383.  
  384.  
  385. Name: AISFinishHeal
  386. Description: AIS end state.
  387. Category: General
  388. Address: 0xC8CF80
  389. Example: AISFinishHeal [wounded,medic,true]
  390. Arg1: [unit,unit,bool]
  391.  
  392.  
  393. Name: alive
  394. Description: Checks whether the given person, vehicle or building is't dead / destroyed.
  395. Category: General
  396. Address: 0xD2C890
  397. Example: alive player
  398. Arg1: obj
  399.  
  400.  
  401. Name: allCurators
  402. Description: Returns list of all curators.
  403. Category: General
  404. Address: 0xCA1950
  405.  
  406.  
  407. Name: allDead
  408. Description: Return a list of dead units and destroyed vehicles. Dead unit might be inside vehicle.,
  409. Category: General
  410. Address: 0xCA1AF0
  411.  
  412.  
  413. Name: allDeadMen
  414. Description: Return a list of dead units. Dead unit might be inside vehicle.,
  415. Category: General
  416. Address: 0xCA1C00
  417.  
  418.  
  419. Name: allGroups
  420. Description: Return a list of all groups.
  421. Category: General
  422. Address: 0xCA1D10
  423.  
  424.  
  425. Name: allMapMarkers
  426. Description: Return all markers in map.
  427. Category: General
  428. Address: 0xD69C50
  429.  
  430.  
  431. Name: allMines
  432. Description: Returns an array of all mines in game.
  433. Category: General
  434. Address: 0xCA1EF0
  435. Example: allMines
  436. Ex. Returns: [listOfAllMines]
  437.  
  438.  
  439. Name: allMissionObjects
  440. Description: Returns all mission objects with given type.
  441. Category: General
  442. Address: 0xCA1F40
  443. Example: allMissionObjects "Air"
  444. Arg1: type
  445.  
  446.  
  447. Name: allSites
  448. Description: Return a list of all sites.
  449. Category: General
  450. Address: 0xCA22E0
  451.  
  452.  
  453. Name: allTurrets
  454. Description: Returns array with turrets in given vehicle
  455. Category: General
  456. Address: 0xCA23E0
  457. Example: allTurrets vehicle player
  458. Arg1: vehicle
  459.  
  460.  
  461. Name: allTurrets
  462. Description: Returns array with turrets in given vehicle. TRUE FALSE stands for return person turrets
  463. Category: General
  464. Address: 0xCA2490
  465. Example: allTurrets [vehicle player, true]
  466. Arg1: [vehicle, includePersonTurrets]
  467.  
  468.  
  469. Name: allUnits
  470. Description: Return a list of all units (all persons except agents).
  471. Category: General
  472. Address: 0xCA26A0
  473.  
  474.  
  475. Name: allUnitsUAV
  476. Description: Return a list of all UAV units.
  477. Category: General
  478. Address: 0xCA28E0
  479.  
  480.  
  481. Name: animationState
  482. Description: Return the name of the current primary animation.
  483. Category: General
  484. Address: 0xD6FE20
  485. Arg1: man
  486.  
  487.  
  488. Name: armoryPoints
  489. Description: Return the stored value of armory points.
  490. Category: General
  491. Address: 0xCA2940
  492.  
  493.  
  494. Name: ASLToATL
  495. Description: Converts a position from <ar>PositionASL</ar> to <ar>Position</ar> format.
  496. Category: General
  497. Address: 0xD3C3B0
  498. Example: ASLToATL getPosASL player
  499. Arg1: pos
  500.  
  501.  
  502. Name: assignedCargo
  503. Description: Returns the list of soldiers assigned to the given vehicle as a cargo.
  504. Category: General
  505. Address: 0xD325E0
  506. Arg1: vehicle
  507.  
  508.  
  509. Name: assignedCommander
  510. Description: Returns the soldier assigned to the given vehicle as a commander.
  511. Category: General
  512. Address: 0xD329B0
  513. Arg1: vehicle
  514.  
  515.  
  516. Name: assignedDriver
  517. Description: Returns the soldier assigned to the given vehicle as a driver.
  518. Category: General
  519. Address: 0xD32D00
  520. Arg1: vehicle
  521.  
  522.  
  523. Name: assignedGunner
  524. Description: Returns the soldier assigned to the given vehicle as a gunner.
  525. Category: General
  526. Address: 0xD33900
  527. Arg1: vehicle
  528.  
  529.  
  530. Name: assignedItems
  531. Description: Get array with all assigned items.
  532. Category: General
  533. Address: 0xD2C8E0
  534. Arg1: unit
  535.  
  536.  
  537. Name: assignedTarget
  538. Description: Return the target assigned to the vehicle.
  539. Category: General
  540. Address: 0xD6FE80
  541. Arg1: vehicle
  542.  
  543.  
  544. Name: assignedTeam
  545. Description: Checks which team does the vehicle (its commander unit) belong to.
  546. Category: General
  547. Address: 0xC908D0
  548. Example: assignedTeam soldier2
  549. Ex. Returns: MAIN
  550. Arg1: vehicle
  551.  
  552.  
  553. Name: assignedVehicle
  554. Description: Return the vehicle person is assigned to.
  555. Category: General
  556. Address: 0xD31120
  557. Arg1: person
  558.  
  559.  
  560. Name: assignedVehicleRole
  561. Description: Return the position in vehicle person is assigned to.
  562. Category: General
  563. Address: 0xD311A0
  564. Arg1: person
  565.  
  566.  
  567. Name: ATLToASL
  568. Description: Converts a position from <ar>Position</ar> to <ar>PositionASL</ar> format.
  569. Category: General
  570. Address: 0xD3C4B0
  571. Example: ATLToASL getPosATL player
  572. Arg1: pos
  573.  
  574.  
  575. Name: attachedObjects
  576. Description: Returns list of attached objects.
  577. Category: General
  578. Address: 0xC90AC0
  579. Example: attachedObjects player
  580. Arg1: Unit
  581.  
  582.  
  583. Name: attachedTo
  584. Description: Returns the object it is attach to.
  585. Category: General
  586. Address: 0xC90CA0
  587. Example: attachedTo player
  588. Arg1: Unit
  589.  
  590.  
  591. Name: attackEnabled
  592. Description: Return whether leader can issue attack commands.
  593. Category: General
  594. Address: 0xCB36B0
  595. Arg1: group
  596.  
  597.  
  598. Name: backpack
  599. Description: Returns a class of a backpack.
  600. Category: General
  601. Address: 0xD2E330
  602. Arg1: unit
  603.  
  604.  
  605. Name: backpackCargo
  606. Description: Get array with backpacks from ammo box (or any general weapon holder container).
  607. Category: General
  608. Address: 0xD2E090
  609. Arg1: box
  610.  
  611.  
  612. Name: backpackContainer
  613. Description: Returns container of a backpack.
  614. Category: General
  615. Address: 0xD2E0B0
  616. Arg1: unit
  617.  
  618.  
  619. Name: backpackItems
  620. Description: Get array with all items from backpack.
  621. Category: General
  622. Address: 0xD2E0D0
  623. Arg1: unit
  624.  
  625.  
  626. Name: backpackMagazines
  627. Description: Get array with all magazines from vest.
  628. Category: General
  629. Address: 0xD2E310
  630. Arg1: unit
  631.  
  632.  
  633. Name: behaviour
  634. Description: Returns the behaviour mode of the given unit ("CARELESS","SAFE","AWARE","COMBAT" or "STEALTH").
  635. Category: General
  636. Address: 0xD2E360
  637. Example: behaviour player
  638. Arg1: unit
  639.  
  640.  
  641. Name: benchmark
  642. Description: Returns the value of "3D performance" as it is in OFP preferences. This can be used to estimate computer performance. The function can be used to create missions that are able to adapt to computer peformance.
  643. Category: General
  644. Address: 0xC90D20
  645. Example: ? benchmark>2000 : setviewdistance 2000
  646.  
  647.  
  648. Name: binocular
  649. Description: Returns name of currently used binocular.
  650. Category: General
  651. Address: 0xD31890
  652. Arg1: unit
  653.  
  654.  
  655. Name: blufor
  656. Description: Pre-defined variable for the blufor side.
  657. Category: General
  658. Address: 0xD57560
  659.  
  660.  
  661. Name: boundingBox
  662. Description: Returns a bounding box of given object in model coordinates space with size adjusted according to animation and destruction. The result is in format [[minX, minZ, minY], [maxX, maxZ, maxY]].
  663. Category: General
  664. Address: 0xD319B0
  665. Arg1: object
  666.  
  667.  
  668. Name: boundingBoxReal
  669. Description: Returns a bounding box of given object in model coordinates space. The result is in format [[minX, minZ, minY], [maxX, maxZ, maxY]].
  670. Category: General
  671. Address: 0xD31CF0
  672. Example: boundingBoxReal cursorTarget
  673. Arg1: obj
  674.  
  675.  
  676. Name: boundingCenter
  677. Description: Returns the position of original (loaded) center of object in model coordinates. The result is in format [x, z, y]
  678. Category: General
  679. Address: 0xD32030
  680. Arg1: object
  681.  
  682.  
  683. Name: briefingName
  684. Description: Returns the name of the current briefing.
  685. Category: General
  686. Address: 0xC90D40
  687.  
  688.  
  689. Name: buldozer_EnableRoadDiag
  690. Category: General
  691. Address: 0xC90F60
  692. Arg1: enable
  693.  
  694.  
  695. Name: buldozer_IsEnabledRoadDiag
  696. Description: Is enabled road diag in buldozer?
  697. Category: General
  698. Address: 0xCB88A0
  699. Example: true/false
  700.  
  701.  
  702. Name: buldozer_LoadNewRoads
  703. Category: General
  704. Address: 0xC90FF0
  705. Arg1: path
  706.  
  707.  
  708. Name: buldozer_reloadOperMap
  709. Description: Reload oper map visible in costMap diag tool.
  710. Category: General
  711. Address: 0xC91100
  712.  
  713.  
  714. Name: buttonAction
  715. Description: Returns the action assigned to the given button or active text. The action is any expression in this scripting language.
  716. Category: General
  717. Address: 0xD61890
  718. Example: _action = buttonAction _button
  719. Arg1: control
  720.  
  721.  
  722. Name: buttonAction
  723. Description: Returns the action assigned to the control with id idc of the topmost user dialog. The action is any expression in this scripting language. The function can be used for buttons and active texts.
  724. Category: General
  725. Address: 0xC91120
  726. Example: _action = buttonAction 100
  727. Arg1: idc
  728.  
  729.  
  730. Name: buttonSetAction
  731. Description: Assigns an action to the control with id idc of the topmost user dialog. Action is any expression in this scripting language. The function can be used for buttons and active texts.
  732. Category: General
  733. Address: 0xC913D0
  734. Example: buttonSetAction [100, "player exec ""reply.sqs"""]
  735. Arg1: [idc, action]
  736.  
  737.  
  738. Name: cadetMode
  739. Description: Returns true if the mission is played in cadet mode and false in veteran mode.
  740. Category: General
  741. Address: 0xC91560
  742.  
  743.  
  744. Name: camCommitted
  745. Description: Checks whether the camera has finished committing.
  746. Category: General
  747. Address: 0xC91940
  748. Example: camCommitted _camera
  749. Arg1: camera
  750.  
  751.  
  752. Name: camDestroy
  753. Description: Destroys the camera.
  754. Category: General
  755. Address: 0xC91E80
  756. Arg1: camera
  757.  
  758.  
  759. Name: cameraEffectEnableHUD
  760. Description: Enable / disable showing of in-game UI during currently active camera effect.
  761. Category: General
  762. Address: 0xC92B10
  763. Arg1: enable
  764.  
  765.  
  766. Name: cameraInterest
  767. Description: Return camera interest for given entity.
  768. Category: General
  769. Address: 0xD6FF70
  770. Arg1: entity
  771.  
  772.  
  773. Name: cameraOn
  774. Description: Returns the vehicle to which the camera is attached.
  775. Category: General
  776. Address: 0xC92B60
  777.  
  778.  
  779. Name: cameraView
  780. Description: Return type of camera.
  781. Category: General
  782. Address: 0xD32510
  783.  
  784.  
  785. Name: campaignConfigFile
  786. Description: Return root of campaign description.ext entries hierarchy.
  787. Category: General
  788. Address: 0xC938A0
  789.  
  790.  
  791. Name: camPreloaded
  792. Description: Checks whether the camera has finished preloading.
  793. Category: General
  794. Address: 0xC92150
  795. Example: camPreloaded _camera
  796. Arg1: camera
  797.  
  798.  
  799. Name: camTarget
  800. Description: Returns camera's target.
  801. Category: General
  802. Address: 0xC91EC0
  803. Example: camTarget _camera
  804. Arg1: camera
  805.  
  806.  
  807. Name: camUseNVG
  808. Description: Set / clear using of night vision during cutscenes.
  809. Category: General
  810. Address: 0xD4FAA0
  811. Arg1: set
  812.  
  813.  
  814. Name: canFire
  815. Description: Checks whether the given vehicle is able to fire. It does not check for ammo, only for damage.
  816. Category: General
  817. Address: 0xD2E840
  818. Example: canFire vehicle player
  819. Arg1: vehicle
  820.  
  821.  
  822. Name: canMove
  823. Description: Checks whether the given vehicle is able to move. It does not test for fuel, only the damage status is checked.
  824. Category: General
  825. Address: 0xD2E8E0
  826. Example: canMove vehicle player
  827. Arg1: vehicle
  828.  
  829.  
  830. Name: canStand
  831. Description: Checks whether the given soldier is able to stand up.
  832. Category: General
  833. Address: 0xD2E950
  834. Example: canStand player
  835. Arg1: soldier
  836.  
  837.  
  838. Name: canUnloadInCombat
  839. Description: Check if cargo of this vehicle want to get out when in combat.
  840. Category: General
  841. Address: 0xD2E9B0
  842. Arg1: vehicle
  843.  
  844.  
  845. Name: captive
  846. Description: Checks whether the unit is a captive. If the unit is a vehicle, its commander is checked instead.
  847. Category: General
  848. Address: 0xD2EA10
  849. Example: captive player
  850. Arg1: unit
  851.  
  852.  
  853. Name: captiveNum
  854. Description: Checks whether the unit is a captive. If the unit is a vehicle, its commander is checked instead.
  855. Category: General
  856. Address: 0xD2EA80
  857. Example: captive player
  858. Arg1: unit
  859.  
  860.  
  861. Name: cbChecked
  862. Description: Returns the current state of CheckBox.
  863. Category: General
  864. Address: 0xD61FA0
  865. Example: _checked = cbChecked _myCheckBox
  866. Arg1: control
  867.  
  868.  
  869. Name: cheatsEnabled
  870. Description: Checks whether cheats are enabled (whether the designers' version is running).
  871. Category: General
  872. Address: 0x11D62F0
  873.  
  874.  
  875. Name: checkAIFeature
  876. Description: Check if given AI feature is currently enabled.
  877. Category: General
  878. Address: 0xC92F30
  879. Arg1: feature
  880.  
  881.  
  882. Name: civilian
  883. Description: The Civilian side.
  884. Category: General
  885. Address: 0xD575A0
  886.  
  887.  
  888. Name: clearAllItemsFromBackpack
  889. Description: Removes all items from the backpack.
  890. Category: General
  891. Address: 0xD2EAF0
  892. Arg1: unit
  893.  
  894.  
  895. Name: clearBackpackCargo
  896. Description: Removes all backpacks from ammo box (or any general weapon holder container).
  897. Category: General
  898. Address: 0xD2EB50
  899. Example: clearBackpackCargo jeepOne
  900. Arg1: box
  901.  
  902.  
  903. Name: clearBackpackCargoGlobal
  904. Description: Removes all magazines from the vehicle cargo space. MP synchronized.
  905. Category: General
  906. Address: 0xD2EBB0
  907. Example: clearMagazineCargoGlobal jeepOne
  908. Arg1: unit
  909.  
  910.  
  911. Name: clearForcesRTD
  912. Description: Remove all force generators from wolrd.
  913. Category: General
  914. Address: 0xC93200
  915.  
  916.  
  917. Name: clearGroupIcons
  918. Description: Removes all icon from group.
  919. Category: General
  920. Address: 0xC93250
  921. Example: clearGroupIcons group
  922. Arg1: group
  923.  
  924.  
  925. Name: clearItemCargo
  926. Description: Removes all items from ammo box (or any general weapon holder container).
  927. Category: General
  928. Address: 0xD2EC00
  929. Example: clearItemCargo jeepOne
  930. Arg1: box
  931.  
  932.  
  933. Name: clearItemCargoGlobal
  934. Description: Removes all items from ammo box (or any general weapon holder container).
  935. Category: General
  936. Address: 0xD2EC60
  937. Example: clearItemCargoGlobal jeepOne
  938. Arg1: box
  939.  
  940.  
  941. Name: clearItemPool
  942. Description: Removes all magazines from the weapon pool (this is used in campaigns to transfer weapons to the next mission).
  943. Category: General
  944. Address: 0xF93130
  945.  
  946.  
  947. Name: clearMagazineCargo
  948. Description: Removes all magazines from the vehicle cargo space.
  949. Category: General
  950. Address: 0xD2ECB0
  951. Example: clearMagazineCargo jeepOne
  952. Arg1: unit
  953.  
  954.  
  955. Name: clearMagazineCargoGlobal
  956. Description: Removes all magazines from the vehicle cargo space. MP synchronized.
  957. Category: General
  958. Address: 0xD2ED10
  959. Example: clearMagazineCargoGlobal jeepOne
  960. Arg1: unit
  961.  
  962.  
  963. Name: clearMagazinePool
  964. Description: Removes all magazines from the weapon pool (this is used in campaigns to transfer weapons to the next mission).
  965. Category: General
  966. Address: 0xF93170
  967.  
  968.  
  969. Name: clearRadio
  970. Description: Clean up the content of radio protocol history.
  971. Category: General
  972. Address: 0xD49360
  973.  
  974.  
  975. Name: clearWeaponCargo
  976. Description: Removes all weapons from the vehicle cargo space.
  977. Category: General
  978. Address: 0xD2ED60
  979. Example: clearWeaponCargo jeepOne
  980. Arg1: unit
  981.  
  982.  
  983. Name: clearWeaponCargoGlobal
  984. Description: Removes all weapons from the vehicle cargo space. MP synchronized.
  985. Category: General
  986. Address: 0xD2EDC0
  987. Example: clearWeaponCargoGlobal jeepOne
  988. Arg1: unit
  989.  
  990.  
  991. Name: clearWeaponPool
  992. Description: Removes all weapons from the weapon pool (this is used in campaigns to transfer weapons to the next mission).
  993. Category: General
  994. Address: 0xF931B0
  995.  
  996.  
  997. Name: closeDialog
  998. Description: Closes the topmost user dialog as if a button with id idc was pressed.
  999. Category: General
  1000. Address: 0xC9AC80
  1001. Example: closeDialog 1
  1002. Arg1: idc
  1003.  
  1004.  
  1005. Name: collectiveRTD
  1006. Description: Returns collective.
  1007. Category: General
  1008. Address: 0xCA37A0
  1009. Arg1: RTD_helicopter
  1010.  
  1011.  
  1012. Name: combatMode
  1013. Description: Returns the combat mode of the given unit ("BLUE","GREEN","YELLOW" or "RED").
  1014. Category: General
  1015. Address: 0xCB2EF0
  1016. Example: combatMode group player
  1017. Arg1: grp
  1018.  
  1019.  
  1020. Name: commander
  1021. Description: Returns the commander of the vehicle. If the vehicle is not a vehicle, but a person, the person is returned instead.
  1022. Category: General
  1023. Address: 0xD2F2D0
  1024. Example: commander vehicle player
  1025. Arg1: vehicle
  1026.  
  1027.  
  1028. Name: commandGetOut
  1029. Description: Orders the unit to get out from the vehicle (via the radio).
  1030. Category: General
  1031. Address: 0xD6E8C0
  1032. Example: commandGetOut unitOne
  1033. Arg1: unit
  1034.  
  1035.  
  1036. Name: commandingMenu
  1037. Description: Return the name of the topmost commanding menu.
  1038. Category: General
  1039. Address: 0xCA3A40
  1040.  
  1041.  
  1042. Name: commandStop
  1043. Description: Orders the unit to stop (via the radio).
  1044. Note: the stop command is never finished; the unit will never be ready.
  1045. Category: General
  1046. Address: 0xD6E900
  1047. Example: commandStop unitOne
  1048. Arg1: unit
  1049.  
  1050.  
  1051. Name: completedFSM
  1052. Description: Check whether the given FSM completes. The FSM handle is the number returned by the execFSM command.
  1053. Category: General
  1054. Address: 0xC9C9B0
  1055. Arg1: FSM handle
  1056.  
  1057.  
  1058. Name: composeText
  1059. Description: Creates a structured text by joining the given structured or plain texts.
  1060. Category: General
  1061. Address: 0xD609B0
  1062. Example: txt = composeText ["First line", image "data\isniper.paa", lineBreak, "Second line"]
  1063. Arg1: [text1, text2, ...]
  1064.  
  1065.  
  1066. Name: configFile
  1067. Description: Return root of config entries hierarchy.
  1068. Category: General
  1069. Address: 0xC942A0
  1070.  
  1071.  
  1072. Name: configName
  1073. Description: Returns name of config entry.
  1074. Category: General
  1075. Address: 0xC94180
  1076. Example: _name = configName (configFile >> "CfgVehicles")
  1077. Ex. Returns: "CfgVehicles"
  1078. Arg1: config
  1079.  
  1080.  
  1081. Name: configProperties
  1082. Description: Returns a list of all properties of the given class. Parameter is an array where first item is a target config class, second is string with condition (similar to configClasses), third is a bool: when set to true, the inherited properties are also included.
  1083. Category: General
  1084. Address: 0xCA4090
  1085. Arg1: [config, condition, includeInherited]
  1086.  
  1087.  
  1088. Name: controlNull
  1089. Description: A non-existing control. This value is not equal to anything, including itself.
  1090. Category: General
  1091. Address: 0xD62F90
  1092.  
  1093.  
  1094. Name: copyFromClipboard
  1095. Description: Return the content of the (text) clipboard.
  1096. Category: General
  1097. Address: 0xC94E60
  1098.  
  1099.  
  1100. Name: copyToClipboard
  1101. Description: Copy the text to the clipboard.
  1102. Category: General
  1103. Address: 0xC94F20
  1104. Arg1: text
  1105.  
  1106.  
  1107. Name: count
  1108. Description: Returns count of subentries.
  1109. Category: General
  1110. Address: 0xC93B00
  1111. Example: _count = count (configFile >> "CfgVehicles")
  1112. Arg1: config
  1113.  
  1114.  
  1115. Name: createAgent
  1116. Description: Creates an (independent) agent (person) of the given type (type is a name of a subclass of CfgVehicles). If the markers array contains several marker names, the position of a random one is used. Otherwise, the given position is used. The unit is placed inside a circle with this position as its center and placement as its radius. Special properties can be: "NONE" and "FORM".
  1117. Category: General
  1118. Address: 0xC8F8E0
  1119. Example: agent = createAgent ["SoldierWB", position player, [], 0, "FORM"]
  1120. Arg1: [type, position, markers, placement, special]
  1121.  
  1122.  
  1123. Name: createCenter
  1124. Description: Creates a new AI center for the given side.
  1125. Category: General
  1126. Address: 0xC92CA0
  1127. Example: center = createCenter East
  1128. Arg1: side
  1129.  
  1130.  
  1131. Name: createDialog
  1132. Description: Creates a user dialog from the resource template name. If a user dialog already exists, it creates a child dialog of the topmost user dialog. The class name is searched in the description.ext file of the mission, the description.ext file of the campaign and the globlal resource.cpp file. The function returns its success.
  1133. Category: General
  1134. Address: 0xC9ACF0
  1135. Example: _ok = createDialog "RscDisplayGame"
  1136. Arg1: name
  1137.  
  1138.  
  1139. Name: createGearDialog
  1140. Description: Opens gear dialog for given unit.
  1141. Category: General
  1142. Address: 0xC95C90
  1143. Example: CreateGearDialog [palyer,"RscDisplayGear"]
  1144. Arg1: [unit,resource]
  1145.  
  1146.  
  1147. Name: createGroup
  1148. Description: Creates a new AI group for the given center (side).
  1149. Category: General
  1150. Address: 0xCB2770
  1151. Example: group = createGroup East
  1152. Arg1: side
  1153.  
  1154.  
  1155. Name: createGuardedPoint
  1156. Description: Adds a point guarded by the given side. If idStatic is not negative, the position of a static object with the given id is guarded. If the given vehicle is valid, the starting position of the vehicle is guarded, otherwise the given position is guarded.
  1157. Category: General
  1158. Address: 0xCB4BD0
  1159. Example: point = createGuardedPoint [East, [0, 0], -1, vehicle player]
  1160. Arg1: [side, position, idStatic, vehicle]
  1161.  
  1162.  
  1163. Name: createMarker
  1164. Description: Creates a new marker on the given position. The marker name has to be unique. The marker is created on all computers in a network session.
  1165. Category: General
  1166. Address: 0xD25AF0
  1167. Example: marker = createMarker [Marker1, position player]
  1168. Arg1: [name, position]
  1169.  
  1170.  
  1171. Name: createMarkerLocal
  1172. Description: Creates a new marker on the given position. The marker name has to be unique. The marker is only created on the computer where the command is called.
  1173. Category: General
  1174. Address: 0xD258F0
  1175. Example: marker = createMarkerLocal [Marker1, position player]
  1176. Arg1: [name, position]
  1177.  
  1178.  
  1179. Name: createMine
  1180. Description: Creates a mine of the given type (type is the name of the subclass of CfgVehicles). If the markers array contains several marker names, the position of a random one is used. Otherwise, the given position is used. The mine is placed inside a circle with this position as its center and placement as its radius.
  1181. Category: General
  1182. Address: 0xD28100
  1183. Example: mine = createMine ["MineMine", position player, [], 0]
  1184. Arg1: [type, position, markers, placement]
  1185.  
  1186.  
  1187. Name: createSoundSource
  1188. Description: Creates a sound source of the given type (type is the name of the subclass of CfgVehicles). If the markers array contains several marker names, the position of a random one is used. Otherwise, the given position is used. The sound source is placed inside a circle with this position as its center and placement as its radius.
  1189. Category: General
  1190. Address: 0xD58DF0
  1191. Example: soundSource = createSoundSource ["LittleDog", position player, [], 0]
  1192. Arg1: [type, position, markers, placement]
  1193.  
  1194.  
  1195. Name: createTeam
  1196. Description: Create a team and name it.
  1197. Category: Agents
  1198. Address: 0xD5D0D0
  1199. Example: _team = createTeam ["USMC_Team", "Fire Team Red"]
  1200. Arg1: [type, name]
  1201.  
  1202.  
  1203. Name: createTrigger
  1204. Description: Creates a new trigger on the given position. An object of the given type is created; this type must be a class name in CfgNonAIVehicles or CfgVehicles with simulation=detector.
  1205. Category: General
  1206. Address: 0xD5F630
  1207. Example: trigger = createTrigger["EmptyDetector", position player]
  1208. Arg1: [type, position]
  1209.  
  1210.  
  1211. Name: createVehicle
  1212. Description: Creates a vehicle of the given type (type is the name of the subclass in CfgVehicles). If the markers array contains several marker names, the position of a random one is used. Otherwise, the given position is used. The vehicle is placed inside a circle with this position as center and placement as its radius. Special properties can be: "NONE", "FLY" and "FORM".
  1213. Category: General
  1214. Address: 0xD6EAC0
  1215. Example: veh = createVehicle ["Cobra", position player, [], 0, "FLY"]
  1216. Arg1: [type, position, markers, placement, special]
  1217.  
  1218.  
  1219. Name: createVehicleCrew
  1220. Description: Creates crew to given vehicle.
  1221. Category: General
  1222. Address: 0xC973B0
  1223. Example: createVehicleCrew vehicle0
  1224. Arg1: Vehicle
  1225.  
  1226.  
  1227. Name: crew
  1228. Description: Returns all units mounted in the given vehicle. If the vehicle is not a vehicle, but person, a list containing only persons is returned.
  1229. Category: General
  1230. Address: 0xD396F0
  1231. Example: crew vehicle player
  1232. Arg1: vehicle
  1233.  
  1234.  
  1235. Name: ctrlActivate
  1236. Description: Launch actions attached to given (button based) control.
  1237. Category: General
  1238. Address: 0xD61E40
  1239. Example: ctrlActivate _control
  1240. Arg1: control
  1241.  
  1242.  
  1243. Name: ctrlAutoScrollDelay
  1244. Description: Returns number of seconds until auto-scroll starts. -2 if scrollbar not present.
  1245. Category: General
  1246. Address: 0xD62520
  1247. Example: _delay = ctrlAutoScrollDelay _control
  1248. Arg1: control
  1249.  
  1250.  
  1251. Name: ctrlAutoScrollRewind
  1252. Description: True if auto-scroll should move back to start after it reach end.
  1253. Category: General
  1254. Address: 0xD62630
  1255. Example: _rewind = ctrlAutoScrollRewind _control
  1256. Arg1: control
  1257.  
  1258.  
  1259. Name: ctrlAutoScrollSpeed
  1260. Description: Returns number of seconds to auto-scroll one line. -1 if auto-scroll is disabled. -2 if scrollbar not present.
  1261. Category: General
  1262. Address: 0xD62720
  1263. Example: _speed = ctrlAutoScrollSpeed _control
  1264. Arg1: control
  1265.  
  1266.  
  1267. Name: ctrlChecked
  1268. Description: Returns the current state of textual checkbox.
  1269. Category: General
  1270. Address: 0xD62830
  1271. Example: _checked = ctrlChecked _control
  1272. Arg1: control
  1273.  
  1274.  
  1275. Name: ctrlClassName
  1276. Description: Returns class name of given control.
  1277. Category: General
  1278. Address: 0xCA4830
  1279. Example: ctrlClassName ((FindDisplay 20000) displayCtrl 20001)
  1280. Arg1: control
  1281.  
  1282.  
  1283. Name: ctrlCommitted
  1284. Description: Check if the control animation is finished.
  1285. Category: General
  1286. Address: 0xD62360
  1287. Example: _done = ctrlCommitted _control
  1288. Arg1: control
  1289.  
  1290.  
  1291. Name: ctrlDelete
  1292. Description: Deletes given control.
  1293. Category: General
  1294. Address: 0xC99B90
  1295. Example: ctrlDelete ((FindDisplay 20000) displayCtrl 20001)
  1296. Arg1: control
  1297.  
  1298.  
  1299. Name: ctrlEnable
  1300. Description: Enables / disables the control with id idc of the topmost user dialog.
  1301. Category: General
  1302. Address: 0xC97A40
  1303. Example: ctrlEnable [100, false]
  1304. Arg1: [idc, enable]
  1305.  
  1306.  
  1307. Name: ctrlEnabled
  1308. Description: Returns whether the control with id idc of the topmost user dialog is enabled.
  1309. Category: General
  1310. Address: 0xC97AF0
  1311. Example: _enabled = ctrlEnabled 100
  1312. Arg1: idc
  1313.  
  1314.  
  1315. Name: ctrlEnabled
  1316. Description: Returns whether given control is enabled.
  1317. Category: General
  1318. Address: 0xD62DF0
  1319. Example: _ok = ctrlEnabled _control
  1320. Arg1: control
  1321.  
  1322.  
  1323. Name: ctrlFade
  1324. Description: Returns the current fade factor of control.
  1325. Category: General
  1326. Address: 0xD628C0
  1327. Example: _scale = ctrlFade _control
  1328. Arg1: control
  1329.  
  1330.  
  1331. Name: ctrlHTMLLoaded
  1332. Description: Returns true when HTML content was successfully loaded.
  1333. Category: General
  1334. Address: 0xD66A20
  1335. Example: _htmlLoaded ctrlHTMLLoaded _control
  1336. Arg1: control
  1337.  
  1338.  
  1339. Name: ctrlIDC
  1340. Description: Returns control IDC.
  1341. Category: General
  1342. Address: 0xD62D70
  1343. Example: IDC = ctrlIDC _control
  1344. Arg1: control
  1345.  
  1346.  
  1347. Name: ctrlIDD
  1348. Description: Returns display IDD.
  1349. Category: General
  1350. Address: 0xD65C90
  1351. Example: IDD = ctrlIDD _display
  1352. Arg1: display
  1353.  
  1354.  
  1355. Name: ctrlMapAnimClear
  1356. Description: Clears the map animation.
  1357. Category: General
  1358. Address: 0xD69F10
  1359. Arg1: control
  1360.  
  1361.  
  1362. Name: ctrlMapAnimCommit
  1363. Description: Plays the map animation.
  1364. Category: General
  1365. Address: 0xD69FA0
  1366. Arg1: control
  1367.  
  1368.  
  1369. Name: ctrlMapAnimDone
  1370. Description: Checks whether the map animation has finished.
  1371. Category: General
  1372. Address: 0xD6A030
  1373. Arg1: control
  1374.  
  1375.  
  1376. Name: ctrlMapMouseOver
  1377. Description: Returns description of map sign mouse cursor is over.
  1378. Category: General
  1379. Address: 0xD6A170
  1380. Arg1: control
  1381.  
  1382.  
  1383. Name: ctrlMapScale
  1384. Description: Return the current scale of the map control.
  1385. Category: General
  1386. Address: 0xD6A0D0
  1387. Arg1: control
  1388.  
  1389.  
  1390. Name: ctrlModel
  1391. Description: Returns model setted in given control.
  1392. Category: General
  1393. Address: 0xCA4BA0
  1394. Example: ctrlModel ((FindDisplay 20000) displayCtrl 20001)
  1395. Arg1: control
  1396.  
  1397.  
  1398. Name: ctrlModelDirAndUp
  1399. Description: Returns orientation setted in given control.
  1400. Category: General
  1401. Address: 0xCA4CA0
  1402. Example: ctrlModelOrientation ((FindDisplay 20000) displayCtrl 20001)
  1403. Arg1: control
  1404.  
  1405.  
  1406. Name: ctrlModelScale
  1407. Description: Returns scale setted in given control object
  1408. Category: General
  1409. Address: 0xCA4DE0
  1410. Example: ctrlModelScale ((FindDisplay 20000) displayCtrl 20001)
  1411. Arg1: control
  1412.  
  1413.  
  1414. Name: ctrlParent
  1415. Description: Returns container of given control.
  1416. Category: General
  1417. Address: 0xD62FD0
  1418. Example: _display = ctrlParent _control
  1419. Arg1: control
  1420.  
  1421.  
  1422. Name: ctrlPosition
  1423. Description: Returns the current position and size of control as [x, y, w, h] array.
  1424. Category: General
  1425. Address: 0xD62970
  1426. Example: _pos = ctrlPosition _control
  1427. Arg1: control
  1428.  
  1429.  
  1430. Name: ctrlScale
  1431. Description: Returns the current scale of control.
  1432. Category: General
  1433. Address: 0xD62C30
  1434. Example: _scale = ctrlScale _control
  1435. Arg1: control
  1436.  
  1437.  
  1438. Name: ctrlSetFocus
  1439. Description: Set the input focus on given control.
  1440. Category: General
  1441. Address: 0xD624A0
  1442. Example: ctrlSetFocus _control
  1443. Arg1: control
  1444.  
  1445.  
  1446. Name: ctrlSetText
  1447. Description: Sets the text that will be shown in the control with id idc of the topmost user dialog. This can be used for static texts, buttons, edit lines and active texts.
  1448. Category: General
  1449. Address: 0xC98170
  1450. Example: ctrlSetText [100, "Hello, world"]
  1451. Arg1: [idc, text]
  1452.  
  1453.  
  1454. Name: ctrlShow
  1455. Description: Shows / hides the control with id idc of the topmost user dialog.
  1456. Category: General
  1457. Address: 0xC982A0
  1458. Example: ctrlShow [100, true]
  1459. Arg1: [idc, show]
  1460.  
  1461.  
  1462. Name: ctrlShown
  1463. Description: Returns whether given control is shown.
  1464. Category: General
  1465. Address: 0xD62F10
  1466. Example: _ok = ctrlShown _control
  1467. Arg1: control
  1468.  
  1469.  
  1470. Name: ctrlText
  1471. Description: Returns the text shown in given control.
  1472. Category: General
  1473. Address: 0xD62CE0
  1474. Example: _text = ctrlText _control
  1475. Arg1: control
  1476.  
  1477.  
  1478. Name: ctrlText
  1479. Description: Returns the text shown in the control with id idc of the topmost user dialog. This can be used for static texts, buttons, edit lines and active texts.
  1480. Category: General
  1481. Address: 0xC97B80
  1482. Example: _message = ctrlText 100
  1483. Arg1: idc
  1484.  
  1485.  
  1486. Name: ctrlTextHeight
  1487. Description: Returns the text height.
  1488. Category: General
  1489. Address: 0xD66600
  1490. Example: h = ctrlTextHeight _control
  1491. Arg1: structuredText control
  1492.  
  1493.  
  1494. Name: ctrlType
  1495. Description: Returns value representing type of control.
  1496. Category: General
  1497. Address: 0xD65690
  1498. Example: _type = ctrlType _control
  1499. Arg1: control
  1500.  
  1501.  
  1502. Name: ctrlVisible
  1503. Description: Returns whether the control with id idc of the topmost user dialog is visible.
  1504. Category: General
  1505. Address: 0xC98350
  1506. Example: _visible = ctrlVisible 100
  1507. Arg1: idc
  1508.  
  1509.  
  1510. Name: curatorAddons
  1511. Description: Return list of addons allowed to given curator.
  1512. Category: General
  1513. Address: 0xCA4EF0
  1514. Arg1: curatorObj
  1515.  
  1516.  
  1517. Name: curatorCamera
  1518. Description: Returns curator camera object.
  1519. Category: General
  1520. Address: 0xCA50A0
  1521.  
  1522.  
  1523. Name: curatorCameraArea
  1524. Description: Return all curator camera areas.
  1525. Category: General
  1526. Address: 0xC98440
  1527. Arg1: curatorObj
  1528.  
  1529.  
  1530. Name: curatorCameraAreaCeiling
  1531. Description: Return ceiling height for curator camera.
  1532. Category: General
  1533. Address: 0xC983D0
  1534. Arg1: curatorObj
  1535.  
  1536.  
  1537. Name: curatorEditableObjects
  1538. Description: Return all editable objects which belongs to a curator.
  1539. Category: General
  1540. Address: 0xCA5270
  1541. Arg1: curatorObj
  1542.  
  1543.  
  1544. Name: curatorEditingArea
  1545. Description: Returns all curator editing areas
  1546. Category: General
  1547. Address: 0xC98680
  1548. Arg1: curatorObj
  1549.  
  1550.  
  1551. Name: curatorEditingAreaType
  1552. Description: Returns type of edit areas assigned to curator (blacklist/whitelist).
  1553. Category: General
  1554. Address: 0xCA51F0
  1555. Arg1: obj
  1556.  
  1557.  
  1558. Name: curatorMouseOver
  1559. Description: Returns curator mouse over object.
  1560. Category: General
  1561. Address: 0xCA5420
  1562.  
  1563.  
  1564. Name: curatorPoints
  1565. Description: Return number of points that curator have.
  1566. Category: General
  1567. Address: 0xCA56B0
  1568. Arg1: curatorObj
  1569.  
  1570.  
  1571. Name: curatorRegisteredObjects
  1572. Description: Returns array with all objects that has curator registered and their settings.
  1573. Category: General
  1574. Address: 0xCA5720
  1575. Arg1: curatorObj
  1576.  
  1577.  
  1578. Name: curatorSelected
  1579. Description: Returns list of all curator selected items.
  1580. Category: General
  1581. Address: 0xCA5C50
  1582.  
  1583.  
  1584. Name: curatorWaypointCost
  1585. Description: Return current price for placing waypoints (curator specific).
  1586. Category: General
  1587. Address: 0xCA6460
  1588. Arg1: curatorObj
  1589.  
  1590.  
  1591. Name: currentCommand
  1592. Description: Return the current command type (empty string when no command).
  1593. Category: General
  1594. Address: 0xD6FFD0
  1595. Arg1: vehicle
  1596.  
  1597.  
  1598. Name: currentMagazine
  1599. Description: Return the name of the type of the currently using magazine (on the primary turret for vehicles).
  1600. Category: General
  1601. Address: 0xD70060
  1602. Arg1: vehicle
  1603.  
  1604.  
  1605. Name: currentMagazineDetail
  1606. Description: Return the name of the type of the currently using magazine (on the primary turret for vehicles).
  1607. Category: General
  1608. Address: 0xD70110
  1609. Arg1: vehicle
  1610.  
  1611.  
  1612. Name: currentMuzzle
  1613. Description: Returns current muzzle of unit's weapon.
  1614. Category: General
  1615. Address: 0xC988C0
  1616. Arg1: gunner
  1617.  
  1618.  
  1619. Name: currentVisionMode
  1620. Description: Returns vision mode of unit's weapon. 0-dayTime, 1-night vision, 2-FLIR
  1621. Category: General
  1622. Address: 0xC989B0
  1623. Arg1: gunner
  1624.  
  1625.  
  1626. Name: currentWaypoint
  1627. Description: Return the index of the current waypoint.
  1628. Category: General
  1629. Address: 0xD74DB0
  1630. Arg1: group
  1631.  
  1632.  
  1633. Name: currentWeapon
  1634. Description: Return the name of the currently selected weapon (on the primary turret for vehicles).
  1635. Category: General
  1636. Address: 0xD703D0
  1637. Arg1: vehicle
  1638.  
  1639.  
  1640. Name: currentWeaponMode
  1641. Description: Returns current weapon mode of unit's weapon.
  1642. Category: General
  1643. Address: 0xC98A60
  1644. Arg1: gunner
  1645.  
  1646.  
  1647. Name: currentZeroing
  1648. Description: Returns zeroing of unit's weapon.
  1649. Category: General
  1650. Address: 0xC98B80
  1651. Arg1: gunner
  1652.  
  1653.  
  1654. Name: cursorTarget
  1655. Description: This is the entity pointed to by a players cursor.
  1656. Category: General
  1657. Address: 0xC98DB0
  1658. Example: alive cursorTarget
  1659.  
  1660.  
  1661. Name: cutObj
  1662. Description: Object background - the argument uses format ["name","type",speed, showInMap] or ["name","type"]. If speed is not given, it's assumed to be one.
  1663. The object can be defined in the description.ext file.
  1664. Category: General
  1665. Address: 0xC99080
  1666. Example: cutObj ["TVSet", "plain"]
  1667. Arg1: effect
  1668.  
  1669.  
  1670. Name: cutRsc
  1671. Description: Resource background - the argument uses format ["name","type",speed, showInMap] or ["name","type"]. If speed is not given, it's assumed to be one.
  1672. The resource can be defined in the description.ext file.
  1673. Category: General
  1674. Address: 0xC993C0
  1675. Example: cutRsc ["binocular", "PLAIN"]
  1676. Arg1: effect
  1677.  
  1678.  
  1679. Name: cutText
  1680. Description: Text background - the argument uses format ["text","type",speed, showInMap] or ["text","type"]. If speed is not given, it's assumed to be one. Type may be one of: "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" or "WHITE IN".
  1681. Category: General
  1682. Address: 0xC99540
  1683. Example: cutText ["", "BLACK OUT"]
  1684. Arg1: effect
  1685.  
  1686.  
  1687. Name: damage
  1688. Description: Returns the object damage in a range of 0 to 1. Note: this function is identical to <f>getDammage</f>.
  1689. Category: General
  1690. Address: 0xD32A30
  1691. Example: damage player
  1692. Arg1: object
  1693.  
  1694.  
  1695. Name: date
  1696. Description: Return the actual mission date and time as an array [year, month, day, hour, minute].
  1697. Category: General
  1698. Address: 0xCA6710
  1699.  
  1700.  
  1701. Name: dateToNumber
  1702. Description: Convert date to float number.
  1703. Category: General
  1704. Address: 0xC99840
  1705. Example: time = DateToNumber [year,month,day,hour,minute]
  1706. Arg1: date
  1707.  
  1708.  
  1709. Name: dayTime
  1710. Description: Returns the time in the world, in hours.
  1711. Category: General
  1712. Address: 0xC99A30
  1713.  
  1714.  
  1715. Name: deActivateKey
  1716. Description: Deactivates the given key from the current user profile. The keys are used to unlock missions or campaigns. See keys, keysLimit and doneKeys in the description.ext file of the missions.
  1717. Category: General
  1718. Address: 0xD1F020
  1719. Example: deActivateKey "M04"
  1720. Arg1: keyName
  1721.  
  1722.  
  1723. Name: debriefingText
  1724. Description: Return debriefing text.
  1725. Category: General
  1726. Address: 0xCA6860
  1727. Arg1: end
  1728.  
  1729.  
  1730. Name: debugLog
  1731. Description: Dumps the argument's type and value to the debugging output.
  1732. Category: General
  1733. Address: 0xD55590
  1734. Example: debugLog player
  1735. Arg1: anything
  1736.  
  1737.  
  1738. Name: deleteCenter
  1739. Description: Destroys the AI center of the given side.
  1740. Category: General
  1741. Address: 0xC92D10
  1742. Example: deleteCenter East
  1743. Arg1: side
  1744.  
  1745.  
  1746. Name: deleteCollection
  1747. Description: same as hideObject.
  1748. Category: General
  1749. Address: 0xCB5C10
  1750. Arg1: object
  1751.  
  1752.  
  1753. Name: deleteGroup
  1754. Description: Destroys the given AI group.
  1755. Category: General
  1756. Address: 0xCB2930
  1757. Example: deleteGroup group
  1758. Arg1: group
  1759.  
  1760.  
  1761. Name: deleteIdentity
  1762. Description: Deletes an identity created by saveIdentity from the campaign progress file.
  1763. Category: General
  1764. Address: 0xC99DC0
  1765. Example: deleteIdentity "playerIdentity"
  1766. Arg1: identityName
  1767.  
  1768.  
  1769. Name: deleteMarker
  1770. Description: Destroys the given marker. The marker is destroyed on all computers in a network session.
  1771. Category: General
  1772. Address: 0xD25C30
  1773. Example: deleteMarker "Marker1"
  1774. Arg1: name
  1775.  
  1776.  
  1777. Name: deleteMarkerLocal
  1778. Description: Destroys the given marker. The marker is only destroyed on the computer where the command is called.
  1779. Category: General
  1780. Address: 0xD25D60
  1781. Example: deleteMarkerLocal "Marker1"
  1782. Arg1: name
  1783.  
  1784.  
  1785. Name: deleteSite
  1786. Description: Removes the site.
  1787. Category: General
  1788. Address: 0xD584B0
  1789. Example: deleteSite tank
  1790. Arg1: site
  1791.  
  1792.  
  1793. Name: deleteStatus
  1794. Description: Deletes a status created by saveStatus from the campaign progress file.
  1795. Category: General
  1796. Address: 0xC9A180
  1797. Example: deleteStatus "playerState"
  1798. Arg1: statusName
  1799.  
  1800.  
  1801. Name: deleteTeam
  1802. Description: Destroy given team.
  1803. Category: Agents
  1804. Address: 0xD5D2D0
  1805. Example: deleteTeam _team
  1806. Arg1: team
  1807.  
  1808.  
  1809. Name: deleteVehicle
  1810. Description: Deletes any unit or vehicle. Only vehicles inserted in the editor or created during a mission can be deleted. The player unit cannot be deleted.
  1811. Category: General
  1812. Address: 0xD6F0B0
  1813. Example: deleteVehicle tank
  1814. Arg1: object
  1815.  
  1816.  
  1817. Name: deleteWaypoint
  1818. Description: Removes the waypoint.
  1819. Category: General
  1820. Address: 0xD74950
  1821. Example: deleteWaypoint [grp, 2]
  1822. Arg1: waypoint
  1823.  
  1824.  
  1825. Name: detach
  1826. Description: Detaches an object.
  1827. Category: General
  1828. Address: 0xD2F6D0
  1829. Example: detach player
  1830. Arg1: obj
  1831.  
  1832.  
  1833. Name: detectedMines
  1834. Description: Returns list af all mines detected by given side.
  1835. Category: General
  1836. Address: 0xCA69B0
  1837. Example: detectedMines (side player)
  1838. Arg1: side
  1839.  
  1840.  
  1841. Name: diag_fps
  1842. Description: Returns average framerate over last 16 frames.
  1843. Category: General
  1844. Address: 0xC9AB40
  1845.  
  1846.  
  1847. Name: diag_fpsmin
  1848. Description: Returns minimal framerate. Calculated from the longest frame over last 16 frames.
  1849. Category: General
  1850. Address: 0xC9AB70
  1851.  
  1852.  
  1853. Name: diag_frameno
  1854. Description: Returns number of frame currently displayed .
  1855. Category: General
  1856. Address: 0xC9ABC0
  1857.  
  1858.  
  1859. Name: diag_log
  1860. Description: Dumps the argument's type and value to the report file.
  1861. Category: General
  1862. Address: 0xC9ABE0
  1863. Example: diag_log player
  1864. Arg1: anything
  1865.  
  1866.  
  1867. Name: diag_tickTime
  1868. Description: Real time spent from the start of the game.
  1869. Category: General
  1870. Address: 0xC9AC40
  1871.  
  1872.  
  1873. Name: dialog
  1874. Description: Returns whether a user dialog is present.
  1875. Category: General
  1876. Address: 0xCB6AC0
  1877.  
  1878.  
  1879. Name: difficulty
  1880. Description: Return difficulty.
  1881. Category: General
  1882. Address: 0xCA6AA0
  1883. Example: difficulty
  1884.  
  1885.  
  1886. Name: difficultyEnabled
  1887. Description: Check if given difficulty setting is currently enabled. For possible values of flag, see config class Flags in CfgDificulties.
  1888. Category: General
  1889. Address: 0xCB6AE0
  1890. Arg1: flag
  1891.  
  1892.  
  1893. Name: difficultyEnabledRTD
  1894. Description: Returns true if rotorlib simulation is enabled. Forcing by mission is included.
  1895. Category: General
  1896. Address: 0xCB8800
  1897.  
  1898.  
  1899. Name: direction
  1900. Description: Returns the object heading in the range of 0 to 360.
  1901. Category: General
  1902. Address: 0xD32C70
  1903. Example: direction player
  1904. Arg1: object
  1905.  
  1906.  
  1907. Name: disableDebriefingStats
  1908. Description: Disable debriefing score table.
  1909. Category: General
  1910. Address: 0xC9AE90
  1911. Example: disableDebriefingStats
  1912.  
  1913.  
  1914. Name: disableUserInput
  1915. Description: Disables all user input. This is normally used only in cutscenes to disable the player's controls.
  1916. Category: General
  1917. Address: 0xC9AF80
  1918. Arg1: disable
  1919.  
  1920.  
  1921. Name: displayNull
  1922. Description: A non-existing display. This value is not equal to anything, including itself.
  1923. Category: General
  1924. Address: 0xD66050
  1925.  
  1926.  
  1927. Name: dissolveTeam
  1928. Description: Dissolves the given team. All members become members of the main team. Possible team values are: "RED", "GREEN", "BLUE" or "YELLOW".
  1929. Category: General
  1930. Address: 0xD5D340
  1931. Example: dissolveTeam "RED"
  1932. Arg1: team
  1933.  
  1934.  
  1935. Name: distributionRegion
  1936. Description: Return the region where the game was sold (based on distribution id).
  1937. Category: General
  1938. Address: 0xCA6B00
  1939.  
  1940.  
  1941. Name: doGetOut
  1942. Description: Orders a unit to get out from the vehicle (silently).
  1943. Category: General
  1944. Address: 0xD6F220
  1945. Example: doGetOut unitOne
  1946. Arg1: unit
  1947.  
  1948.  
  1949. Name: doStop
  1950. Description: Orders the unit to stop (silently).
  1951. Note: the stop command is never finished; the unit will never be ready.
  1952. Category: General
  1953. Address: 0xD6F260
  1954. Example: doStop unitOne
  1955. Arg1: unit
  1956.  
  1957.  
  1958. Name: drawIcon3D
  1959. Description: Draws an ingame icon at a given position.
  1960. Category: General
  1961. Address: 0xD76D80
  1962. Example: drawIcon3D ["#(argb,8,8,3)color(0,0.5,1,1)", [1,1,1,1], position cursorTarget, 1, 1, 45, "Target", 1, 0.05, "TahomaB"]
  1963. Arg1: [texture, color, position, width, height, angle, text, shadow, textSize, font]
  1964.  
  1965.  
  1966. Name: drawLine3D
  1967. Description: Draws a line of a given COLOR from START to END.
  1968. Category: General
  1969. Address: 0xD76E30
  1970. Example: drawLine3D [position soldier, position cursorTarget, [1,1,1,1]]
  1971. Arg1: [start, end, color]
  1972.  
  1973.  
  1974. Name: driver
  1975. Description: Returns the driver of the vehicle. If the vehicle is not a vehicle, but a person, the person is returned instead.
  1976. Category: General
  1977. Address: 0xD2FBC0
  1978. Example: driver vehicle player
  1979. Arg1: vehicle
  1980.  
  1981.  
  1982. Name: drop
  1983. Description: Drops a particle into the scene. Array is in format <ar>ParticleArray</ar>.
  1984. Category: General
  1985. Address: 0x99CCF0
  1986. Arg1: array
  1987.  
  1988.  
  1989. Name: east
  1990. Description: The East side.
  1991. Category: General
  1992. Address: 0xD578B0
  1993.  
  1994.  
  1995. Name: effectiveCommander
  1996. Description: Returns the effective commander (who really commands) of the vehicle.
  1997. Category: General
  1998. Address: 0xD2FC40
  1999. Arg1: vehicle
  2000.  
  2001.  
  2002. Name: enableCamShake
  2003. Description: Enables/disables camera shakes.
  2004. Category: General
  2005. Address: 0xC9B900
  2006. Arg1: true/false
  2007.  
  2008.  
  2009. Name: enableCaustics
  2010. Description: Enable/disable caustics drawing.
  2011. Category: General
  2012. Address: 0xC9B960
  2013. Arg1: enable
  2014.  
  2015.  
  2016. Name: enableDebriefingStats
  2017. Description: Enable debriefing score table. The table will be displayed at specified coordinates.
  2018. Category: General
  2019. Address: 0xC9BA40
  2020. Example: enableDebriefingStats [0.1, 0.1, 0.8, 0.8]
  2021. Arg1: [left, top, width, height]
  2022.  
  2023.  
  2024. Name: enableDiagLegend
  2025. Description: Enable or disable legend for diagnostic
  2026. Category: General
  2027. Address: 0xC9BB30
  2028. Example: enableDiagLegend false
  2029. Arg1: true/false
  2030.  
  2031.  
  2032. Name: enableEndDialog
  2033. Description: Enables the dialog buttons to be shown during the OnPlayerKilled script.
  2034. Category: General
  2035. Address: 0xC9BBA0
  2036.  
  2037.  
  2038. Name: enableEngineArtillery
  2039. Description: Enables/disables engine's artillery.
  2040. Category: General
  2041. Address: 0xC9B840
  2042. Arg1: true/false
  2043.  
  2044.  
  2045. Name: enableEnvironment
  2046. Description: Enable/disable environmental effects (ambient life + sound).
  2047. Category: General
  2048. Address: 0xC9BBC0
  2049. Example: enableEnvironment false
  2050. Arg1: enabled
  2051.  
  2052.  
  2053. Name: enableRadio
  2054. Description: Enables radio transmissions to be heard and seen on screen.
  2055. Category: General
  2056. Address: 0xC9BBF0
  2057. Arg1: enable
  2058.  
  2059.  
  2060. Name: enableSatNormalOnDetail
  2061. Description: Enables/disables satellite normal map od detail maps.
  2062. Category: General
  2063. Address: 0xC9BD20
  2064. Arg1: true/false
  2065.  
  2066.  
  2067. Name: enableSaving
  2068. Description: Enable / disable saving of the game. When disabled, the autosave is created (if not forbidden by save == false).
  2069. Category: General
  2070. Address: 0xC9BD90
  2071. Arg1: enable or [enable, save]
  2072.  
  2073.  
  2074. Name: enableSentences
  2075. Description: Enables radio transmissions to be heard and seen on screen. It does not affect KBTell conversations.
  2076. Category: General
  2077. Address: 0xC9BEB0
  2078. Arg1: enable
  2079.  
  2080.  
  2081. Name: enableStressDamage
  2082. Description: Enable stress damage.
  2083. Category: General
  2084. Address: 0xC9BEF0
  2085. Arg1: enable
  2086.  
  2087.  
  2088. Name: enableTeamSwitch
  2089. Description: Enable / disable team switch.
  2090. Category: General
  2091. Address: 0xD5EF20
  2092. Arg1: enable
  2093.  
  2094.  
  2095. Name: enableTraffic
  2096. Description: Enable ambient traffic.
  2097. Category: General
  2098. Address: 0xD55590
  2099. Arg1: enable
  2100.  
  2101.  
  2102. Name: endLoadingScreen
  2103. Description: Finish loading screen displaying (started by startLoadingScreen).
  2104. Category: General
  2105. Address: 0xD24170
  2106.  
  2107.  
  2108. Name: endMission
  2109. Description: Finish the mission. The end type can be "CONTINUE", "KILLED", "LOSER", "END1", "END2", "END3", "END4", "END5", or "END6".
  2110. Category: General
  2111. Address: 0xD28590
  2112. Arg1: end type
  2113.  
  2114.  
  2115. Name: enginesIsOnRTD
  2116. Description: Returns which engines are producing some work.
  2117. Category: General
  2118. Address: 0xCA75B0
  2119. Arg1: RTD_helicopter
  2120.  
  2121.  
  2122. Name: enginesPowerRTD
  2123. Description: Power produced by engines in Watts.
  2124. Category: General
  2125. Address: 0xCA7790
  2126. Arg1: RTD_Helicopter
  2127.  
  2128.  
  2129. Name: enginesRpmRTD
  2130. Description: Returns all engines RPM.
  2131. Category: General
  2132. Address: 0xCA7960
  2133. Arg1: RTD_helicopter
  2134.  
  2135.  
  2136. Name: enginesTorqueRTD
  2137. Description: Torque produced by engines in Newton*meter.
  2138. Category: General
  2139. Address: 0xCA7B40
  2140. Arg1: RTD_Helicopter
  2141.  
  2142.  
  2143. Name: entities
  2144. Description: Returns a list of entities with given type.
  2145. Category: General
  2146. Address: 0xCA7D10
  2147. Example: entities "Car"
  2148. Arg1: type
  2149.  
  2150.  
  2151. Name: estimatedEndServerTime
  2152. Description: Estimated end of MP game converted to serverTime.
  2153. Category: General
  2154. Address: 0xCA7E60
  2155.  
  2156.  
  2157. Name: estimatedTimeLeft
  2158. Description: Returns the estimated time left in the game. Using this function the designer can provide a "time left" estimate that is shown in the "Game in progress" screen or in the master browser. For missions with a hard set limit adjusted via Param1, the following example can be used in the init.sqs file.
  2159. Category: General
  2160. Address: 0xC9C1B0
  2161. Example: estimatedTimeLeft Param1
  2162. Arg1: timeLeft
  2163.  
  2164.  
  2165. Name: everyBackpack
  2166. Description: Returns array of backpacks stored in given crate .e.g. used for accessing backpack content of a backpack on ground.
  2167. Category: General
  2168. Address: 0xD32D90
  2169. Example: everyBackpack cursorTarget
  2170. Arg1: box
  2171.  
  2172.  
  2173. Name: everyContainer
  2174. Description: Returns array of all containers(uniforms, vest, backpacks) stored in given crate .e.g. used for accessing container's content stored into ammoBox or ground.
  2175. Category: General
  2176. Address: 0xD32F30
  2177. Example: everyContainer cursorTarget
  2178. Arg1: box
  2179.  
  2180.  
  2181. Name: execFSM
  2182. Description: Execute the scripted FSM. The FSM file is first searched in the mission folder, then in the campaign scripts folder and finally in the global scripts folder. Return the FSM handler or 0 when failed.
  2183. Category: General
  2184. Address: 0xC9C720
  2185. Example: execFSM "test.fsm"
  2186. Arg1: filename
  2187.  
  2188.  
  2189. Name: execVM
  2190. Description: Compile and execute function (sqf). The function is first searched in the mission folder, then in the campaign scripts folder and finally in the global scripts folder.
  2191. Category: General
  2192. Address: 0xD6D9D0
  2193. Example: execVM "test.sqf"
  2194. Arg1: filename
  2195.  
  2196.  
  2197. Name: exit
  2198. Description: Exits the script.
  2199. Category: General
  2200. Address: 0xB9CC10
  2201.  
  2202.  
  2203. Name: expectedDestination
  2204. Description: Return expected destination of unit as a [position, planningMode, forceReplan].
  2205. Category: General
  2206. Address: 0xD70580
  2207. Arg1: person
  2208.  
  2209.  
  2210. Name: eyeDirection
  2211. Description: Returns the direction object is watching (eyes, or a vehicle primary observer).
  2212. Category: General
  2213. Address: 0xD32B30
  2214. Example: eyeDirection player
  2215. Arg1: unit
  2216.  
  2217.  
  2218. Name: eyePos
  2219. Description: Returns the position of the object eye in format <ar>PositionASL</ar>.
  2220. Category: General
  2221. Address: 0xD35850
  2222. Example: eyePos player
  2223. Arg1: obj
  2224.  
  2225.  
  2226. Name: face
  2227. Description: Returns the face from identity of given object.
  2228. Category: General
  2229. Address: 0xD30250
  2230. Example: face player
  2231. Arg1: object
  2232.  
  2233.  
  2234. Name: faction
  2235. Description: Gets unit faction. If faction is not defined, returns empty string.
  2236. Category: General
  2237. Address: 0xCA7F40
  2238. Arg1: unit
  2239.  
  2240.  
  2241. Name: factor
  2242. Description: Extend expression
  2243. Category: Simple expression
  2244. Address: 0x12388B0
  2245. Arg1: expr
  2246. Arg2: val
  2247.  
  2248.  
  2249. Name: factor
  2250. Description: Extend expression
  2251. Category: Simple expression
  2252. Address: 0x12388B0
  2253. Arg1: expr
  2254. Arg2: val
  2255.  
  2256.  
  2257. Name: failMission
  2258. Description: Finish the mission. The end type can be "CONTINUE", "KILLED", "LOSER", "END1", "END2", "END3", "END4", "END5", or "END6". Mission saves will not be deleted.
  2259. Category: General
  2260. Address: 0xC9CB70
  2261. Arg1: end type
  2262.  
  2263.  
  2264. Name: fillWeaponsFromPool
  2265. Description: Adds magazines from the campaign pool to the person (depending on the weapons the person has).
  2266. Category: General
  2267. Address: 0xD44840
  2268. Example: fillWeaponsFromPool victor
  2269. Arg1: person
  2270.  
  2271.  
  2272. Name: findDisplay
  2273. Description: Find display by its IDD.
  2274. Category: General
  2275. Address: 0xD664F0
  2276. Example: _display = findDisplay 1
  2277. Arg1: idd
  2278.  
  2279.  
  2280. Name: finishMissionInit
  2281. Description: Finish world initialization before mission is launched.
  2282. Category: General
  2283. Address: 0xD28670
  2284.  
  2285.  
  2286. Name: firstBackpack
  2287. Description: Returns object of the first stored backpack in another weaponholder.e.g. used for accessing backpack content of a backpack on ground.
  2288. Category: General
  2289. Address: 0xD33570
  2290. Example: firstBackpack cursorTarget
  2291. Arg1: box
  2292.  
  2293.  
  2294. Name: flag
  2295. Description: If the unit has a flag, this flag is returned.
  2296. If not, objNull is returned.
  2297. Category: General
  2298. Address: 0xD33640
  2299. Example: flag player
  2300. Arg1: unit
  2301.  
  2302.  
  2303. Name: flagOwner
  2304. Description: When used on a flag, the returned value is the person that has this flag.
  2305. When used on anything else, objNull is returned.
  2306. Category: General
  2307. Address: 0xD336C0
  2308. Example: flagowner flagOne
  2309. Arg1: flag
  2310.  
  2311.  
  2312. Name: fleeing
  2313. Description: Checks whether the unit is fleeing. A dead or empty unit returns false.
  2314. Category: General
  2315. Address: 0xD305B0
  2316. Example: fleeing player
  2317. Arg1: unit
  2318.  
  2319.  
  2320. Name: fog
  2321. Description: Return the current fog.
  2322. Category: General
  2323. Address: 0xCA81B0
  2324.  
  2325.  
  2326. Name: fogForecast
  2327. Description: Return the fog forecast.
  2328. Category: General
  2329. Address: 0xCA81E0
  2330.  
  2331.  
  2332. Name: fogParams
  2333. Description: Returns actual params for fog.
  2334. Category: General
  2335. Address: 0xCA8210
  2336.  
  2337.  
  2338. Name: forceAtPositionRTD
  2339. Description: Add force generator to world. Returns force index.
  2340. Category: General
  2341. Address: 0xC9E640
  2342. Arg1: position
  2343.  
  2344.  
  2345. Name: forceEnd
  2346. Description: Forces the mission to terminate.
  2347. Category: General
  2348. Address: 0xC9EA50
  2349.  
  2350.  
  2351. Name: forceGeneratorRTD
  2352. Description: Add force generator to world. Returns force index.
  2353. Category: General
  2354. Address: 0xCA83C0
  2355. Arg1: index
  2356.  
  2357.  
  2358. Name: forceMap
  2359. Description: Forces the map to display.
  2360. Category: General
  2361. Address: 0xD25170
  2362. Example: forceMap true
  2363. Arg1: show
  2364.  
  2365.  
  2366. Name: forceRespawn
  2367. Description: Force respawns given unit (stays old "killed" body). Will not count score
  2368. Category: General
  2369. Address: 0xC9EA70
  2370. Arg1: targetUnit
  2371.  
  2372.  
  2373. Name: forceWeatherChange
  2374. Description: Forces saved wanted settings for weather to be actual. (BEWARE: Will cause lag)
  2375. Category: General
  2376. Address: 0xC9EFF0
  2377.  
  2378.  
  2379. Name: format
  2380. Description: The first argument of the array is in format string. This string may contain references to the following arguments using format %1, %2, etc. Each %x is replaced by the corresponding argument. %x may appear in the string in any order.
  2381. Category: General
  2382. Address: 0xD59200
  2383. Example: format ["%1 - %2 - %1", 1, "text"]
  2384. Ex. Returns: "1 - text - 1"
  2385. Arg1: format
  2386.  
  2387.  
  2388. Name: formation
  2389. Description: Return a formation of given team.
  2390. Category: Agents
  2391. Address: 0xD5D900
  2392. Example: _formation = formation _team
  2393. Arg1: team
  2394.  
  2395.  
  2396. Name: formation
  2397. Description: Returns the formation of the group ("COLUMN", "STAG COLUMN", "WEDGE", "ECH LEFT", "ECH RIGHT", "VEE" or "LINE").
  2398. Category: General
  2399. Address: 0xCB30F0
  2400. Example: formation group player
  2401. Arg1: grp
  2402.  
  2403.  
  2404. Name: formationDirection
  2405. Description: Return the direction unit watching in formation.
  2406. Category: General
  2407. Address: 0xD33740
  2408. Arg1: person
  2409.  
  2410.  
  2411. Name: formationLeader
  2412. Description: Return leader of the formation.
  2413. Category: General
  2414. Address: 0xD70830
  2415. Arg1: person
  2416.  
  2417.  
  2418. Name: formationMembers
  2419. Description: Return list of units (drivers) in the formation.
  2420. Category: General
  2421. Address: 0xD70900
  2422. Arg1: person
  2423.  
  2424.  
  2425. Name: formationPosition
  2426. Description: Return position of unit in the formation.
  2427. Category: General
  2428. Address: 0xD70AA0
  2429. Arg1: person
  2430.  
  2431.  
  2432. Name: formationTask
  2433. Description: Return the current task of the unit in the formation.
  2434. Category: General
  2435. Address: 0xD70BF0
  2436. Arg1: person
  2437.  
  2438.  
  2439. Name: formatText
  2440. Description: Creates a structured text by replacing %1, %2, etc. in format by plain or structured texts given as arguments.
  2441. Category: General
  2442. Address: 0xD60C90
  2443. Example: txt = formatText ["Image: %1", image "data\isniper.paa"]
  2444. Arg1: [format, arg1, arg2, ...]
  2445.  
  2446.  
  2447. Name: formLeader
  2448. Description: Returns the formation leader for the given unit. For dead units objNull is returned. The result is often the same as groupLeader, but not always.
  2449. Category: General
  2450. Address: 0xD39120
  2451. Example: formLeader player != leader player
  2452. Arg1: unit
  2453.  
  2454.  
  2455. Name: freeLook
  2456. Description: Returns true if freelook is active.
  2457. Category: General
  2458. Address: 0xCA8980
  2459.  
  2460.  
  2461. Name: fromEditor
  2462. Description: Return if given team was inserted directly from mission editor.
  2463. Category: Agents
  2464. Address: 0xD5E120
  2465. Example: _fromEditor = fromEditor _member
  2466. Arg1: teamMember
  2467.  
  2468.  
  2469. Name: fuel
  2470. Description: Checks how much fuel is left in the gas tank, in the range from 0 to 1.
  2471. Category: General
  2472. Address: 0xD30650
  2473. Example: fuel vehicle player
  2474. Arg1: vehicle
  2475.  
  2476.  
  2477. Name: fullCrew
  2478. Description: Returns array with all crew inside given vehicle
  2479. Category: General
  2480. Address: 0xCA0E50
  2481. Example: fullCrew vehicle player
  2482. Arg1: vehicle
  2483.  
  2484.  
  2485. Name: fullCrew
  2486. Description: Returns array with all crew of given type inside given vehicle
  2487. Category: General
  2488. Address: 0xCA0F10
  2489. Example: fullCrew [vehicle player, "turret"]
  2490. Arg1: [vehicle, type]
  2491.  
  2492.  
  2493. Name: gearIDCAmmoCount
  2494. Description: Returns ammo count of assigned magazine.
  2495. Category: General
  2496. Address: 0xCB5ED0
  2497. Example: ammo = gearSlotAmmoCount IDC
  2498. Arg1: control IDC
  2499.  
  2500.  
  2501. Name: gearSlotAmmoCount
  2502. Description: Returns ammo count of assigned magazine.
  2503. Category: General
  2504. Address: 0xD61CF0
  2505. Example: ammo = gearSlotAmmoCount _control
  2506. Arg1: control
  2507.  
  2508.  
  2509. Name: gearSlotData
  2510. Description: Returns gear slot item name.
  2511. Category: General
  2512. Address: 0xD61DA0
  2513. Example: weapon = gearSlotData _control
  2514. Arg1: control
  2515.  
  2516.  
  2517. Name: getAmmoCargo
  2518. Description: Returns the amount of ammo resources in the cargo space of a repair vehicle.
  2519. Category: General
  2520. Address: 0xD31030
  2521. Example: getAmmoCargo vehicle
  2522. Arg1: vehicle
  2523.  
  2524.  
  2525. Name: getArray
  2526. Description: Extract array from config entry.
  2527. Category: General
  2528. Address: 0xC93B90
  2529. Example: _array = getArray (configFile >> "CfgVehicles" >> "Thing" >> "threat")
  2530. Arg1: config
  2531.  
  2532.  
  2533. Name: getArtilleryAmmo
  2534. Description: Get list of all available magazines of artillery units in the list.
  2535. Category: General
  2536. Address: 0xCA2A80
  2537. Arg1: [unitlist]
  2538.  
  2539.  
  2540. Name: getArtilleryComputerSettings
  2541. Description: Returns settings from artillery computer currently opened by player.
  2542. Category: General
  2543. Address: 0xCA2E30
  2544.  
  2545.  
  2546. Name: getAssignedCuratorLogic
  2547. Description: Returns curator logic to which has given player access.
  2548. Category: General
  2549. Address: 0xCA3360
  2550. Arg1: player
  2551.  
  2552.  
  2553. Name: getAssignedCuratorUnit
  2554. Description: Returns unit assigned to curator logic.
  2555. Category: General
  2556. Address: 0xCA32F0
  2557. Arg1: curatorObj
  2558.  
  2559.  
  2560. Name: getBackpackCargo
  2561. Description: Returns all backpacks names and count from ammo box (or any general weapon holder container).
  2562. Category: General
  2563. Address: 0xD31500
  2564. Example: getBackpackCargo jeepOne
  2565. Arg1: box
  2566.  
  2567.  
  2568. Name: getBleedingRemaining
  2569. Description: Return reamining time of bleeding.
  2570. Category: General
  2571. Address: 0xD31950
  2572. Arg1: unit
  2573.  
  2574.  
  2575. Name: getBurningValue
  2576. Description: Return amount of damage from fire.
  2577. Category: General
  2578. Address: 0xD324A0
  2579. Arg1: unit
  2580.  
  2581.  
  2582. Name: getCenterOfMass
  2583. Description: Returns center of mass of an object
  2584. Category: General
  2585. Address: 0xD328A0
  2586. Example: com = getCenterOfMass myEntity
  2587. Arg1: object
  2588.  
  2589.  
  2590. Name: getClientState
  2591. Description: Return client state in network game
  2592. Category: General
  2593. Address: 0xCA3760
  2594.  
  2595.  
  2596. Name: getConnectedUAV
  2597. Description: Returns UAV if unit has connection to some UAV.
  2598. Category: General
  2599. Address: 0xCA4750
  2600. Example: getConnectedUAV player
  2601. Arg1: Unit
  2602.  
  2603.  
  2604. Name: getDammage
  2605. Description: Returns the object damage in the range from 0 to 1.
  2606. Category: General
  2607. Address: 0xD32A50
  2608. Example: getDammage player
  2609. Arg1: obj
  2610.  
  2611.  
  2612. Name: getDescription
  2613. Description: Returns the string representation of unit as an four slots array ([unit,uniform,vest,backpack])
  2614. Category: General
  2615. Address: 0xD77700
  2616. Example: getDescription player
  2617. Arg1: unit
  2618.  
  2619.  
  2620. Name: getDir
  2621. Description: Returns the object heading in the range from 0 to 360.
  2622. Category: General
  2623. Address: 0xD32C70
  2624. Example: getDir player
  2625. Arg1: obj
  2626.  
  2627.  
  2628. Name: getDirVisual
  2629. Description: Returns the object heading in the range from 0 to 360.
  2630. Category: General
  2631. Address: 0xD32CE0
  2632. Example: getDir player
  2633. Arg1: obj
  2634.  
  2635.  
  2636. Name: getDLCAssetsUsage
  2637. Description: Returns an array of the DLC usage times. Returned array contain DLC item in this format: [[name, dlcAppId, sessionTime, totalTime], [name, dlcAppId, sessionTime, totalTime], ...]
  2638. Category: General
  2639. Address: 0xCA6C40
  2640.  
  2641.  
  2642. Name: getDLCAssetsUsageByName
  2643. Description: Returns an array with the session and global time the asset has been used.
  2644. Category: General
  2645. Address: 0xCA6CD0
  2646. Arg1: assetName
  2647.  
  2648.  
  2649. Name: getDLCs
  2650. Description: Returns list of appIds of game DLCs. Use filter param to get only certain DLCs: 0:all, 1:owned, 2:not owned
  2651. Category: General
  2652. Address: 0xCA6F90
  2653. Arg1: filter
  2654.  
  2655.  
  2656. Name: getDLCUsageTime
  2657. Description: Returns total time the assets of the given DLC has been used.
  2658. Category: General
  2659. Address: 0xCA6EF0
  2660. Arg1: appId
  2661.  
  2662.  
  2663. Name: getElevationOffset
  2664. Description: Returns the map elevation offset from [map]/config.cpp
  2665. Category: General
  2666. Address: 0xCA73A0
  2667.  
  2668.  
  2669. Name: getEngineTargetRPMRTD
  2670. Description: Returns target rpm of all engines.
  2671. Category: General
  2672. Address: 0xCA73E0
  2673. Arg1: RTD_helicopter
  2674.  
  2675.  
  2676. Name: getFatigue
  2677. Description: Returns fatigue of given unit.
  2678. Category: General
  2679. Address: 0xD333D0
  2680. Arg1: unit
  2681.  
  2682.  
  2683. Name: getFieldManualStartPage
  2684. Description: Returns array of the starting topic and hint the given field manual should display
  2685. Category: General
  2686. Address: 0xD66270
  2687. Arg1: display
  2688.  
  2689.  
  2690. Name: getFuelCargo
  2691. Description: Returns the fuel amount in the cargo space of a refuelling vehicle.
  2692. Category: General
  2693. Address: 0xD33810
  2694. Example: getFuelCargo vehicle
  2695. Arg1: vehicle
  2696.  
  2697.  
  2698. Name: getGroupIconParams
  2699. Description: Returns group icons params. [color, text,scale, visible]
  2700. Category: General
  2701. Address: 0xCA8E00
  2702. Example: getGroupIconParams group
  2703. Arg1: group
  2704.  
  2705.  
  2706. Name: getGroupIcons
  2707. Description: Returns all group icons.[[id,icon,[offsetx,offsety],[..],..]
  2708. Category: General
  2709. Address: 0xCA9030
  2710. Example: getGroupIcons group
  2711. Arg1: group
  2712.  
  2713.  
  2714. Name: getItemCargo
  2715. Description: Returns all items names and count from ammo box (or any general weapon holder container).
  2716. Category: General
  2717. Address: 0xD33DB0
  2718. Example: getItemCargo jeepOne
  2719. Arg1: box
  2720.  
  2721.  
  2722. Name: getMagazineCargo
  2723. Description: Returns all magazines names and count from ammo box (or any general weapon holder container).
  2724. Category: General
  2725. Address: 0xD34340
  2726. Example: getMagazineCargo jeepOne
  2727. Arg1: box
  2728.  
  2729.  
  2730. Name: getMarkerColor
  2731. Description: Gets the marker color. See <f>setMarkerColor</f>.
  2732. Category: General
  2733. Address: 0xD26050
  2734. Example: getMarkerColor "MarkerOne"
  2735. Arg1: marker
  2736.  
  2737.  
  2738. Name: getMarkerPos
  2739. Description: Returns the marker positon in format [x,z,y].
  2740. Category: General
  2741. Address: 0xD26230
  2742. Example: getMarkerPos "markerOne"
  2743. Arg1: markerName
  2744.  
  2745.  
  2746. Name: getMarkerSize
  2747. Description: Gets the marker size. See <f>setMarkerSize</f>.
  2748. Category: General
  2749. Address: 0xD264A0
  2750. Example: getMarkerSize "MarkerOne"
  2751. Arg1: marker
  2752.  
  2753.  
  2754. Name: getMarkerType
  2755. Description: Gets the type of the marker. See <f>setMarkerType</f>.
  2756. Category: General
  2757. Address: 0xD266E0
  2758. Example: getMarkerType "MarkerOne"
  2759. Arg1: marker
  2760.  
  2761.  
  2762. Name: getMass
  2763. Description: Returns mass of an object
  2764. Category: General
  2765. Address: 0xD346D0
  2766. Example: mass = getMass myEntity
  2767. Arg1: object
  2768.  
  2769.  
  2770. Name: getMissionDlcs
  2771. Description: Returns list of DLCs that are used in the mission. List is created only from units listed in mission.sqm and doesn't detect units created by scripts!
  2772. Category: General
  2773. Address: 0xCAAA50
  2774. Example: list of DLCs detected for the mission
  2775.  
  2776.  
  2777. Name: getNumber
  2778. Description: Extract number from config entry.
  2779. Category: General
  2780. Address: 0xC94200
  2781. Example: _array = getNumber (configFile >> "CfgVehicles" >> "Thing" >> "maxSpeed")
  2782. Arg1: config
  2783.  
  2784.  
  2785. Name: getObjectDLC
  2786. Description: Returns an appId the object belongs to. The information is taken from it's model.
  2787. Category: General
  2788. Address: 0xCAD230
  2789. Example: getObjectDLC cursorTarget
  2790. Arg1: Object
  2791.  
  2792.  
  2793. Name: getOxygenRemaining
  2794. Description: Return amount of remaining oxygen.
  2795. Category: General
  2796. Address: 0xD35300
  2797. Arg1: unit
  2798.  
  2799.  
  2800. Name: getPersonUsedDLCs
  2801. Description: Returns list of all DLCs (appIds, both owned or not) the person is currently using.
  2802. Category: General
  2803. Address: 0xCAD350
  2804. Example: getPersonUsedDLCs player
  2805. Arg1: Person
  2806.  
  2807.  
  2808. Name: getPlayerUID
  2809. Description: Get unique player id.
  2810. Category: General
  2811. Address: 0xCAD7A0
  2812. Arg1: unit
  2813.  
  2814.  
  2815. Name: getPos
  2816. Description: Returns the object position in format <ar>Position</ar>.
  2817. Category: General
  2818. Address: 0xD35380
  2819. Example: getPos player
  2820. Arg1: obj
  2821.  
  2822.  
  2823. Name: getPosASL
  2824. Description: Returns the object position in format <ar>PositionASL</ar>.
  2825. Category: General
  2826. Address: 0xD35470
  2827. Example: getPosASL player
  2828. Arg1: obj
  2829.  
  2830.  
  2831. Name: getPosASLVisual
  2832. Description: Returns the object rendered position in format <ar>PositionASL</ar>.
  2833. Category: General
  2834. Address: 0xD36D90
  2835. Example: visiblePositionASL player
  2836. Arg1: object
  2837.  
  2838.  
  2839. Name: getPosASLW
  2840. Description: Returns the object position in format <ar>PositionASLW</ar>.
  2841. Category: General
  2842. Address: 0xD355C0
  2843. Example: getPosASLW player
  2844. Arg1: obj
  2845.  
  2846.  
  2847. Name: getPosATL
  2848. Description: Returns the object position in format <ar>PositionATL</ar>.
  2849. Category: General
  2850. Address: 0xD35720
  2851. Example: getPosATL player
  2852. Arg1: obj
  2853.  
  2854.  
  2855. Name: getPosATLVisual
  2856. Description: Returns the object position in format <ar>PositionATL</ar>.
  2857. Category: General
  2858. Address: 0xD35740
  2859. Example: getPosATL player
  2860. Arg1: obj
  2861.  
  2862.  
  2863. Name: getPosVisual
  2864. Description: Returns the object rendered position in format <ar>Position</ar>.
  2865. Category: General
  2866. Address: 0xD36C70
  2867. Example: visiblePosition player
  2868. Arg1: object
  2869.  
  2870.  
  2871. Name: getPosWorld
  2872. Description: Returns the object position in format <ar>PositionWorld</ar>.
  2873. Category: General
  2874. Address: 0xD35AC0
  2875. Example: getPosWorld player
  2876. Arg1: obj
  2877.  
  2878.  
  2879. Name: getRepairCargo
  2880. Description: Returns the amount or repair resources in the cargo space of a repair vehicle.
  2881. Category: General
  2882. Address: 0xD35CC0
  2883. Example: getRepairCargo vehicle
  2884. Arg1: vehicle
  2885.  
  2886.  
  2887. Name: getResolution
  2888. Description: returns [width, height, 2D viewport Width, 2D viewport Height, aspect ration, UI scale]
  2889. Category: General
  2890. Address: 0xCADDD0
  2891.  
  2892.  
  2893. Name: getRotorBrakeRTD
  2894. Description: Returns if rotorbrake is on.
  2895. Category: General
  2896. Address: 0xCAE050
  2897. Arg1: RTD_helicopter
  2898.  
  2899.  
  2900. Name: getShadowDistance
  2901. Description: Get the shadows rendering distance.
  2902. Category: General
  2903. Address: 0xCAA910
  2904. Example: _dist = getShadowDistance
  2905.  
  2906.  
  2907. Name: getSlingLoad
  2908. Description: Return object which is sling loaded by vehicle
  2909. Category: General
  2910. Address: 0xCAE820
  2911. Example: getSlingLoad veh
  2912. Arg1: vehicle
  2913.  
  2914.  
  2915. Name: getStatValue
  2916. Description: Returns value of the given stat.
  2917. Category: General
  2918. Address: 0xCAEFF0
  2919. Arg1: statName
  2920.  
  2921.  
  2922. Name: getTerrainHeightASL
  2923. Description: Returns terrain height above sea level.
  2924. Category: General
  2925. Address: 0xCAF6A0
  2926. Example: z = getTerrainHeightASL [x,y]
  2927. Arg1: [x,y]
  2928.  
  2929.  
  2930. Name: getText
  2931. Description: Extract text from config entry.
  2932. Category: General
  2933. Address: 0xC94470
  2934. Example: _array = getText (configFile >> "CfgVehicles" >> "Thing" >> "icon")
  2935. Arg1: config
  2936.  
  2937.  
  2938. Name: getTotalDLCUsageTime
  2939. Description: Returns total DLC usage time in this game session
  2940. Category: General
  2941. Address: 0xCAFFB0
  2942.  
  2943.  
  2944. Name: getTrimOffsetRTD
  2945. Description: Returns controls trim offset.
  2946. Category: General
  2947. Address: 0xCB0010
  2948. Arg1: RTD_helicopter
  2949.  
  2950.  
  2951. Name: getWeaponCargo
  2952. Description: Returns all weapons names and count from ammo box (or any general weapon holder container).
  2953. Category: General
  2954. Address: 0xD371B0
  2955. Example: getWeaponCargo jeepOne
  2956. Arg1: box
  2957.  
  2958.  
  2959. Name: getWingsOrientationRTD
  2960. Description: Returns orientation of horizontaol stabilizers.
  2961. Category: General
  2962. Address: 0xCB1E10
  2963. Arg1: RTD_helicopter
  2964.  
  2965.  
  2966. Name: getWingsPositionRTD
  2967. Description: Returns position of stabilizers.
  2968. Category: General
  2969. Address: 0xCB21E0
  2970. Arg1: RTD_helicopter
  2971.  
  2972.  
  2973. Name: getWPPos
  2974. Description: Gets the waypoint position. The format of waypoint is <ar>Waypoint</ar>.
  2975. Category: General
  2976. Address: 0xD771E0
  2977. Example: getWPPos [groupOne, 1]
  2978. Arg1: waypoint
  2979.  
  2980.  
  2981. Name: goggles
  2982. Description: Returns name of currently used goggles.
  2983. Category: General
  2984. Address: 0xD37F20
  2985. Arg1: unit
  2986.  
  2987.  
  2988. Name: goto
  2989. Description: Only in scripts: go to given label. Note: the string argument is used here. Be sure to use double quotes around the label name in goto.
  2990. Category: General
  2991. Address: 0xB9CC30
  2992. Example: goto "Loop"
  2993. Arg1: label
  2994.  
  2995.  
  2996. Name: group
  2997. Description: Returns the group to which the given unit is assigned. For dead units, grpNull is returned.
  2998. Category: General
  2999. Address: 0xD37F50
  3000. Example: group player == group leader player
  3001. Arg1: obj
  3002.  
  3003.  
  3004. Name: groupFromNetId
  3005. Description: Get group with given unique ID.
  3006. Category: General
  3007. Address: 0xCA9290
  3008. Example: groupFromNetId (netId group player)
  3009. Ex. Returns: group player
  3010. Arg1: id
  3011.  
  3012.  
  3013. Name: groupIconSelectable
  3014. Description: Return if groups icon raises onClick and onOver events.
  3015. Category: General
  3016. Address: 0xCB8020
  3017.  
  3018.  
  3019. Name: groupIconsVisible
  3020. Description: Return group icons are visible.
  3021. Category: General
  3022. Address: 0xCB8040
  3023.  
  3024.  
  3025. Name: groupID
  3026. Description: Returns group name.
  3027. Category: General
  3028. Address: 0xCB3190
  3029. Example: name = groupID (group player)
  3030. Arg1: group
  3031.  
  3032.  
  3033. Name: groupSelectedUnits
  3034. Description: Returns selected groups in sgroup.
  3035. Category: General
  3036. Address: 0xCB2BE0
  3037. Example: array = groupSelectedUnits unit
  3038. Arg1: unit
  3039.  
  3040.  
  3041. Name: grpNull
  3042. Description: A non-existing group. This value is not equal to anything, including itself.
  3043. Category: General
  3044. Address: 0xCB3A10
  3045. Example: group player == objNull
  3046. Ex. Returns: false
  3047.  
  3048.  
  3049. Name: gunner
  3050. Description: Returns the gunner of the vehicle. If the vehicle is not a vehicle, but a person, the person is returned.
  3051. Category: General
  3052. Address: 0xD38180
  3053. Example: gunner vehicle player
  3054. Arg1: vehicle
  3055.  
  3056.  
  3057. Name: gusts
  3058. Description: Return the current gusts value.
  3059. Category: General
  3060. Address: 0xCA9350
  3061.  
  3062.  
  3063. Name: handgunItems
  3064. Description: Get array with all items assigned to a weapon.
  3065. Category: General
  3066. Address: 0xD38230
  3067. Arg1: unit
  3068.  
  3069.  
  3070. Name: handgunMagazine
  3071. Description: Return the names of the types of currently loaded magazines in given weapon.
  3072. Category: General
  3073. Address: 0xD70C60
  3074. Arg1: vehicle
  3075.  
  3076.  
  3077. Name: handgunWeapon
  3078. Description: Returns the name of a units's handgun (an empty string if there is none).
  3079. Category: General
  3080. Address: 0xD33980
  3081. Example: handgunWeapon player
  3082. Arg1: unit
  3083.  
  3084.  
  3085. Name: handsHit
  3086. Description: Checks whether the soldier's hands are hit (causing inaccurate aiming).
  3087. Category: General
  3088. Address: 0xD38250
  3089. Example: handsHit leader player
  3090. Arg1: soldier
  3091.  
  3092.  
  3093. Name: hasInterface
  3094. Description: Returns true if the computer has an inteface (a real player). False for a dedicated server or for a headless client.
  3095. Category: General
  3096. Address: 0xCB5BD0
  3097.  
  3098.  
  3099. Name: hcAllGroups
  3100. Description: Returns selected groups in high command.
  3101. Category: General
  3102. Address: 0xCB50F0
  3103. Example: array = hcAllGroups unit
  3104. Arg1: unit
  3105.  
  3106.  
  3107. Name: hcLeader
  3108. Description: Returns group's HC commander.
  3109. Category: General
  3110. Address: 0xCB5530
  3111. Example: hcLeader group
  3112. Arg1: group
  3113.  
  3114.  
  3115. Name: hcRemoveAllGroups
  3116. Description: Remove all groups from unit's high command bar.
  3117. Category: General
  3118. Address: 0xCB5320
  3119. Example: hcRemoveAllGroups unit
  3120. Arg1: unit
  3121.  
  3122.  
  3123. Name: hcSelected
  3124. Description: Returns selected groups in high command.
  3125. Category: General
  3126. Address: 0xCB58D0
  3127. Example: array = hcSelected unit
  3128. Arg1: unit
  3129.  
  3130.  
  3131. Name: hcShowBar
  3132. Description: Shows or hides HC bar. There must be some groups under hc command to show hc bar.
  3133. Category: General
  3134. Address: 0xCB5B30
  3135. Example: hcShowBar true
  3136. Arg1: bool
  3137.  
  3138.  
  3139. Name: hcShownBar
  3140. Description: Return true if the HC bar is shown/active.
  3141. Category: General
  3142. Address: 0xCB80B0
  3143.  
  3144.  
  3145. Name: headgear
  3146. Description: Returns name of currently used headgear.
  3147. Category: General
  3148. Address: 0xD38420
  3149. Arg1: unit
  3150.  
  3151.  
  3152. Name: hideBody
  3153. Description: Hides the body of the given person.
  3154. Category: General
  3155. Address: 0xD38450
  3156. Example: hideBody player
  3157. Arg1: person
  3158.  
  3159.  
  3160. Name: hideObject
  3161. Description: Hide object (cannot hide static objects).
  3162. Category: General
  3163. Address: 0xCB5C10
  3164. Arg1: object
  3165.  
  3166.  
  3167. Name: hideObjectGlobal
  3168. Description: Hide object globally (cannot hide static objects). Only from server
  3169. Category: General
  3170. Address: 0xCB5CB0
  3171. Arg1: object
  3172.  
  3173.  
  3174. Name: hint
  3175. Description: Shows a text hint. The text can contain several lines. \n is used to indicate the end of a line.
  3176. Category: General
  3177. Address: 0xD56860
  3178. Example: hint "Press W to move forward"
  3179. Arg1: text
  3180.  
  3181.  
  3182. Name: hintC
  3183. Description: Shows a text hint. The text can contain several lines. \n is used to indicate the end of a line. This hint has to be confirmed.
  3184. Category: General
  3185. Address: 0xD56C30
  3186. Example: hintC "Press W to move forward"
  3187. Arg1: text
  3188.  
  3189.  
  3190. Name: hintCadet
  3191. Description: Shows a text hint only when using cadet mode. The text can contain several lines. \n is used to indicate the end of a line.
  3192. Category: General
  3193. Address: 0xD56C70
  3194. Example: hintCadet "Press W to move forward"
  3195. Arg1: text
  3196.  
  3197.  
  3198. Name: hintSilent
  3199. Description: Same as <f>hint</f>, but without a sound.
  3200. Category: General
  3201. Address: 0xD56DA0
  3202. Arg1: text
  3203.  
  3204.  
  3205. Name: hmd
  3206. Description: Returns name of currently used HMD.
  3207. Category: General
  3208. Address: 0xD38200
  3209. Arg1: unit
  3210.  
  3211.  
  3212. Name: hostMission
  3213. Description: Host the MP mission described by config class. Should be called as a reaction to some UI action in some dialog.
  3214. Category: General
  3215. Address: 0xCB5DF0
  3216. Arg1: [Config,Display]
  3217.  
  3218.  
  3219. Name: HUDMovementLevels
  3220. Description: Returns movement borders for HUD [min speed, max speed, min alt, max alt, min dir, max dir, position[x,y,z] or target]
  3221. Category: General
  3222. Address: 0xCA9390
  3223.  
  3224.  
  3225. Name: humidity
  3226. Description: Return the current humidity value.
  3227. Category: General
  3228. Address: 0xCA9990
  3229.  
  3230.  
  3231. Name: image
  3232. Description: Creates a structured text containing the given image.
  3233. Category: General
  3234. Address: 0xD60F80
  3235. Example: txt1 = image "data\isniper.paa"
  3236. Arg1: filename
  3237.  
  3238.  
  3239. Name: incapacitatedState
  3240. Description: Returns the incapacitated state of the given unit.
  3241. Category: General
  3242. Address: 0xD33D00
  3243. Arg1: unit
  3244.  
  3245.  
  3246. Name: independent
  3247. Description: Pre-defined variable for the independent side.
  3248. Category: General
  3249. Address: 0xD57790
  3250.  
  3251.  
  3252. Name: inflamed
  3253. Description: Check if fireplace is inflamed (buring).
  3254. Category: General
  3255. Address: 0xD385F0
  3256. Example: inflamed fireplaceOne
  3257. Arg1: fireplace
  3258.  
  3259.  
  3260. Name: inGameUISetEventHandler
  3261. Description: Sets given event handler of in-game UI.
  3262. Category: General
  3263. Address: 0xCB5FB0
  3264. Arg1: [handler name, function]
  3265.  
  3266.  
  3267. Name: inheritsFrom
  3268. Description: Returns base entry of config entry.
  3269. Category: General
  3270. Address: 0xC93C40
  3271. Example: _base = inheritsFrom (configFile >> "CfgVehicles" >> "Car")
  3272. Arg1: config
  3273.  
  3274.  
  3275. Name: initAmbientLife
  3276. Description: Initialize the ambient life.
  3277. Category: General
  3278. Address: 0xC90590
  3279.  
  3280.  
  3281. Name: inputAction
  3282. Description: Return the state of input devices mapped to given input action (see CfgDefaultKeysMapping for action names).
  3283. Category: General
  3284. Address: 0xCA9EB0
  3285. Arg1: name
  3286.  
  3287.  
  3288. Name: interpolate
  3289. Description: Extend expression
  3290. Category: Simple expression
  3291. Address: 0x1238D80
  3292. Arg1: expr
  3293. Arg2: val
  3294.  
  3295.  
  3296. Name: interpolate
  3297. Description: Extend expression
  3298. Category: Simple expression
  3299. Address: 0x1238D80
  3300. Arg1: expr
  3301. Arg2: val
  3302.  
  3303.  
  3304. Name: isAbleToBreathe
  3305. Description: Return whether the unit is diving.
  3306. Category: General
  3307. Address: 0xD38640
  3308. Arg1: unit
  3309.  
  3310.  
  3311. Name: isAgent
  3312. Description: Check if team member is an agent.
  3313. Category: Agents
  3314. Address: 0xD5E9B0
  3315. Arg1: teamMember
  3316.  
  3317.  
  3318. Name: isArray
  3319. Description: Check if config entry represents array.
  3320. Category: General
  3321. Address: 0xC94510
  3322. Example: _ok = isArray (configFile >> "CfgVehicles")
  3323. Ex. Returns: false
  3324. Arg1: config
  3325.  
  3326.  
  3327. Name: isAutoHoverOn
  3328. Description: Returns true if vehicle has enabled auto hover
  3329. Category: General
  3330. Address: 0xCB67A0
  3331. Arg1: vehicle
  3332.  
  3333.  
  3334. Name: isAutonomous
  3335. Description: Return true if UAV is in autonomous mode.
  3336. Category: General
  3337. Address: 0xCB68A0
  3338. Example: uavAuto = isAutonomous uav
  3339. Arg1: Uav
  3340.  
  3341.  
  3342. Name: isAutoStartUpEnabledRTD
  3343. Description: Returns true if automatic start up action is enabled.
  3344. Category: General
  3345. Address: 0xCB6800
  3346. Arg1: RTD_helicopter
  3347.  
  3348.  
  3349. Name: isAutotest
  3350. Description: Returns true if game was started with autotest parameter
  3351. Category: General
  3352. Address: 0xCB6900
  3353. Example: isAutotest
  3354.  
  3355.  
  3356. Name: isAutoTrimOnRTD
  3357. Description: Returns true if autotrim is enabled.
  3358. Category: General
  3359. Address: 0xCB6850
  3360. Arg1: RTD_helicopter
  3361.  
  3362.  
  3363. Name: isBleeding
  3364. Description: Return whether the unit is bleeding.
  3365. Category: General
  3366. Address: 0xD386A0
  3367. Arg1: unit
  3368.  
  3369.  
  3370. Name: isBurning
  3371. Description: Return whether the unit is burning.
  3372. Category: General
  3373. Address: 0xD386F0
  3374. Arg1: unit
  3375.  
  3376.  
  3377. Name: isClass
  3378. Description: Check if config entry represents config class.
  3379. Category: General
  3380. Address: 0xC94580
  3381. Example: _ok = isClass (configFile >> "CfgVehicles")
  3382. Ex. Returns: true
  3383. Arg1: config
  3384.  
  3385.  
  3386. Name: isCollisionLightOn
  3387. Description: Checks whether the collision light is on.(non-vehicle param returns false)
  3388. Category: General
  3389. Address: 0xD71520
  3390. Example: on = isLightOn vehicle player
  3391. Arg1: vehicle
  3392.  
  3393.  
  3394. Name: isCopilotEnabled
  3395. Description: Returns true if copilots actions are enabled.
  3396. Category: General
  3397. Address: 0xCB6A00
  3398. Example: enabled = isCopilotEnabled (vehicle player)
  3399. Arg1: vehicle
  3400.  
  3401.  
  3402. Name: isDedicated
  3403. Description: Return true for dedicated server.
  3404. Category: General
  3405. Address: 0xCB6AA0
  3406.  
  3407.  
  3408. Name: isDLCAvailable
  3409. Description: Returns true if the DLC is marked as available.
  3410. Category: General
  3411. Address: 0xCB6B90
  3412. Ex. Returns: 123896
  3413. Arg1: appId
  3414.  
  3415.  
  3416. Name: isEngineOn
  3417. Description: Checks whether the engine is on.
  3418. Category: General
  3419. Address: 0xD715E0
  3420. Example: on = isEngineOn vehicle player
  3421. Arg1: vehicle
  3422.  
  3423.  
  3424. Name: isForcedWalk
  3425. Description: Returns true if player is forced to walk
  3426. Category: General
  3427. Address: 0xCB7F20
  3428. Arg1: player
  3429.  
  3430.  
  3431. Name: isFormationLeader
  3432. Description: Returns true if the specified person is subgroup leader.
  3433. Category: General
  3434. Address: 0xD71640
  3435. Arg1: person
  3436.  
  3437.  
  3438. Name: isHidden
  3439. Description: Return whether the person is hidden (reached the hiding position).
  3440. Category: General
  3441. Address: 0xD38790
  3442. Arg1: person
  3443.  
  3444.  
  3445. Name: isInRemainsCollector
  3446. Description: Returns true if object will be managed by the unitRemove manager
  3447. Category: General
  3448. Address: 0xCB80E0
  3449. Example: isInRemainsCollector player
  3450. Arg1: object
  3451.  
  3452.  
  3453. Name: isInstructorFigureEnabled
  3454. Description: True if instructor figure is enabled in Game Options.
  3455. Category: General
  3456. Address: 0xCB8180
  3457. Example: isInstructorFigureEnabled
  3458. Ex. Returns: true or false
  3459.  
  3460.  
  3461. Name: isKeyActive
  3462. Description: Checks whether the given key is active in the current user profile.
  3463. Category: General
  3464. Address: 0xCB81A0
  3465. Example: ok = isKeyActive "M04"
  3466. Arg1: keyName
  3467.  
  3468.  
  3469. Name: isLightOn
  3470. Description: Checks whether the light is on.(non-vehicle param returns false)
  3471. Category: General
  3472. Address: 0xD716D0
  3473. Example: on = isLightOn vehicle player
  3474. Arg1: vehicle
  3475.  
  3476.  
  3477. Name: isLocalized
  3478. Description: Checks whether given string name is localized.
  3479. Category: General
  3480. Address: 0xD59530
  3481. Example: isLocalized "STR_DN_SNAKE"
  3482. Arg1: stringName
  3483.  
  3484.  
  3485. Name: isManualFire
  3486. Description: Returns true if manul fire is on.
  3487. Category: General
  3488. Address: 0xCB84A0
  3489. Arg1: vehicle
  3490.  
  3491.  
  3492. Name: isMarkedForCollection
  3493. Description: Checks whether the object is marked for weapons collection.
  3494. Category: General
  3495. Address: 0xD389C0
  3496. Example: marked = isMarkedForCollection truck
  3497. Arg1: object
  3498.  
  3499.  
  3500. Name: isMultiplayer
  3501. Description: Return true if multiPlayer.
  3502. Category: General
  3503. Address: 0xCB86B0
  3504.  
  3505.  
  3506. Name: isNull
  3507. Description: Checks whether the value is equal to grpNull.
  3508. Note: a==GrpNull does not work, because grpNull is not equal to anything, even to itself.
  3509. Category: General
  3510. Address: 0xCB3730
  3511. Example: isNull group player
  3512. Ex. Returns: false
  3513. Arg1: grp
  3514.  
  3515.  
  3516. Name: isNull
  3517. Description: Checks whether the value is equal to scriptNull.
  3518. Note: script == scriptNull does not work, because scriptNull is not equal to anything, even to itself.
  3519. Category: General
  3520. Address: 0xD4D150
  3521. Example: isNull scriptNull
  3522. Ex. Returns: true
  3523. Arg1: script
  3524.  
  3525.  
  3526. Name: isNull
  3527. Description: Checks whether the value is equal to displayNull.
  3528. Note: a==displayNull does not work, because displayNull is not equal to anything, even to itself.
  3529. Category: General
  3530. Address: 0xD65D10
  3531. Example: isNull displayNull
  3532. Ex. Returns: true
  3533. Arg1: display
  3534.  
  3535.  
  3536. Name: isNull
  3537. Description: Checks whether the value is equal to objNetNull.
  3538. Note: a==ObjNetNull does not work, because objNetNull is not equal to anything, even to itself.
  3539. Category: General
  3540. Address: 0xD29950
  3541. Example: isNull objNetNull
  3542. Ex. Returns: true
  3543. Arg1: NetObject
  3544.  
  3545.  
  3546. Name: isNull
  3547. Description: Checks whether the value is equal to controlNull.
  3548. Note: a==controlNull does not work, because controlNull is not equal to anything, even to itself.
  3549. Category: General
  3550. Address: 0xD62E70
  3551. Example: isNull controlNull
  3552. Ex. Returns: true
  3553. Arg1: control
  3554.  
  3555.  
  3556. Name: isNull
  3557. Description: Checks whether the value is equal to objNull.
  3558. Note: a==ObjNull does not work, because objNull is not equal to anything, even to itself.
  3559. Category: General
  3560. Address: 0xD38A20
  3561. Example: isNull objNull
  3562. Ex. Returns: true
  3563. Arg1: obj
  3564.  
  3565.  
  3566. Name: isNumber
  3567. Description: Check if config entry represents number.
  3568. Category: General
  3569. Address: 0xC945F0
  3570. Example: _ok = isNumber (configFile >> "CfgVehicles")
  3571. Ex. Returns: false
  3572. Arg1: config
  3573.  
  3574.  
  3575. Name: isObjectRTD
  3576. Description: Returns true if RTD model is loaded.
  3577. Category: General
  3578. Address: 0xCB8770
  3579. Arg1: helicopter
  3580.  
  3581.  
  3582. Name: isOnRoad
  3583. Description: Check whether given position is on road.
  3584. Category: General
  3585. Address: 0xD472D0
  3586. Arg1: position or object
  3587.  
  3588.  
  3589. Name: isPipEnabled
  3590. Description: Returns true if PiP is enabled.
  3591. Category: General
  3592. Address: 0xCB87D0
  3593.  
  3594.  
  3595. Name: isPlayer
  3596. Description: Check if given person is the player.
  3597. Category: General
  3598. Address: 0xD38AC0
  3599. Arg1: person
  3600.  
  3601.  
  3602. Name: isServer
  3603. Description: Returns true if the computer is the server.
  3604. Category: General
  3605. Address: 0xCB8930
  3606.  
  3607.  
  3608. Name: isSteamMission
  3609. Description: Returns true if mission is started from the steam.
  3610. Category: General
  3611. Address: 0xCB8980
  3612.  
  3613.  
  3614. Name: isStreamFriendlyUIEnabled
  3615. Description: True if stream friendly UI is enabled in Game Options.
  3616. Category: General
  3617. Address: 0xCB89E0
  3618. Example: isStreamFriendlyUIEnabled
  3619. Ex. Returns: true or false
  3620.  
  3621.  
  3622. Name: isStressDamageEnabled
  3623. Description: Returns true if stress damage is enabled.
  3624. Category: General
  3625. Address: 0xCB8A00
  3626.  
  3627.  
  3628. Name: isText
  3629. Description: Check if config entry represents text.
  3630. Category: General
  3631. Address: 0xC94670
  3632. Example: _ok = isText (configFile >> "CfgVehicles")
  3633. Ex. Returns: false
  3634. Arg1: config
  3635.  
  3636.  
  3637. Name: isTouchingGround
  3638. Description: Returns true if object is touching the ground.
  3639. Category: General
  3640. Address: 0xD38B20
  3641. Example: isTouchingGround vehicle
  3642. Arg1: object
  3643.  
  3644.  
  3645. Name: isTutHintsEnabled
  3646. Description: True if tutorial hints are enabled in Game Options.
  3647. Category: General
  3648. Address: 0xCB8A50
  3649. Example: isTutHintsEnabled
  3650. Ex. Returns: true or false
  3651.  
  3652.  
  3653. Name: isUAVConnected
  3654. Description: Returns true if UAV is connected to some terminal.
  3655. Category: General
  3656. Address: 0xCB8BA0
  3657. Example: isUAVConnected cursorTarget
  3658. Arg1: Uav
  3659.  
  3660.  
  3661. Name: isWalking
  3662. Description: Returns true walk is toggled.
  3663. Category: General
  3664. Address: 0xCB8C70
  3665. Arg1: soldier
  3666.  
  3667.  
  3668. Name: itemCargo
  3669. Description: Get array with items from ammo box (or any general weapon holder container).
  3670. Category: General
  3671. Address: 0xD38FA0
  3672. Arg1: box
  3673.  
  3674.  
  3675. Name: items
  3676. Description: Returns only items that are not magazines/explosives/grenades. Includes also items that are linked on unit (i.e. includes assignedItems array)
  3677. Category: General
  3678. Address: 0xD2CD20
  3679. Arg1: unit
  3680.  
  3681.  
  3682. Name: itemsWithMagazines
  3683. Description: Get array with all inventory items.
  3684. Category: General
  3685. Address: 0xD2CCC0
  3686. Arg1: unit
  3687.  
  3688.  
  3689. Name: keyImage
  3690. Description: Returns a structured text, containing an image or name (if no image is found) of the button (on the keyboard, mouse or joystick) with the given code.
  3691. Category: General
  3692. Address: 0xCA9FA0
  3693. Example: name = keyImage 28
  3694. Ex. Returns: "Enter"
  3695. Arg1: dikCode
  3696.  
  3697.  
  3698. Name: keyName
  3699. Description: Returns the name of a button (on the keyboard, mouse or joystick) with the given code.
  3700. Category: General
  3701. Address: 0xCAA040
  3702. Example: name = keyName 28
  3703. Ex. Returns: "Enter"
  3704. Arg1: dikCode
  3705.  
  3706.  
  3707. Name: landResult
  3708. Description: Return the result of helicopter landing position searching (performed after land command). The value can be "Found" (position found), "NotFound" (position not found), "NotReady" (position searching is still in progress) or empty string when wrong argument given.
  3709. Category: General
  3710. Address: 0xD341D0
  3711. Arg1: helicopter
  3712.  
  3713.  
  3714. Name: language
  3715. Description: Returns current game language.
  3716. Category: General
  3717. Address: 0xCAA350
  3718.  
  3719.  
  3720. Name: laserTarget
  3721. Description: Returns target created by gunner in given vehicle.
  3722. Category: General
  3723. Address: 0xCAA380
  3724. Arg1: vehicle
  3725.  
  3726.  
  3727. Name: lbAdd
  3728. Description: Adds an item with the given text to the listbox or combobox with id idc of the topmost user dialog. It returns the index of the newly added item.
  3729. Category: General
  3730. Address: 0xD1F2D0
  3731. Example: _index = lbAdd [101, "First item"]
  3732. Arg1: [idc, text]
  3733.  
  3734.  
  3735. Name: lbClear
  3736. Description: Clears all items in the listbox or combobox with id idc of the topmost user dialog.
  3737. Category: General
  3738. Address: 0xD20A10
  3739. Example: lbClear 101
  3740. Arg1: idc
  3741.  
  3742.  
  3743. Name: lbClear
  3744. Description: Clears all items in the given listbox or combobox.
  3745. Category: General
  3746. Address: 0xD66B80
  3747. Example: lbClear _control
  3748. Arg1: control
  3749.  
  3750.  
  3751. Name: lbColor
  3752. Description: Returns the text color of the item with the given index of the listbox or combobox with id idc of the topmost user dialog. The color is returned in format <ar>Color</ar>.
  3753. Category: General
  3754. Address: 0xD1F4A0
  3755. Example: _color = lbColor [101, 0]
  3756. Arg1: [idc, index]
  3757.  
  3758.  
  3759. Name: lbCurSel
  3760. Description: Returns the index of the selected item of the listbox or combobox with id idc of the topmost user dialog.
  3761. Category: General
  3762. Address: 0xD1F5F0
  3763. Example: _index = lbCurSel 101
  3764. Arg1: idc
  3765.  
  3766.  
  3767. Name: lbCurSel
  3768. Description: Returns the index of the selected item of the given listbox or combobox.
  3769. Category: General
  3770. Address: 0xD66DD0
  3771. Example: _index = lbCurSel _control
  3772. Arg1: control
  3773.  
  3774.  
  3775. Name: lbData
  3776. Description: Returns the additional text (invisible) in an item with the given index of the listbox or combobox with id idc of the topmost user dialog.
  3777. Category: General
  3778. Address: 0xD1F640
  3779. Example: _data = lbData [101, 0]
  3780. Arg1: [idc, index]
  3781.  
  3782.  
  3783. Name: lbDelete
  3784. Description: Removes the item with the given index from the listbox or combobox with id idc of the topmost user dialog.
  3785. Category: General
  3786. Address: 0xD1F3D0
  3787. Example: lbDelete [101, 0]
  3788. Arg1: [idc, index]
  3789.  
  3790.  
  3791. Name: lbPicture
  3792. Description: Returns the picture name of the item with the given index of the listbox or combobox with id idc of the topmost user dialog.
  3793. Category: General
  3794. Address: 0xD1F720
  3795. Example: _picture = lbPicture [101, 0]
  3796. Arg1: [idc, index]
  3797.  
  3798.  
  3799. Name: lbSelection
  3800. Description: Returns the array of selected rows indices in the given listbox.
  3801. Category: General
  3802. Address: 0xD670A0
  3803. Example: _indices = lbSelection _control
  3804. Arg1: control
  3805.  
  3806.  
  3807. Name: lbSetColor
  3808. Description: Sets the color of the item with the given index of the listbox or combobox with id idc of the topmost user dialog to the given color. Color is in format <ar>Color</ar>.
  3809. Category: General
  3810. Address: 0xD1FAB0
  3811. Example: lbSetColor [101, 0, [0, 1, 0, 0.5]]
  3812. Arg1: [idc, index, color]
  3813.  
  3814.  
  3815. Name: lbSetCurSel
  3816. Description: Selects the item with the given index of the listbox or combobox with id idc of the topmost user dialog.
  3817. Category: General
  3818. Address: 0xD1FBE0
  3819. Example: lbSetCurSel [101, 0]
  3820. Arg1: [idc, index]
  3821.  
  3822.  
  3823. Name: lbSetData
  3824. Description: Sets the additional text (invisible) in the item with the given index of the listbox or combobox with id idc of the topmost user dialog to the given data.
  3825. Category: General
  3826. Address: 0xD1FD80
  3827. Example: lbSetData [101, 1, "#1"]
  3828. Arg1: [idc, index, data]
  3829.  
  3830.  
  3831. Name: lbSetPicture
  3832. Description: Sets the picture in the item with the given index of the listbox or combobox with id idc of the topmost user dialog. Name is the picture name. The picture is searched in the mission directory, the dtaExt subdirectory of the campaign directory and the dtaExt directory and the data bank (or directory).
  3833. Category: General
  3834. Address: 0xD1FDA0
  3835. Example: lbSetPicture [101, 0, "iskoda"]
  3836. Arg1: [idc, index, name]
  3837.  
  3838.  
  3839. Name: lbSetPictureColor
  3840. Description: Sets the color of item's picture with the given index of the listbox with id idc of the topmost user dialog to the given color. Color is in format <ar>Color</ar>. (color which consists from only zeros means disable this override)
  3841. Category: General
  3842. Address: 0xD1FF20
  3843. Example: lbSetPictureColor [101, 0, [0, 1, 0, 0.5]]
  3844. Arg1: [idc, index, color]
  3845.  
  3846.  
  3847. Name: lbSetPictureColorDisabled
  3848. Description: Sets the disabled color of item's picture with the given index of the listbox with id idc of the topmost user dialog to the given color. Color is in format <ar>Color</ar>. (color which consists from only zeros means disable this override)
  3849. Category: General
  3850. Address: 0xD20110
  3851. Example: lbSetPictureColorDisabled [101, 0, [0, 1, 0, 0.5]]
  3852. Arg1: [idc, index, color]
  3853.  
  3854.  
  3855. Name: lbSetPictureColorSelected
  3856. Description: Sets the selected color of item's picture with the given index of the listbox with id idc of the topmost user dialog to the given color. Color is in format <ar>Color</ar>. (color which consists from only zeros means disable this override)
  3857. Category: General
  3858. Address: 0xD20280
  3859. Example: lbSetPictureColorSelected [101, 0, [0, 1, 0, 0.5]]
  3860. Arg1: [idc, index, color]
  3861.  
  3862.  
  3863. Name: lbSetTooltip
  3864. Description: Sets tooltip for item with the given index of the listbox or combobox with id idc of the topmost user dialog to the given data.
  3865. Category: General
  3866. Address: 0xD202A0
  3867. Example: lbSetTooltip [101, 1, "tooltip"]
  3868. Arg1: [idc, index, tooltip]
  3869.  
  3870.  
  3871. Name: lbSetValue
  3872. Description: Sets the additional integer value in the item with the given index of the listbox or combobox with id idc of the topmost user dialog to the given value.
  3873. Category: General
  3874. Address: 0xD202C0
  3875. Example: lbSetValue [101, 0, 1]
  3876. Arg1: [idc, index, value]
  3877.  
  3878.  
  3879. Name: lbSize
  3880. Description: Returns the number of items in the given listbox or combobox.
  3881. Category: General
  3882. Address: 0xD672B0
  3883. Example: _n = lbSize _control
  3884. Arg1: control
  3885.  
  3886.  
  3887. Name: lbSize
  3888. Description: Returns the number of items in the listbox or combobox with id idc of the topmost user dialog.
  3889. Category: General
  3890. Address: 0xD1F880
  3891. Example: _n = lbSize 101
  3892. Arg1: idc
  3893.  
  3894.  
  3895. Name: lbSort
  3896. Description: Sorts the given listbox or combobox by item text, order can be "asc" for ascending or "desc" for descending.
  3897. Category: General
  3898. Address: 0xD68000
  3899. Example: lbSort [_control, "desc"]
  3900. Arg1: [control, order]
  3901.  
  3902.  
  3903. Name: lbSort
  3904. Description: Sorts the given listbox or combobox by item text.
  3905. Category: General
  3906. Address: 0xD67F00
  3907. Example: lbSort _control
  3908. Arg1: control
  3909.  
  3910.  
  3911. Name: lbSortByValue
  3912. Description: Sorts the given listbox or combobox by item value.
  3913. Category: General
  3914. Address: 0xD67F80
  3915. Example: lbSortByValue _control
  3916. Arg1: control
  3917.  
  3918.  
  3919. Name: lbText
  3920. Description: Returns the shown text in the item with the given index of the listbox or combobox with id idc of the topmost user dialog.
  3921. Category: General
  3922. Address: 0xD1F8D0
  3923. Example: _text = lbText [101, 0]
  3924. Arg1: [idc, index]
  3925.  
  3926.  
  3927. Name: lbValue
  3928. Description: Returns the additional integer value in the item with the given index of the listbox or combobox with id idc of the topmost user dialog.
  3929. Category: General
  3930. Address: 0xD1F9B0
  3931. Example: _value = lbValue [101, 0]
  3932. Arg1: [idc, index]
  3933.  
  3934.  
  3935. Name: leader
  3936. Description: Returns the group leader for the given group. For a dead unit, grpNull is returned.
  3937. Category: General
  3938. Address: 0xCB3850
  3939. Example: leader group player == leader player
  3940. Arg1: grp
  3941.  
  3942.  
  3943. Name: leader
  3944. Description: Return the leader of given team.
  3945. Category: Agents
  3946. Address: 0xD5E190
  3947. Arg1: team
  3948.  
  3949.  
  3950. Name: leader
  3951. Description: Returns the group leader for the given unit. For dead units, objNull is returned.
  3952. Category: General
  3953. Address: 0xD38070
  3954. Example: leader player
  3955. Arg1: unit
  3956.  
  3957.  
  3958. Name: libraryCredits
  3959. Description: Copyright information needed by libraries used.
  3960. Category: General
  3961. Address: 0xD222D0
  3962. Example: libraryCredits
  3963. Ex. Returns: [['Real Virtuality','(C) 2012 Bohemia Interactive','All rights reserved']]
  3964.  
  3965.  
  3966. Name: libraryDisclaimers
  3967. Description: Disclaimer information needed by libraries used (duplicate disclaimers are removed).
  3968. Category: General
  3969. Address: 0xD225D0
  3970. Example: libraryDisclaimers
  3971. Ex. Returns: ['All rights reserved']
  3972.  
  3973.  
  3974. Name: lifeState
  3975. Description: Returns the life state of the given unit.
  3976. Category: General
  3977. Address: 0xD34240
  3978. Arg1: unit
  3979.  
  3980.  
  3981. Name: lightDetachObject
  3982. Description: Detach light from object.
  3983. Category: General
  3984. Address: 0xD22940
  3985. Arg1: light
  3986.  
  3987.  
  3988. Name: lightIsOn
  3989. Description: Checks whether the lampost is turned on. Possible values are "ON", "OFF" and "AUTO" (auto means the lamp will be shining during the night automatically).
  3990. Category: General
  3991. Address: 0xD391B0
  3992. Example: lightIsOn nearestObject [player, "StreetLamp"] != "OFF"
  3993. Arg1: lamppost
  3994.  
  3995.  
  3996. Name: lightnings
  3997. Description: Return lightnings value.
  3998. Category: General
  3999. Address: 0xCAA430
  4000.  
  4001.  
  4002. Name: linearConversion
  4003. Description: Converts value in interval [min, max] to newMin + a*(max-min)/(newMax - newMin), potentially clamps the final value.
  4004. Category: General
  4005. Address: 0xCB6530
  4006. Example: linearConversion [4, 8, 5, 0, 1, false]
  4007. Arg1: [min, max, value, newMin, newMax, clamp]
  4008.  
  4009.  
  4010. Name: lineBreak
  4011. Description: Creates a structured text containing a line break.
  4012. Category: General
  4013. Address: 0xD60920
  4014. Example: txt3 = lineBreak
  4015.  
  4016.  
  4017. Name: lineIntersects
  4018. Description: Returns true, if line intersect with any object.
  4019. Category: General
  4020. Address: 0xD23190
  4021. Example: lineIntersects [begPos, endPos, withObj, ignoreObj]
  4022. Arg1: array
  4023.  
  4024.  
  4025. Name: lineIntersectsObjs
  4026. Description: Returns list of objects intersected by given line. Filters (can be combined): CF_ONLY_WATER=1,CF_NEAREST_CONTACT=2,CF_ONLY_STATIC=4,CF_ONLY_DYNAMIC=8,CF_FIRST_CONTACT=16,CF_ALL_OBJECTS=32 (usable only with CF_FIRST_CONTACT and it will check one contact per object)
  4027. Category: General
  4028. Address: 0xD231B0
  4029. Example: lineIntersectsObjs [begPos, endPos, withObj, ignoreObj, sortByDist, flags]
  4030. Arg1: array
  4031.  
  4032.  
  4033. Name: lineIntersectsWith
  4034. Description: Returns list of objects intersected by given line.
  4035. Category: General
  4036. Address: 0xD231B0
  4037. Example: lineIntersectsWith [begPos, endPos, withObj, ignoreObj, sortByDist]
  4038. Arg1: array
  4039.  
  4040.  
  4041. Name: list
  4042. Description: Returns a list of units that would activate the given trigger. For a trigger of type "Not present" the list is the same as the list that would be returned for type "Present".
  4043. Category: General
  4044. Address: 0xD39660
  4045. Example: list triggerOne
  4046. Arg1: trigger
  4047.  
  4048.  
  4049. Name: lnbAddArray
  4050. Description: Adds list of rows of strings.
  4051. Category: General
  4052. Address: 0xD203E0
  4053. Example: _index = lnbAddArray [idc,[[[text,text,text], [value], [data]], [[text,text,text], [value, value], [data]]]] . Returns row index.
  4054. Arg1: [IDC,[[[text,text], [value,..], [data,..]], [[text,text], [value,..], [data,..]],]]
  4055.  
  4056.  
  4057. Name: lnbAddColumn
  4058. Description: Adds an column at given position. It returns the index of the newly added column.
  4059. Category: General
  4060. Address: 0xD207A0
  4061. Example: _index = lnbAddColumn [105, 0.8]
  4062. Arg1: [idc, position]
  4063.  
  4064.  
  4065. Name: lnbAddRow
  4066. Description: Adds an row of strings.
  4067. Category: General
  4068. Address: 0xD20880
  4069. Example: _index = lnbAddRow [105, ["First column", "second column", ...]]. Returns row index.
  4070. Arg1: [idc, [text, text,...]]
  4071.  
  4072.  
  4073. Name: lnbClear
  4074. Description: Clears all items in the given listbox or combobox.
  4075. Category: General
  4076. Address: 0xD66B60
  4077. Example: lbClear _control
  4078. Arg1: control
  4079.  
  4080.  
  4081. Name: lnbClear
  4082. Description: Clears all items in the 2D listbox.
  4083. Category: General
  4084. Address: 0xD20A10
  4085. Example: lnbClear 101
  4086. Arg1: idc
  4087.  
  4088.  
  4089. Name: lnbColor
  4090. Description: Returns the text color of the item with the given position of the 2D listbox. The color is returned in format <ar>Color</ar>.
  4091. Category: General
  4092. Address: 0xD20C00
  4093. Example: _color = lnbColor [101, [0,1]]
  4094. Arg1: [idc, [row, column]
  4095.  
  4096.  
  4097. Name: lnbCurSelRow
  4098. Description: Returns the index of the selected row id 2D listbox.
  4099. Category: General
  4100. Address: 0xD1F5F0
  4101. Example: _row = lnbCurSel 105
  4102. Arg1: idc
  4103.  
  4104.  
  4105. Name: lnbCurSelRow
  4106. Description: Returns the index of the selected item of the given listbox or combobox.
  4107. Category: General
  4108. Address: 0xD68850
  4109. Example: _index = lbCurSel _control
  4110. Arg1: control
  4111.  
  4112.  
  4113. Name: lnbData
  4114. Description: Returns the additional text (invisible) in an item with the given position of the 2D listbox.
  4115. Category: General
  4116. Address: 0xD20F10
  4117. Example: _data = lnbData [101, [0,1]]
  4118. Arg1: [idc, [row, column]
  4119.  
  4120.  
  4121. Name: lnbDeleteColumn
  4122. Description: Removes column with given index.
  4123. Category: General
  4124. Address: 0xD20A40
  4125. Example: lnbDeleteColumn [101, 0]
  4126. Arg1: [idc, index]
  4127.  
  4128.  
  4129. Name: lnbDeleteRow
  4130. Description: Removes row with given index from the 2D listbox.
  4131. Category: General
  4132. Address: 0xD20B20
  4133. Example: lnbDeleteRow [105, 0]
  4134. Arg1: [idc, index]
  4135.  
  4136.  
  4137. Name: lnbGetColumnsPosition
  4138. Description: Returns the columns position in 2D listbox.
  4139. Category: General
  4140. Address: 0xD20E00
  4141. Example: _n = lnbGetColumnsSize 105
  4142. Arg1: idc
  4143.  
  4144.  
  4145. Name: lnbGetColumnsPosition
  4146. Description: Returns the index of the selected item of the given listbox or combobox.
  4147. Category: General
  4148. Address: 0xD68740
  4149. Example: _index = lbCurSel _control
  4150. Arg1: control
  4151.  
  4152.  
  4153. Name: lnbPicture
  4154. Description: Returns the picture name of the item with the given position of the 2D listbox.
  4155. Category: General
  4156. Address: 0xD21090
  4157. Example: _picture = lnbPicture [101, [0,1]]
  4158. Arg1: [idc, [row, column]
  4159.  
  4160.  
  4161. Name: lnbSetColor
  4162. Description: Sets the color of the item with the given position of the 2D listbox. Color is in format <ar>Color</ar>.
  4163. Category: General
  4164. Address: 0xD216A0
  4165. Example: lnbSetColor [101, [0,1], [0, 1, 0, 0.5]]
  4166. Arg1: [idc, [row, column], color]
  4167.  
  4168.  
  4169. Name: lnbsetColumnsPos
  4170. Description: Sets the additional text (invisible) in the item with the given position of the 2D listbox.
  4171. Category: General
  4172. Address: 0xD21890
  4173. Example: lnbSetData [101, [0,1], "#1"]
  4174. Arg1: [idc, [row, column], data]
  4175.  
  4176.  
  4177. Name: lnbSetCurSelRow
  4178. Description: Selects the row with the given index of the 2D listbox.
  4179. Category: General
  4180. Address: 0xD21A00
  4181. Example: lnbSetCurSel [105, 0]
  4182. Arg1: [idc, index]
  4183.  
  4184.  
  4185. Name: lnbSetData
  4186. Description: Sets the additional text (invisible) in the item with the given position of the 2D listbox.
  4187. Category: General
  4188. Address: 0xD21AE0
  4189. Example: lnbSetData [101, [0,1], "#1"]
  4190. Arg1: [idc, [row, column], data]
  4191.  
  4192.  
  4193. Name: lnbSetPicture
  4194. Description: Sets the picture in the item with the given position of the 2D listbox. Name is the picture name. The picture is searched in the mission directory, the dtaExt subdirectory of the campaign directory and the dtaExt directory and the data bank (or directory).
  4195. Category: General
  4196. Address: 0xD21CD0
  4197. Example: lnbSetPicture [101, [0,1], "iskoda"]
  4198. Arg1: [idc, [row, column], name]
  4199.  
  4200.  
  4201. Name: lnbSetText
  4202. Description: Sets the additional text (invisible) in the item with the given position of the 2D listbox.
  4203. Category: General
  4204. Address: 0xD21EF0
  4205. Example: lnbSetData [101, [0,1], "#1"]
  4206. Arg1: [idc, [row, column], data]
  4207.  
  4208.  
  4209. Name: lnbSetValue
  4210. Description: Sets the additional integer value in the item with the position index of the 2D listbox.
  4211. Category: General
  4212. Address: 0xD220E0
  4213. Example: lnbSetValue [101, [0,1], 1]
  4214. Arg1: [idc, [row, column], value]
  4215.  
  4216.  
  4217. Name: lnbSize
  4218. Description: Returns the number of items in the given listbox or combobox.
  4219. Category: General
  4220. Address: 0xD68C70
  4221. Example: _n = lbSize _control
  4222. Arg1: control
  4223.  
  4224.  
  4225. Name: lnbSize
  4226. Description: Returns [X,Y] size of 2D listbox.
  4227. Category: General
  4228. Address: 0xD21270
  4229. Example: _n = lnbSize 105
  4230. Arg1: idc
  4231.  
  4232.  
  4233. Name: lnbText
  4234. Description: Returns the shown text in the item with the given position of the 2D listbox.
  4235. Category: General
  4236. Address: 0xD21380
  4237. Example: _text = lnbText [101, [0,1]]
  4238. Arg1: [idc, [row, column]]
  4239.  
  4240.  
  4241. Name: lnbValue
  4242. Description: Returns the additional integer value in the item with the given position of the 2D listbox.
  4243. Category: General
  4244. Address: 0xD21500
  4245. Example: _value = lnbValue [101, [0,1]]
  4246. Arg1: [idc, [row, column]
  4247.  
  4248.  
  4249. Name: load
  4250. Description: Returns current sum of mass from items stored in all unit's containers.
  4251. Category: General
  4252. Address: 0xD30780
  4253. Example: load player
  4254. Arg1: unit
  4255.  
  4256.  
  4257. Name: loadAbs
  4258. Description: Returns current sum of mass from items stored in a all unit's containers, linked items and weapons.
  4259. Category: General
  4260. Address: 0xD30860
  4261. Example: loadAbs player
  4262. Arg1: unit
  4263.  
  4264.  
  4265. Name: loadBackpack
  4266. Description: Returns current sum of mass from items stored in a backpack.
  4267. Category: General
  4268. Address: 0xD34730
  4269. Example: loadBackpack player
  4270. Arg1: unit
  4271.  
  4272.  
  4273. Name: loadFile
  4274. Description: Returns contents of a given file. On dedicated server/client connected to a dedicated server, if allowedLoadFileExtensions parameter is used in the DS config file this only returns contents of a file if the file extension is listed in it. The list should contain at least the following extensions: hpp, sqs, sqf, fsm, cpp, paa, txt, xml, inc, ext, sqm, ods, fxy, lip, csv, kb, bik, bikn, html, biedi. Note, this list may not be completely up to date
  4275. Category: General
  4276. Address: 0xD597C0
  4277. Example: loadFile "myFunction.sqf"
  4278. Ex. Returns: "if a>b then {a} else {b}"
  4279. Arg1: filename
  4280.  
  4281.  
  4282. Name: loadGame
  4283. Description: Load a game from the autosave, if failed, restart the mission.
  4284. Category: General
  4285. Address: 0xD23B90
  4286.  
  4287.  
  4288. Name: loadUniform
  4289. Description: Returns current sum of mass from items stored in a uniform.
  4290. Category: General
  4291. Address: 0xD347E0
  4292. Example: loadUniform player
  4293. Arg1: unit
  4294.  
  4295.  
  4296. Name: loadVest
  4297. Description: Returns current sum of mass from items stored in a vest.
  4298. Category: General
  4299. Address: 0xD34890
  4300. Example: loadVest player
  4301. Arg1: unit
  4302.  
  4303.  
  4304. Name: local
  4305. Description: MP: checks whether the given unit is local on the computer. This can be used when one or more activation fields or scripts need to be performed only on one computer.
  4306. In SP all objects are local. Note: all static objects are local on all computers.
  4307. Category: General
  4308. Address: 0xD38980
  4309. Example: local unitName
  4310. Arg1: obj
  4311.  
  4312.  
  4313. Name: local
  4314. Description: MP: checks whether the given group is local on the computer.
  4315. Category: General
  4316. Address: 0xCB36F0
  4317. Example: local group1
  4318. Arg1: grp
  4319.  
  4320.  
  4321. Name: localize
  4322. Description: Replaces the string with the given name with the corresponding localized text from the stringtable.csv file.
  4323. Category: General
  4324. Address: 0xD59670
  4325. Example: localize "STR_DN_FROG"
  4326. Arg1: stringName
  4327.  
  4328.  
  4329. Name: locked
  4330. Description: Checks whether the vehicle is locked for the player. If it's locked, the player cannot mount / dismount without an order. 0 - Unlocked, 1 - Default, 2 - Locked, 3 - Locked for player
  4331. Category: General
  4332. Address: 0xD3A480
  4333. Example: locked jeepOne
  4334. Arg1: unit
  4335.  
  4336.  
  4337. Name: lockedDriver
  4338. Description: Check whether driver position of the vehicle turret is locked.
  4339. Category: General
  4340. Address: 0xD71590
  4341. Arg1: vehicle
  4342.  
  4343.  
  4344. Name: logEntities
  4345. Description: Creates a log file containing a list of all game entites in scene.,
  4346. Category: General
  4347. Address: 0xD24380
  4348.  
  4349.  
  4350. Name: magazineCargo
  4351. Description: Get array with magazines from ammo box (or any general weapon holder container).
  4352. Category: General
  4353. Address: 0xD3A4E0
  4354. Arg1: box
  4355.  
  4356.  
  4357. Name: magazines
  4358. Description: Returns an array with the type names of all the vehicle's magazines.
  4359. Category: General
  4360. Address: 0xD308D0
  4361. Example: magazines player
  4362. Arg1: vehicle
  4363.  
  4364.  
  4365. Name: magazinesAmmo
  4366. Description: Returns an array of subarrays with the type names and ammo left of all the vehicle's magazines.
  4367. Category: General
  4368. Address: 0xD309C0
  4369. Example: magazinesAmmo player
  4370. Arg1: vehicle
  4371.  
  4372.  
  4373. Name: magazinesAmmoCargo
  4374. Description: Returns an array of subarrays with the type names and ammo left of all the vehicle's cargo magazines.
  4375. Category: General
  4376. Address: 0xD30B40
  4377. Example: magazinesAmmoCargo vehicle player
  4378. Arg1: vehicle
  4379.  
  4380.  
  4381. Name: magazinesAmmoFull
  4382. Description: Returns an array of subarrays with the type names and ammo left of all the vehicle's magazines.
  4383. Category: General
  4384. Address: 0xD30C70
  4385. Example: magazinesAmmoFull player
  4386. Arg1: vehicle
  4387.  
  4388.  
  4389. Name: magazinesDetail
  4390. Description: Returns an array with the type names of all the unit's magazines.
  4391. Category: General
  4392. Address: 0xD30900
  4393. Example: magazines player
  4394. Arg1: unit
  4395.  
  4396.  
  4397. Name: magazinesDetailBackpack
  4398. Description: Returns an array with the type names of all the unit's backpack magazines.
  4399. Category: General
  4400. Address: 0xD30930
  4401. Example: magazinesBackpack player
  4402. Arg1: unit
  4403.  
  4404.  
  4405. Name: magazinesDetailUniform
  4406. Description: Returns an array with the type names of all the unit's uniform magazines.
  4407. Category: General
  4408. Address: 0xD30960
  4409. Example: magazinesUniform player
  4410. Arg1: unit
  4411.  
  4412.  
  4413. Name: magazinesDetailVest
  4414. Description: Returns an array with the type names of all the unit's vest magazines.
  4415. Category: General
  4416. Address: 0xD30990
  4417. Example: magazinesVest player
  4418. Arg1: unit
  4419.  
  4420.  
  4421. Name: mapAnimAdd
  4422. Description: Adds the next frame to the map animation. The format of frame is [time, zoom, position], the format of position is <ar>Position2D</ar>.
  4423. Category: General
  4424. Address: 0xD243A0
  4425. Example: mapAnimAdd [1, 0.1, getMarkerPos "anim1"]
  4426. Arg1: frame
  4427.  
  4428.  
  4429. Name: mapAnimClear
  4430. Description: Clears the map animation.
  4431. Category: General
  4432. Address: 0xD24530
  4433.  
  4434.  
  4435. Name: mapAnimCommit
  4436. Description: Plays the map animation.
  4437. Category: General
  4438. Address: 0xD24590
  4439.  
  4440.  
  4441. Name: mapAnimDone
  4442. Description: Checks whether the map animation has finished.
  4443. Category: General
  4444. Address: 0xD245F0
  4445.  
  4446.  
  4447. Name: mapGridPosition
  4448. Description: Returns the position as map coords.
  4449. Category: General
  4450. Address: 0xD251B0
  4451. Example: mapGridPosition player
  4452. Arg1: object
  4453.  
  4454.  
  4455. Name: markAsFinishedOnSteam
  4456. Description: Marks current mission and finished on steam. Returns true is Steam query is successfully started or false otherwise.
  4457. Category: General
  4458. Address: 0xD25880
  4459.  
  4460.  
  4461. Name: markerAlpha
  4462. Description: Gets the marker alpha. See <f>setMarkerAlpha</f>.
  4463. Category: General
  4464. Address: 0xD25E70
  4465. Example: markerAlpha "MarkerOne"
  4466. Arg1: markerName
  4467.  
  4468.  
  4469. Name: markerBrush
  4470. Description: Gets the marker brush. See <f>setMarkerBrush</f>.
  4471. Category: General
  4472. Address: 0xD25F50
  4473. Example: markerBrush "MarkerOne"
  4474. Arg1: name
  4475.  
  4476.  
  4477. Name: markerColor
  4478. Description: Gets the marker color. See <f>setMarkerColor</f>.
  4479. Note: this function is identical to <f>getMarkerColor</f>.
  4480. Category: General
  4481. Address: 0xD26030
  4482. Example: markerColor "MarkerOne"
  4483. Arg1: markerName
  4484.  
  4485.  
  4486. Name: markerDir
  4487. Description: Gets the marker direction. See <f>setMarkerDir</f>.
  4488. Category: General
  4489. Address: 0xD26130
  4490. Example: markerDir "MarkerOne"
  4491. Arg1: markerName
  4492.  
  4493.  
  4494. Name: markerPos
  4495. Description: Returns the marker positon in format [x,z,y].
  4496. Note: this function is identical to <f>getMarkerPos</f>.
  4497. Category: General
  4498. Address: 0xD26210
  4499. Example: markerPos "markerOne"
  4500. Arg1: markerName
  4501.  
  4502.  
  4503. Name: markerShape
  4504. Description: Gets the marker shape. See <f>setMarkerShape</f>.
  4505. Category: General
  4506. Address: 0xD26390
  4507. Example: markerShape "MarkerOne"
  4508. Arg1: name
  4509.  
  4510.  
  4511. Name: markerSize
  4512. Description: Gets the marker size. See <f>setMarkerSize</f>.
  4513. Note: this function is identical to <f>getMarkerSize</f>.
  4514. Category: General
  4515. Address: 0xD26480
  4516. Example: markerSize "MarkerOne"
  4517. Arg1: markerName
  4518.  
  4519.  
  4520. Name: markerText
  4521. Description: Gets the marker text. See <f>setMarkerText</f>.
  4522. Category: General
  4523. Address: 0xD265E0
  4524. Example: markerText "MarkerOne"
  4525. Arg1: markerName
  4526.  
  4527.  
  4528. Name: markerType
  4529. Description: Gets the type of the marker. See <f>setMarkerType</f>.
  4530. Note: this function is identical to <f>getMarkerType</f>.
  4531. Category: General
  4532. Address: 0xD266C0
  4533. Example: markerType "MarkerOne"
  4534. Arg1: markerName
  4535.  
  4536.  
  4537. Name: max
  4538. Description: Extend expression
  4539. Category: Simple expression
  4540. Address: 0x1238DE0
  4541. Arg1: expr
  4542. Arg2: val
  4543.  
  4544.  
  4545. Name: max
  4546. Description: Extend expression
  4547. Category: Simple expression
  4548. Address: 0x123AEC0
  4549. Arg1: val
  4550. Arg2: expr
  4551.  
  4552.  
  4553. Name: max
  4554. Description: Extend expression
  4555. Category: Simple expression
  4556. Address: 0x1238DB0
  4557. Arg1: expr1
  4558. Arg2: expr2
  4559.  
  4560.  
  4561. Name: max
  4562. Description: Extend expression
  4563. Category: Simple expression
  4564. Address: 0x1238DB0
  4565. Arg1: expr1
  4566. Arg2: expr2
  4567.  
  4568.  
  4569. Name: max
  4570. Description: Extend expression
  4571. Category: Simple expression
  4572. Address: 0x1238DE0
  4573. Arg1: expr
  4574. Arg2: val
  4575.  
  4576.  
  4577. Name: max
  4578. Description: Extend expression
  4579. Category: Simple expression
  4580. Address: 0x123AEC0
  4581. Arg1: val
  4582. Arg2: expr
  4583.  
  4584.  
  4585. Name: members
  4586. Description: Return a list of members in given team.
  4587. Category: Agents
  4588. Address: 0xD5E230
  4589. Example: _members = members _team
  4590. Arg1: team
  4591.  
  4592.  
  4593. Name: min
  4594. Description: Extend expression
  4595. Category: Simple expression
  4596. Address: 0x1238E10
  4597. Arg1: expr1
  4598. Arg2: expr2
  4599.  
  4600.  
  4601. Name: min
  4602. Description: Extend expression
  4603. Category: Simple expression
  4604. Address: 0x1238E10
  4605. Arg1: expr1
  4606. Arg2: expr2
  4607.  
  4608.  
  4609. Name: min
  4610. Description: Extend expression
  4611. Category: Simple expression
  4612. Address: 0x123AEF0
  4613. Arg1: val
  4614. Arg2: expr
  4615.  
  4616.  
  4617. Name: min
  4618. Description: Extend expression
  4619. Category: Simple expression
  4620. Address: 0x1238E40
  4621. Arg1: expr
  4622. Arg2: val
  4623.  
  4624.  
  4625. Name: min
  4626. Description: Extend expression
  4627. Category: Simple expression
  4628. Address: 0x123AEF0
  4629. Arg1: val
  4630. Arg2: expr
  4631.  
  4632.  
  4633. Name: min
  4634. Description: Extend expression
  4635. Category: Simple expression
  4636. Address: 0x1238E40
  4637. Arg1: expr
  4638. Arg2: val
  4639.  
  4640.  
  4641. Name: mineActive
  4642. Description: Checks whether the given mine is active
  4643. Category: General
  4644. Address: 0xD28090
  4645. Example: active mine
  4646. Arg1: obj
  4647.  
  4648.  
  4649. Name: missionConfigFile
  4650. Description: Return root of mission description.ext entries hierarchy.
  4651. Category: General
  4652. Address: 0xC946E0
  4653.  
  4654.  
  4655. Name: missionDifficulty
  4656. Description: Return difficulty that has been forced for this mission, returns -1 if difficulty is not forced and it's used one from player's options.
  4657. Category: General
  4658. Address: 0xCAA9D0
  4659. Example: difficulty
  4660.  
  4661.  
  4662. Name: missionName
  4663. Description: Returns the name of the current mission.
  4664. Category: General
  4665. Address: 0xD28A20
  4666.  
  4667.  
  4668. Name: missionNamespace
  4669. Description: Return the global namespace attached to mission.
  4670. Category: General
  4671. Address: 0xD29810
  4672.  
  4673.  
  4674. Name: missionStart
  4675. Description: Returns the time of the mission start in format [year, month, day, hour, minute, second].
  4676. Category: General
  4677. Address: 0xD28E80
  4678.  
  4679.  
  4680. Name: moonIntensity
  4681. Description: Returns moon light intensity.
  4682. Category: General
  4683. Address: 0xCAABD0
  4684.  
  4685.  
  4686. Name: morale
  4687. Description: Checks a current morale level of the unit (-1..+1).
  4688. Category: General
  4689. Address: 0xD3AD90
  4690. Example: morale leader player
  4691. Ex. Returns: 0.5
  4692. Arg1: unit
  4693.  
  4694.  
  4695. Name: moveOut
  4696. Description: Moves the soldier out of vehicle. (Immediately, without animation).
  4697. Category: General
  4698. Address: 0xD3BAF0
  4699. Arg1: soldier
  4700.  
  4701.  
  4702. Name: moveTime
  4703. Description: Returns the current time of the most important RTM animation currently being played on the soldier.
  4704. Category: General
  4705. Address: 0xD34940
  4706. Example: moveTime player
  4707. Arg1: soldier
  4708.  
  4709.  
  4710. Name: moveToCompleted
  4711. Description: Check if latest low level moveTo command is finished.
  4712. Category: General
  4713. Address: 0xC8FBA0
  4714. Arg1: person
  4715.  
  4716.  
  4717. Name: moveToFailed
  4718. Description: Check if latest low level moveTo command failed.
  4719. Category: General
  4720. Address: 0x11D62F0
  4721. Arg1: person
  4722.  
  4723.  
  4724. Name: musicVolume
  4725. Description: Checks the current music volume (set by <f>fadeMusic</f>).
  4726. Category: General
  4727. Address: 0xCAAC20
  4728.  
  4729.  
  4730. Name: name
  4731. Description: Returns the name of the variable assigned to the object in the mission editor. When used on a vehicle, the name of the first crew member is returned (in order: commander, driver, gunner).
  4732. Category: General
  4733. Address: 0xD3BB50
  4734. Example: name vehicle player
  4735. Arg1: object
  4736.  
  4737.  
  4738. Name: nameSound
  4739. Description: Returns the nameSound of the variable assigned to the object in the mission editor.
  4740. Category: General
  4741. Address: 0xD3BDD0
  4742. Example: nameSound player
  4743. Arg1: object
  4744.  
  4745.  
  4746. Name: nearestBuilding
  4747. Description: Returns the nearest building to the given object.
  4748. Category: General
  4749. Address: 0xD349A0
  4750. Example: neareastBuilding player
  4751. Arg1: obj
  4752.  
  4753.  
  4754. Name: nearestBuilding
  4755. Description: Returns the nearest building to the given position.
  4756. Category: General
  4757. Address: 0xD34A30
  4758. Example: neareastBuilding position player
  4759. Arg1: pos
  4760.  
  4761.  
  4762. Name: nearestObject
  4763. Description: Returns the nearest object of the given type to the given position or object.
  4764. Pos may be using format [x,y,z, "type"] or [object, "type"].
  4765. Category: General
  4766. Address: 0xCAC1C0
  4767. Example: nearestObject [player, "StreetLamp"]
  4768. Arg1: pos
  4769.  
  4770.  
  4771. Name: nearestObjects
  4772. Description: Returns a list of nearest objects of the given types to the given position or object, within the specified distance.
  4773. Pos may be using format [x,y,z, ["type",...], limit] or [object, ["type",...], limit].
  4774. Category: General
  4775. Address: 0xCAC6B0
  4776. Example: nearestObjects [player, ["Car","Tank"], 200]
  4777. Arg1: pos
  4778.  
  4779.  
  4780. Name: needReload
  4781. Description: Return how much vehicle wants to reload its weapons.
  4782. Category: General
  4783. Address: 0xD71190
  4784. Arg1: vehicle
  4785.  
  4786.  
  4787. Name: netId
  4788. Description: Unique ID of an object.
  4789. Category: General
  4790. Address: 0xCACEA0
  4791. Example: netId player
  4792. Ex. Returns: 1:8965
  4793. Arg1: object
  4794.  
  4795.  
  4796. Name: netId
  4797. Description: Unique ID of a group.
  4798. Category: General
  4799. Address: 0xCACE60
  4800. Example: netId (group player)
  4801. Ex. Returns: 1:5623
  4802. Arg1: group
  4803.  
  4804.  
  4805. Name: netObjNull
  4806. Description: A non-existing object. This value is not equal to anything, including itself.
  4807. Category: General
  4808. Address: 0xD299F0
  4809. Example: myNetObject == objNetNull
  4810. Ex. Returns: false
  4811.  
  4812.  
  4813. Name: nextWeatherChange
  4814. Description: Return the time (in seconds) when the next weather change will occur.
  4815. Category: General
  4816. Address: 0xCACFD0
  4817.  
  4818.  
  4819. Name: numberOfEnginesRTD
  4820. Description: Returns number of engines helicopter has.
  4821. Category: General
  4822. Address: 0xCAD020
  4823. Arg1: RTD_helicopter
  4824.  
  4825.  
  4826. Name: numberToDate
  4827. Description: Convert float number to date.
  4828. Category: General
  4829. Address: 0xD29B20
  4830. Example: date = NumberToDate [2008,0.5324]
  4831. Arg1: [year,time]
  4832.  
  4833.  
  4834. Name: objectCurators
  4835. Description: Returns array with all curators which can edit given object.
  4836. Category: General
  4837. Address: 0xCA64D0
  4838. Arg1: obj
  4839.  
  4840.  
  4841. Name: objectFromNetId
  4842. Description: Get object with given unique ID.
  4843. Category: General
  4844. Address: 0xCAD080
  4845. Example: objectFromNetId netId player
  4846. Ex. Returns: player
  4847. Arg1: id
  4848.  
  4849.  
  4850. Name: objNull
  4851. Description: A non-existing object. This value is not equal to anything, including itself.
  4852. Category: General
  4853. Address: 0xD3BF40
  4854. Example: player == objNull
  4855. Ex. Returns: false
  4856.  
  4857.  
  4858. Name: onBriefingGroup
  4859. Description: Defines a sound (voice) that is played the first time when the Group section in the briefing is selected.
  4860. Category: General
  4861. Address: 0xC90D60
  4862. Example: onBriefingGroup "GroupVoiceOver"
  4863. Arg1: sound
  4864.  
  4865.  
  4866. Name: onBriefingNotes
  4867. Description: Defines a sound (voice) that is played the first time when the Notes section in the briefing is selected.
  4868. Category: General
  4869. Address: 0xC90DE0
  4870. Example: onBriefingNotes "NotesVoiceOver"
  4871. Arg1: sound
  4872.  
  4873.  
  4874. Name: onBriefingPlan
  4875. Description: Defines a sound (voice) that is played the first time when the Plan section in the briefing is selected.
  4876. Category: General
  4877. Address: 0xC90E60
  4878. Example: onBriefingPlan "PlanVoiceOver"
  4879. Arg1: sound
  4880.  
  4881.  
  4882. Name: onBriefingTeamSwitch
  4883. Description: Defines a sound (voice) that is played the first time when the Team switch section in the briefing is selected.
  4884. Category: General
  4885. Address: 0xC90EE0
  4886. Example: onBriefingTeamSwitch "TeamSwitchVoiceOver"
  4887. Arg1: sound
  4888.  
  4889.  
  4890. Name: onCommandModeChanged
  4891. Description: Defines an action performed when command mode change. Command receives <br/>
  4892. _isHighCommand <t>bool</t>
  4893. Category: General
  4894. Address: 0xC93880
  4895. Arg1: command
  4896.  
  4897.  
  4898. Name: onEachFrame
  4899. Description: Defines an action performed on each frame (even when game is paused). Code is performed synchronously, cannot contain any sleep or wait.
  4900. Category: General
  4901. Address: 0xD51490
  4902. Example: onEachFrame {}
  4903. Arg1: command
  4904.  
  4905.  
  4906. Name: onGroupIconClick
  4907. Description: Defines an action performed when player clicked on group marker (3D or in a map)
  4908. Category: General
  4909. Address: 0xCB29A0
  4910. Arg1: command
  4911.  
  4912.  
  4913. Name: onGroupIconOverEnter
  4914. Description: Defines an action performed when player clicked on group marker (3D or in a map)
  4915. Category: General
  4916. Address: 0xCB29C0
  4917. Arg1: command
  4918.  
  4919.  
  4920. Name: onGroupIconOverLeave
  4921. Description: Defines an action performed when player clicked on group marker (3D or in a map)
  4922. Category: General
  4923. Address: 0xCB29E0
  4924. Arg1: command
  4925.  
  4926.  
  4927. Name: onHCGroupSelectionChanged
  4928. Description: Defines an action performed when HC group has been selected. Command receives <br/>
  4929. _group <t>group</t> selected group <br/>
  4930. _isSelected <t>bool</t> new selection state
  4931. Category: General
  4932. Address: 0xCB53A0
  4933. Arg1: command
  4934.  
  4935.  
  4936. Name: onMapSingleClick
  4937. Description: Defines an action performed when the user clicks on the map. Command receives:<br/>
  4938. <br/>
  4939. _pos <t>array</t> position<br/>
  4940. _units <t>array</t> selected units<br/>
  4941. _shift,_alt <t>bool</t> key state<br/>
  4942. <br/>If the click is processed, command should return true.
  4943. Category: General
  4944. Address: 0xD25350
  4945. Example: onMapSingleClick """SoldierEG"" createUnit [_pos, group player]"
  4946. Arg1: command
  4947.  
  4948.  
  4949. Name: onPlayerConnected
  4950. Description: This statement is launched whenever a player is connected to a MP session. Variables _id, _name and _uid are set. See also getPlayerUID, kickUID, banUID.
  4951. Category: General
  4952. Address: 0xD29AA0
  4953. Arg1: statement
  4954.  
  4955.  
  4956. Name: onPlayerDisconnected
  4957. Description: This statement is launched whenever a player is disconnected from a MP session. Variables _id, _name and _uid are set.
  4958. Category: General
  4959. Address: 0xD29AC0
  4960. Arg1: statement
  4961.  
  4962.  
  4963. Name: onPreloadFinished
  4964. Description: Defines an action performed after the preload screen finished.
  4965. Category: General
  4966. Address: 0xD45D40
  4967. Arg1: command
  4968.  
  4969.  
  4970. Name: onPreloadStarted
  4971. Description: Defines an action performed just before the preload screen started.
  4972. Category: General
  4973. Address: 0xD45D60
  4974. Arg1: command
  4975.  
  4976.  
  4977. Name: onTeamSwitch
  4978. Description: Defines an action performed when the team switch is finished. Command receives:<br/>
  4979. <br/>
  4980. _from <t>object</t> previous unit<br/>
  4981. _to <t>object</t> current units<br/>
  4982. <br/>
  4983. Category: General
  4984. Address: 0xD45D80
  4985. Arg1: command
  4986.  
  4987.  
  4988. Name: openCuratorInterface
  4989. Description: Force opens curator interface.
  4990. Category: General
  4991. Address: 0xD45DC0
  4992.  
  4993.  
  4994. Name: openDlcPage
  4995. Description: Opens a Steam page of the app with given appId. Only works for known appId (game + linked DLCs)
  4996. Category: General
  4997. Address: 0xD45E80
  4998. Example: openDlcPage 288520
  4999. Arg1: appId
  5000.  
  5001.  
  5002. Name: openMap
  5003. Description: Show player's map. If forced, cannot be closed.
  5004. Category: General
  5005. Address: 0xD45F50
  5006. Example: openMap true
  5007. Arg1: show
  5008.  
  5009.  
  5010. Name: openMap
  5011. Description: Show player's map. If forced, cannot be closed.
  5012. Category: General
  5013. Address: 0xD45F50
  5014. Example: openMap [true,true]
  5015. Arg1: [show, forced]
  5016.  
  5017.  
  5018. Name: openYoutubeVideo
  5019. Description: Opens Steam overlay with the given YT video. The YT url is the end of the video page url. Example: for 'https://www.youtube.com/watch?v=DXIoEUq8YE8' set youTubeUrl to 'watch?v=DXIoEUq8YE8'
  5020. Category: General
  5021. Address: 0xD46110
  5022. Arg1: youTubeUrl
  5023.  
  5024.  
  5025. Name: opfor
  5026. Description: Pre-defined variable for the opfor side.
  5027. Category: General
  5028. Address: 0xD578B0
  5029.  
  5030.  
  5031. Name: overcast
  5032. Description: Return the current overcast.
  5033. Category: General
  5034. Address: 0xCAD2B0
  5035.  
  5036.  
  5037. Name: overcastForecast
  5038. Description: Return the overcast forecast.
  5039. Category: General
  5040. Address: 0xCAD2E0
  5041.  
  5042.  
  5043. Name: owner
  5044. Description: On server machine, return the ID of the client where the object is local. Otherwise return 0.
  5045. Category: General
  5046. Address: 0xD35280
  5047. Arg1: object
  5048.  
  5049.  
  5050. Name: parseText
  5051. Description: Creates a structured text by parsing the given XML description.
  5052. Category: General
  5053. Address: 0xD61060
  5054. Example: txt = parseText "First line&lt;img image=data\isniper.paa/&gt;&ltbr/&gt;Second line"
  5055. Arg1: text
  5056.  
  5057.  
  5058. Name: parsingNamespace
  5059. Description: Return the global namespace attached to config parser.
  5060. Category: General
  5061. Address: 0xD29830
  5062.  
  5063.  
  5064. Name: particlesQuality
  5065. Description: Return current settings for particles quality.
  5066. Category: General
  5067. Address: 0xCAD310
  5068.  
  5069.  
  5070. Name: pickWeaponPool
  5071. Description: Transfers weapons and magazines from the cargo space of object obj to the weapon pool (used in campaigns to transfer weapons to the next mission).
  5072. Category: General
  5073. Address: 0xF934D0
  5074. Arg1: obj
  5075.  
  5076.  
  5077. Name: pitch
  5078. Description: Returns the pitch of the variable assigned to the object in the mission editor.
  5079. Category: General
  5080. Address: 0xD3BF80
  5081. Example: pitch player
  5082. Arg1: object
  5083.  
  5084.  
  5085. Name: playableSlotsNumber
  5086. Description: Returns the number of available slots in mission per side (both empty and taken). In singleplayer mission, it returns number of playable units per side.
  5087. Category: General
  5088. Address: 0xD46E20
  5089. Arg1: side
  5090.  
  5091.  
  5092. Name: playableUnits
  5093. Description: Return a list of playable units (occupied by both AI or players).
  5094. Category: General
  5095. Address: 0xCAD4E0
  5096.  
  5097.  
  5098. Name: player
  5099. Description: This is the person controlled by the player. In MP this value is different on each computer.
  5100. Category: General
  5101. Address: 0xD46E90
  5102. Example: alive player
  5103.  
  5104.  
  5105. Name: playerRespawnTime
  5106. Description: Return the player remaining time to respawn.
  5107. Category: General
  5108. Address: 0xCAD740
  5109.  
  5110.  
  5111. Name: playerSide
  5112. Description: Returns the player's side. This is valid even when the player controlled person is dead (a difference from player side).
  5113. Category: General
  5114. Address: 0xD46EE0
  5115.  
  5116.  
  5117. Name: playersNumber
  5118. Description: Returns the number of players playing on the given side.
  5119. Category: General
  5120. Address: 0xD46F30
  5121. Arg1: side
  5122.  
  5123.  
  5124. Name: playMission
  5125. Description: The mission is launched (from the main menu). Both campaign and mission are given as their directory name. If the campaign is empty, a single mission is launched. If skipBriefing is true, the intro and briefing are skipped.
  5126. Category: General
  5127. Address: 0xD28A50
  5128. Example: playMission["XOutrage","x05Negotiator.Noe"]
  5129. Arg1: [campaign, mission] or [campaign, mission, skipBriefing]
  5130.  
  5131.  
  5132. Name: playMusic
  5133. Description: Plays music defined in the description.ext file.
  5134. Category: General
  5135. Address: 0xD46470
  5136. Example: playMusic "musicname"
  5137. Arg1: name
  5138.  
  5139.  
  5140. Name: playMusic
  5141. Description: Plays music defined in the description.ext file. The format of nameAndPos is [name,position]. Position is in seconds.
  5142. Category: General
  5143. Address: 0xD46470
  5144. Example: playMusic ["Track13", 30]
  5145. Arg1: nameAndPos
  5146.  
  5147.  
  5148. Name: playScriptedMission
  5149. Description: Load the given world, launch an empty mission and execute the given expression. Config (optional) can reference to the config entry replacing description.ext for this mission.
  5150. Category: General
  5151. Address: 0xD4D320
  5152. Arg1: [world, expression, config, (ignoreChildWindow)]
  5153.  
  5154.  
  5155. Name: playSound
  5156. Description: Plays a sound defined in the description.ext file.
  5157. Category: General
  5158. Address: 0xD46B90
  5159. Example: playSound "soundname"
  5160. Arg1: name
  5161.  
  5162.  
  5163. Name: playSound
  5164. Description: Plays a sound defined in the description.ext file. Accomodation set to false disable sound volume changes.
  5165. Category: General
  5166. Address: 0xD46B90
  5167. Example: playSound ["soundname", false]
  5168. Arg1: name, enable / disable sound volume accomodation
  5169.  
  5170.  
  5171. Name: playSound3D
  5172. Description: Plays a sound with given filename. Position of the source object in world coordinates. Distance is how far is sound audible (0 = no max distance). At least 2 parameters must be added.
  5173. Category: General
  5174. Address: 0xD467C0
  5175. Example: playSound3D ["A3\Sounds_F\sfx\blip1.wav", player] or playSound3D ["A3\Sounds_F\sfx\blip1.wav", player, false, getPos player, 1, 1, 0]
  5176. Arg1: ["filename", source, isInside, position, volume, frequency, distance]
  5177.  
  5178.  
  5179. Name: position
  5180. Description: Returns the object position in format <ar>Position</ar>.
  5181. Category: General
  5182. Address: 0xD35360
  5183. Example: position player
  5184. Arg1: object
  5185.  
  5186.  
  5187. Name: positionCameraToWorld
  5188. Description: Transform position from camera coordinate space to world coordinate space.
  5189. Category: General
  5190. Address: 0xD46F90
  5191. Example: _worldPos = positionCameraToWorld _cameraPos
  5192. Arg1: position
  5193.  
  5194.  
  5195. Name: precision
  5196. Description: Return the precision of the given entity.
  5197. Category: General
  5198. Address: 0xD35BA0
  5199. Arg1: entity
  5200.  
  5201.  
  5202. Name: preloadCamera
  5203. Description: Preload all textures and models around given position
  5204. Category: General
  5205. Address: 0xC91FB0
  5206. Arg1: position
  5207.  
  5208.  
  5209. Name: preloadSound
  5210. Description: Make sure sound can start playing without any delay once we need it.
  5211. Category: General
  5212. Address: 0xD58BD0
  5213. Arg1: sound
  5214.  
  5215.  
  5216. Name: preloadTitleObj
  5217. Description: Object title - argument uses format ["text","type",speed, showInMap] or ["name","type"]. Speed is ignored.
  5218. Preload data
  5219. The object can be defined in the description.ext file.
  5220. Category: General
  5221. Address: 0xC9F240
  5222. Example: titleObj ["BISLogo","plain"]
  5223. Arg1: effect
  5224.  
  5225.  
  5226. Name: preloadTitleRsc
  5227. Description: Resource title - argument uses format ["name","type",speed, showInMap] or ["name","type"]. Speed is ignored.
  5228. Preload data
  5229. The resource can be defined in the description.ext file.
  5230. Category: General
  5231. Address: 0xC9F430
  5232. Example: titleRsc ["BIS", "PLAIN"]
  5233. Arg1: effect
  5234.  
  5235.  
  5236. Name: preprocessFile
  5237. Description: Returns the preprocessed content of the given file. The preprocessor is C-like, it supports comments using // or /* and */ and macros defined with #define. On dedicated server/client connected to a dedicated server, if allowedPreprocessFileExtensions parameter is used in the DS config file this only returns contents of a given file if the file extension is listed in it. The list should containt at least the following extensions: hpp, sqs, sqf, fsm, cpp, paa, txt, xml, inc, ext, sqm, ods, fxy, lip, csv, kb, bik, bikn, html, biedi. Note, this list may not be completely up to date
  5238. Category: General
  5239. Address: 0xD59AE0
  5240. Example: preprocessFile "myFunction.sqf"
  5241. Ex. Returns: "if a>b then {a} else {b}"
  5242. Arg1: filename
  5243.  
  5244.  
  5245. Name: preprocessFileLineNumbers
  5246. Description: Returns the preprocessed contents of a given file. The preprocessor is C-like, it supports comments using // or /* and */ and macros defined with #define. On dedicated server/client connected to a dedicated server, if allowedPreprocessFileExtensions parameter is used in the DS config file this only returns contents of a given file if the file extension is listed in it. The list should containt at least the following extensions: hpp, sqs, sqf, fsm, cpp, paa, txt, xml, inc, ext, sqm, ods, fxy, lip, csv, kb, bik, bikn, html, biedi. Note, this list may not be completely up to date.
  5247. Category: General
  5248. Address: 0xD59E60
  5249. Example: preprocessFileLineNumbers "myFunction.sqf"
  5250. Ex. Returns: "if a>b then {a} else {b}"
  5251. Arg1: filename
  5252.  
  5253.  
  5254. Name: primaryWeapon
  5255. Description: Returns the name of the vehicle's primary weapon (an empty string if there is none).
  5256. Category: General
  5257. Address: 0xD35C00
  5258. Example: primaryWeapon player
  5259. Arg1: vehicle
  5260.  
  5261.  
  5262. Name: primaryWeaponItems
  5263. Description: Get array with all items assigned to a weapon.
  5264. Category: General
  5265. Address: 0xD3C5B0
  5266. Arg1: unit
  5267.  
  5268.  
  5269. Name: primaryWeaponMagazine
  5270. Description: Return the names of the types of currently loaded magazines in given weapon.
  5271. Category: General
  5272. Address: 0xD71170
  5273. Arg1: vehicle
  5274.  
  5275.  
  5276. Name: productVersion
  5277. Description: Return the product name and version, in form ["product name","product short name",version*100,build]
  5278. Category: General
  5279. Address: 0xCAD9D0
  5280. Example: productVersion
  5281. Ex. Returns: ["ArmA 2 OA","ArmA2OA",160,87840]
  5282.  
  5283.  
  5284. Name: profileName
  5285. Description: Return profile name.
  5286. Category: General
  5287. Address: 0xCADB80
  5288.  
  5289.  
  5290. Name: profileNamespace
  5291. Description: Return the global namespace attached to user profile.
  5292. Category: General
  5293. Address: 0xD29850
  5294.  
  5295.  
  5296. Name: progressLoadingScreen
  5297. Description: If loading screen is show, set progress bar to the given value (from interval [0, 1])
  5298. Category: General
  5299. Address: 0xD24330
  5300. Arg1: progress
  5301.  
  5302.  
  5303. Name: progressPosition
  5304. Description: Returns the current position in the progress bar.
  5305. Category: General
  5306. Address: 0xD6AB90
  5307. Example: _pos = progressPosition _control
  5308. Arg1: control
  5309.  
  5310.  
  5311. Name: publicVariable
  5312. Description: Broadcasts the variable value to all computers.
  5313. Only type <t>Number</t> is supported in versions 1.33 and before.
  5314. The following types are supported since 1.34:
  5315. <t>Number</t>, <t>Boolean</t>, <t>Object</t> and <t>Group</t>.
  5316. Category: General
  5317. Address: 0xD48E00
  5318. Example: publicVariable "CTFscoreOne"
  5319. Arg1: varName
  5320.  
  5321.  
  5322. Name: publicVariableServer
  5323. Description: Send the variable value to the server computer.
  5324. Only type <t>Number</t> is supported in versions 1.33 and before.
  5325. The following types are supported since 1.34:
  5326. <t>Number</t>, <t>Boolean</t>, <t>Object</t> and <t>Group</t>.
  5327. Category: General
  5328. Address: 0xD48ED0
  5329. Example: publicVariableServer "CTFscoreOne"
  5330. Arg1: varName
  5331.  
  5332.  
  5333. Name: putWeaponPool
  5334. Description: Transfers weapons and magazines from the weapon pool (used in campaigns to transfer weapons to the next mission) into the cargo space of object obj.
  5335. Category: General
  5336. Address: 0xF931F0
  5337. Arg1: obj
  5338.  
  5339.  
  5340. Name: queryItemsPool
  5341. Description: Returns the number of items of type name in the weapon pool (used in campaigns to transfer weapons to the next mission).
  5342. Category: General
  5343. Address: 0xF93260
  5344. Arg1: name
  5345.  
  5346.  
  5347. Name: queryMagazinePool
  5348. Description: Returns the number of magazines of type name in the weapon pool (used in campaigns to transfer weapons to the next mission).
  5349. Category: General
  5350. Address: 0xF93330
  5351. Arg1: name
  5352.  
  5353.  
  5354. Name: queryWeaponPool
  5355. Description: Returns the number of weapons of type name in the weapon pool (used in campaigns to transfer weapons to the next mission).
  5356. Category: General
  5357. Address: 0xF93400
  5358. Arg1: name
  5359.  
  5360.  
  5361. Name: radioChannelCreate
  5362. Description: Create Custom Radio Channel with given callSign color, callSign format and units. sentenceColorType sets color for sentences - true for colorMessageProtocol otherwise colorMessage. Returns index to identify/manipulate the created Custom Channel.
  5363. Category: General
  5364. Address: 0xC96100
  5365. Arg1: [[r,g,b,a], label, callSign, [unit1,unit2,...], sentenceColorType]
  5366.  
  5367.  
  5368. Name: radioVolume
  5369. Description: Checks the current radio volume (set by <f>setRadioVolume</f>).
  5370. Category: General
  5371. Address: 0xCADBB0
  5372.  
  5373.  
  5374. Name: rain
  5375. Description: Return the current rain.
  5376. Category: General
  5377. Address: 0xCADBD0
  5378.  
  5379.  
  5380. Name: rainbow
  5381. Description: Return the current rainbow intensity.
  5382. Category: General
  5383. Address: 0xCADBF0
  5384.  
  5385.  
  5386. Name: randomGen
  5387. Description: Create expression which will generate random number from interval &lt;0, multiplier)
  5388. Category: Simple expression
  5389. Address: 0x1238FF0
  5390. Example: randomGen daylight
  5391. Arg1: multiplier
  5392.  
  5393.  
  5394. Name: randomGen
  5395. Description: Create expression which will generate random number from interval &lt;0, multiplier)
  5396. Category: Simple expression
  5397. Address: 0x123AF50
  5398. Example: randomGen 5
  5399. Arg1: multiplier
  5400.  
  5401.  
  5402. Name: rank
  5403. Description: Return the rank of the given unit.
  5404. Category: General
  5405. Address: 0xD6D160
  5406. Arg1: unit
  5407.  
  5408.  
  5409. Name: rankId
  5410. Description: Return the rank of the given unit for comparison.
  5411. Category: General
  5412. Address: 0xD6D1E0
  5413. Arg1: unit
  5414.  
  5415.  
  5416. Name: rating
  5417. Description: Checks the unit rating. This rating is increased for killing enemies, decreased for killing friendlies and can be changed by a mission designer.
  5418. Category: General
  5419. Address: 0xD301D0
  5420. Example: rating player
  5421. Arg1: unit
  5422.  
  5423.  
  5424. Name: reload
  5425. Description: Reload all weapons.
  5426. Category: General
  5427. Address: 0xD72350
  5428. Arg1: vehicle
  5429.  
  5430.  
  5431. Name: reloadEnabled
  5432. Description: Check whether magazine is reloaded whenever emptied.
  5433. Category: General
  5434. Address: 0xD71730
  5435. Arg1: vehicle
  5436.  
  5437.  
  5438. Name: removeAllActions
  5439. Description: Removes the action with the given id.
  5440. Category: General
  5441. Address: 0xD3CA00
  5442. Example: removeAllActions player
  5443. Arg1: unit
  5444.  
  5445.  
  5446. Name: removeAllAssignedItems
  5447. Description: Removes all linked items from gear (map, compass, headgear, goggles etc.).
  5448. Category: General
  5449. Address: 0xD49C10
  5450. Arg1: unit
  5451.  
  5452.  
  5453. Name: removeAllContainers
  5454. Description: Removes all containers from the unit.
  5455. Category: General
  5456. Address: 0xD3C6F0
  5457. Example: removeAllContainers player
  5458. Arg1: unit
  5459.  
  5460.  
  5461. Name: removeAllCuratorAddons
  5462. Description: Restrict access to all addons for given curator.
  5463. Category: General
  5464. Address: 0xD49CE0
  5465. Arg1: curatorObj
  5466.  
  5467.  
  5468. Name: removeAllCuratorCameraAreas
  5469. Description: Delete all curator camera areas.
  5470. Category: General
  5471. Address: 0xD49E00
  5472. Arg1: curatorObj
  5473.  
  5474.  
  5475. Name: removeAllCuratorEditingAreas
  5476. Description: Delete all curator edit areas.
  5477. Category: General
  5478. Address: 0xD49EB0
  5479. Arg1: curatorObj
  5480.  
  5481.  
  5482. Name: removeAllHandgunItems
  5483. Description: Removes all items from weapon except magazine.
  5484. Category: General
  5485. Address: 0xD3C7A0
  5486. Arg1: unit
  5487.  
  5488.  
  5489. Name: removeAllItems
  5490. Description: Removes all items from the uniform, vest and backpack.
  5491. Category: General
  5492. Address: 0xD3C8A0
  5493. Arg1: unit
  5494.  
  5495.  
  5496. Name: removeAllItemsWithMagazines
  5497. Description: Removes all items from the uniform, vest and backpack.
  5498. Category: General
  5499. Address: 0xD3C7C0
  5500. Arg1: unit
  5501.  
  5502.  
  5503. Name: removeAllMissionEventHandlers
  5504. Description: Removes all event handlers of the given type which were added by <f>addMissionEventHandler</f>.
  5505. Category: General
  5506. Address: 0xD28D60
  5507. Example: removeAllMissionEventHandlers "ended"
  5508. Arg1: type
  5509.  
  5510.  
  5511. Name: removeAllMusicEventHandlers
  5512. Description: Remove all music track event handlers.
  5513. Category: General
  5514. Address: 0xD296A0
  5515. Example: removeAllMusicEventHandlers "MusicStart"
  5516. Arg1: type
  5517.  
  5518.  
  5519. Name: removeAllPrimaryWeaponItems
  5520. Description: Removes all items from weapon except magazine.
  5521. Category: General
  5522. Address: 0xD3C9E0
  5523. Arg1: unit
  5524.  
  5525.  
  5526. Name: removeAllWeapons
  5527. Description: Removes all weapons from the unit.
  5528. Category: General
  5529. Address: 0xD3CA40
  5530. Example: removeAllWeapons player
  5531. Arg1: unit
  5532.  
  5533.  
  5534. Name: removeBackpack
  5535. Description: Remove backpack from unit.
  5536. Category: General
  5537. Address: 0xD49FD0
  5538. Example: removeBackpack player
  5539. Arg1: unit
  5540.  
  5541.  
  5542. Name: removeBackpackGlobal
  5543. Description: Remove backpack from unit(even non-local).
  5544. Category: General
  5545. Address: 0xD4A040
  5546. Example: removeBackpackGlobal player
  5547. Arg1: unit
  5548.  
  5549.  
  5550. Name: removeFromRemainsCollector
  5551. Description: Removes flag from given objects to be managed by unitRemove manager
  5552. Category: General
  5553. Address: 0xD4A780
  5554. Example: removeFromRemainsCollector [unit1, unit2]
  5555. Arg1: array
  5556.  
  5557.  
  5558. Name: removeGoggles
  5559. Description: Remove goggles from unit.
  5560. Category: General
  5561. Address: 0xD4A830
  5562. Example: removeBackpack player
  5563. Arg1: unit
  5564.  
  5565.  
  5566. Name: removeHeadgear
  5567. Description: Remove headgear from unit.
  5568. Category: General
  5569. Address: 0xD4A8F0
  5570. Example: removeBackpack player
  5571. Arg1: unit
  5572.  
  5573.  
  5574. Name: removeMissionEventHandler
  5575. Description: Removes event handler added by <f>addMissionEventHandler</f>. Id is returned by addMissionEventHandler. When any handler is removed, all handler indices higher that the deleted one should be decremented.
  5576. Category: General
  5577. Address: 0xD28DA0
  5578. Example: removeMissionEventHandler ["ended",0]
  5579. Arg1: [type, id]
  5580.  
  5581.  
  5582. Name: removeMusicEventHandler
  5583. Description: Remove specified music track event handler.
  5584. Category: General
  5585. Address: 0xD296E0
  5586. Example: removeMusicEventHandler ["MusicTerminate", "1"]
  5587. Arg1: [type, id]
  5588.  
  5589.  
  5590. Name: removeSwitchableUnit
  5591. Description: Remove a unit from the list of units available for team switch.
  5592. Category: General
  5593. Address: 0xD4AA80
  5594. Arg1: person
  5595.  
  5596.  
  5597. Name: removeUniform
  5598. Description: Remove uniform from unit.
  5599. Category: General
  5600. Address: 0xD4AB80
  5601. Example: removeBackpack player
  5602. Arg1: unit
  5603.  
  5604.  
  5605. Name: removeVest
  5606. Description: Remove vest from unit.
  5607. Category: General
  5608. Address: 0xD4ACB0
  5609. Example: removeBackpack player
  5610. Arg1: unit
  5611.  
  5612.  
  5613. Name: requiredVersion
  5614. Description: Checks whether the appropriate version of the application is available. If it's not, a warning message is shown and false is returned. The version format is "Major.Minor", e.g. "1.30".
  5615. Category: General
  5616. Address: 0xD4ACD0
  5617. Example: requiredVersion "1.30"
  5618. Arg1: version
  5619.  
  5620.  
  5621. Name: resetCamShake
  5622. Description: Resets all camera shakes.
  5623. Category: General
  5624. Address: 0xD4AE00
  5625.  
  5626.  
  5627. Name: resetSubgroupDirection
  5628. Description: Reset direction of subgroup.
  5629. Category: General
  5630. Address: 0xD4AE60
  5631. Example: resetSubgroupDirection unit
  5632. Arg1: subgroup member
  5633.  
  5634.  
  5635. Name: resistance
  5636. Description: The Resistance side.
  5637. Category: General
  5638. Address: 0xD57790
  5639.  
  5640.  
  5641. Name: resources
  5642. Description: Return a list of the resources belonging to a team.
  5643. Category: Agents
  5644. Address: 0xD5E430
  5645. Arg1: teamMember
  5646.  
  5647.  
  5648. Name: reversedMouseY
  5649. Description: Return if mouse vertical axe is inverted.
  5650. Category: General
  5651. Address: 0xD4B390
  5652.  
  5653.  
  5654. Name: roadsConnectedTo
  5655. Description: Find the road segments connected to the given road segment.
  5656. Category: General
  5657. Address: 0xCA43C0
  5658. Arg1: road segment
  5659.  
  5660.  
  5661. Name: ropeAttachedObjects
  5662. Description: Returns list of attached objects on ropes
  5663. Category: General
  5664. Address: 0xD4B690
  5665. Example: ropeAttachedObjects obj
  5666. Arg1: vehicle
  5667.  
  5668.  
  5669. Name: ropeAttachedTo
  5670. Description: Returns the object it is attached to by rope
  5671. Category: General
  5672. Address: 0xD4B890
  5673. Example: ropeAttachedTo obj
  5674. Arg1: vehicle
  5675.  
  5676.  
  5677. Name: ropeAttachEnabled
  5678. Description: Check if the vehicle can be attached to ropes
  5679. Category: General
  5680. Address: 0xD4B3B0
  5681. Arg1: vehicle
  5682.  
  5683.  
  5684. Name: ropeCreate
  5685. Description: Create instance of rope object attached on vehicle
  5686. Category: General
  5687. Address: 0xD4B970
  5688. Example: ropeCreate [veh1, [0,0,-2], veh2, [0,0,0], 10] or ropeCreate [veh1, [0,0,-2], 10] or ropeCreate [veh1, [0,0,-2], veh2, [0,0,0], 10, [], ["ropeend", [0,0,-1]]]
  5689. Arg1: [fromObject, fromPoint, toObject, toPoint, (length), ([ropeStart, downDir]), ([ropeEnd, downDir])]
  5690.  
  5691.  
  5692. Name: ropeCut
  5693. Description: Cut rope and detach rope from vehicle
  5694. Category: General
  5695. Address: 0xD4C3B0
  5696. Example: ropeCut [rope, 5]
  5697. Arg1: [rope, distance]
  5698.  
  5699.  
  5700. Name: ropeDestroy
  5701. Description: Destroy rope and detach rope from vehicle
  5702. Category: General
  5703. Address: 0xD4C470
  5704. Example: ropeDestroy rope
  5705. Arg1: rope
  5706.  
  5707.  
  5708. Name: ropeEndPosition
  5709. Description: Return rope end positions
  5710. Category: General
  5711. Address: 0xD4C560
  5712. Example: [start position, end position] ropeEndPosition ropeObj
  5713. Arg1: rope
  5714.  
  5715.  
  5716. Name: ropeLength
  5717. Description: Return rope length (set by ropeCreate, ropeCut, ropeUnwind)
  5718. Category: General
  5719. Address: 0xCADFC0
  5720. Example: ropeLength rope
  5721. Arg1: rope
  5722.  
  5723.  
  5724. Name: ropes
  5725. Description: Return vehicle ropes
  5726. Category: General
  5727. Address: 0xD4C8E0
  5728. Example: ropes vehicle player
  5729. Arg1: vehicle
  5730.  
  5731.  
  5732. Name: ropeUnwind
  5733. Description: Unwind rope to target length. Use relative parameter for change rope length +/- from current length
  5734. Category: General
  5735. Address: 0xD4C7A0
  5736. Example: ropeUnwind [rope, 3, 10]
  5737. Arg1: [rope, speed, targetLength, (relative)]
  5738.  
  5739.  
  5740. Name: ropeUnwound
  5741. Description: False if unwiding in progress, otherwise true
  5742. Category: General
  5743. Address: 0xD4C730
  5744. Example: ropeUnwound rope
  5745. Arg1: rope
  5746.  
  5747.  
  5748. Name: rotorsForcesRTD
  5749. Description: Returns force produced by rotors.
  5750. Category: General
  5751. Address: 0xCAE0D0
  5752. Arg1: RTD_helicopter
  5753.  
  5754.  
  5755. Name: rotorsRpmRTD
  5756. Description: Returns rotors RPM.
  5757. Category: General
  5758. Address: 0xCAE490
  5759. Arg1: RTD_helicopter
  5760.  
  5761.  
  5762. Name: runInitScript
  5763. Description: Launch init.sqs script.
  5764. Category: General
  5765. Address: 0xD28E60
  5766.  
  5767.  
  5768. Name: safeZoneH
  5769. Category: General
  5770. Address: 0xD4CA80
  5771.  
  5772.  
  5773. Name: safeZoneW
  5774. Category: General
  5775. Address: 0xD4CAC0
  5776.  
  5777.  
  5778. Name: safeZoneWAbs
  5779. Category: General
  5780. Address: 0xD4CB00
  5781.  
  5782.  
  5783. Name: safeZoneX
  5784. Category: General
  5785. Address: 0xD4CB40
  5786.  
  5787.  
  5788. Name: safeZoneXAbs
  5789. Category: General
  5790. Address: 0xD4CB80
  5791.  
  5792.  
  5793. Name: safeZoneY
  5794. Category: General
  5795. Address: 0xD4CBC0
  5796.  
  5797.  
  5798. Name: saveGame
  5799. Description: Creates an autosave game (used for Retry).
  5800. Category: General
  5801. Address: 0xD4CC00
  5802.  
  5803.  
  5804. Name: saveJoysticks
  5805. Description: Saves joysticks key mappings into the joysticks.cfg file. Engine add these joysticks to the Joystick Scheme mapping dialog in options controls section.
  5806. Category: General
  5807. Address: 0xD4CC40
  5808.  
  5809.  
  5810. Name: saveProfileNamespace
  5811. Description: Saves the variables stored in profileNamespace to user profile.
  5812. Category: General
  5813. Address: 0xD4CCA0
  5814.  
  5815.  
  5816. Name: saveVar
  5817. Description: Saves the variable value into the global campaign space. The variable is then available to all following missions in the campaign.
  5818. Category: General
  5819. Address: 0xD4CD40
  5820. Example: saveVar "varOne"
  5821. Arg1: varName
  5822.  
  5823.  
  5824. Name: savingEnabled
  5825. Description: Check if saving the game is enabled.
  5826. Category: General
  5827. Address: 0xCB8900
  5828.  
  5829.  
  5830. Name: score
  5831. Description: MP: returns the unit's score.
  5832. Category: General
  5833. Address: 0xD35DB0
  5834. Example: score unitOne
  5835. Arg1: unit
  5836.  
  5837.  
  5838. Name: scoreSide
  5839. Description: MP: returns side score.
  5840. Category: General
  5841. Address: 0xD57740
  5842. Example: score west
  5843. Arg1: side
  5844.  
  5845.  
  5846. Name: screenToWorld
  5847. Description: Returns the position on landscape (in world coordinates) corresponding to the given point on screen (in UI coordinates).
  5848. Category: General
  5849. Address: 0xD4CE00
  5850. Arg1: position
  5851.  
  5852.  
  5853. Name: scriptDone
  5854. Description: Check if script is already finished
  5855. Category: General
  5856. Address: 0xD4D030
  5857. Arg1: script
  5858.  
  5859.  
  5860. Name: scriptNull
  5861. Description: A non-existing script. This value is not equal to anything, including itself.
  5862. Category: General
  5863. Address: 0xD4D170
  5864. Example: script == scriptNull
  5865. Ex. Returns: false
  5866.  
  5867.  
  5868. Name: scudState
  5869. Description: Returns the current state of the given scud launcher. The following states are recognized: 0 - No activity, 1 - Launch preparation, 2 - Launch prepared, 3 - Ignition and 4 - Launched. Note: non-integral values are used to indicate a transition between states.
  5870. Category: General
  5871. Address: 0xD35F50
  5872. Example: scudState scudOne>=4
  5873. Arg1: scud
  5874.  
  5875.  
  5876. Name: secondaryWeapon
  5877. Description: Returns the name of a vehicle's secondary weapon (an empty string if there is none).
  5878. Category: General
  5879. Address: 0xD35FB0
  5880. Example: secondaryWeapon player
  5881. Arg1: vehicle
  5882.  
  5883.  
  5884. Name: secondaryWeaponItems
  5885. Description: Get array with all items assigned to a weapon.
  5886. Category: General
  5887. Address: 0xD3F0C0
  5888. Arg1: unit
  5889.  
  5890.  
  5891. Name: secondaryWeaponMagazine
  5892. Description: Return the names of the types of currently loaded magazines in given weapon.
  5893. Category: General
  5894. Address: 0xD711F0
  5895. Arg1: vehicle
  5896.  
  5897.  
  5898. Name: selectBestPlaces
  5899. Description: Find the places with the max. value of _expression in the given area.
  5900. Category: General
  5901. Address: 0xC901D0
  5902. Arg1: [_position, _radius, _expression, _precision, _sourcesCount]
  5903.  
  5904.  
  5905. Name: selectNoPlayer
  5906. Description: Switch player to no unit.
  5907. Category: General
  5908. Address: 0xD4D450
  5909.  
  5910.  
  5911. Name: selectPlayer
  5912. Description: Switch player to given unit.
  5913. Category: General
  5914. Address: 0xD4D4A0
  5915. Example: selectPlayer aP
  5916. Arg1: unit
  5917.  
  5918.  
  5919. Name: sendAUMessage
  5920. Description: Send the command to the list of clients or some count of clients.
  5921. Category: General
  5922. Address: 0xD4D740
  5923. Example: SendAUMessage [[dpnid1, dpnid2], "ConnectTo: 192.168.1.66"]
  5924. Arg1: [count|[clientList], "command"]
  5925.  
  5926.  
  5927. Name: sendUDPMessage
  5928. Description: Send message to given adress using UDP protocol.
  5929. Category: General
  5930. Address: 0x11D62F0
  5931. Arg1: [ip,port,"message"]
  5932.  
  5933.  
  5934. Name: serverCommand
  5935. Description: Process the specified server command.
  5936. The Server command string is identical to that used in chat line in MP.
  5937. This command needs to be executed from UI handler to succeed.
  5938. Category: General
  5939. Address: 0xD4EAB0
  5940. Example: serverCommand "#kick friendlykiller"
  5941. Arg1: server command
  5942.  
  5943.  
  5944. Name: serverCommandAvailable
  5945. Description: Checks whether current user is able to process the specified server command. See also <f>serverCommand</f>
  5946. Category: General
  5947. Address: 0xD4EB90
  5948. Example: serverCommandAvailable "#kick"
  5949. Arg1: server command
  5950.  
  5951.  
  5952. Name: serverCommandExecutable
  5953. Description: Checks whether current user is able to execute the specified server command.
  5954. This command needs to be executed from UI handler to succeed and mirrors serverCommand behavior. See also <f>serverCommand</f>
  5955. Category: General
  5956. Address: 0xD4EC20
  5957. Example: serverCommandExecutable "#kick"
  5958. Arg1: server command
  5959.  
  5960.  
  5961. Name: serverTime
  5962. Description: Server time synchronized to clients.
  5963. Category: General
  5964. Address: 0xCAE760
  5965.  
  5966.  
  5967. Name: setAccTime
  5968. Description: Sets the time acceleration coeficient. It can also be used to slow down time in cutscenes.
  5969. Category: General
  5970. Address: 0xD4ED90
  5971. Example: setAccTime 0.1
  5972. Arg1: accFactor
  5973.  
  5974.  
  5975. Name: setAperture
  5976. Description: Sets custom camera apreture (-1 to do it automatically).
  5977. Category: General
  5978. Address: 0xD4F000
  5979. Arg1: set
  5980.  
  5981.  
  5982. Name: setApertureNew
  5983. Description: Sets custom camera apreture (-1 to do it automatically).
  5984. Category: General
  5985. Address: 0xD4F0D0
  5986. Arg1: [min, std, max, std lum]
  5987.  
  5988.  
  5989. Name: setArmoryPoints
  5990. Description: Store the given amount of armory points.
  5991. Category: General
  5992. Address: 0xD4F2B0
  5993. Arg1: points
  5994.  
  5995.  
  5996. Name: setCamShakeDefParams
  5997. Description: Sets camera shake default params.
  5998. Category: General
  5999. Address: 0xD4F6C0
  6000. Arg1: [power, duration, maxDistance, frequency, minSpeed, minMass, caliberCoefHit, caliberCoefFire, vehicleCoef]
  6001.  
  6002.  
  6003. Name: setCamShakeParams
  6004. Description: Sets camera shake params.
  6005. Category: General
  6006. Address: 0xD4F910
  6007. Arg1: [posCoef, rotXCoef, rotYCoef, rotZCoef, interp]
  6008.  
  6009.  
  6010. Name: setCompassOscillation
  6011. Description: Set Compass Oscilation.
  6012. Category: General
  6013. Address: 0xD4FC00
  6014. Arg1: [angle, frequencyMin, frequencyMax]
  6015.  
  6016.  
  6017. Name: setDate
  6018. Description: Sets the actual mission date and time.
  6019. Category: General
  6020. Address: 0xD50450
  6021. Arg1: [year, month, day, hour, minute]
  6022.  
  6023.  
  6024. Name: setDefaultCamera
  6025. Description: Sets the position and direction for camera used after camera is set on no object (e.g. leaving a multiplayer game).
  6026. Category: General
  6027. Address: 0xD507E0
  6028. Example: setDefaultCamera [ [ 5000,5000,200], [1,1,-1] ]
  6029. Arg1: [ position, direction = [0,0,-1]]
  6030.  
  6031.  
  6032. Name: setDetailMapBlendPars
  6033. Description: Sets the detail texture map blend pars.
  6034. Category: General
  6035. Address: 0xD50920
  6036. Example: setDetailMapBlendPars [20, 50]
  6037. Arg1: [fullDetail, noDetail]
  6038.  
  6039.  
  6040. Name: setGroupIconsSelectable
  6041. Description: Sets if group icons raises onclick and onover events.
  6042. Category: General
  6043. Address: 0xD4D6D0
  6044. Example: selectableGroupIcons true
  6045. Arg1: bool
  6046.  
  6047.  
  6048. Name: setGroupIconsVisible
  6049. Description: Sets if group icons are visible.
  6050. Category: General
  6051. Address: 0xD56730
  6052. Example: showGroupIcons [true,true]
  6053. Arg1: array
  6054.  
  6055.  
  6056. Name: setHorizonParallaxCoef
  6057. Description: Sets coef used to shift horizon position based on camera height (use 0 to disable shifting).
  6058. Category: General
  6059. Address: 0xD52400
  6060. Arg1: coef
  6061.  
  6062.  
  6063. Name: setHUDMovementLevels
  6064. Description: Set min/max movement borders displayed in HUD gauges. Use -1 to skip some value.Speed [m/s],alt [m], dir [deg]. Use [-1,-1,-1] to keep current position
  6065. Category: General
  6066. Address: 0xD51F10
  6067. Example: SetHUDMovementLevels [20,30,-1,-1,0.23,2.1]
  6068. Arg1: [min speed, max speed, min alt, max alt, min dir, max dir, position[x,y,z] or target]
  6069.  
  6070.  
  6071. Name: setLocalWindParams
  6072. Description: Sets parameters for local wind emiters (like helicopters). Default [1.0, 1.0]
  6073. Category: General
  6074. Address: 0xD525F0
  6075. Arg1: [strength, diameter]
  6076.  
  6077.  
  6078. Name: setMousePosition
  6079. Description: Move (UI) mouse pointer to specified position of the screen.
  6080. Category: General
  6081. Address: 0xD527D0
  6082. Example: setMousePosition [0.5, 0.5]
  6083. Arg1: [x, y]
  6084.  
  6085.  
  6086. Name: setMusicEventHandler
  6087. Description: Sets given music track event handler.
  6088. Category: General
  6089. Address: 0xD29790
  6090. Example: setMusicEventHandler ["MusicTerminate", ""]
  6091. Arg1: [type, function]
  6092.  
  6093.  
  6094. Name: setObjectViewDistance
  6095. Description: Sets the rendering distance of objects.
  6096. Category: General
  6097. Address: 0xD53510
  6098. Example: setobjectviewdistance 2000
  6099. Arg1: distance
  6100.  
  6101.  
  6102. Name: setObjectViewDistance
  6103. Description: Sets the rendering distance of objects.
  6104. Category: General
  6105. Address: 0xD53510
  6106. Example: setobjectviewdistance [2000,50]
  6107. Arg1: [vehiclesZ, shadowsZ]
  6108.  
  6109.  
  6110. Name: setPlayable
  6111. Description: Create MP role for the unit.
  6112. Category: General
  6113. Address: 0xD54840
  6114. Example: setPlayable aP
  6115. Arg1: unit
  6116.  
  6117.  
  6118. Name: setPlayerRespawnTime
  6119. Description: Set the time interval to wait on player respawn. It is set to mission default on mission start again.
  6120. Category: General
  6121. Address: 0xD54890
  6122. Arg1: time interval
  6123.  
  6124.  
  6125. Name: setShadowDistance
  6126. Description: Sets the shadows rendering distance.
  6127. Category: General
  6128. Address: 0xD52760
  6129. Example: setShadowDistance 1000
  6130. Arg1: newDistance
  6131.  
  6132.  
  6133. Name: setSimulWeatherLayers
  6134. Description: Sets simul weather layers
  6135. Category: General
  6136. Address: 0xD54D30
  6137. Arg1: layers
  6138.  
  6139.  
  6140. Name: setStatValue
  6141. Description: Sets a value to given stat.
  6142. Category: General
  6143. Address: 0xD55000
  6144. Arg1: [statName, value]
  6145.  
  6146.  
  6147. Name: setSystemOfUnits
  6148. Description: Set system of units. 0 for metric, 1 for mixed, 2 for imperial.
  6149. Category: General
  6150. Address: 0xD55240
  6151. Arg1: value
  6152.  
  6153.  
  6154. Name: setTerrainGrid
  6155. Description: Sets the desired terrain resolution (in meters). For default landscapes the supported resolutions are: 50, 25, 12.5, 6.25 and 3.125. If you select an unsupported resolution, the nearest supported resolution is used instead.
  6156. Category: General
  6157. Address: 0xD55290
  6158. Example: setTerrainGrid 12.5
  6159. Arg1: grid
  6160.  
  6161.  
  6162. Name: setTimeMultiplier
  6163. Description: Time multiplier for in game time.
  6164. Category: General
  6165. Address: 0xD55490
  6166. Example: setTimeMultiplier 60
  6167. Arg1: multiplier
  6168.  
  6169.  
  6170. Name: setTrafficDensity
  6171. Description: Set the density of ambient cars in a rectangle (in cars per kilometer).
  6172. Category: General
  6173. Address: 0xD55590
  6174. Arg1: [density, xMin, xMax, zMin, zMax]
  6175.  
  6176.  
  6177. Name: setTrafficDistance
  6178. Description: Set maximum ambient traffic draw distance (in 2D).
  6179. Category: General
  6180. Address: 0xD55590
  6181. Arg1: distance
  6182.  
  6183.  
  6184. Name: setTrafficGap
  6185. Description: Set the average gap between ambient cars in a rectangle (in meters).
  6186. Category: General
  6187. Address: 0xD55590
  6188. Arg1: [gap, xMin, xMax, zMin, zMax]
  6189.  
  6190.  
  6191. Name: setTrafficSpeed
  6192. Description: Set ambient traffic speed in a rectangle (in kilometers per hour).
  6193. Category: General
  6194. Address: 0xD55590
  6195. Arg1: [speed, xMin, xMax, zMin, zMax]
  6196.  
  6197.  
  6198. Name: setViewDistance
  6199. Description: Sets the rendering distance. Default is 900 meters. The accepted range is from 500 to 5000 meters.
  6200. Category: General
  6201. Address: 0xD55AE0
  6202. Example: setviewdistance 2000
  6203. Arg1: distance
  6204.  
  6205.  
  6206. Name: setWind
  6207. Description: Set current (forced == false) or permanent (forced == true) wind direction and force.
  6208. Category: General
  6209. Address: 0xD56030
  6210. Arg1: [x, z, forced]
  6211.  
  6212.  
  6213. Name: setWindDir
  6214. Description: Set current wind direction and force.
  6215. Category: General
  6216. Address: 0xD561E0
  6217. Arg1: [x, z]
  6218.  
  6219.  
  6220. Name: showChat
  6221. Description: Shows/hides the whole chat window.
  6222. Category: General
  6223. Address: 0xD56560
  6224. Example: showChat false
  6225. Arg1: true/false
  6226.  
  6227.  
  6228. Name: showCinemaBorder
  6229. Description: Forces drawing of the cinema borders. This is normally used in cutscenes to indicate the player has no control.
  6230. Category: General
  6231. Address: 0xC10A20
  6232. Arg1: show
  6233.  
  6234.  
  6235. Name: showCommandingMenu
  6236. Description: Create the commanding menu described by the given config class. When class name is empty, current commanding menu is hidden.
  6237. Category: General
  6238. Address: 0xD4FBC0
  6239. Arg1: class name
  6240.  
  6241.  
  6242. Name: showCompass
  6243. Description: Enables the compass (the default is true).
  6244. Category: General
  6245. Address: 0xD565A0
  6246. Arg1: show
  6247.  
  6248.  
  6249. Name: showCuratorCompass
  6250. Description: Hides or shows compass in curator interface.
  6251. Category: General
  6252. Address: 0xD56620
  6253. Arg1: show?
  6254.  
  6255.  
  6256. Name: showGps
  6257. Description: Enables the GPS receiver (the default is false).
  6258. Category: General
  6259. Address: 0xD566B0
  6260. Arg1: show
  6261.  
  6262.  
  6263. Name: showHUD
  6264. Description: Enable / disable showing of HUD.
  6265. Category: General
  6266. Address: 0xD56810
  6267. Arg1: enable
  6268.  
  6269.  
  6270. Name: showMap
  6271. Description: Enables the map (the default is true).
  6272. Category: General
  6273. Address: 0xD56EB0
  6274. Example: showMap true
  6275. Arg1: show
  6276.  
  6277.  
  6278. Name: shownArtilleryComputer
  6279. Description: Checks whether the player has the artillery computer currently enabled.
  6280. Category: General
  6281. Address: 0xCB6760
  6282.  
  6283.  
  6284. Name: shownChat
  6285. Description: Checks whether the player chat is visible.
  6286. Category: General
  6287. Address: 0xCB6940
  6288.  
  6289.  
  6290. Name: shownCompass
  6291. Description: Checks whether the player has the compass enabled.
  6292. Category: General
  6293. Address: 0xCB6960
  6294.  
  6295.  
  6296. Name: shownCuratorCompass
  6297. Description: Returns true if compass is shown.
  6298. Category: General
  6299. Address: 0xCB6A50
  6300.  
  6301.  
  6302. Name: shownGps
  6303. Description: Checks whether the player has the GPS receiver enabled.
  6304. Category: General
  6305. Address: 0xCB7F70
  6306.  
  6307.  
  6308. Name: shownMap
  6309. Description: Checks whether the player has the map enabled.
  6310. Category: General
  6311. Address: 0xCB84F0
  6312.  
  6313.  
  6314. Name: shownPad
  6315. Description: Checks whether the player has the notebook enabled.
  6316. Category: General
  6317. Address: 0xCB86E0
  6318.  
  6319.  
  6320. Name: shownRadio
  6321. Description: Checks whether the player has the radio transmitter enabled.
  6322. Category: General
  6323. Address: 0xCB8C00
  6324.  
  6325.  
  6326. Name: shownUAVFeed
  6327. Description: True if UAV view is visible.
  6328. Category: General
  6329. Address: 0xD57530
  6330.  
  6331.  
  6332. Name: shownWarrant
  6333. Description: Checks whether the player has the ID card enabled.
  6334. (Obsolete).
  6335. Category: General
  6336. Address: 0xCB8CC0
  6337.  
  6338.  
  6339. Name: shownWatch
  6340. Description: Checks whether the player has the watch enabled.
  6341. Category: General
  6342. Address: 0xCB8D30
  6343.  
  6344.  
  6345. Name: showPad
  6346. Description: Enables the notepad (the default is true).
  6347. Category: General
  6348. Address: 0xD56F30
  6349. Arg1: show
  6350.  
  6351.  
  6352. Name: showRadio
  6353. Description: Enables the radio (the default is false).
  6354. Category: General
  6355. Address: 0xD573D0
  6356. Arg1: show
  6357.  
  6358.  
  6359. Name: showSubtitles
  6360. Description: Enable / disable showing of subtitles. Return the previous state.
  6361. Category: General
  6362. Address: 0xD56FF0
  6363. Arg1: enable
  6364.  
  6365.  
  6366. Name: showUAVFeed
  6367. Description: Show UAV view.
  6368. Category: General
  6369. Address: 0xD57350
  6370. Example: showUAVFeed true
  6371. Arg1: show
  6372.  
  6373.  
  6374. Name: showWarrant
  6375. Description: Obsolete.
  6376. Enables the ID card (the default is false).
  6377. Category: General
  6378. Address: 0xD57440
  6379. Arg1: show
  6380.  
  6381.  
  6382. Name: showWatch
  6383. Description: Enables the watch (the default is true).
  6384. Category: General
  6385. Address: 0xD574B0
  6386. Arg1: show
  6387.  
  6388.  
  6389. Name: side
  6390. Description: Returns the side of the unit.
  6391. Category: General
  6392. Address: 0xD43110
  6393. Example: side player == west
  6394. Arg1: unit
  6395.  
  6396.  
  6397. Name: side
  6398. Description: Returns the side of the group.
  6399. Category: General
  6400. Address: 0xCB4960
  6401. Example: side group player == west
  6402. Arg1: group
  6403.  
  6404.  
  6405. Name: sideEnemy
  6406. Description: The Enemy side (used for renegades).
  6407. Category: General
  6408. Address: 0xD576C0
  6409.  
  6410.  
  6411. Name: sideFriendly
  6412. Description: The Friendly side (used for captives).
  6413. Category: General
  6414. Address: 0xD57700
  6415.  
  6416.  
  6417. Name: sideLogic
  6418. Description: The Logic side.
  6419. Category: General
  6420. Address: 0xD57870
  6421.  
  6422.  
  6423. Name: sideUnknown
  6424. Description: The unknown side.
  6425. Category: General
  6426. Address: 0xD578F0
  6427.  
  6428.  
  6429. Name: simulationEnabled
  6430. Description: Check if the entity has enabled simulation.
  6431. Category: General
  6432. Address: 0xD71780
  6433. Arg1: entity
  6434.  
  6435.  
  6436. Name: simulCloudDensity
  6437. Description: Returns density of clouds at given position.
  6438. Category: General
  6439. Address: 0xD57C30
  6440. Arg1: position
  6441.  
  6442.  
  6443. Name: simulCloudOcclusion
  6444. Description: Returns clouds occlusion between two given points (0 = no clouds, 1 = full clouds).
  6445. Category: General
  6446. Address: 0xD57E40
  6447. Arg1: [position1, position2]
  6448.  
  6449.  
  6450. Name: simulInClouds
  6451. Description: Returns if given position is in clouds.
  6452. Category: General
  6453. Address: 0xD581D0
  6454. Arg1: position
  6455.  
  6456.  
  6457. Name: simulWeatherSync
  6458. Description: Synchronizes SW with arma weather, generates all keyframes.
  6459. Category: General
  6460. Address: 0xD58400
  6461.  
  6462.  
  6463. Name: sizeOf
  6464. Description: Return the size of the entity of given type.
  6465. Category: General
  6466. Address: 0xD61780
  6467. Arg1: typeName
  6468.  
  6469.  
  6470. Name: skill
  6471. Description: Returns the current level of ability of the person.
  6472. Category: General
  6473. Address: 0xD30700
  6474. Example: skill player
  6475. Arg1: person
  6476.  
  6477.  
  6478. Name: skipTime
  6479. Description: Skips the specified time. Daytime is adjusted, a weather change is estimated and no changes to any units are done. Duration is in hours.
  6480. Category: General
  6481. Address: 0xD58550
  6482. Example: skipTime 2.5
  6483. Arg1: duration
  6484.  
  6485.  
  6486. Name: sleep
  6487. Description: Suspend execution of script for given time.
  6488. Category: General
  6489. Address: 0xD6DB30
  6490. Example: sleep 0.5
  6491. Arg1: delay
  6492.  
  6493.  
  6494. Name: sliderPosition
  6495. Description: Returns the current thumb position of the given slider.
  6496. Category: General
  6497. Address: 0xD6ADD0
  6498. Example: _pos = sliderPosition _control
  6499. Arg1: control
  6500.  
  6501.  
  6502. Name: sliderPosition
  6503. Description: Returns the current thumb position of the slider with id idc of the topmost user dialog.
  6504. Category: General
  6505. Address: 0xD585B0
  6506. Example: _pos = sliderPosition 101
  6507. Arg1: idc
  6508.  
  6509.  
  6510. Name: sliderRange
  6511. Description: Returns the limits (as an array [min, max]) of the slider with id idc of the topmost user dialog.
  6512. Category: General
  6513. Address: 0xD585F0
  6514. Example: _limits = sliderRange 100
  6515. Arg1: idc
  6516.  
  6517.  
  6518. Name: sliderRange
  6519. Description: Returns the limits (as an array [min, max]) of the given slider.
  6520. Category: General
  6521. Address: 0xD6AE60
  6522. Example: _limits = sliderRange _control
  6523. Arg1: control
  6524.  
  6525.  
  6526. Name: sliderSetPosition
  6527. Description: Sets the current thumb position of the slider with id idc of the topmost user dialog.
  6528. Category: General
  6529. Address: 0xD588E0
  6530. Example: sliderSetPosition [100, 0]
  6531. Arg1: [idc, pos]
  6532.  
  6533.  
  6534. Name: sliderSetRange
  6535. Description: Sets the limits of the slider with id idc of the topmost user dialog.
  6536. Category: General
  6537. Address: 0xD589A0
  6538. Example: sliderSetRange [100, 0, 10]
  6539. Arg1: [idc, min, max]
  6540.  
  6541.  
  6542. Name: sliderSetSpeed
  6543. Description: Sets the speed (a click on the arrow results in a move per line. A click on the scale outside the thumb results in a move per page) of the slider with id idc of the topmost user dialog.
  6544. Category: General
  6545. Address: 0xD58A90
  6546. Example: sliderSetSpeed [100, 0.5, 2.0]
  6547. Arg1: [idc, line, page]
  6548.  
  6549.  
  6550. Name: sliderSpeed
  6551. Description: Returns the speed (as an array [line, page]) of the given slider.
  6552. Category: General
  6553. Address: 0xD6B020
  6554. Example: _speed = sliderSpeed _control
  6555. Arg1: control
  6556.  
  6557.  
  6558. Name: sliderSpeed
  6559. Description: Returns the speed (as an array [line, page]) of the slider with id idc of the topmost user dialog.
  6560. Category: General
  6561. Address: 0xD58760
  6562. Example: _speed = sliderSpeed
  6563. Arg1: idc
  6564.  
  6565.  
  6566. Name: slingLoadAssistantShown
  6567. Description: Return true if Sling Load Assistant is shown.
  6568. Category: General
  6569. Address: 0xD77C30
  6570. Example: slingLoadAssistantShown
  6571.  
  6572.  
  6573. Name: SoldierMagazines
  6574. Description: Get array with all magazines from vest.
  6575. Category: General
  6576. Address: 0xD2D350
  6577. Arg1: unit
  6578.  
  6579.  
  6580. Name: someAmmo
  6581. Description: Checks whether the unit has some ammo remaining.
  6582. Category: General
  6583. Address: 0xD435A0
  6584. Example: someAmmo vehicle player
  6585. Arg1: unit
  6586.  
  6587.  
  6588. Name: soundVolume
  6589. Description: Checks the current sound volume (set by <f>setSoundVolume</f>).
  6590. Category: General
  6591. Address: 0xCAEB50
  6592.  
  6593.  
  6594. Name: speaker
  6595. Description: Returns the speaker of the variable assigned to the object in the mission editor.
  6596. Category: General
  6597. Address: 0xD436D0
  6598. Example: speaker player
  6599. Arg1: object
  6600.  
  6601.  
  6602. Name: speed
  6603. Description: Returns the object speed (in km/h).
  6604. Category: General
  6605. Address: 0xD36390
  6606. Example: speed player
  6607. Arg1: obj
  6608.  
  6609.  
  6610. Name: speedMode
  6611. Description: Returns the speed mode of the group ("LIMITED", "NORMAL" or "FULL").
  6612. Category: General
  6613. Address: 0xCB49D0
  6614. Example: speedMode group player
  6615. Arg1: grp
  6616.  
  6617.  
  6618. Name: squadParams
  6619. Description: Returns data about squad of given unit loaded from squad.xml
  6620. Category: General
  6621. Address: 0xCAEB70
  6622. Arg1: unit
  6623.  
  6624.  
  6625. Name: stance
  6626. Description: Returns the stance of the given unit.
  6627. Category: General
  6628. Address: 0xD36400
  6629. Arg1: unit
  6630.  
  6631.  
  6632. Name: startLoadingScreen
  6633. Description: Shows loading screen with the given text, using the given resource. When loading screen is shown, simulation and scene drawing is disabled, scripts run at full speed.
  6634. Category: General
  6635. Address: 0xD241A0
  6636. Arg1: [text] or [text, resource]
  6637.  
  6638.  
  6639. Name: stopEngineRTD
  6640. Description: Instant engines stop.
  6641. Category: General
  6642. Address: 0xD4AE20
  6643. Arg1: RTD_helicopter
  6644.  
  6645.  
  6646. Name: stopped
  6647. Description: Checks whether the unit is stopped using the "stop" command.
  6648. Category: General
  6649. Address: 0xD437C0
  6650. Example: stopped jeepOne
  6651. Arg1: unit
  6652.  
  6653.  
  6654. Name: sunOrMoon
  6655. Description: Returns sun to moon transition state.
  6656. Category: General
  6657. Address: 0xCAF3E0
  6658.  
  6659.  
  6660. Name: surfaceIsWater
  6661. Description: Returns whether water is on given position.
  6662. Category: General
  6663. Address: 0xD5A5F0
  6664. Arg1: [x, y]
  6665.  
  6666.  
  6667. Name: surfaceNormal
  6668. Description: Returns surface normal on given position.
  6669. Category: General
  6670. Address: 0xD5A2D0
  6671. Arg1: [x, y]
  6672.  
  6673.  
  6674. Name: surfaceType
  6675. Description: Returns what surface is on given position.
  6676. Category: General
  6677. Address: 0xD5A490
  6678. Arg1: [x, y]
  6679.  
  6680.  
  6681. Name: switchableUnits
  6682. Description: Return a list of units accessible through team switch.
  6683. Category: General
  6684. Address: 0xCAF430
  6685.  
  6686.  
  6687. Name: synchronizedObjects
  6688. Description: Return the list of objects synchronized with the given unit/trigger.
  6689. Category: General
  6690. Address: 0xD36490
  6691. Arg1: unit/trigger
  6692.  
  6693.  
  6694. Name: synchronizedTriggers
  6695. Description: Return the list of triggers synchronized with a given waypoint.
  6696. Category: General
  6697. Address: 0xD5A790
  6698. Example: synchronizedTriggers [group player, 1]
  6699. Arg1: waypoint
  6700.  
  6701.  
  6702. Name: synchronizedWaypoints
  6703. Description: Return the list of waypoints synchronized with a given waypoint.
  6704. Category: General
  6705. Address: 0xD5A960
  6706. Example: synchronizedWaypoints [group player, 1]
  6707. Arg1: waypoint
  6708.  
  6709.  
  6710. Name: synchronizedWaypoints
  6711. Description: Return the list of waypoints synchronized with a given trigger.
  6712. Category: General
  6713. Address: 0xD5A960
  6714. Example: synchronizedWaypoints trigger1
  6715. Arg1: trigger
  6716.  
  6717.  
  6718. Name: systemChat
  6719. Description: Types text to the system radio channel.
  6720. Note: this function only types text to the list, it does not broadcast the message. If you want the message to show on all computers, you have to execute it on all of them.
  6721. Category: General
  6722. Address: 0xD5AAF0
  6723. Example: systemChat "Dam of Peace"
  6724. Arg1: chatText
  6725.  
  6726.  
  6727. Name: systemOfUnits
  6728. Description: Returns 0 for metric, 1 for mixed (ground units uses metric, air units uses imperial) and 2 for imperial.
  6729. Category: General
  6730. Address: 0xCAF630
  6731.  
  6732.  
  6733. Name: taskHint
  6734. Description: Shows info about new,changed or failed task. The text can contain several lines. \n is used to indicate the end of a line.
  6735. Category: General
  6736. Address: 0xD57030
  6737. Example: taskHint "Capture town."
  6738. Arg1: text
  6739.  
  6740.  
  6741. Name: teamMember
  6742. Description: Return an agent for given person.
  6743. Category: Agents
  6744. Address: 0xD36600
  6745. Example: _agent = teamMember player
  6746. Arg1: person
  6747.  
  6748.  
  6749. Name: teamMemberNull
  6750. Description: A non-existing team member. This value is not equal to anything, including itself.
  6751. Category: Agents
  6752. Address: 0xD5EA20
  6753. Example: _teamMember == teamMemberNull
  6754. Ex. Returns: false
  6755.  
  6756.  
  6757. Name: teamName
  6758. Description: Return a name of given team.
  6759. Category: Agents
  6760. Address: 0xD5D990
  6761. Example: _name = teamName _team
  6762. Arg1: team
  6763.  
  6764.  
  6765. Name: teams
  6766. Description: Return a list of teams in the current mission.
  6767. Category: Agents
  6768. Address: 0xD5E5B0
  6769. Example: _teams = teams
  6770.  
  6771.  
  6772. Name: teamSwitch
  6773. Description: Invoke the team switch dialog (force it even when conditions are not met).
  6774. Category: General
  6775. Address: 0xD48D90
  6776.  
  6777.  
  6778. Name: teamSwitchEnabled
  6779. Description: Check if tam switch is currently enabled.
  6780. Category: General
  6781. Address: 0xCB8A20
  6782.  
  6783.  
  6784. Name: teamType
  6785. Description: Return a type of given team.
  6786. Category: Agents
  6787. Address: 0xD5DA20
  6788. Example: _type = teamType _team
  6789. Arg1: team
  6790.  
  6791.  
  6792. Name: terminate
  6793. Description: Terminate (abort) the script
  6794. Category: General
  6795. Address: 0xD4D2B0
  6796. Arg1: script
  6797.  
  6798.  
  6799. Name: terrainIntersect
  6800. Description: Checks for intersection of terrain between two positions. Returns true if intersects with terrain
  6801. Category: General
  6802. Address: 0xD5F020
  6803. Example: _doesIntersect = terrainIntersect [ position player, position enemy1 ];
  6804. Arg1: [ position begin, position end ]
  6805.  
  6806.  
  6807. Name: terrainIntersectASL
  6808. Description: Checks for intersection of terrain between two positions. Returns true if intersects with terrain
  6809. Category: General
  6810. Address: 0xD5F1A0
  6811. Example: _doesIntersect = terrainIntersectASL [ getposAsl player, getposAsl enemy1 ];
  6812. Arg1: [ positionASL begin, positionASL end ]
  6813.  
  6814.  
  6815. Name: text
  6816. Description: Creates a structured text containing the given plain text.
  6817. Category: General
  6818. Address: 0xD613B0
  6819. Example: txt2 = text "Hello world."
  6820. Arg1: text
  6821.  
  6822.  
  6823. Name: textLog
  6824. Description: Dumps the argument value into the debugging output.
  6825. Category: General
  6826. Address: 0xD55590
  6827. Example: textLog player
  6828. Arg1: anything
  6829.  
  6830.  
  6831. Name: textLogFormat
  6832. Description: Shortcut to textLog format [format, arg1, arg2, ...] (for better performance in retail version).
  6833. Category: General
  6834. Address: 0xD55590
  6835. Arg1: [format, arg1, arg2, ...]
  6836.  
  6837.  
  6838. Name: time
  6839. Description: Returns the time that elapsed since the mission started (in seconds).
  6840. Category: General
  6841. Address: 0xC9F620
  6842.  
  6843.  
  6844. Name: timeMultiplier
  6845. Description: Returns game time multiplier setted to speed up game time
  6846. Category: General
  6847. Address: 0xCA8A30
  6848. Example: multiplier
  6849.  
  6850.  
  6851. Name: titleCut
  6852. Description: Obsolete.
  6853. Category: General
  6854. Address: 0xC996F0
  6855. Arg1: effect
  6856.  
  6857.  
  6858. Name: titleFadeOut
  6859. Description: Terminate the title effect and set duration of the fade out phase to the given time.
  6860. Category: General
  6861. Address: 0xC9F650
  6862. Example: titleFadeIn 1.0
  6863. Arg1: duration
  6864.  
  6865.  
  6866. Name: titleObj
  6867. Description: Object title - the argument uses format ["text","type",speed, showInMap] or ["name","type"]. If speed is not given, it's assumed to be one.
  6868. The object can be defined in the description.ext file.
  6869. Category: General
  6870. Address: 0xC9F690
  6871. Example: titleObj ["BISLogo","plain"]
  6872. Arg1: effect
  6873.  
  6874.  
  6875. Name: titleRsc
  6876. Description: Resource title - the argument uses format ["name","type",speed, showInMap] or ["name","type"]. If speed is not given, it's assumed to be one.
  6877. Resource can be defined in the description.ext file.
  6878. Category: General
  6879. Address: 0xC9F800
  6880. Example: titleRsc ["BIS", "PLAIN"]
  6881. Arg1: effect
  6882.  
  6883.  
  6884. Name: titleText
  6885. Description: Text title - the argument uses format ["text","type",speed, showInMap] or ["text","type"]. If speed is not given, it's assumed to be one.
  6886. Category: General
  6887. Address: 0xC9F980
  6888. Example: titleText ["Show this text", "PLAIN"]
  6889. Arg1: effect
  6890.  
  6891.  
  6892. Name: triggerActivated
  6893. Description: Returns true if the trigger has been activated.
  6894. Category: General
  6895. Address: 0xD5F490
  6896. Arg1: trigger
  6897.  
  6898.  
  6899. Name: triggerActivation
  6900. Description: Returns trigger activation in the form [by, type, repeating]
  6901. Category: General
  6902. Address: 0xD5F9E0
  6903. Arg1: trigger
  6904.  
  6905.  
  6906. Name: triggerArea
  6907. Description: Returns trigger area in the form [a, b, angle, rectangle]
  6908. Category: General
  6909. Address: 0xD5FB20
  6910. Arg1: trigger
  6911.  
  6912.  
  6913. Name: triggerAttachedVehicle
  6914. Description: Returns vehicle attached to the trigger (for example using <f>triggerAttachVehicle</f>)
  6915. Category: General
  6916. Address: 0xD5FC30
  6917. Arg1: trigger
  6918.  
  6919.  
  6920. Name: triggerStatements
  6921. Description: Returns trigger statements in the form [cond, activ, desactiv]
  6922. Category: General
  6923. Address: 0xD5FCA0
  6924. Arg1: trigger
  6925.  
  6926.  
  6927. Name: triggerText
  6928. Description: Returns trigger text.
  6929. Category: General
  6930. Address: 0xD5FDF0
  6931. Arg1: trigger
  6932.  
  6933.  
  6934. Name: triggerTimeout
  6935. Description: Returns trigger timeout in the form [min, mid, max, interruptable]
  6936. Category: General
  6937. Address: 0xD5FE60
  6938. Arg1: trigger
  6939.  
  6940.  
  6941. Name: triggerTimeoutCurrent
  6942. Description: Returns trigger timeout or -1 if countdown is not in progress.
  6943. Category: General
  6944. Address: 0xD5FF30
  6945. Example: triggerTimeoutCurrent triggerOne
  6946. Arg1: trigger
  6947.  
  6948.  
  6949. Name: triggerType
  6950. Description: Returns trigger type.
  6951. Category: General
  6952. Address: 0xD5FF90
  6953. Arg1: trigger
  6954.  
  6955.  
  6956. Name: tvAdd
  6957. Description: Adds an item with given text to Tree View with given idc under specified path (zero based).
  6958. Category: General
  6959. Address: 0xD5AB20
  6960. Example: tvAdd [101, [0], "First item"]
  6961. Arg1: [idc, [path], text]
  6962.  
  6963.  
  6964. Name: tvClear
  6965. Description: Removes all items from Tree View with given idc.
  6966. Category: General
  6967. Address: 0xD5ADA0
  6968. Example: tvClear 101
  6969. Arg1: idc
  6970.  
  6971.  
  6972. Name: tvClear
  6973. Description: Removes all items from Tree View with given idc.
  6974. Category: General
  6975. Address: 0xD6B610
  6976. Example: tvClear 101
  6977. Arg1: idc
  6978.  
  6979.  
  6980. Name: tvCollapse
  6981. Description: Collapses tree item pointed to by path. IDC means id of parent Tree View.
  6982. Category: General
  6983. Address: 0xD5ADF0
  6984. Example: tvCollapse [101,[0]]
  6985. Arg1: [idc, [path]]
  6986.  
  6987.  
  6988. Name: tvCount
  6989. Description: Returns childrens count of item on given path. IDC means id of parent Tree View.
  6990. Category: General
  6991. Address: 0xD5AF50
  6992. Example: tvCount [101,[0]]
  6993. Arg1: [idc, [path]]
  6994.  
  6995.  
  6996. Name: tvCurSel
  6997. Description: Returns path to currently selected item. IDC means id of parent Tree View.
  6998. Category: General
  6999. Address: 0xD6B7B0
  7000. Example: tvCurSel 101
  7001. Arg1: idc
  7002.  
  7003.  
  7004. Name: tvCurSel
  7005. Description: Returns path to currently selected item. IDC means id of parent Tree View.
  7006. Category: General
  7007. Address: 0xD5B5A0
  7008. Example: tvCurSel 101
  7009. Arg1: idc
  7010.  
  7011.  
  7012. Name: tvData
  7013. Description: Returns string data from item on given path. IDC means id of parent Tree View.
  7014. Category: General
  7015. Address: 0xD5B0C0
  7016. Example: tvData [101,[0]]
  7017. Arg1: [idc, [path]]
  7018.  
  7019.  
  7020. Name: tvDelete
  7021. Description: Removes an item on given path from Tree View with given idc.
  7022. Category: General
  7023. Address: 0xD5B240
  7024. Example: tvDelete [101, [0,0]]
  7025. Arg1: [idc, [path]]
  7026.  
  7027.  
  7028. Name: tvExpand
  7029. Description: Expands tree item pointed to by path. IDC means id of parent Tree View.
  7030. Category: General
  7031. Address: 0xD5B440
  7032. Example: tvExpand [101,[0]]
  7033. Arg1: [idc, [path]]
  7034.  
  7035.  
  7036. Name: tvPicture
  7037. Description: Returns name of picture from item pointed to by path. IDC means id of parent Tree View.
  7038. Category: General
  7039. Address: 0xD5BA80
  7040. Example: tvPicture [101,[0]]
  7041. Arg1: [idc, [path]]
  7042.  
  7043.  
  7044. Name: tvSetCurSel
  7045. Description: Sets cursor to given item on given path. IDC means id of parent Tree View.
  7046. Category: General
  7047. Address: 0xD5C1B0
  7048. Example: tvSetCurSel [101,[0]]
  7049. Arg1: [idc, [path]]
  7050.  
  7051.  
  7052. Name: tvSetData
  7053. Description: Sets string data to item on given path. IDC means id of parent Tree View.
  7054. Category: General
  7055. Address: 0xD5BC90
  7056. Example: tvSetData [101,[0],"Test data"]
  7057. Arg1: [idc, [path], "data"]
  7058.  
  7059.  
  7060. Name: tvSetPicture
  7061. Description: Sets picture to item selected by path. IDC means id of parent Tree View. Name is the picture name. The picture is searched in the mission directory
  7062. Category: General
  7063. Address: 0xD5BED0
  7064. Example: tvSetPicture [101,[0],"picture"]
  7065. Arg1: [idc, [path],name]
  7066.  
  7067.  
  7068. Name: tvSetTooltip
  7069. Description: Sets tooltip for item with the given index of the tree view with id idc of the topmost user dialog to the given data.
  7070. Category: General
  7071. Address: 0xD5C310
  7072. Example: tvSetTooltip [101, 1, "tooltip"]
  7073. Arg1: [idc, index, tooltip]
  7074.  
  7075.  
  7076. Name: tvSetValue
  7077. Description: Sets scalar data to item on given path. IDC means id of parent Tree View.
  7078. Category: General
  7079. Address: 0xD5C460
  7080. Example: tvSetValue [101,[0], 555]
  7081. Arg1: [idc, [path], val]
  7082.  
  7083.  
  7084. Name: tvSort
  7085. Description: Sorts childrens of given item by data. Param reversed is optional. IDC means id of parent Tree View.
  7086. Category: General
  7087. Address: 0xD5C600
  7088. Example: tvSort [101,[0],false]
  7089. Arg1: [idc,[path],reversed]
  7090.  
  7091.  
  7092. Name: tvSortByValue
  7093. Description: Sorts childrens of given item by value. Param reversed is optional. IDC means id of parent Tree View.
  7094. Category: General
  7095. Address: 0xD5C760
  7096. Example: tvSort [101,[0],false]
  7097. Arg1: [idc,[path],reversed]
  7098.  
  7099.  
  7100. Name: tvText
  7101. Description: Returns shown text in the item on given path. IDC means id of parent Tree View.
  7102. Category: General
  7103. Address: 0xD5CAA0
  7104. Example: tvText [101,[0]]
  7105. Arg1: [idc, [path]]
  7106.  
  7107.  
  7108. Name: tvTooltip
  7109. Description: Returns the tooltip of the item in the given path of the treeview with id idc of the topmost user dialog.
  7110. Category: General
  7111. Address: 0xD5B870
  7112. Example: _text = lbText [101, 0]
  7113. Arg1: [idc, path]
  7114.  
  7115.  
  7116. Name: tvValue
  7117. Description: Returns scalar data from item on given path. IDC means id of parent Tree View.
  7118. Category: General
  7119. Address: 0xD5CC20
  7120. Example: tvValue [101,[0]]
  7121. Arg1: [idc, [path]]
  7122.  
  7123.  
  7124. Name: typeOf
  7125. Description: Returns the name of the type of the given object.
  7126. Category: General
  7127. Address: 0xD36690
  7128. Example: typeOf player
  7129. Ex. Returns: "SoldierWB"
  7130. Arg1: object
  7131.  
  7132.  
  7133. Name: UAVControl
  7134. Description: Get list with unit connected to vehicle and position in that vehicle.
  7135. Category: General
  7136. Address: 0xD6C490
  7137. Example: UAVControl cameraOn
  7138. Arg1: Uav
  7139.  
  7140.  
  7141. Name: uiNamespace
  7142. Description: Return the global namespace attached to user interface.
  7143. Category: General
  7144. Address: 0xD29890
  7145.  
  7146.  
  7147. Name: uisleep
  7148. Description: Suspend execution of script for given uitime.
  7149. Category: General
  7150. Address: 0xD6AD10
  7151. Example: uisleep 0.5
  7152. Arg1: delay
  7153.  
  7154.  
  7155. Name: unassignCurator
  7156. Description: Unassign curator (will destroy both sides of connection).
  7157. Category: General
  7158. Address: 0xD6C7C0
  7159. Arg1: curatorObj
  7160.  
  7161.  
  7162. Name: unassignTeam
  7163. Description: Unassigns the vehicle (its commander unit) from his team. This is equal to vehicle assignTeam "MAIN".
  7164. Category: General
  7165. Address: 0xD5EF70
  7166. Example: unassignTeam soldier2
  7167. Arg1: vehicle
  7168.  
  7169.  
  7170. Name: unassignVehicle
  7171. Description: The person is unassigned from the vehicle. If he is currently inside, the group leader will issue an order to disembark.
  7172. Category: General
  7173. Address: 0xD43C40
  7174. Example: unassignVehicle player
  7175. Arg1: unit
  7176.  
  7177.  
  7178. Name: underwater
  7179. Description: Return whether object is fully underwater.
  7180. Category: General
  7181. Address: 0xD38D90
  7182. Arg1: object
  7183.  
  7184.  
  7185. Name: uniform
  7186. Description: Returns name of currently used uniform.
  7187. Category: General
  7188. Address: 0xD43F20
  7189. Arg1: unit
  7190.  
  7191.  
  7192. Name: uniformContainer
  7193. Description: Returns container of currently used uniform.
  7194. Category: General
  7195. Address: 0xD43C90
  7196. Arg1: unit
  7197.  
  7198.  
  7199. Name: uniformItems
  7200. Description: Get array with all items from uniform.
  7201. Category: General
  7202. Address: 0xD43CB0
  7203. Arg1: unit
  7204.  
  7205.  
  7206. Name: uniformMagazines
  7207. Description: Get array with all magazines from vest.
  7208. Category: General
  7209. Address: 0xD43F00
  7210. Arg1: unit
  7211.  
  7212.  
  7213. Name: unitAddons
  7214. Description: Get list with addons which unitClass belongs to.
  7215. Category: General
  7216. Address: 0xCB0630
  7217. Example: unitAddons unitClass
  7218. Arg1: unitClass
  7219.  
  7220.  
  7221. Name: unitBackpack
  7222. Description: Returns unit's backpack.
  7223. Category: General
  7224. Address: 0xCB09C0
  7225. Arg1: unit
  7226.  
  7227.  
  7228. Name: unitPos
  7229. Description: Return the unit position rules.
  7230. Category: General
  7231. Address: 0xD36750
  7232. Arg1: person
  7233.  
  7234.  
  7235. Name: unitReady
  7236. Description: Checks whether the unit is ready. A unit is busy when it's given an order like "move", until the command is finished.
  7237. Category: General
  7238. Address: 0xD6F2C0
  7239. Example: unitReady player
  7240. Arg1: unit
  7241.  
  7242.  
  7243. Name: unitRecoilCoefficient
  7244. Description: Returns unit's custom recoil coefficient.
  7245. Category: General
  7246. Address: 0xCB0A40
  7247. Example: coef = unitRecoilCoefficient player
  7248. Arg1: soldier
  7249.  
  7250.  
  7251. Name: units
  7252. Description: Returns an array with all the units in the group of the given object. For a destroyed object an empty array is returned.
  7253. Category: General
  7254. Address: 0xCB4A70
  7255. Example: player in units player
  7256. Arg1: unit
  7257.  
  7258.  
  7259. Name: units
  7260. Description: Returns an array with all the units in the group.
  7261. Category: General
  7262. Address: 0xCB4A90
  7263. Example: player in units group player
  7264. Arg1: grp
  7265.  
  7266.  
  7267. Name: unlockAchievement
  7268. Description: Unlock the given achievement.
  7269. Category: General
  7270. Address: 0xC8D180
  7271. Arg1: name
  7272.  
  7273.  
  7274. Name: vectorDir
  7275. Description: Return object's direction vector in world coordinates as [x, z, y].
  7276. Category: General
  7277. Address: 0xD36A30
  7278. Arg1: obj
  7279.  
  7280.  
  7281. Name: vectorDirVisual
  7282. Description: Return object's direction vector in world coordinates as [x, z, y].
  7283. Category: General
  7284. Address: 0xD36A50
  7285. Arg1: obj
  7286.  
  7287.  
  7288. Name: vectorMagnitude
  7289. Description: Magnitude of a vector
  7290. Category: General
  7291. Address: 0x5CF640
  7292. Example: vectorMagnitude [0,8,7]
  7293. Arg1: array
  7294.  
  7295.  
  7296. Name: vectorMagnitudeSqr
  7297. Description: Squared magnitude of a vector
  7298. Category: General
  7299. Address: 0x5CF570
  7300. Example: vectorMagnitudeSqr [4,1,3]
  7301. Arg1: array
  7302.  
  7303.  
  7304. Name: vectorNormalized
  7305. Description: Normalized vector (unit vector), if original vector is zero, result is a zero vector as well
  7306. Category: General
  7307. Address: 0x5CF890
  7308. Example: vectorNormalized [4,1,3]
  7309. Arg1: array
  7310.  
  7311.  
  7312. Name: vectorUp
  7313. Description: Return object's up vector in world coordinates as [x, z, y].
  7314. Category: General
  7315. Address: 0xD36A70
  7316. Arg1: obj
  7317.  
  7318.  
  7319. Name: vectorUpVisual
  7320. Description: Return object's up vector in world coordinates as [x, z, y].
  7321. Category: General
  7322. Address: 0xD36A90
  7323. Arg1: obj
  7324.  
  7325.  
  7326. Name: vehicle
  7327. Description: Returns the vehicle in which the given unit is mounted. If there is none, the unit is returned.
  7328. Category: General
  7329. Address: 0xD43FF0
  7330. Example: vehicle player != player
  7331. Arg1: unit
  7332.  
  7333.  
  7334. Name: vehicles
  7335. Description: Return a list of vehicles in the current mission.
  7336. Category: General
  7337. Address: 0xCB1130
  7338. Example: _vehicles = vehicles
  7339.  
  7340.  
  7341. Name: vehicleVarName
  7342. Description: Returns the name of the variable which contains a reference to this object.
  7343. Category: General
  7344. Address: 0xD71400
  7345. Arg1: object
  7346.  
  7347.  
  7348. Name: velocity
  7349. Description: Returns the velocity (speed vector) of the vehicle as an array with format [x, z, y].
  7350. Category: General
  7351. Address: 0xD36AB0
  7352. Arg1: vehicle
  7353.  
  7354.  
  7355. Name: velocityModelSpace
  7356. Description: Returns the velocity (speed vector) of the vehicle as an array with format [x, z, y]. Vector is in model space
  7357. Category: General
  7358. Address: 0xD36B90
  7359. Arg1: vehicle
  7360.  
  7361.  
  7362. Name: verifySignature
  7363. Description: Check if file is signed by any key present in game keys folders. Note: On client, it does not check against the keys accepted by server.
  7364. Category: General
  7365. Address: 0xD57930
  7366. Arg1: filename
  7367.  
  7368.  
  7369. Name: vest
  7370. Description: Returns name of currently used vest.
  7371. Category: General
  7372. Address: 0xD444D0
  7373. Arg1: unit
  7374.  
  7375.  
  7376. Name: vestContainer
  7377. Description: Returns container of currently used vest.
  7378. Category: General
  7379. Address: 0xD441A0
  7380. Arg1: unit
  7381.  
  7382.  
  7383. Name: vestItems
  7384. Description: Get array with all items from vest.
  7385. Category: General
  7386. Address: 0xD441C0
  7387. Arg1: unit
  7388.  
  7389.  
  7390. Name: vestMagazines
  7391. Description: Get array with all magazines from vest.
  7392. Category: General
  7393. Address: 0xD444B0
  7394. Arg1: unit
  7395.  
  7396.  
  7397. Name: viewDistance
  7398. Description: Returns the rendering distance.
  7399. Category: General
  7400. Address: 0xCB1190
  7401.  
  7402.  
  7403. Name: visibleCompass
  7404. Description: Checks whether the player has the compass opened and visible.
  7405. Category: General
  7406. Address: 0xCB69C0
  7407.  
  7408.  
  7409. Name: visibleGps
  7410. Description: Checks whether the player has the GPS receiver opened and visible.
  7411. Category: General
  7412. Address: 0xCB7FD0
  7413.  
  7414.  
  7415. Name: visibleMap
  7416. Description: Return true if the main map is shown (active).
  7417. Category: General
  7418. Address: 0xCB8550
  7419.  
  7420.  
  7421. Name: visiblePosition
  7422. Description: Returns the object rendered position in format <ar>Position</ar>.
  7423. Category: General
  7424. Address: 0xD36C90
  7425. Example: visiblePosition player
  7426. Arg1: object
  7427.  
  7428.  
  7429. Name: visiblePositionASL
  7430. Description: Returns the object rendered position in format <ar>PositionASL</ar>.
  7431. Category: General
  7432. Address: 0xD36D90
  7433. Example: visiblePositionASL player
  7434. Arg1: object
  7435.  
  7436.  
  7437. Name: visibleWatch
  7438. Description: Checks whether the player has the watch opened and visible.
  7439. Category: General
  7440. Address: 0xCB8D90
  7441.  
  7442.  
  7443. Name: waves
  7444. Description: Return waves value.
  7445. Category: General
  7446. Address: 0xCB11E0
  7447.  
  7448.  
  7449. Name: waypointAttachedObject
  7450. Description: Gets the object attached to the waypoint.
  7451. Category: General
  7452. Address: 0xD74B10
  7453. Example: waypointAttachedObject [groupOne, 1]
  7454. Arg1: waypoint
  7455.  
  7456.  
  7457. Name: waypointAttachedVehicle
  7458. Description: Gets the vehicle attached to the waypoint.
  7459. Category: General
  7460. Address: 0xD74C00
  7461. Example: waypointAttachedVehicle [groupOne, 1]
  7462. Arg1: waypoint
  7463.  
  7464.  
  7465. Name: waypointBehaviour
  7466. Description: Gets the waypoint behavior.
  7467. Category: General
  7468. Address: 0xD74C80
  7469. Example: waypointBehaviour [groupOne, 1]
  7470. Arg1: waypoint
  7471.  
  7472.  
  7473. Name: waypointCombatMode
  7474. Description: Gets the waypoint combat mode.
  7475. Category: General
  7476. Address: 0xD74CF0
  7477. Example: waypointCombatMode [groupOne, 1]
  7478. Arg1: waypoint
  7479.  
  7480.  
  7481. Name: waypointCompletionRadius
  7482. Description: Gets the radius around the waypoint where is the waypoint completed.
  7483. Category: General
  7484. Address: 0xD74D60
  7485. Example: _radius = waypointCompletionRadius [groupOne, 1]
  7486. Arg1: waypoint
  7487.  
  7488.  
  7489. Name: waypointDescription
  7490. Description: Gets the waypoint description.
  7491. Category: General
  7492. Address: 0xD74E00
  7493. Example: waypointDescription [groupOne, 1]
  7494. Arg1: waypoint
  7495.  
  7496.  
  7497. Name: waypointFormation
  7498. Description: Gets the waypoint formation.
  7499. Category: General
  7500. Address: 0xD74E70
  7501. Example: waypointFormation [groupOne, 1]
  7502. Arg1: waypoint
  7503.  
  7504.  
  7505. Name: waypointHousePosition
  7506. Description: Gets the house position assigned to the waypoint.
  7507. Category: General
  7508. Address: 0xD74EE0
  7509. Example: waypointHousePosition [groupOne, 1]
  7510. Arg1: waypoint
  7511.  
  7512.  
  7513. Name: waypointLoiterRadius
  7514. Description: Gets the waypoint loiter radius. Waypoint uses format <ar>Waypoint</ar>.
  7515.  
  7516. Category: General
  7517. Address: 0xD74F40
  7518. Example: waypointLoiterRadius [groupOne, 1]
  7519. Arg1: waypoint
  7520.  
  7521.  
  7522. Name: waypointLoiterType
  7523. Description: Gets the waypoint loiter type. Waypoint uses format <ar>Waypoint</ar>.
  7524.  
  7525. Category: General
  7526. Address: 0xD75050
  7527. Example: waypointLoiterRadius [groupOne, 1]
  7528. Arg1: waypoint
  7529.  
  7530.  
  7531. Name: waypointName
  7532. Description: Gets the waypoint name.
  7533. Category: General
  7534. Address: 0xD751F0
  7535. Example: waypointName [groupOne, 1]
  7536. Arg1: waypoint
  7537.  
  7538.  
  7539. Name: waypointPosition
  7540. Description: Gets the waypoint position. Waypoint uses format <ar>Waypoint</ar>.
  7541. Note: this function is identical to <f>getWaypointPosition</f>.
  7542. Category: General
  7543. Address: 0xD771C0
  7544. Example: waypointPosition [groupOne, 1]
  7545. Arg1: waypoint
  7546.  
  7547.  
  7548. Name: waypoints
  7549. Description: Return the list of waypoints for given group.
  7550. Category: General
  7551. Address: 0xCB3440
  7552. Arg1: group
  7553.  
  7554.  
  7555. Name: waypointScript
  7556. Description: Gets the waypoint script.
  7557. Category: General
  7558. Address: 0xD75260
  7559. Example: waypointScript [groupOne, 1]
  7560. Arg1: waypoint
  7561.  
  7562.  
  7563. Name: waypointShow
  7564. Description: Gets the waypoint show/hide status.
  7565. Category: General
  7566. Address: 0xD752D0
  7567. Example: waypointShow [groupOne, 1]
  7568. Arg1: waypoint
  7569.  
  7570.  
  7571. Name: waypointSpeed
  7572. Description: Gets the waypoint speed.
  7573. Category: General
  7574. Address: 0xD75340
  7575. Example: waypointSpeed [groupOne, 1]
  7576. Arg1: waypoint
  7577.  
  7578.  
  7579. Name: waypointStatements
  7580. Description: Gets the waypoint statements.
  7581. Category: General
  7582. Address: 0xD753B0
  7583. Example: waypointStatements [groupOne, 1]
  7584. Arg1: waypoint
  7585.  
  7586.  
  7587. Name: waypointTimeout
  7588. Description: Gets the waypoint timeout values.
  7589. Category: General
  7590. Address: 0xD75470
  7591. Example: waypointTimeout [groupOne, 1]
  7592. Arg1: waypoint
  7593.  
  7594.  
  7595. Name: waypointTimeoutCurrent
  7596. Description: Gets the current waypoint timeout or -1 if countdown is not in progress.
  7597. Category: General
  7598. Address: 0xD75540
  7599. Example: waypointTimeoutCurrent groupOne
  7600. Arg1: waypoint
  7601.  
  7602.  
  7603. Name: waypointType
  7604. Description: Gets the waypoint type.
  7605. Category: General
  7606. Address: 0xD755E0
  7607. Example: waypointType [groupOne, 1]
  7608. Arg1: waypoint
  7609.  
  7610.  
  7611. Name: waypointVisible
  7612. Description: Gets waypoint visibility.
  7613. Category: General
  7614. Address: 0xD75650
  7615. Example: visible = waypointVisible [groupOne, 1]
  7616. Arg1: waypoint
  7617.  
  7618.  
  7619. Name: weaponCargo
  7620. Description: Get array with weapons from ammo box (or any general weapon holder container).
  7621. Category: General
  7622. Address: 0xD44500
  7623. Arg1: box
  7624.  
  7625.  
  7626. Name: weaponInertia
  7627. Description: Returns current rate of how much the weapon view is distorted because of quick aiming
  7628. Category: General
  7629. Address: 0x5CEE90
  7630. Example: weaponInertia player
  7631. Arg1: soldier
  7632.  
  7633.  
  7634. Name: weaponLowered
  7635. Description: True if given soldier's weapon is lowered.
  7636. Category: General
  7637. Address: 0xD38F40
  7638. Example: weaponLowered player
  7639. Arg1: soldier
  7640.  
  7641.  
  7642. Name: weapons
  7643. Description: Returns an array of names of all the vehicle's weapons.
  7644. Category: General
  7645. Address: 0xD30CE0
  7646. Example: weapons player
  7647. Arg1: vehicle
  7648.  
  7649.  
  7650. Name: weaponsItems
  7651. Description: Returns an array with subarrays contains class names and also names of connected items of all the vehicle's weapons like [['arifle_MX_ACO_pointer_F','','acc_pointer_IR','optic_Aco',['30Rnd_65x39_caseless_mag',29]]]
  7652. Category: General
  7653. Address: 0xD30D00
  7654. Example: weaponsItems player
  7655. Arg1: vehicle
  7656.  
  7657.  
  7658. Name: weaponsItemsCargo
  7659. Description: Returns an array with subarrays contains class names and also names of connected items of all the vehicle's cargo weapons like [['arifle_MX_ACO_pointer_F','','acc_pointer_IR','optic_Aco',['30Rnd_65x39_caseless_mag',29]]]
  7660. Category: General
  7661. Address: 0xD30EB0
  7662. Example: weaponsItemsCargo vehicle player
  7663. Arg1: vehicle
  7664.  
  7665.  
  7666. Name: weaponState
  7667. Description: Returns the current weapon state as an array of strings in the follow format [WeaponName, MuzzleName, ModeName, MagazineName].
  7668. Category: General
  7669. Address: 0xD37890
  7670. Example: weaponState player or weaponState [vehicle player,[0]]
  7671. Arg1: Gunner or [veh,turret path]
  7672.  
  7673.  
  7674. Name: weightRTD
  7675. Description: Returns weight of helicopter.
  7676. Category: General
  7677. Address: 0xCB1600
  7678. Example: [fuselage weight, crew weight, fuel weight, custom weight, weapons weight]
  7679. Arg1: helicopter
  7680.  
  7681.  
  7682. Name: west
  7683. Description: The West side.
  7684. Category: General
  7685. Address: 0xD57560
  7686.  
  7687.  
  7688. Name: WFSideText
  7689. Description: Returns the unlocalized text value of a object's side as: East, West, Resistance, Civilian, or Unknown.
  7690. Category: General
  7691. Address: 0xD74160
  7692. Example: WFSideText player
  7693. Arg1: object
  7694.  
  7695.  
  7696. Name: WFSideText
  7697. Description: Returns the unlocalized text value of a group's side as: East, West, Resistance, Civilian, or Unknown.
  7698. Category: General
  7699. Address: 0xD74070
  7700. Example: WFSideText group player
  7701. Arg1: group
  7702.  
  7703.  
  7704. Name: wind
  7705. Description: Return the current wind vector.
  7706. Category: General
  7707. Address: 0xCB17D0
  7708.  
  7709.  
  7710. Name: windDir
  7711. Description: Return the current wind azimut.
  7712. Category: General
  7713. Address: 0xCB1860
  7714.  
  7715.  
  7716. Name: windRTD
  7717. Description: Returns wind strength and direction.
  7718. Category: General
  7719. Address: 0xCB18C0
  7720.  
  7721.  
  7722. Name: windStr
  7723. Description: Return the current wind strength.
  7724. Category: General
  7725. Address: 0xCB1A10
  7726.  
  7727.  
  7728. Name: wingsForcesRTD
  7729. Description: Returns force produced by wings.
  7730. Category: General
  7731. Address: 0xCB1A50
  7732. Arg1: RTD_helicopter
  7733.  
  7734.  
  7735. Name: worldName
  7736. Description: Return the name of the currently loaded world.
  7737. Category: General
  7738. Address: 0xCB25B0
  7739.  
  7740.  
  7741. Name: worldToScreen
  7742. Description: Converts position in world space into screen (UI) space.
  7743. Category: General
  7744. Address: 0xD76F00
  7745. Arg1: position
Add Comment
Please, Sign In to add comment