Guest User

Untitled

a guest
Mar 19th, 2015
570
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 387.27 KB | None | 0 0
  1. -
  2. Left Argument: a
  3. Description: "unary minus: zero minus a"
  4. Example: - - 3
  5. Example Return: 3
  6. Category: Default
  7. @e
  8. -
  9. Left Argument: a
  10. Right Argument: b
  11. Description: "a minus b"
  12. Example: counter - 1
  13. Category: Default
  14. @e
  15. -
  16. Left Argument: a
  17. Description: "unary minus: zero minus a"
  18. Example: - - 3
  19. Example Return: 3
  20. Category: Default
  21. @e
  22. -
  23. Left Argument: a
  24. Right Argument: b
  25. Description: "a minus b"
  26. Example: counter - 1
  27. Category: Default
  28. @e
  29. !
  30. Left Argument: a
  31. Description: "not a"
  32. Example: !true
  33. Example Return: false
  34. Category: Default
  35. @e
  36. !
  37. Left Argument: a
  38. Description: "not a"
  39. Example: !true
  40. Example Return: false
  41. Category: Default
  42. @e
  43. !=
  44. Left Argument: a
  45. Right Argument: b
  46. Description: "a is not equal to b"
  47. Example: counter != 4
  48. Category: Default
  49. @e
  50. !=
  51. Left Argument: a
  52. Right Argument: b
  53. Description: "a is not equal to b"
  54. Example: counter != 4
  55. Category: Default
  56. @e
  57. %
  58. Left Argument: a
  59. Right Argument: b
  60. Description: "The remainder of a divided by b. Note that the remainder is calculated in the real domain."
  61. Example: 4.5 % 3
  62. Example Return: 1.5
  63. Category: Default
  64. @e
  65. %
  66. Left Argument: a
  67. Right Argument: b
  68. Description: "The remainder of a divided by b. Note that the remainder is calculated in the real domain."
  69. Example: 4.5 % 3
  70. Example Return: 1.5
  71. Category: Default
  72. @e
  73. &&
  74. Left Argument: a
  75. Right Argument: b
  76. Description: "a and b"
  77. Example: alive player && alive leader player
  78. Category: Default
  79. @e
  80. &&
  81. Left Argument: a
  82. Right Argument: b
  83. Description: "a and b"
  84. Example: alive player && alive leader player
  85. Category: Default
  86. @e
  87. *
  88. Left Argument: a
  89. Right Argument: b
  90. Description: "a multiplied by b"
  91. Example: iCounter*3
  92. Category: Default
  93. @e
  94. *
  95. Left Argument: a
  96. Right Argument: b
  97. Description: "a multiplied by b"
  98. Example: iCounter*3
  99. Category: Default
  100. @e
  101. /
  102. Left Argument: a
  103. Right Argument: b
  104. Description: "a divided by b"
  105. Example: enemyStrenght/3
  106. Category: Default
  107. @e
  108. /
  109. Left Argument: a
  110. Right Argument: b
  111. Description: "a divided by b"
  112. Example: enemyStrenght/3
  113. Category: Default
  114. @e
  115. :
  116. Left Argument: a
  117. Right Argument: b
  118. Description: "see switch"
  119. Category: Default
  120. @e
  121. :
  122. Left Argument: a
  123. Right Argument: b
  124. Description: "see switch"
  125. Category: Default
  126. @e
  127. ^
  128. Left Argument: a
  129. Right Argument: b
  130. Description: "a raised to the power of b"
  131. Example: count^4
  132. Category: Default
  133. @e
  134. ^
  135. Left Argument: a
  136. Right Argument: b
  137. Description: "a raised to the power of b"
  138. Example: count^4
  139. Category: Default
  140. @e
  141. ||
  142. Left Argument: a
  143. Right Argument: b
  144. Description: "a or b"
  145. Example: !alive player || !alive leader player
  146. Category: Default
  147. @e
  148. ||
  149. Left Argument: a
  150. Right Argument: b
  151. Description: "a or b"
  152. Example: !alive player || !alive leader player
  153. Category: Default
  154. @e
  155. +
  156. Left Argument: a
  157. Right Argument: b
  158. Description: "a plus b"
  159. Example: counter + 1
  160. Category: Default
  161. @e
  162. +
  163. Left Argument: a
  164. Right Argument: b
  165. Description: "a plus b"
  166. Example: counter + 1
  167. Category: Default
  168. @e
  169. +
  170. Left Argument: a
  171. Description: "unary plus: returns a"
  172. Example: +4
  173. Example Return: 4
  174. Category: Default
  175. @e
  176. +
  177. Left Argument: a
  178. Description: "unary plus: returns a"
  179. Example: +4
  180. Example Return: 4
  181. Category: Default
  182. @e
  183. <
  184. Left Argument: a
  185. Right Argument: b
  186. Description: "a lesser than b"
  187. Example: counter < 4
  188. Category: Default
  189. @e
  190. <
  191. Left Argument: a
  192. Right Argument: b
  193. Description: "a lesser than b"
  194. Example: counter < 4
  195. Category: Default
  196. @e
  197. <=
  198. Left Argument: a
  199. Right Argument: b
  200. Description: "a lesser or equal than b"
  201. Example: player distance redCar <= 100
  202. Category: Default
  203. @e
  204. <=
  205. Left Argument: a
  206. Right Argument: b
  207. Description: "a lesser or equal than b"
  208. Example: player distance redCar <= 100
  209. Category: Default
  210. @e
  211. ==
  212. Left Argument: a
  213. Right Argument: b
  214. Description: "a equal to b"
  215. Example: counter == 4
  216. Category: Default
  217. @e
  218. ==
  219. Left Argument: a
  220. Right Argument: b
  221. Description: "a equal to b"
  222. Example: counter == 4
  223. Category: Default
  224. @e
  225. >
  226. Left Argument: a
  227. Right Argument: b
  228. Description: "a greater than b"
  229. Example: counter > 4
  230. Category: Default
  231. @e
  232. >
  233. Left Argument: a
  234. Right Argument: b
  235. Description: "a greater than b"
  236. Example: counter > 4
  237. Category: Default
  238. @e
  239. >=
  240. Left Argument: a
  241. Right Argument: b
  242. Description: "a greater or equal than b"
  243. Example: player distance redCar < 100
  244. Category: Default
  245. @e
  246. >=
  247. Left Argument: a
  248. Right Argument: b
  249. Description: "a greater or equal than b"
  250. Example: player distance redCar < 100
  251. Category: Default
  252. @e
  253. >>
  254. Left Argument: config
  255. Right Argument: name
  256. Description: "Returns subentry of config entry with given name."
  257. Example: configFile >> "CfgVehicles"
  258. Category: General
  259. @e
  260. abs
  261. Left Argument: x
  262. Description: "The absolute value of x."
  263. Example: abs -3
  264. Example Return: 3
  265. Category: Default
  266. @e
  267. abs
  268. Left Argument: x
  269. Description: "The absolute value of x."
  270. Example: abs -3
  271. Example Return: 3
  272. Category: Default
  273. @e
  274. accTime
  275. Description: "Returns the current time acceleration factor."
  276. Category: General
  277. @e
  278. acos
  279. Left Argument: x
  280. Description: "The arccosine of x, the result is in degrees."
  281. Example: acos 0.5
  282. Example Return: 60
  283. Category: Default
  284. @e
  285. acos
  286. Left Argument: x
  287. Description: "The arccosine of x, the result is in degrees."
  288. Example: acos 0.5
  289. Example Return: 60
  290. Category: Default
  291. @e
  292. action
  293. Left Argument: unit
  294. Right Argument: action
  295. Description: "Makes the unit peform an action. The format of action can be [type, target, param1, param2, param3]. Only type is required, target defaults to unit and param1, param2, param3 are type specific."
  296. Example: soldierOne action ["eject", vehicle soldierOne]
  297. Category: General
  298. @e
  299. actionKeys
  300. Left Argument: action
  301. Description: "Returns a list of dikCodes of buttons assigned to the given user action."
  302. Example: array = actionKeys "ReloadMagazine"
  303. Category: General
  304. @e
  305. actionKeysImages
  306. Left Argument: action or [action, maxKeys]
  307. 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."
  308. Example: text = actionKeysImages "ReloadMagazine"
  309. Category: General
  310. @e
  311. actionKeysNames
  312. Left Argument: action or [action, maxKeys] or [action, maxKeys, inputDevicePriority]
  313. 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."
  314. Example: list = actionKeysNames "ReloadMagazine"
  315. Category: General
  316. @e
  317. actionKeysNamesArray
  318. Left Argument: action or [action, maxKeys] or [action, maxKeys, inputDevicePriority]
  319. 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."
  320. Example: list = actionKeysNames "ReloadMagazine"
  321. Category: General
  322. @e
  323. actionName
  324. Left Argument: action
  325. Description: "Returns localized name of action."
  326. Example: name = actionName "ReloadMagazine"
  327. Category: General
  328. @e
  329. activateAddons
  330. Left Argument: [addon1, ...]
  331. Description: "Activates the listed addons. The list of active addons is reinitialized during this function."
  332. Example: activateAddons ["BISOFP"]
  333. Category: General
  334. @e
  335. activatedAddons
  336. Category: General
  337. @e
  338. activateKey
  339. Left Argument: keyName
  340. 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."
  341. Example: activateKey "M04"
  342. Category: General
  343. @e
  344. addAction
  345. Left Argument: unit
  346. Right Argument: [action, script filename or code(, arguments, priority, showWindow, hideOnUse, shortcut, condition)]
  347. Description: "Creates an action and returns its ID. It uses the following algorithm: the first action added to the given vehicle has ID zero, the next vehicle has ID one, etc."
  348. Example: player addAction ["Hello", "hello.sqs"]; player addAction ["Hello2", { hint "Hello!"} ]
  349. Category: General
  350. @e
  351. addBackpack
  352. Left Argument: unit
  353. Right Argument: backpackName
  354. Description: "Adds the backpack to the unit. "
  355. Example: player addBackpack "usbackpack"
  356. Category: General
  357. @e
  358. addBackpackCargo
  359. Left Argument: unit
  360. Right Argument: backpacks
  361. Description: "Adds bacpacks to the cargo space. The format of backpacks is [backpacksName, count].
  362. For backpacksName values see <cl>CfgWeapons</cl>."
  363. Example: rearmTruckOne addBackpackCargo ["DSHKM_TK_GUE_Bag_EP1", 2]
  364. Category: General
  365. @e
  366. addBackpackCargoGlobal
  367. Left Argument: unit
  368. Right Argument: backpacks
  369. Description: "Adds bacpacks to the cargo space. MP synchronized. The format of backpacks is [backpacksName, count].
  370. For backpacksName values see <cl>CfgWeapons</cl>."
  371. Example: rearmTruckOne addBackpackCargo ["DSHKM_TK_GUE_Bag_EP1", 2]
  372. Category: General
  373. @e
  374. addBackpackGlobal
  375. Left Argument: unit
  376. Right Argument: backpackName
  377. Description: "Adds the backpack to the unit(even non-local) "
  378. Example: player addBackpackGlobal "usbackpack"
  379. Category: General
  380. @e
  381. addCamShake
  382. Left Argument: [power, duration, frquency]
  383. Description: "Adds camera shake source."
  384. Category: General
  385. @e
  386. addCuratorAddons
  387. Left Argument: curatorObj
  388. Right Argument: [addons]
  389. Description: "Allow curator use of given addon."
  390. Example: curator addCuratorAddons [addon1, addon2]
  391. Category: General
  392. @e
  393. addCuratorCameraArea
  394. Left Argument: curatorObj
  395. Right Argument: [cameraAreaID, [position],radius]
  396. Description: "Adds or changes curator camera area (depends on if ID is allready used)"
  397. Category: General
  398. @e
  399. addCuratorEditableObjects
  400. Left Argument: curatorObj
  401. Right Argument: [[objects],addCrew = true]
  402. Description: "Register objects which can be edited by a curator."
  403. Example: 0 addCuratorEditableObjects [cursorTarget, true]
  404. Category: General
  405. @e
  406. addCuratorEditingArea
  407. Left Argument: curatorObj
  408. Right Argument: [editAreaID, [position], radius]
  409. Description: "Adds or changes curator edit area (depends on if ID is allready used)"
  410. Category: General
  411. @e
  412. addCuratorPoints
  413. Left Argument: curatorObj
  414. Right Argument: number of points
  415. Description: "Adds or removes curator points."
  416. Example: 0 addCuratorPoints 0.5
  417. Category: General
  418. @e
  419. addEditorObject
  420. Left Argument: map
  421. Right Argument: [type, [name1, value1, ...], subtype class]
  422. Description: "Add an object to the editor and assign arguments. Create script is called with _new equal to true. Returns the ID of the new EditorObject. Subtype class is optional."
  423. Category: Editor
  424. @e
  425. addEventHandler
  426. Left Argument: object
  427. Right Argument: handler
  428. Description: "The format of handler is [type,command]. Check scripting topic Event handlers for more information. The index of the currently added handler is returned."
  429. Example: player addEventHandler ["killed",{_this exec "playerKilled.sqs"}]
  430. Category: General
  431. @e
  432. addForceGeneratorRTD
  433. Left Argument: [bool enabled, int type, vec3 strengh, vec3 position, vec3 radius, vec3 orientation, object AttachTo]
  434. Description: "Add force generator to world. Returns force index."
  435. Category: General
  436. @e
  437. addGoggles
  438. Left Argument: unit
  439. Right Argument: type
  440. Description: "Create a new item and try to link them into goggles slot."
  441. Category: General
  442. @e
  443. addGroupIcon
  444. Left Argument: group
  445. Right Argument: properties
  446. Description: "Add icon to a group. Returns icon ID"
  447. Example: id = group addGroupIcon["b_inf",[offsetX,ofsetY]]
  448. Category: General
  449. @e
  450. addHandgunItem
  451. Left Argument: unit
  452. Right Argument: item
  453. Description: "Adds item to the weapon cargo space. This is used for infantry weapons."
  454. Example: player addHandgunItem "ItemClassName"
  455. Category: General
  456. @e
  457. addHeadgear
  458. Left Argument: unit
  459. Right Argument: weapons
  460. Description: "Create a new item and try to link them into headgear slot"
  461. Category: General
  462. @e
  463. addItem
  464. Left Argument: unit
  465. Right Argument: item
  466. Description: "Create new item and store it to to the inventory. "
  467. Category: General
  468. @e
  469. addItemCargo
  470. Left Argument: unit
  471. Right Argument: [item, count]
  472. Description: "Create new items and store them to the weapon holder."
  473. Example: rearmTruckOne addItemCargo ["optic_ARCO", 10]
  474. Category: General
  475. @e
  476. addItemCargoGlobal
  477. Left Argument: unit
  478. Right Argument: [item, count]
  479. Description: "Create new items and store them to the weapon holder."
  480. Example: rearmTruckOne addItemCargo ["optic_ARCO", 10]
  481. Category: General
  482. @e
  483. addItemPool
  484. Description: "Adds count items of type name into the weapon pool (used in the campaign to transfer weapons to the next mission)."
  485. Category: General
  486. @e
  487. addItemToBackpack
  488. Left Argument: unit
  489. Right Argument: item
  490. Description: "Create new item and store it to soldier's backpack"
  491. Category: General
  492. @e
  493. addItemToUniform
  494. Left Argument: unit
  495. Right Argument: item
  496. Description: "Create new item and store it to soldier's uniform"
  497. Category: General
  498. @e
  499. addItemToVest
  500. Left Argument: unit
  501. Right Argument: item
  502. Description: "Create new item and store it to soldier's vest"
  503. Category: General
  504. @e
  505. addLiveStats
  506. Left Argument: unit
  507. Right Argument: score
  508. Description: "Xbox Live MP only: adds score to the Xbox Live Statistics score for the given unit (or the commander unit of the given vehicle)."
  509. Example: player addLiveStats 10
  510. Category: General
  511. @e
  512. addMagazine
  513. Left Argument: unit
  514. Right Argument: magazineName
  515. Description: "Adds a magazine to the unit. Note: you may create invalid combinations by using this function, for example by adding 20 grenades. When doing so, application behaviour is undefined."
  516. Example: player addMagazine "M16"
  517. Category: General
  518. @e
  519. AddMagazineAmmoCargo
  520. Left Argument: unit
  521. Right Argument: magazines
  522. Description: "Adds magazines to the weapon cargo space. This is used for infantry weapons. MP synchronized. The format of magazines is [magazineName, count, ammo].
  523. For magazineName values see <cl>CfgWeapons</cl>."
  524. Example: rearmTruckOne AddMagazineAmmoCargo ["M16", 2,12]
  525. Category: General
  526. @e
  527. addMagazineCargo
  528. Left Argument: unit
  529. Right Argument: magazines
  530. Description: "Adds magazines to the weapon cargo space. This is used for infantry weapons. The format of magazines is [magazineName, count].
  531. For magazineName values see <cl>CfgWeapons</cl>."
  532. Example: rearmTruckOne addMagazineCargo ["M16", 10]
  533. Category: General
  534. @e
  535. addMagazineCargoGlobal
  536. Left Argument: unit
  537. Right Argument: magazines
  538. Description: "Adds magazines to the weapon cargo space. This is used for infantry weapons. MP synchronized. The format of magazines is [magazineName, count].
  539. For magazineName values see <cl>CfgWeapons</cl>."
  540. Example: rearmTruckOne addMagazineCargo ["M16", 10]
  541. Category: General
  542. @e
  543. addMagazineGlobal
  544. Left Argument: unit
  545. Right Argument: magazineName
  546. Description: "Adds a magazine to the unit. Note: you may create invalid combinations by using this function, for example by adding 20 grenades. When doing so, application behaviour is undefined."
  547. Example: player addMagazineGlobal "M16"
  548. Category: General
  549. @e
  550. addMagazinePool
  551. Description: "Adds count magazines of type name into the weapon pool (used in the campaign to transfer weapons to the next mission)."
  552. Category: General
  553. @e
  554. addMagazines
  555. Left Argument: unit
  556. Right Argument: [magazineName, count]
  557. Description: "Adds magazines to the unit."
  558. Example: player addMagazines ["magazine name",count]
  559. Category: General
  560. @e
  561. addMagazineTurret
  562. Left Argument: transport
  563. Right Argument: [weaponName, turret path]
  564. Description: "Adds a magazine to the turret. Use turret path [-1] for driver's turret. Note: you may create invalid combinations by using this function, for example by adding 20 grenades. When doing so, application behaviour is undefined."
  565. Example: player addMagazine "M16"
  566. Category: General
  567. @e
  568. addMenu
  569. Left Argument: map
  570. Right Argument: [text,priority]
  571. Description: "Adds a new menu button. Priority is optional."
  572. Category: Editor
  573. @e
  574. addMenuItem
  575. Left Argument: map
  576. Right Argument: [menu or index,text,command,priority]
  577. Description: "Creates a new menu item. Menu can be "file" or "view", index is index as returned from addMenu command. priority is optional and determines where in the menu the item will reside (higher priority items first)."
  578. Category: Editor
  579. @e
  580. addMissionEventHandler
  581. Left Argument: [type, command]
  582. 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."
  583. Example: _id = addMissionEventHandler ["ended",{_this exec "missionEnded.sqs"}]
  584. Category: General
  585. @e
  586. addMPEventHandler
  587. Left Argument: object
  588. Right Argument: handler
  589. Description: "The format of handler is [type,command]. Check scripting topic Event handlers for more information. The index of the currently added handler is returned."
  590. Example: player addMPEventHandler ["mpkilled",{_this exec "playerKilled.sqs"}]
  591. Category: General
  592. @e
  593. addMusicEventHandler
  594. Left Argument: [type, function]
  595. Description: "Add an music track event handler. Returns id of the handler or -1 when failed."
  596. Example: _id = addMusicEventHandler ["MusicStart", "hint format['Sample %1 start', _this select 0]"]
  597. Category: General
  598. @e
  599. addPrimaryWeaponItem
  600. Left Argument: unit
  601. Right Argument: item
  602. Description: "Adds item to the weapon cargo space of primary weapon."
  603. Example: player addPrimaryWeaponItem "ItemClassName"
  604. Category: General
  605. @e
  606. addPublicVariableEventHandler
  607. Left Argument: name
  608. Right Argument: code
  609. Description: "Create an event handler for given variable. The event handler will be executed when some client in MP exports a variable using publicVariable on all clients except the publishing one."
  610. Example: "alarm" addPublicVariableEventHandler {_this execVM "alarm.sqf"}
  611. Category: General
  612. @e
  613. addRating
  614. Left Argument: unit
  615. Right Argument: number
  616. Description: "Adds number to the unit rating. This is usually used to reward for completed mission objectives. The rating for killed enemies and killed friendlies is adjusted automatically. When the rating is lower than zero, a unit is considered "renegade" and is an enemy to everyone."
  617. Example: player addRating 1000
  618. Category: General
  619. @e
  620. addResources
  621. Left Argument: teamMember
  622. Right Argument: [resource1, resource2, ...]
  623. Description: "Add (register) resources to the team member."
  624. Example: teamMember _agent addResources ["Arms", "Legs"]
  625. Category: Agents
  626. @e
  627. addScore
  628. Left Argument: unit
  629. Right Argument: score
  630. Description: "MP only: adds unit score. This is shown in the "I" MP screen as the total score."
  631. Example: player addScore 10
  632. Category: General
  633. @e
  634. addScoreSide
  635. Left Argument: side
  636. Right Argument: score
  637. Description: "MP only: adds side score. This is shown in the "I" MP screen as the total score."
  638. Example: side addScore 10
  639. Category: General
  640. @e
  641. addSecondaryWeaponItem
  642. Left Argument: unit
  643. Right Argument: item
  644. Description: "Adds item to the weapon cargo space of secondary weapon."
  645. Example: player addSecondaryWeaponItem "ItemClassName"
  646. Category: General
  647. @e
  648. addSwitchableUnit
  649. Left Argument: person
  650. Description: "Add a unit into the list of units available for team switch."
  651. Category: General
  652. @e
  653. addTeamMember
  654. Left Argument: team
  655. Right Argument: member
  656. Description: "Add given member to given team."
  657. Example: _team addTeamMember _teamMember
  658. Category: Agents
  659. @e
  660. addToRemainsCollector
  661. Left Argument: array
  662. Description: "Flags given objects to me managed by unitRemove manager"
  663. Example: addToRemainsCollector [unit1, unit2]
  664. Category: General
  665. @e
  666. addUniform
  667. Left Argument: unit
  668. Right Argument: type
  669. Description: "Create a new uniform and try to link it into uniform slot(given uniform has to be supported by allowedUniforms list of target soldier)."
  670. Category: General
  671. @e
  672. addVehicle
  673. Left Argument: group
  674. Right Argument: vehicle
  675. Description: "Tells the group it owns the vehicle now."
  676. Category: General
  677. @e
  678. addVest
  679. Left Argument: unit
  680. Right Argument: type
  681. Description: "Create a new vest and try to link it into vest slot."
  682. Category: General
  683. @e
  684. addWaypoint
  685. Left Argument: group
  686. Right Argument: [center, radius] or [center, radius, index] or [center, radius, index, name]
  687. Description: "Adds (or inserts when index is given) a new waypoint to a group. The waypoint is placed randomly in a circle with the given center and radius. The function returns a waypoint with format [group, index]."
  688. Example: grp addWaypoint [position player, 0]
  689. Category: General
  690. @e
  691. addWeapon
  692. Left Argument: unit
  693. Right Argument: weaponName
  694. Description: "Adds the weapon to the unit. Note: you may create invalid combinations by using this function, for example by adding two rifles. When doing so, application behaviour is undefined."
  695. Example: player addWeapon "AK74"
  696. Category: General
  697. @e
  698. addWeaponCargo
  699. Left Argument: unit
  700. Right Argument: weapons
  701. Description: "Adds weapons to the weapon cargo space. This is used for infantry weapons. The format of weapons is [weaponName, count].
  702. For weaponName values see <cl>CfgWeapons</cl>."
  703. Example: rearmTruckOne addWeaponCargo ["M16", 10]
  704. Category: General
  705. @e
  706. addWeaponCargoGlobal
  707. Left Argument: unit
  708. Right Argument: weapons
  709. Description: "Adds weapons to the weapon cargo space. This is used for infantry weapons. MP synchronized. The format of weapons is [weaponName, count].
  710. For weaponName values see <cl>CfgWeapons</cl>."
  711. Example: rearmTruckOne addWeaponCargo ["M16", 10]
  712. Category: General
  713. @e
  714. addWeaponGlobal
  715. Left Argument: unit
  716. Right Argument: weaponName
  717. Description: "Adds the weapon to the unit. Note: you may create invalid combinations by using this function, for example by adding two rifles. When doing so, application behaviour is undefined."
  718. Example: player addWeaponGlobal "AK74"
  719. Category: General
  720. @e
  721. addWeaponItem
  722. Left Argument: unit
  723. Right Argument: [weapon,item]
  724. Description: "Adds item to the weapon cargo space of a given weapon."
  725. Example: player addWeaponItem ["WeaponClassName","ItemClassName"]
  726. Category: General
  727. @e
  728. addWeaponPool
  729. Left Argument: [name, count]
  730. Description: "Adds count weapons of type name into the weapon pool (used in campaigns to transfer weapons to the next mission)."
  731. Category: General
  732. @e
  733. addWeaponTurret
  734. Left Argument: vehicle
  735. Right Argument: [weaponName,turret array]
  736. Description: "Adds the weapon to the given vehicle's turret. "
  737. Example: vehicle player addWeaponTurret ["Horn",[0,0]]
  738. Category: General
  739. @e
  740. agent
  741. Left Argument: agent
  742. Description: "Return a person for given agent."
  743. Example: _person = agent _agent
  744. Category: Agents
  745. @e
  746. agents
  747. Description: "Return a list of agents in the current mission."
  748. Example: _agents = agents
  749. Category: Agents
  750. @e
  751. aimedAtTarget
  752. Left Argument: vehicle
  753. Right Argument: [target, weapon]
  754. Description: "Returns how good is weapon aimed to target."
  755. Example: bool = vehicle AimedAtTarget [target]; bool = vehicle AimedAtTarget [target,1]
  756. Category: General
  757. @e
  758. aimPos
  759. Left Argument: obj
  760. Description: "Returns the position of the object other units can aim to in format <ar>PositionASL</ar>."
  761. Example: aimPos player
  762. Category: General
  763. @e
  764. airDensityCurveRTD
  765. Description: "Returns air density curve graph."
  766. Category: General
  767. @e
  768. airDensityRTD
  769. Left Argument: altitude
  770. Description: "Returns air density in given altitude."
  771. Category: General
  772. @e
  773. airportSide
  774. Left Argument: airportId
  775. Description: "Checks a side of the airport."
  776. Example: airportSide 0
  777. Example Return: west
  778. Category: General
  779. @e
  780. AISFinishHeal
  781. Left Argument: [unit,unit,bool]
  782. Description: "AIS end state."
  783. Example: AISFinishHeal [wounded,medic,true]
  784. Category: General
  785. @e
  786. alive
  787. Left Argument: obj
  788. Description: "Checks whether the given person, vehicle or building is't dead / destroyed."
  789. Example: alive player
  790. Category: General
  791. @e
  792. allControls
  793. Left Argument: display
  794. Description: "Returns a list of all controls from given display."
  795. Category: General
  796. @e
  797. allCurators
  798. Description: "Returns list of all curators."
  799. Category: General
  800. @e
  801. allDead
  802. Description: "Return a list of dead units and destroyed vehicles. Dead unit might be inside vehicle.,"
  803. Category: General
  804. @e
  805. allDeadMen
  806. Description: "Return a list of dead units. Dead unit might be inside vehicle.,"
  807. Category: General
  808. @e
  809. allDisplays
  810. Description: "Returns list of all displays registered in engine."
  811. Category: General
  812. @e
  813. allGroups
  814. Description: "Return a list of all groups."
  815. Category: General
  816. @e
  817. allMapMarkers
  818. Description: "Return all markers in map."
  819. Category: General
  820. @e
  821. allMines
  822. Description: "Returns an array of all mines in game."
  823. Example: allMines
  824. Example Return: [listOfAllMines]
  825. Category: General
  826. @e
  827. allMissionObjects
  828. Left Argument: type
  829. Description: "Returns all mission objects with given type. "
  830. Example: allMissionObjects "Air"
  831. Category: General
  832. @e
  833. allow3DMode
  834. Left Argument: map
  835. Right Argument: bool
  836. Description: "Allow/dissallow 3D mode."
  837. Category: Editor
  838. @e
  839. allowCrewInImmobile
  840. Left Argument: vehicle
  841. Right Argument: bool
  842. Description: "If true, units can be in vehicle with broken tracks/wheels."
  843. Example: vehicle allowCrewInImmobile true
  844. Category: General
  845. @e
  846. allowCuratorLogicIgnoreAreas
  847. Left Argument: curatorObj
  848. Right Argument: allow?
  849. Description: "Allow curator placing and working with modules outside of edit areas."
  850. Example: curator allowCuratorLogicIgnoreAreas true
  851. Category: General
  852. @e
  853. allowDamage
  854. Left Argument: obj
  855. Right Argument: allow
  856. Description: "Obsolete."
  857. Category: General
  858. @e
  859. allowDammage
  860. Left Argument: obj
  861. Right Argument: allow
  862. Description: "Obsolete."
  863. Category: General
  864. @e
  865. allowFileOperations
  866. Left Argument: map
  867. Right Argument: bool
  868. Description: "Allow/dissallow file ops (load/save etc)."
  869. Category: Editor
  870. @e
  871. allowFleeing
  872. Left Argument: unit
  873. Right Argument: courage
  874. Description: "Sets the group courage. The less courage, the sooner the group will start fleeing. 0 means maximum courage, while 1 means always fleeing."
  875. Example: soldierOne allowFleeing 0
  876. Category: General
  877. @e
  878. allowGetIn
  879. Left Argument: unitArray
  880. Right Argument: allow
  881. Description: "Allows the getting in of vehicles of all units in the list."
  882. Example: [unitOne, unitTwo] allowGetIn false
  883. Category: General
  884. @e
  885. allSites
  886. Description: "Return a list of all sites."
  887. Category: General
  888. @e
  889. allTurrets
  890. Left Argument: [vehicle, includePersonTurrets]
  891. Description: "Returns array with turrets in given vehicle. TRUE FALSE stands for return person turrets"
  892. Example: allTurrets [vehicle player, true]
  893. Category: General
  894. @e
  895. allUnits
  896. Description: "Return a list of all units (all persons except agents)."
  897. Category: General
  898. @e
  899. allUnitsUAV
  900. Description: "Return a list of all UAV units."
  901. Category: General
  902. @e
  903. allVariables
  904. Left Argument: map
  905. Description: "Returns a list of all variables stored in given map."
  906. Category: Editor
  907. @e
  908. ammo
  909. Left Argument: gunner or vehicle
  910. Right Argument: magazine
  911. Description: "Counts how many shots the unit has left for the given magazine type."
  912. Example: player ammo "M16"
  913. Category: General
  914. @e
  915. and
  916. Left Argument: a
  917. Right Argument: b
  918. Description: "a and b"
  919. Example: alive player and alive leader player
  920. Category: Default
  921. @e
  922. and
  923. Left Argument: a
  924. Right Argument: b
  925. Description: "a and b"
  926. Example: alive player and alive leader player
  927. Category: Default
  928. @e
  929. animate
  930. Left Argument: object
  931. Right Argument: [animation, phase]
  932. Description: "Process animation on object. Animation is defined in config file. Wanted animation phase is set to phase."
  933. Example: house animate ["doors1", 1]
  934. Category: General
  935. @e
  936. animateDoor
  937. Left Argument: object
  938. Right Argument: [doorname, phase, now]
  939. Description: "Process animation of door on vehicle. Animation is defined in config file. Wanted animation phase is set to phase."
  940. Example: heli animateDoor ["doors1", 1, false]
  941. Category: General
  942. @e
  943. animationPhase
  944. Left Argument: object
  945. Right Argument: animation
  946. Description: "Return animation phase of animation on object."
  947. Example: house animationPhase "doors1"
  948. Category: General
  949. @e
  950. animationState
  951. Left Argument: man
  952. Description: "Return the name of the current primary animation."
  953. Category: General
  954. @e
  955. append
  956. Left Argument: arrayA
  957. Right Argument: arrayB
  958. Description: "Appends arrayB to arrayA"
  959. Example: arrayA=[0, 1]; arrayA append [2, 3]
  960. Example Return: [0, 1, 2, 3] in arrayA
  961. Category: Default
  962. @e
  963. append
  964. Left Argument: arrayA
  965. Right Argument: arrayB
  966. Description: "Appends arrayB to arrayA"
  967. Example: arrayA=[0, 1]; arrayA append [2, 3]
  968. Example Return: [0, 1, 2, 3] in arrayA
  969. Category: Default
  970. @e
  971. armoryPoints
  972. Description: "Return the stored value of armory points."
  973. Category: General
  974. @e
  975. asin
  976. Left Argument: x
  977. Description: "The arcsine of x, the result is in degrees."
  978. Example: asin 0.5
  979. Example Return: 30
  980. Category: Default
  981. @e
  982. asin
  983. Left Argument: x
  984. Description: "The arcsine of x, the result is in degrees."
  985. Example: asin 0.5
  986. Example Return: 30
  987. Category: Default
  988. @e
  989. ASLToATL
  990. Left Argument: pos
  991. Description: "Converts a position from <ar>PositionASL</ar> to <ar>Position</ar> format."
  992. Example: ASLToATL getPosASL player
  993. Category: General
  994. @e
  995. assert
  996. Left Argument: codition
  997. Description: "Tests a condition and if the condition is false, halts the program."
  998. Example: assert (_x>0)
  999. Category: Default
  1000. @e
  1001. assert
  1002. Left Argument: codition
  1003. Description: "Tests a condition and if the condition is false, halts the program."
  1004. Example: assert (_x>0)
  1005. Category: Default
  1006. @e
  1007. assignAsCargo
  1008. Left Argument: soldier
  1009. Right Argument: vehicle
  1010. Description: "Assigns the soldier to the cargo / passenger space of the given vehicle."
  1011. Example: player assignAsCargo tankOne
  1012. Category: General
  1013. @e
  1014. assignAsCargoIndex
  1015. Left Argument: soldier
  1016. Right Argument: [vehicle, index]
  1017. Description: "Assigns the character to a specific cargo / passenger index of the given vehicle."
  1018. Example: player assignAsCargoIndex [tankOne,1]
  1019. Category: General
  1020. @e
  1021. assignAsCommander
  1022. Left Argument: soldier
  1023. Right Argument: vehicle
  1024. Description: "Assigns the soldier as commander of the given vehicle."
  1025. Example: player assignAsCommander tankOne
  1026. Category: General
  1027. @e
  1028. assignAsDriver
  1029. Left Argument: soldier
  1030. Right Argument: vehicle
  1031. Description: "Assigns the soldier as driver of the given vehicle."
  1032. Example: player assignAsDriver tankOne
  1033. Category: General
  1034. @e
  1035. assignAsGunner
  1036. Left Argument: soldier
  1037. Right Argument: vehicle
  1038. Description: "Assigns the soldier as gunner of the given vehicle."
  1039. Example: player assignAsGunner tankOne
  1040. Category: General
  1041. @e
  1042. assignAsTurret
  1043. Left Argument: unit
  1044. Right Argument: [vehicle, [turretPath]]
  1045. Description: "Assigns the soldier to turret."
  1046. Example: player assignAsTurret [tankOne, [0,0]]
  1047. Category: General
  1048. @e
  1049. assignCurator
  1050. Left Argument: player
  1051. Right Argument: curatorObj
  1052. Description: "Assign player as curator. 2 players cannot act as one Zeus."
  1053. Example: player assignCurator curator
  1054. Category: General
  1055. @e
  1056. assignedCargo
  1057. Left Argument: vehicle
  1058. Description: "Returns the list of soldiers assigned to the given vehicle as a cargo."
  1059. Category: General
  1060. @e
  1061. assignedCommander
  1062. Left Argument: vehicle
  1063. Description: "Returns the soldier assigned to the given vehicle as a commander."
  1064. Category: General
  1065. @e
  1066. assignedDriver
  1067. Left Argument: vehicle
  1068. Description: "Returns the soldier assigned to the given vehicle as a driver."
  1069. Category: General
  1070. @e
  1071. assignedGunner
  1072. Left Argument: vehicle
  1073. Description: "Returns the soldier assigned to the given vehicle as a gunner."
  1074. Category: General
  1075. @e
  1076. assignedItems
  1077. Left Argument: unit
  1078. Description: "Get array with all assigned items."
  1079. Category: General
  1080. @e
  1081. assignedTarget
  1082. Left Argument: vehicle
  1083. Description: "Return the target assigned to the vehicle."
  1084. Category: General
  1085. @e
  1086. assignedTeam
  1087. Left Argument: vehicle
  1088. Description: "Checks which team does the vehicle (its commander unit) belong to."
  1089. Example: assignedTeam soldier2
  1090. Example Return: MAIN
  1091. Category: General
  1092. @e
  1093. assignedVehicle
  1094. Left Argument: person
  1095. Description: "Return the vehicle person is assigned to."
  1096. Category: General
  1097. @e
  1098. assignedVehicleRole
  1099. Left Argument: person
  1100. Description: "Return the position in vehicle person is assigned to."
  1101. Category: General
  1102. @e
  1103. assignItem
  1104. Left Argument: unit
  1105. Right Argument: item
  1106. Description: "Assigns existing item from inventory (uniform, vest, backpack) to a correct slot."
  1107. Category: General
  1108. @e
  1109. assignTeam
  1110. Left Argument: vehicle
  1111. Right Argument: team
  1112. Description: "Assigns the vehicle (specifically its commander unit) to the given team. The possible team values are: "MAIN", "RED", "GREEN", "BLUE" and "YELLOW"."
  1113. Example: soldier2 assignTeam "RED"
  1114. Category: General
  1115. @e
  1116. assignToAirport
  1117. Left Argument: airplane
  1118. Right Argument: airportId
  1119. Description: "Set airport to be used by AI on getout"
  1120. Example: plane assignToAirport 0
  1121. Category: General
  1122. @e
  1123. atan
  1124. Left Argument: x
  1125. Description: "The arctangens of x, the result is in degrees."
  1126. Example: atan 1
  1127. Example Return: 45
  1128. Category: Default
  1129. @e
  1130. atan
  1131. Left Argument: x
  1132. Description: "The arctangens of x, the result is in degrees."
  1133. Example: atan 1
  1134. Example Return: 45
  1135. Category: Default
  1136. @e
  1137. atan2
  1138. Left Argument: x
  1139. Right Argument: y
  1140. Description: "Returns the arctangens of x/y. The returned value is in degrees, in the range from -180 to +180, using the signs of both parameters to determine the quadrant of the returned value."
  1141. Example: 5 atan2 3
  1142. Example Return: 59.0362
  1143. Category: Default
  1144. @e
  1145. atan2
  1146. Left Argument: x
  1147. Right Argument: y
  1148. Description: "Returns the arctangens of x/y. The returned value is in degrees, in the range from -180 to +180, using the signs of both parameters to determine the quadrant of the returned value."
  1149. Example: 5 atan2 3
  1150. Example Return: 59.0362
  1151. Category: Default
  1152. @e
  1153. atg
  1154. Left Argument: x
  1155. Description: "The arctangens of x, the result is in degrees."
  1156. Example: atg 1
  1157. Example Return: 45
  1158. Category: Default
  1159. @e
  1160. atg
  1161. Left Argument: x
  1162. Description: "The arctangens of x, the result is in degrees."
  1163. Example: atg 1
  1164. Example Return: 45
  1165. Category: Default
  1166. @e
  1167. ATLToASL
  1168. Left Argument: pos
  1169. Description: "Converts a position from <ar>Position</ar> to <ar>PositionASL</ar> format."
  1170. Example: ATLToASL getPosATL player
  1171. Category: General
  1172. @e
  1173. attachedObject
  1174. Left Argument: location
  1175. Description: "Return object attached to given location."
  1176. Category: Location
  1177. @e
  1178. attachedObjects
  1179. Left Argument: Unit
  1180. Description: "Returns list of attached objects."
  1181. Example: attachedObjects player
  1182. Category: General
  1183. @e
  1184. attachedTo
  1185. Left Argument: Unit
  1186. Description: "Returns the object it is attach to."
  1187. Example: attachedTo player
  1188. Category: General
  1189. @e
  1190. attachObject
  1191. Left Argument: location
  1192. Right Argument: object
  1193. Description: "Attach a object to given location."
  1194. Category: Location
  1195. @e
  1196. attachTo
  1197. Left Argument: obj
  1198. Right Argument: [obj,offset,MemPoint]
  1199. Description: "Attaches an object to another object. The offset is applied to the object center unless a memory point is provided."
  1200. Example: player attachTo [car, [0,2,0],hatch1]
  1201. Category: General
  1202. @e
  1203. attackEnabled
  1204. Left Argument: group
  1205. Description: "Return whether leader can issue attack commands."
  1206. Category: General
  1207. @e
  1208. backpack
  1209. Left Argument: unit
  1210. Description: "Returns a class of a backpack."
  1211. Category: General
  1212. @e
  1213. backpackCargo
  1214. Left Argument: box
  1215. Description: "Get array with backpacks from ammo box (or any general weapon holder container)."
  1216. Category: General
  1217. @e
  1218. backpackContainer
  1219. Left Argument: unit
  1220. Description: "Returns container of a backpack."
  1221. Category: General
  1222. @e
  1223. backpackItems
  1224. Left Argument: unit
  1225. Description: "Get array with all items from backpack."
  1226. Category: General
  1227. @e
  1228. backpackMagazines
  1229. Left Argument: unit
  1230. Description: "Get array with all magazines from vest."
  1231. Category: General
  1232. @e
  1233. backpackSpaceFor
  1234. Left Argument: backpack
  1235. Right Argument: weapon or magazine type
  1236. Description: "Returns how much space is in backpack for given weapon or magazine."
  1237. Example: [weapons, magazines] = backpack backpackSpaceFor "m16"
  1238. Category: General
  1239. @e
  1240. behaviour
  1241. Left Argument: unit
  1242. Description: "Returns the behaviour mode of the given unit ("CARELESS","SAFE","AWARE","COMBAT" or "STEALTH")."
  1243. Example: behaviour player
  1244. Category: General
  1245. @e
  1246. benchmark
  1247. 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."
  1248. Example: ? benchmark>2000 : setviewdistance 2000
  1249. Category: General
  1250. @e
  1251. binocular
  1252. Left Argument: unit
  1253. Description: "Returns name of currently used binocular."
  1254. Category: General
  1255. @e
  1256. blufor
  1257. Description: "Pre-defined variable for the blufor side."
  1258. Category: General
  1259. @e
  1260. boundingBox
  1261. Left Argument: object
  1262. 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]]."
  1263. Category: General
  1264. @e
  1265. boundingBoxReal
  1266. Left Argument: obj
  1267. Description: "Returns a bounding box of given object in model coordinates space. The result is in format [[minX, minZ, minY], [maxX, maxZ, maxY]]."
  1268. Example: boundingBoxReal cursorTarget
  1269. Category: General
  1270. @e
  1271. boundingCenter
  1272. Left Argument: object
  1273. Description: "Returns the position of original (loaded) center of object in model coordinates. The result is in format [x, z, y]"
  1274. Category: General
  1275. @e
  1276. breakOut
  1277. Left Argument: name
  1278. Description: "Breaks block out scope named 'name'. Nil is returned."
  1279. Category: Default
  1280. @e
  1281. breakOut
  1282. Left Argument: name
  1283. Description: "Breaks block out scope named 'name'. Nil is returned."
  1284. Category: Default
  1285. @e
  1286. breakTo
  1287. Left Argument: name
  1288. Description: "Breaks block to scope named 'name'. Nil is returned."
  1289. Category: Default
  1290. @e
  1291. breakTo
  1292. Left Argument: name
  1293. Description: "Breaks block to scope named 'name'. Nil is returned."
  1294. Category: Default
  1295. @e
  1296. briefingName
  1297. Description: "Returns the name of the current briefing."
  1298. Category: General
  1299. @e
  1300. buildingExit
  1301. Left Argument: building
  1302. Right Argument: index
  1303. Description: "Returns the given indexed exit in a building. The returned value is in format <ar>Position</ar>."
  1304. Example: buildingExit [building, 1]
  1305. Category: General
  1306. @e
  1307. buildingPos
  1308. Left Argument: building
  1309. Right Argument: index
  1310. Description: "Returns the given indexed position in a building. The returned value is in format <ar>Position</ar>."
  1311. Example: building buildingPos 1
  1312. Category: General
  1313. @e
  1314. buldozer_EnableRoadDiag
  1315. Left Argument: enable
  1316. Category: General
  1317. @e
  1318. buldozer_IsEnabledRoadDiag
  1319. Description: "Is enabled road diag in buldozer?"
  1320. Example: true/false
  1321. Category: General
  1322. @e
  1323. buldozer_LoadNewRoads
  1324. Left Argument: path
  1325. Category: General
  1326. @e
  1327. buldozer_reloadOperMap
  1328. Description: "Reload oper map visible in costMap diag tool."
  1329. Category: General
  1330. @e
  1331. buttonAction
  1332. Left Argument: control
  1333. Description: "Returns the action assigned to the given button or active text. The action is any expression in this scripting language."
  1334. Example: _action = buttonAction _button
  1335. Category: General
  1336. @e
  1337. buttonSetAction
  1338. Left Argument: control
  1339. Right Argument: action
  1340. Description: "Assigns an action to the given button or active text. Action is any expression in this scripting language."
  1341. Example: _control buttonSetAction "player exec ""reply.sqs"""
  1342. Category: General
  1343. @e
  1344. buttonSetAction
  1345. Left Argument: [idc, action]
  1346. 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."
  1347. Example: buttonSetAction [100, "player exec ""reply.sqs"""]
  1348. Category: General
  1349. @e
  1350. cadetMode
  1351. Description: "Returns true if the mission is played in cadet mode and false in veteran mode."
  1352. Category: General
  1353. @e
  1354. call
  1355. Left Argument: pars
  1356. Right Argument: body
  1357. Description: "Executes the function body. Argument pars is passed as _this."
  1358. Example: [1,2] call {(_this select 0)+(_this select 1)}
  1359. Example Return: 3
  1360. Category: Default
  1361. @e
  1362. call
  1363. Left Argument: code
  1364. Description: "Executes the given code."
  1365. Example: call {"x=2"}
  1366. Category: Default
  1367. @e
  1368. call
  1369. Left Argument: pars
  1370. Right Argument: body
  1371. Description: "Executes the function body. Argument pars is passed as _this."
  1372. Example: [1,2] call {(_this select 0)+(_this select 1)}
  1373. Example Return: 3
  1374. Category: Default
  1375. @e
  1376. call
  1377. Left Argument: code
  1378. Description: "Executes the given code."
  1379. Example: call {"x=2"}
  1380. Category: Default
  1381. @e
  1382. callExtension
  1383. Left Argument: extension
  1384. Right Argument: functionWithArguments
  1385. Description: "Execute an extension function"
  1386. Example: handle = "pipes" callExtension "openPipe(pipe)"
  1387. Category: General
  1388. @e
  1389. camCommand
  1390. Left Argument: camera
  1391. Right Argument: command
  1392. Description: "Executes a command on the given camera / actor object. The "manual on" and "manual off" commands are recognized for all types. For the "camera" type, the following commands can be used: "inertia on" and "inertia off". For the "seagull" type it's one of: "landed" and "airborne"."
  1393. Example: _camera camCommand "Manual on"
  1394. Category: General
  1395. @e
  1396. camCommit
  1397. Left Argument: camera
  1398. Right Argument: time
  1399. Description: "Commits the camera changes smoothly over time. A time of zero results in an immediate change."
  1400. Example: _camera camCommit 5
  1401. Category: General
  1402. @e
  1403. camCommitPrepared
  1404. Left Argument: camera
  1405. Right Argument: time
  1406. Description: "Commits the prepared camera changes smoothly over time. A time of zero results in an immediate change."
  1407. Example: _camera camCommit 5
  1408. Category: General
  1409. @e
  1410. camCommitted
  1411. Left Argument: camera
  1412. Description: "Checks whether the camera has finished committing."
  1413. Example: camCommitted _camera
  1414. Category: General
  1415. @e
  1416. camConstuctionSetParams
  1417. Left Argument: camera
  1418. Right Argument: [[x,y,z],radius, max above land]
  1419. Description: "Sets construction camera parameters."
  1420. Example: _camera camConstuctionSetParams [getpos player,50,20]
  1421. Category: General
  1422. @e
  1423. camCreate
  1424. Left Argument: type
  1425. Right Argument: position
  1426. Description: "Creates a camera or an actor of the given type on the given initial position (format <ar>Position</ar>). Its type is one of "CAMERA" or "SEAGULL"."
  1427. Example: _camera = camCreate getPos player
  1428. Category: General
  1429. @e
  1430. camDestroy
  1431. Left Argument: camera
  1432. Description: "Destroys the camera."
  1433. Category: General
  1434. @e
  1435. cameraEffect
  1436. Left Argument: camera
  1437. Right Argument: effect
  1438. Description: "Switches the camera to the given vehicle / camera. The format of effect is [name, position]. Name is one of: "Internal", "External", "Fixed" or "FixedWithZoom". Position is one of: "TOP", "LEFT", "RIGHT", "FRONT" or "BACK" ("BACK" is normally used)."
  1439. Example: cameraEffect ["External", "Back"]
  1440. Category: General
  1441. @e
  1442. cameraEffectEnableHUD
  1443. Left Argument: enable
  1444. Description: "Enable / disable showing of in-game UI during currently active camera effect."
  1445. Category: General
  1446. @e
  1447. cameraInterest
  1448. Left Argument: entity
  1449. Description: "Return camera interest for given entity."
  1450. Category: General
  1451. @e
  1452. cameraOn
  1453. Description: "Returns the vehicle to which the camera is attached."
  1454. Category: General
  1455. @e
  1456. cameraView
  1457. Description: "Return type of camera."
  1458. Category: General
  1459. @e
  1460. campaignConfigFile
  1461. Description: "Return root of campaign description.ext entries hierarchy."
  1462. Category: General
  1463. @e
  1464. camPreload
  1465. Left Argument: camera
  1466. Right Argument: time
  1467. Description: "Preload the scene for he prepared camera. Time gives timeout, zero means no (infinite) timeout."
  1468. Example: _camera camCommit 5
  1469. Category: General
  1470. @e
  1471. camPreloaded
  1472. Left Argument: camera
  1473. Description: "Checks whether the camera has finished preloading."
  1474. Example: camPreloaded _camera
  1475. Category: General
  1476. @e
  1477. camPrepareBank
  1478. Left Argument: camera
  1479. Right Argument: bank
  1480. Description: "Prepares the camera bank angle. See also <f>camPreload</f> and <f>camCommitPrepared</f>."
  1481. Example: _camera camPrepareBank -0.1
  1482. Category: General
  1483. @e
  1484. camPrepareDir
  1485. Left Argument: camera
  1486. Right Argument: direction
  1487. Description: "Prepares the camera heading. See also <f>camPreload</f> and <f>camCommitPrepared</f>."
  1488. Example: _camera camPrepareDir 150
  1489. Category: General
  1490. @e
  1491. camPrepareDive
  1492. Left Argument: camera
  1493. Right Argument: dive
  1494. Description: "Prepares the camera dive angle. See also <f>camPreload</f> and <f>camCommitPrepared</f>."
  1495. Example: _camera camPrepareDive -0.1
  1496. Category: General
  1497. @e
  1498. camPrepareFocus
  1499. Left Argument: camera
  1500. Right Argument: focusRange
  1501. Description: "focusRange is in format [distance,blur].
  1502. Prepares the camera focus blur. See also <f>camPreload</f> and <f>camCommitPrepared</f>."
  1503. Example: _camera camPrepareFocus [50, 1]
  1504. Category: General
  1505. @e
  1506. camPrepareFov
  1507. Left Argument: camera
  1508. Right Argument: fieldOfView
  1509. Description: "Prepares the camera field of view (zoom). See also <f>camPreload</f> and <f>camCommitPrepared</f>."
  1510. Example: _camera camPrepareFov 0.1
  1511. Category: General
  1512. @e
  1513. camPrepareFovRange
  1514. Left Argument: camera
  1515. Right Argument: fovRange
  1516. Description: "Prepares the camera field of view range for auto zooming. See also <f>camPreload</f> and <f>camCommitPrepared</f>."
  1517. Example: _camera camPrepareFovRange [0.1, 0.5]
  1518. Category: General
  1519. @e
  1520. camPreparePos
  1521. Left Argument: camera
  1522. Right Argument: position
  1523. Description: "Prepares the camera position (format <ar>Position</ar>). See also <f>camPreload</f> and <f>camCommitPrepared</f>."
  1524. Example: _camera camPreparePos getPos player
  1525. Category: General
  1526. @e
  1527. camPrepareRelPos
  1528. Left Argument: camera
  1529. Right Argument: position
  1530. Description: "Prepares the camera position relative to the current position of the currect target (see <f>camPrepareTarget</f>). See also <f>camPreload</f> and <f>camCommitPrepared</f>."
  1531. Example: _camera camPrepareRelPos [10,5]
  1532. Category: General
  1533. @e
  1534. camPrepareTarget
  1535. Left Argument: camera
  1536. Right Argument: target
  1537. Description: "Prepares the camera target. See also <f>camPreload</f> and <f>camCommitPrepared</f>."
  1538. Example: _camera camPrepareTarget player
  1539. Category: General
  1540. @e
  1541. camSetBank
  1542. Left Argument: camera
  1543. Right Argument: bank
  1544. Description: "Sets the camera bank angle. It does not automatically commit changes."
  1545. Example: _camera camSetBank -0.1
  1546. Category: General
  1547. @e
  1548. camSetDir
  1549. Left Argument: camera
  1550. Right Argument: direction
  1551. Description: "Sets the camera heading. It does not automatically commit changes."
  1552. Example: _camera camSetDir 150
  1553. Category: General
  1554. @e
  1555. camSetDive
  1556. Left Argument: camera
  1557. Right Argument: dive
  1558. Description: "Sets the camera dive angle. It does not automatically commit changes."
  1559. Example: _camera camSetDive -0.1
  1560. Category: General
  1561. @e
  1562. camSetFocus
  1563. Left Argument: camera
  1564. Right Argument: focusRange
  1565. Description: "focusRange is in format [distance,blur].
  1566. Sets the camera focus blur. It does not automatically commit changes."
  1567. Example: _camera camSetFocus [50, 1]
  1568. Category: General
  1569. @e
  1570. camSetFov
  1571. Left Argument: camera
  1572. Right Argument: fieldOfView
  1573. Description: "Sets the camera field of view (zoom). It does not automatically commit changes."
  1574. Example: _camera camSetFov 0.1
  1575. Category: General
  1576. @e
  1577. camSetFovRange
  1578. Left Argument: camera
  1579. Right Argument: fovRange
  1580. Description: "Sets the camera field of view range for auto zooming. It does not automatically commit changes."
  1581. Example: _camera camSetFovRange [0.1, 0.5]
  1582. Category: General
  1583. @e
  1584. camSetPos
  1585. Left Argument: camera
  1586. Right Argument: position
  1587. Description: "Sets the camera position (format <ar>Position</ar>). It does not automatically commit changes."
  1588. Example: _camera camSetPos getPos player
  1589. Category: General
  1590. @e
  1591. camSetRelPos
  1592. Left Argument: camera
  1593. Right Argument: position
  1594. Description: "Sets the camera position relative to the current position of the currect target (see <f>camSetTarget</f>). It does not automatically commit changes."
  1595. Example: _camera camSetRelPos [10,5]
  1596. Category: General
  1597. @e
  1598. camSetTarget
  1599. Left Argument: camera
  1600. Right Argument: target
  1601. Description: "Sets the camera target. It does not automatically commit changes."
  1602. Example: _camera camSetTarget player
  1603. Category: General
  1604. @e
  1605. camTarget
  1606. Left Argument: camera
  1607. Description: "Returns camera's target."
  1608. Example: camTarget _camera
  1609. Category: General
  1610. @e
  1611. camUseNVG
  1612. Left Argument: set
  1613. Description: "Set / clear using of night vision during cutscenes."
  1614. Category: General
  1615. @e
  1616. canAdd
  1617. Left Argument: unit
  1618. Right Argument: item
  1619. Description: "Check if given object can be stored into target entity"
  1620. Category: General
  1621. @e
  1622. canAddItemToBackpack
  1623. Left Argument: unit
  1624. Right Argument: item
  1625. Description: "Check if given object can be stored into soldier's uniform"
  1626. Category: General
  1627. @e
  1628. canAddItemToUniform
  1629. Left Argument: unit
  1630. Right Argument: item
  1631. Description: "Check if given object can be stored into soldier's uniform"
  1632. Category: General
  1633. @e
  1634. canAddItemToVest
  1635. Left Argument: unit
  1636. Right Argument: item
  1637. Description: "Check if given object can be stored into soldier's uniform"
  1638. Category: General
  1639. @e
  1640. cancelSimpleTaskDestination
  1641. Left Argument: task
  1642. Description: "Cancels a simple task destination"
  1643. Category: Identity
  1644. @e
  1645. canFire
  1646. Left Argument: vehicle
  1647. Description: "Checks whether the given vehicle is able to fire. It does not check for ammo, only for damage."
  1648. Example: canFire vehicle player
  1649. Category: General
  1650. @e
  1651. canMove
  1652. Left Argument: vehicle
  1653. Description: "Checks whether the given vehicle is able to move. It does not test for fuel, only the damage status is checked."
  1654. Example: canMove vehicle player
  1655. Category: General
  1656. @e
  1657. canSlingLoad
  1658. Left Argument: vehicle
  1659. Right Argument: cargo
  1660. Description: "Returns true if it is possible to sling load cargo"
  1661. Example: veh1 canSlingLoad veh2
  1662. Category: General
  1663. @e
  1664. canStand
  1665. Left Argument: soldier
  1666. Description: "Checks whether the given soldier is able to stand up."
  1667. Example: canStand player
  1668. Category: General
  1669. @e
  1670. canUnloadInCombat
  1671. Left Argument: vehicle
  1672. Description: "Check if cargo of this vehicle want to get out when in combat."
  1673. Category: General
  1674. @e
  1675. captive
  1676. Left Argument: unit
  1677. Description: "Checks whether the unit is a captive. If the unit is a vehicle, its commander is checked instead."
  1678. Example: captive player
  1679. Category: General
  1680. @e
  1681. captiveNum
  1682. Left Argument: unit
  1683. Description: "Checks whether the unit is a captive. If the unit is a vehicle, its commander is checked instead."
  1684. Example: captive player
  1685. Category: General
  1686. @e
  1687. case
  1688. Left Argument: b
  1689. Description: "see switch"
  1690. Category: Default
  1691. @e
  1692. case
  1693. Left Argument: b
  1694. Description: "see switch"
  1695. Category: Default
  1696. @e
  1697. catch
  1698. Left Argument: try-Block
  1699. Right Argument: code
  1700. Description: "processes code, when exception is thrown in <f>try</f> block"
  1701. Category: Default
  1702. @e
  1703. catch
  1704. Left Argument: try-Block
  1705. Right Argument: code
  1706. Description: "processes code, when exception is thrown in <f>try</f> block"
  1707. Category: Default
  1708. @e
  1709. cbChecked
  1710. Left Argument: control
  1711. Description: "Returns the current state of CheckBox."
  1712. Example: _checked = cbChecked _myCheckBox
  1713. Category: General
  1714. @e
  1715. cbSetChecked
  1716. Left Argument: control
  1717. Right Argument: enabled
  1718. Description: "Sets the current state of CheckBox."
  1719. Example: _myCheckBox cbSetChecked true;
  1720. Category: General
  1721. @e
  1722. ceil
  1723. Left Argument: x
  1724. Description: "The ceil value of x."
  1725. Example: ceil 5.25
  1726. Example Return: 6
  1727. Category: Default
  1728. @e
  1729. ceil
  1730. Left Argument: x
  1731. Description: "The ceil value of x."
  1732. Example: ceil 5.25
  1733. Example Return: 6
  1734. Category: Default
  1735. @e
  1736. cheatsEnabled
  1737. Description: "Checks whether cheats are enabled (whether the designers' version is running)."
  1738. Category: General
  1739. @e
  1740. checkAIFeature
  1741. Left Argument: feature
  1742. Description: "Check if given AI feature is currently enabled."
  1743. Category: General
  1744. @e
  1745. civilian
  1746. Description: "The Civilian side."
  1747. Category: General
  1748. @e
  1749. className
  1750. Left Argument: location
  1751. Description: "Return short name of location. (used for scripting)"
  1752. Category: Location
  1753. @e
  1754. clearAllItemsFromBackpack
  1755. Left Argument: unit
  1756. Description: "Removes all items from the backpack."
  1757. Category: General
  1758. @e
  1759. clearBackpackCargo
  1760. Left Argument: box
  1761. Description: "Removes all backpacks from ammo box (or any general weapon holder container)."
  1762. Example: clearBackpackCargo jeepOne
  1763. Category: General
  1764. @e
  1765. clearBackpackCargoGlobal
  1766. Left Argument: unit
  1767. Description: "Removes all magazines from the vehicle cargo space. MP synchronized."
  1768. Example: clearMagazineCargoGlobal jeepOne
  1769. Category: General
  1770. @e
  1771. clearForcesRTD
  1772. Description: "Remove all force generators from wolrd."
  1773. Category: General
  1774. @e
  1775. clearGroupIcons
  1776. Left Argument: group
  1777. Description: "Removes all icon from group."
  1778. Example: clearGroupIcons group
  1779. Category: General
  1780. @e
  1781. clearItemCargo
  1782. Left Argument: box
  1783. Description: "Removes all items from ammo box (or any general weapon holder container)."
  1784. Example: clearItemCargo jeepOne
  1785. Category: General
  1786. @e
  1787. clearItemCargoGlobal
  1788. Left Argument: box
  1789. Description: "Removes all items from ammo box (or any general weapon holder container)."
  1790. Example: clearItemCargoGlobal jeepOne
  1791. Category: General
  1792. @e
  1793. clearItemPool
  1794. Description: "Removes all magazines from the weapon pool (this is used in campaigns to transfer weapons to the next mission)."
  1795. Category: General
  1796. @e
  1797. clearMagazineCargo
  1798. Left Argument: unit
  1799. Description: "Removes all magazines from the vehicle cargo space."
  1800. Example: clearMagazineCargo jeepOne
  1801. Category: General
  1802. @e
  1803. clearMagazineCargoGlobal
  1804. Left Argument: unit
  1805. Description: "Removes all magazines from the vehicle cargo space. MP synchronized."
  1806. Example: clearMagazineCargoGlobal jeepOne
  1807. Category: General
  1808. @e
  1809. clearMagazinePool
  1810. Description: "Removes all magazines from the weapon pool (this is used in campaigns to transfer weapons to the next mission)."
  1811. Category: General
  1812. @e
  1813. clearOverlay
  1814. Left Argument: map
  1815. Description: "Clear the current overlay."
  1816. Example: clearOverlay _map
  1817. Category: Editor
  1818. @e
  1819. clearRadio
  1820. Description: "Clean up the content of radio protocol history."
  1821. Category: General
  1822. @e
  1823. clearWeaponCargo
  1824. Left Argument: unit
  1825. Description: "Removes all weapons from the vehicle cargo space."
  1826. Example: clearWeaponCargo jeepOne
  1827. Category: General
  1828. @e
  1829. clearWeaponCargoGlobal
  1830. Left Argument: unit
  1831. Description: "Removes all weapons from the vehicle cargo space. MP synchronized."
  1832. Example: clearWeaponCargoGlobal jeepOne
  1833. Category: General
  1834. @e
  1835. clearWeaponPool
  1836. Description: "Removes all weapons from the weapon pool (this is used in campaigns to transfer weapons to the next mission)."
  1837. Category: General
  1838. @e
  1839. closeDialog
  1840. Left Argument: idc
  1841. Description: "Closes the topmost user dialog as if a button with id idc was pressed."
  1842. Example: closeDialog 1
  1843. Category: General
  1844. @e
  1845. closeDisplay
  1846. Left Argument: display
  1847. Right Argument: exitcode
  1848. Description: "Close given display."
  1849. Example: _display closeDisplay IDC_OK
  1850. Category: General
  1851. @e
  1852. closeOverlay
  1853. Left Argument: map
  1854. Description: "Closes the current overlay without committing."
  1855. Category: Editor
  1856. @e
  1857. collapseObjectTree
  1858. Left Argument: map
  1859. Description: "Collapse the object tree."
  1860. Example: collapseObjectTree _map
  1861. Category: Editor
  1862. @e
  1863. collectiveRTD
  1864. Left Argument: RTD_helicopter
  1865. Description: "Returns collective."
  1866. Category: General
  1867. @e
  1868. combatMode
  1869. Left Argument: grp
  1870. Description: "Returns the combat mode of the given unit ("BLUE","GREEN","YELLOW" or "RED")."
  1871. Example: combatMode group player
  1872. Category: General
  1873. @e
  1874. commandArtilleryFire
  1875. Left Argument: unit
  1876. Right Argument: [position, type, rounds]
  1877. Description: "Orders a unit to reaload defined magazine commence fire burst on the given position (via the radio)."
  1878. Example: mortar1 commandArtilleryFire [[3000, 120, 1000], "8Rnd_82mm_Mo_shells", 3]
  1879. Category: General
  1880. @e
  1881. commandChat
  1882. Left Argument: unit
  1883. Right Argument: chatText
  1884. Description: "Types text to the command radio channel.
  1885. 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."
  1886. Example: soldierOne commandChat "Show this text"
  1887. Category: General
  1888. @e
  1889. commander
  1890. Left Argument: vehicle
  1891. Description: "Returns the commander of the vehicle. If the vehicle is not a vehicle, but a person, the person is returned instead."
  1892. Example: commander vehicle player
  1893. Category: General
  1894. @e
  1895. commandFire
  1896. Left Argument: unit
  1897. Right Argument: target
  1898. Description: "Orders a unit to commence firing on the given target (via the radio). If the target is objNull, the unit is ordered to commence firing on its current target (set using doTarget or commandTarget)."
  1899. Example: soldierOne commandFire player
  1900. Category: General
  1901. @e
  1902. commandFollow
  1903. Left Argument: unit
  1904. Right Argument: formationLeader
  1905. Description: "Orders a unit to follow the given unit (via the radio)."
  1906. Example: soldierOne commandFollow player
  1907. Category: General
  1908. @e
  1909. commandFSM
  1910. Left Argument: unit(s)
  1911. Right Argument: [fsm name, position, target]
  1912. Description: "Orders a unit to process command defined by FSM file (via the radio)."
  1913. Example: soldierOne commandFSM ["move.fsm", position player, player]
  1914. Category: General
  1915. @e
  1916. commandGetOut
  1917. Left Argument: unit
  1918. Description: "Orders the unit to get out from the vehicle (via the radio)."
  1919. Example: commandGetOut unitOne
  1920. Category: General
  1921. @e
  1922. commandingMenu
  1923. Description: "Return the name of the topmost commanding menu."
  1924. Category: General
  1925. @e
  1926. commandMove
  1927. Left Argument: unit
  1928. Right Argument: position
  1929. Description: "Orders the unit to move to the given position (format <ar>Position</ar>) (via the radio)."
  1930. Example: soldierOne commandMove getMarkerPos "MarkerMoveOne"
  1931. Category: General
  1932. @e
  1933. commandRadio
  1934. Left Argument: unit
  1935. Right Argument: radioName
  1936. Description: "Sends the message to the command radio channel. The message is defined in the description.ext file or radio protocol."
  1937. Example: soldierOne commandRadio "messageOne"
  1938. Category: General
  1939. @e
  1940. commandStop
  1941. Left Argument: unit
  1942. Description: "Orders the unit to stop (via the radio).
  1943. Note: the stop command is never finished; the unit will never be ready."
  1944. Example: commandStop unitOne
  1945. Category: General
  1946. @e
  1947. commandTarget
  1948. Left Argument: unit
  1949. Right Argument: position
  1950. Description: "Orders the unit to target the given target (via the radio)."
  1951. Example: soldierOne commandTarget player
  1952. Category: General
  1953. @e
  1954. commandWatch
  1955. Left Argument: unit
  1956. Right Argument: position
  1957. Description: "Orders the unit to watch the given position (format <ar>Position</ar>) (via the radio)."
  1958. Example: soldierOne commandWatch getMarkerPos "MarkerMoveOne"
  1959. Category: General
  1960. @e
  1961. comment
  1962. Left Argument: comment
  1963. Description: "This function does nothing. It's used to create comments."
  1964. Example: comment "This is a comment."
  1965. Category: Default
  1966. @e
  1967. comment
  1968. Left Argument: comment
  1969. Description: "This function does nothing. It's used to create comments."
  1970. Example: comment "This is a comment."
  1971. Category: Default
  1972. @e
  1973. commitOverlay
  1974. Left Argument: map
  1975. Description: "Commit the current overlay."
  1976. Example: commitOverlay _map
  1977. Category: Editor
  1978. @e
  1979. compile
  1980. Left Argument: expression
  1981. Description: "Compile expression."
  1982. Example: _function = "a = a + 1"; _compiled = compile _function; call _compiled;
  1983. Category: Default
  1984. @e
  1985. compile
  1986. Left Argument: expression
  1987. Description: "Compile expression."
  1988. Example: _function = "a = a + 1"; _compiled = compile _function; call _compiled;
  1989. Category: Default
  1990. @e
  1991. compileFinal
  1992. Left Argument: expression
  1993. Description: "Compile expression. Expression cannot be ovverriden."
  1994. Example: _function = "a = a + 1"; _compiled = compile _function; call _compiled;
  1995. Category: Default
  1996. @e
  1997. compileFinal
  1998. Left Argument: expression
  1999. Description: "Compile expression. Expression cannot be ovverriden."
  2000. Example: _function = "a = a + 1"; _compiled = compile _function; call _compiled;
  2001. Category: Default
  2002. @e
  2003. completedFSM
  2004. Left Argument: FSM handle
  2005. Description: "Check whether the given FSM completes. The FSM handle is the number returned by the execFSM command."
  2006. Category: General
  2007. @e
  2008. composeText
  2009. Left Argument: [text1, text2, ...]
  2010. Description: "Creates a structured text by joining the given structured or plain texts."
  2011. Example: txt = composeText ["First line", image "data\isniper.paa", lineBreak, "Second line"]
  2012. Category: General
  2013. @e
  2014. configClasses
  2015. Left Argument: condition
  2016. Right Argument: config
  2017. Description: "Returns an array of config entries which meet the criteria in the code."
  2018. Example: (getnumber _x >> vbs_entity) == 1 configClasses (configfile >> CfgWeapons)
  2019. Category: General
  2020. @e
  2021. configFile
  2022. Description: "Return root of config entries hierarchy."
  2023. Category: General
  2024. @e
  2025. configName
  2026. Left Argument: config
  2027. Description: "Returns name of config entry."
  2028. Example: _name = configName (configFile >> "CfgVehicles")
  2029. Example Return: "CfgVehicles"
  2030. Category: General
  2031. @e
  2032. configProperties
  2033. Left Argument: [config, condition, includeInherited]
  2034. 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."
  2035. Category: General
  2036. @e
  2037. configSourceMod
  2038. Left Argument: config
  2039. Description: "Returns modDir of the mod that given config class was loaded from."
  2040. Example: configSourceMod (configFile >> "CfgVehicles" >> "Car")
  2041. Category: General
  2042. @e
  2043. configSourceModList
  2044. Left Argument: config
  2045. Description: "Returns an array of mods which moddified the given config class."
  2046. Example: configSourceModList (configFile >> "CfgVehicles" >> "Car")
  2047. Category: General
  2048. @e
  2049. connectTerminalToUAV
  2050. Left Argument: person
  2051. Right Argument: UAV
  2052. Description: "Connect person with UAV terminal to UAV unit, or disconnect when UAV==objNull"
  2053. Example: player connectTerminalToUAV cursorTarget/objNull
  2054. Category: General
  2055. @e
  2056. controlNull
  2057. Description: "A non-existing control. This value is not equal to anything, including itself."
  2058. Category: General
  2059. @e
  2060. copyFromClipboard
  2061. Description: "Return the content of the (text) clipboard."
  2062. Category: General
  2063. @e
  2064. copyToClipboard
  2065. Left Argument: text
  2066. Description: "Copy the text to the clipboard."
  2067. Category: General
  2068. @e
  2069. copyWaypoints
  2070. Left Argument: groupTo
  2071. Right Argument: groupFrom
  2072. Description: "Copy the chain of waypoints from source to target group. The target group will start to process waypoints from the first one."
  2073. Category: General
  2074. @e
  2075. cos
  2076. Left Argument: x
  2077. Description: "The cosine of x, the argument is in degrees."
  2078. Example: cos 60
  2079. Example Return: 0.5
  2080. Category: Default
  2081. @e
  2082. cos
  2083. Left Argument: x
  2084. Description: "The cosine of x, the argument is in degrees."
  2085. Example: cos 60
  2086. Example Return: 0.5
  2087. Category: Default
  2088. @e
  2089. count
  2090. Left Argument: condition
  2091. Right Argument: array
  2092. Description: "Counts the elements in the array for which the given condition is true.
  2093.  
  2094. It is calculated as follows:
  2095.  
  2096. 1) Set the count to 0.
  2097. 2) For each element in the array assign an element as _x and evaluate the condition expression. If it's true, increase the count."
  2098. Example: "_x > 2" count [0, 1, 1, 2, 3, 3]
  2099. Example Return: 2
  2100. Category: Default
  2101. @e
  2102. count
  2103. Left Argument: array
  2104. Description: "The number of elements in the array."
  2105. Example: count [0,0,1,2]
  2106. Example Return: 4
  2107. Category: Default
  2108. @e
  2109. count
  2110. Left Argument: condition
  2111. Right Argument: array
  2112. Description: "Counts the elements in the array for which the given condition is true.
  2113.  
  2114. It is calculated as follows:
  2115.  
  2116. 1) Set the count to 0.
  2117. 2) For each element in the array assign an element as _x and evaluate the condition expression. If it's true, increase the count."
  2118. Example: "_x > 2" count [0, 1, 1, 2, 3, 3]
  2119. Example Return: 2
  2120. Category: Default
  2121. @e
  2122. count
  2123. Left Argument: array
  2124. Description: "The number of elements in the array."
  2125. Example: count [0,0,1,2]
  2126. Example Return: 4
  2127. Category: Default
  2128. @e
  2129. countEnemy
  2130. Left Argument: unit
  2131. Right Argument: array
  2132. Description: "Counts how many units in the array are considered enemy by the given unit."
  2133. Example: player countEnemy list triggerOne
  2134. Category: General
  2135. @e
  2136. countFriendly
  2137. Left Argument: unit
  2138. Right Argument: array
  2139. Description: "Counts how many units in the array are considered friendly by the given unit."
  2140. Example: player countFriendly list triggerOne
  2141. Category: General
  2142. @e
  2143. countSide
  2144. Left Argument: side
  2145. Right Argument: array
  2146. Description: "Checks how many vehicles belong to the given side."
  2147. Example: west countSide list triggerOne
  2148. Category: General
  2149. @e
  2150. countType
  2151. Left Argument: typeName
  2152. Right Argument: array
  2153. Description: "Counts how many vehicles in the array are of the given type. For types see <cl>CfgVehicles</cl>."
  2154. Example: "Tank" countType list triggerOne
  2155. Category: General
  2156. @e
  2157. countUnknown
  2158. Left Argument: unit
  2159. Right Argument: array
  2160. Description: "Counts how many units in the array are considered unknown to the given unit."
  2161. Example: player countUnknown list triggerOne
  2162. Category: General
  2163. @e
  2164. createAgent
  2165. Left Argument: [type, position, markers, placement, special]
  2166. 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"."
  2167. Example: agent = createAgent ["SoldierWB", position player, [], 0, "FORM"]
  2168. Category: General
  2169. @e
  2170. createCenter
  2171. Left Argument: side
  2172. Description: "Creates a new AI center for the given side."
  2173. Example: center = createCenter East
  2174. Category: General
  2175. @e
  2176. createDialog
  2177. Left Argument: name
  2178. 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."
  2179. Example: _ok = createDialog "RscDisplayGame"
  2180. Category: General
  2181. @e
  2182. createDiaryLink
  2183. Left Argument: [subject, object, text]
  2184. Description: "Create a link to the section of diary given by subject. Record is selected based on given object (diary record, task or unit)."
  2185. Example: _link = createDiarySubject ["Group", player, "Player"]
  2186. Category: Identity
  2187. @e
  2188. createDiaryRecord
  2189. Left Argument: person
  2190. Right Argument: [subject, text(, task(, state))] or [subject, [title, text](, task(, state))]
  2191. Description: "Create a new record in a log."
  2192. Example: _record = player createDiaryRecord ["diary", "Kill all enemies."]
  2193. Category: Identity
  2194. @e
  2195. createDiarySubject
  2196. Left Argument: person
  2197. Right Argument: [subject, display name] or [subject, display name, picture]
  2198. Description: "Create a new subject page in a log."
  2199. Example: _index = player createDiarySubject ["myPage", "My page"]
  2200. Category: Identity
  2201. @e
  2202. createDisplay
  2203. Left Argument: parent
  2204. Right Argument: name
  2205. Description: "Create child display of given display and load from resource "name"."
  2206. Example: _display createDisplay "RscObserver"
  2207. Category: General
  2208. @e
  2209. createGearDialog
  2210. Left Argument: [unit,resource]
  2211. Description: "Opens gear dialog for given unit."
  2212. Example: CreateGearDialog [palyer,"RscDisplayGear"]
  2213. Category: General
  2214. @e
  2215. createGroup
  2216. Left Argument: side
  2217. Description: "Creates a new AI group for the given center (side)."
  2218. Example: group = createGroup East
  2219. Category: General
  2220. @e
  2221. createGuardedPoint
  2222. Left Argument: [side, position, idStatic, vehicle]
  2223. 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."
  2224. Example: point = createGuardedPoint [East, [0, 0], -1, vehicle player]
  2225. Category: General
  2226. @e
  2227. createLocation
  2228. Left Argument: [type, position, sizeX, sizeZ]
  2229. Description: "Create location of given type with given size at given position."
  2230. Category: Location
  2231. @e
  2232. createMarker
  2233. Left Argument: [name, position]
  2234. 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."
  2235. Example: marker = createMarker [Marker1, position player]
  2236. Category: General
  2237. @e
  2238. createMarkerLocal
  2239. Left Argument: [name, position]
  2240. 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."
  2241. Example: marker = createMarkerLocal [Marker1, position player]
  2242. Category: General
  2243. @e
  2244. createMenu
  2245. Left Argument: map
  2246. Right Argument: index
  2247. Description: "Creates a previously added menu."
  2248. Category: Editor
  2249. @e
  2250. createMine
  2251. Left Argument: [type, position, markers, placement]
  2252. 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."
  2253. Example: mine = createMine ["MineMine", position player, [], 0]
  2254. Category: General
  2255. @e
  2256. createMissionDisplay
  2257. Left Argument: parent
  2258. Right Argument: root
  2259. Description: "Create single missions display as a child of given display. The mission dialog will be set to the directory given as an argument "root"."
  2260. Example: _display createMissionDisplay "Test missions"
  2261. Category: General
  2262. @e
  2263. createSimpleTask
  2264. Left Argument: person
  2265. Right Argument: [name] or [name, parentTask]
  2266. Description: "Create a new simple task (subtask of parentTask)."
  2267. Category: Identity
  2268. @e
  2269. createSite
  2270. Left Argument: type
  2271. Right Argument: pos
  2272. Description: "Creates a new site."
  2273. Category: General
  2274. @e
  2275. createSoundSource
  2276. Left Argument: [type, position, markers, placement]
  2277. 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."
  2278. Example: soundSource = createSoundSource ["LittleDog", position player, [], 0]
  2279. Category: General
  2280. @e
  2281. createTask
  2282. Left Argument: teamMember
  2283. Right Argument: [[type] or [type, parentTask], priority, name1, value1, name2, value2, ...]
  2284. Description: "Create a new AI task (subtask of parentTask). Type is name of registered task type."
  2285. Category: Identity
  2286. @e
  2287. createTeam
  2288. Left Argument: [type, name]
  2289. Description: "Create a team and name it."
  2290. Example: _team = createTeam ["USMC_Team", "Fire Team Red"]
  2291. Category: Agents
  2292. @e
  2293. createTrigger
  2294. Left Argument: [type, position]
  2295. 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."
  2296. Example: trigger = createTrigger["EmptyDetector", position player]
  2297. Category: General
  2298. @e
  2299. createUnit
  2300. Left Argument: type
  2301. Right Argument: unitInfo
  2302. Description: "Creates a unit of the given type. The format of unitInfo is:
  2303. [pos (<ar>Position</ar>), group (<t>Group</t>), init (<t>String</t>), skill (<t>Number</t>), rank (<t>String</t>)].
  2304. Note: init, skill and rank are optional. Their default values are "", 0.5, "PRIVATE"."
  2305. Example: "SoldierWB" createUnit [getMarkerPos "barracks", groupAlpha]
  2306. Category: General
  2307. @e
  2308. createVehicle
  2309. Left Argument: type
  2310. Right Argument: pos
  2311. Description: "Creates an empty vehicle of the given type. Pos is in format <ar>Position</ar>.
  2312. See <cl>CfgVehicles</cl> for possible type values."
  2313. Example: _tank = "M1Abrams" createVehicle getmarkerpos "tankFactory"
  2314. Category: General
  2315. @e
  2316. createVehicle
  2317. Left Argument: [type, position, markers, placement, special]
  2318. 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"."
  2319. Example: veh = createVehicle ["Cobra", position player, [], 0, "FLY"]
  2320. Category: General
  2321. @e
  2322. createVehicleCrew
  2323. Left Argument: Vehicle
  2324. Description: "Creates crew to given vehicle."
  2325. Example: createVehicleCrew vehicle0
  2326. Category: General
  2327. @e
  2328. createVehicleLocal
  2329. Left Argument: type
  2330. Right Argument: pos
  2331. Description: "Creates an empty vehicle of the given type. Pos is in format <ar>Position</ar>.
  2332. See <cl>CfgVehicles</cl> for possible type values. Vehicle is not transferred through network in MP games."
  2333. Example: _tank = "M1Abrams" createVehicleLocal getmarkerpos "tankFactory"
  2334. Category: General
  2335. @e
  2336. crew
  2337. Left Argument: vehicle
  2338. 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."
  2339. Example: crew vehicle player
  2340. Category: General
  2341. @e
  2342. ctrlActivate
  2343. Left Argument: control
  2344. Description: "Launch actions attached to given (button based) control."
  2345. Example: ctrlActivate _control
  2346. Category: General
  2347. @e
  2348. ctrlAddEventHandler
  2349. Left Argument: control
  2350. Right Argument: [handler name, function]
  2351. Description: "Add an event handler to the given control. Returns id of the handler or -1 when failed."
  2352. Example: _id = _control ctrlAddEventHandler ["KeyDown", ""]
  2353. Category: General
  2354. @e
  2355. ctrlAutoScrollDelay
  2356. Left Argument: control
  2357. Description: "Returns number of seconds until auto-scroll starts. -2 if scrollbar not present."
  2358. Example: _delay = ctrlAutoScrollDelay _control
  2359. Category: General
  2360. @e
  2361. ctrlAutoScrollRewind
  2362. Left Argument: control
  2363. Description: "True if auto-scroll should move back to start after it reach end."
  2364. Example: _rewind = ctrlAutoScrollRewind _control
  2365. Category: General
  2366. @e
  2367. ctrlAutoScrollSpeed
  2368. Left Argument: control
  2369. Description: "Returns number of seconds to auto-scroll one line. -1 if auto-scroll is disabled. -2 if scrollbar not present."
  2370. Example: _speed = ctrlAutoScrollSpeed _control
  2371. Category: General
  2372. @e
  2373. ctrlChecked
  2374. Left Argument: control
  2375. Description: "Returns the current state of textual checkbox."
  2376. Example: _checked = ctrlChecked _control
  2377. Category: General
  2378. @e
  2379. ctrlClassName
  2380. Left Argument: control
  2381. Description: "Returns class name of given control."
  2382. Example: ctrlClassName ((FindDisplay 20000) displayCtrl 20001)
  2383. Category: General
  2384. @e
  2385. ctrlCommit
  2386. Left Argument: control
  2387. Right Argument: time
  2388. Description: "Commit control animation."
  2389. Example: _control ctrlCommit 2
  2390. Category: General
  2391. @e
  2392. ctrlCommitted
  2393. Left Argument: control
  2394. Description: "Check if the control animation is finished."
  2395. Example: _done = ctrlCommitted _control
  2396. Category: General
  2397. @e
  2398. ctrlCreate
  2399. Left Argument: parent_display
  2400. Right Argument: [baseClass, idc, groupControl]
  2401. Description: "Creates new control in given display. The control is created in given groupControl (optional)"
  2402. Example: ctrl ctrlCreate ["RscText", 1234]
  2403. Category: General
  2404. @e
  2405. ctrlDelete
  2406. Left Argument: control
  2407. Description: "Deletes given control."
  2408. Example: ctrlDelete ((FindDisplay 20000) displayCtrl 20001)
  2409. Category: General
  2410. @e
  2411. ctrlEnable
  2412. Left Argument: control
  2413. Right Argument: enable
  2414. Description: "Enable / disable given control."
  2415. Example: _control ctrlEnable false
  2416. Category: General
  2417. @e
  2418. ctrlEnable
  2419. Left Argument: [idc, enable]
  2420. Description: "Enables / disables the control with id idc of the topmost user dialog."
  2421. Example: ctrlEnable [100, false]
  2422. Category: General
  2423. @e
  2424. ctrlEnabled
  2425. Left Argument: control
  2426. Description: "Returns whether given control is enabled."
  2427. Example: _ok = ctrlEnabled _control
  2428. Category: General
  2429. @e
  2430. ctrlFade
  2431. Left Argument: control
  2432. Description: "Returns the current fade factor of control."
  2433. Example: _scale = ctrlFade _control
  2434. Category: General
  2435. @e
  2436. ctrlHTMLLoaded
  2437. Left Argument: control
  2438. Description: "Returns true when HTML content was successfully loaded."
  2439. Example: _htmlLoaded ctrlHTMLLoaded _control
  2440. Category: General
  2441. @e
  2442. ctrlIDC
  2443. Left Argument: control
  2444. Description: "Returns control IDC."
  2445. Example: IDC = ctrlIDC _control
  2446. Category: General
  2447. @e
  2448. ctrlIDD
  2449. Left Argument: display
  2450. Description: "Returns display IDD."
  2451. Example: IDD = ctrlIDD _display
  2452. Category: General
  2453. @e
  2454. ctrlMapAnimAdd
  2455. Left Argument: map
  2456. Right Argument: frame
  2457. 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>."
  2458. Example: _map ctrlMapAnimAdd [1, 0.1, getMarkerPos "anim1"]
  2459. Category: General
  2460. @e
  2461. ctrlMapAnimClear
  2462. Left Argument: control
  2463. Description: "Clears the map animation."
  2464. Category: General
  2465. @e
  2466. ctrlMapAnimCommit
  2467. Left Argument: control
  2468. Description: "Plays the map animation."
  2469. Category: General
  2470. @e
  2471. ctrlMapAnimDone
  2472. Left Argument: control
  2473. Description: "Checks whether the map animation has finished."
  2474. Category: General
  2475. @e
  2476. ctrlMapCursor
  2477. Left Argument: control
  2478. Right Argument: texture names
  2479. Description: "Changes default cursor texture ("Track", "Move","Array", "Scroll") to custom one. To restore default texture, write empty string. If new texture does not exist, default cursor texture is used."
  2480. Example: <map_control> ctrlMapCursor ["Track","customCursor"]
  2481. Category: General
  2482. @e
  2483. ctrlMapMouseOver
  2484. Left Argument: control
  2485. Description: "Returns description of map sign mouse cursor is over."
  2486. Category: General
  2487. @e
  2488. ctrlMapScale
  2489. Left Argument: control
  2490. Description: "Return the current scale of the map control."
  2491. Category: General
  2492. @e
  2493. ctrlMapScreenToWorld
  2494. Left Argument: map
  2495. Right Argument: [x, y]
  2496. Description: "Convert position in the map from screen coordinates to world coordinates."
  2497. Category: General
  2498. @e
  2499. ctrlMapWorldToScreen
  2500. Left Argument: map
  2501. Right Argument: position
  2502. Description: "Convert position in the map from world coordinates to screen coordinates."
  2503. Category: General
  2504. @e
  2505. ctrlModel
  2506. Left Argument: control
  2507. Description: "Returns model setted in given control."
  2508. Example: ctrlModel ((FindDisplay 20000) displayCtrl 20001)
  2509. Category: General
  2510. @e
  2511. ctrlModelDirAndUp
  2512. Left Argument: control
  2513. Description: "Returns orientation setted in given control."
  2514. Example: ctrlModelOrientation ((FindDisplay 20000) displayCtrl 20001)
  2515. Category: General
  2516. @e
  2517. ctrlModelScale
  2518. Left Argument: control
  2519. Description: "Returns scale setted in given control object"
  2520. Example: ctrlModelScale ((FindDisplay 20000) displayCtrl 20001)
  2521. Category: General
  2522. @e
  2523. ctrlParent
  2524. Left Argument: control
  2525. Description: "Returns container of given control."
  2526. Example: _display = ctrlParent _control
  2527. Category: General
  2528. @e
  2529. ctrlPosition
  2530. Left Argument: control
  2531. Description: "Returns the current position and size of control as [x, y, w, h] array."
  2532. Example: _pos = ctrlPosition _control
  2533. Category: General
  2534. @e
  2535. ctrlRemoveAllEventHandlers
  2536. Left Argument: control
  2537. Right Argument: handler name
  2538. Description: "Remove all even handlers from the given control."
  2539. Example: _control ctrlRemoveAllEventHandlers "KeyDown"
  2540. Category: General
  2541. @e
  2542. ctrlRemoveEventHandler
  2543. Left Argument: control
  2544. Right Argument: [handler name, id]
  2545. Description: "Remove a given event handler from the given control."
  2546. Example: _control ctrlRemoveEventHandler ["KeyDown", 0]
  2547. Category: General
  2548. @e
  2549. ctrlScale
  2550. Left Argument: control
  2551. Description: "Returns the current scale of control."
  2552. Example: _scale = ctrlScale _control
  2553. Category: General
  2554. @e
  2555. ctrlSetActiveColor
  2556. Left Argument: display
  2557. Right Argument: color
  2558. Description: "Sets text color of given control when control is selected. Color is in format <ar>Color</ar>."
  2559. Example: _control ctrlSetActiveColor [1, 0, 0, 1]
  2560. Category: General
  2561. @e
  2562. ctrlSetAutoScrollDelay
  2563. Left Argument: control
  2564. Right Argument: delay
  2565. Description: "Sets number of second before auto-scroll starts."
  2566. Example: _control ctrlSetAutoScrollDelay 5
  2567. Category: General
  2568. @e
  2569. ctrlSetAutoScrollRewind
  2570. Left Argument: control
  2571. Right Argument: delay
  2572. Description: "Defines if scroll should rewind when auto-scroll reach end."
  2573. Example: _control ctrlSetAutoScrollDelay 5
  2574. Category: General
  2575. @e
  2576. ctrlSetAutoScrollSpeed
  2577. Left Argument: control
  2578. Right Argument: speed
  2579. Description: "Sets number of second required to scroll to next line. If speed smaller than 0, auto-scroll is disabled."
  2580. Example: _control ctrlSetAutoScrollSpeed 5
  2581. Category: General
  2582. @e
  2583. ctrlSetBackgroundColor
  2584. Left Argument: display
  2585. Right Argument: color
  2586. Description: "Sets background color of given control. Color is in format <ar>Color</ar>."
  2587. Example: _control ctrlSetBackgroundColor [1, 0, 0, 1]
  2588. Category: General
  2589. @e
  2590. ctrlSetChecked
  2591. Left Argument: control
  2592. Right Argument: enabled
  2593. Description: "Sets checked state of checkbox."
  2594. Example: _control ctrlSetChecked true
  2595. Category: General
  2596. @e
  2597. ctrlSetEventHandler
  2598. Left Argument: control
  2599. Right Argument: [handler name, function]
  2600. Description: "Sets given event handler of given control"
  2601. Example: _control ctrlSetEventHandler ["KeyDown", ""]
  2602. Category: General
  2603. @e
  2604. ctrlSetFade
  2605. Left Argument: control
  2606. Right Argument: fade
  2607. Description: "Sets wanted transparency for control animation."
  2608. Example: _control ctrlSetFade 1
  2609. Category: General
  2610. @e
  2611. ctrlSetFocus
  2612. Left Argument: control
  2613. Description: "Set the input focus on given control."
  2614. Example: ctrlSetFocus _control
  2615. Category: General
  2616. @e
  2617. ctrlSetFont
  2618. Left Argument: control
  2619. Right Argument: name
  2620. Description: "Sets the main font of given control."
  2621. Example: _control ctrlSetFont "TahomaB"
  2622. Category: General
  2623. @e
  2624. ctrlSetFontH1
  2625. Left Argument: control
  2626. Right Argument: name
  2627. Description: "Sets H1 font of given HTML control."
  2628. Example: _control ctrlSetFontH1 "TahomaB"
  2629. Category: General
  2630. @e
  2631. ctrlSetFontH1B
  2632. Left Argument: control
  2633. Right Argument: name
  2634. Description: "Sets H1 bold font of given HTML control."
  2635. Example: _control ctrlSetFontH1B "TahomaB"
  2636. Category: General
  2637. @e
  2638. ctrlSetFontH2
  2639. Left Argument: control
  2640. Right Argument: name
  2641. Description: "Sets H2 font of given HTML control."
  2642. Example: _control ctrlSetFontH2 "TahomaB"
  2643. Category: General
  2644. @e
  2645. ctrlSetFontH2B
  2646. Left Argument: control
  2647. Right Argument: name
  2648. Description: "Sets H2 bold font of given HTML control."
  2649. Example: _control ctrlSetFontH2B "TahomaB"
  2650. Category: General
  2651. @e
  2652. ctrlSetFontH3
  2653. Left Argument: control
  2654. Right Argument: name
  2655. Description: "Sets H3 font of given HTML control."
  2656. Example: _control ctrlSetFontH3 "TahomaB"
  2657. Category: General
  2658. @e
  2659. ctrlSetFontH3B
  2660. Left Argument: control
  2661. Right Argument: name
  2662. Description: "Sets H3 bold font of given HTML control."
  2663. Example: _control ctrlSetFontH3B "TahomaB"
  2664. Category: General
  2665. @e
  2666. ctrlSetFontH4
  2667. Left Argument: control
  2668. Right Argument: name
  2669. Description: "Sets H4 font of given HTML control."
  2670. Example: _control ctrlSetFontH4 "TahomaB"
  2671. Category: General
  2672. @e
  2673. ctrlSetFontH4B
  2674. Left Argument: control
  2675. Right Argument: name
  2676. Description: "Sets H4 bold font of given HTML control."
  2677. Example: _control ctrlSetFontH4B "TahomaB"
  2678. Category: General
  2679. @e
  2680. ctrlSetFontH5
  2681. Left Argument: control
  2682. Right Argument: name
  2683. Description: "Sets H5 font of given HTML control."
  2684. Example: _control ctrlSetFontH5 "TahomaB"
  2685. Category: General
  2686. @e
  2687. ctrlSetFontH5B
  2688. Left Argument: control
  2689. Right Argument: name
  2690. Description: "Sets H5 bold font of given HTML control."
  2691. Example: _control ctrlSetFontH5B "TahomaB"
  2692. Category: General
  2693. @e
  2694. ctrlSetFontH6
  2695. Left Argument: control
  2696. Right Argument: name
  2697. Description: "Sets H5 font of given HTML control."
  2698. Example: _control ctrlSetFontH6 "TahomaB"
  2699. Category: General
  2700. @e
  2701. ctrlSetFontH6B
  2702. Left Argument: control
  2703. Right Argument: name
  2704. Description: "Sets H6 bold font of given HTML control."
  2705. Example: _control ctrlSetFontH6B "TahomaB"
  2706. Category: General
  2707. @e
  2708. ctrlSetFontHeight
  2709. Left Argument: control
  2710. Right Argument: height
  2711. Description: "Sets the main font size of given control."
  2712. Example: _control ctrlSetFontHeight 0.05
  2713. Category: General
  2714. @e
  2715. ctrlSetFontHeightH1
  2716. Left Argument: control
  2717. Right Argument: height
  2718. Description: "Sets H1 font size of given HTML control."
  2719. Example: _control ctrlSetFontHeightH1 0.05
  2720. Category: General
  2721. @e
  2722. ctrlSetFontHeightH2
  2723. Left Argument: control
  2724. Right Argument: height
  2725. Description: "Sets H2 font size of given HTML control."
  2726. Example: _control ctrlSetFontHeightH2 0.05
  2727. Category: General
  2728. @e
  2729. ctrlSetFontHeightH3
  2730. Left Argument: control
  2731. Right Argument: height
  2732. Description: "Sets H3 font size of given HTML control."
  2733. Example: _control ctrlSetFontHeightH3 0.05
  2734. Category: General
  2735. @e
  2736. ctrlSetFontHeightH4
  2737. Left Argument: control
  2738. Right Argument: height
  2739. Description: "Sets H4 font size of given HTML control."
  2740. Example: _control ctrlSetFontHeightH4 0.05
  2741. Category: General
  2742. @e
  2743. ctrlSetFontHeightH5
  2744. Left Argument: control
  2745. Right Argument: height
  2746. Description: "Sets H5 font size of given HTML control."
  2747. Example: _control ctrlSetFontHeightH5 0.05
  2748. Category: General
  2749. @e
  2750. ctrlSetFontHeightH6
  2751. Left Argument: control
  2752. Right Argument: height
  2753. Description: "Sets H6 font size of given HTML control."
  2754. Example: _control ctrlSetFontHeightH6 0.05
  2755. Category: General
  2756. @e
  2757. ctrlSetFontHeightSecondary
  2758. Left Argument: control
  2759. Right Argument: height
  2760. Description: "Sets the font size of the secondary text of given control."
  2761. Example: _control ctrlSetFontHeightSecondary 0.05
  2762. Category: General
  2763. @e
  2764. ctrlSetFontP
  2765. Left Argument: control
  2766. Right Argument: name
  2767. Description: "Sets P font of given HTML control."
  2768. Example: _control ctrlSetFontP "TahomaB"
  2769. Category: General
  2770. @e
  2771. ctrlSetFontPB
  2772. Left Argument: control
  2773. Right Argument: name
  2774. Description: "Sets P bold font of given HTML control."
  2775. Example: _control ctrlSetFontPB "TahomaB"
  2776. Category: General
  2777. @e
  2778. ctrlSetFontSecondary
  2779. Left Argument: control
  2780. Right Argument: name
  2781. Description: "Sets the font of the secondary text in given control."
  2782. Example: _control ctrlSetFontSecondary "TahomaB"
  2783. Category: General
  2784. @e
  2785. ctrlSetForegroundColor
  2786. Left Argument: display
  2787. Right Argument: color
  2788. Description: "Sets background color of given control. Color is in format <ar>Color</ar>."
  2789. Example: _control ctrlSetForegroundColor [1, 0, 0, 1]
  2790. Category: General
  2791. @e
  2792. ctrlSetModel
  2793. Left Argument: ctrl
  2794. Right Argument: model
  2795. Description: "Sets model to draw as control object."
  2796. Example: ctrl ctrlSetModel "\a3\Ui_f\objects\Compass.p3d"
  2797. Category: General
  2798. @e
  2799. ctrlSetModelDirAndUp
  2800. Left Argument: ctrl
  2801. Right Argument: [direction, up]
  2802. Description: "Sets orientation to control object."
  2803. Example: ctrl ctrlSetDirection [dir, up]
  2804. Category: General
  2805. @e
  2806. ctrlSetModelScale
  2807. Left Argument: ctrl
  2808. Right Argument: scale
  2809. Description: "Sets given scale into control."
  2810. Example: ctrl ctrlSetModelScale 1
  2811. Category: General
  2812. @e
  2813. ctrlSetPosition
  2814. Left Argument: control
  2815. Right Argument: [x, y, w, h]
  2816. Description: "Sets wanted position and size for control animation. Width and height are optional."
  2817. Example: _control ctrlSetPosition [0.5, 0.5]
  2818. Category: General
  2819. @e
  2820. ctrlSetScale
  2821. Left Argument: control
  2822. Right Argument: scale
  2823. Description: "Sets wanted scale for control animation. Top left corner remains same."
  2824. Example: _control ctrlScale 0.5
  2825. Category: General
  2826. @e
  2827. ctrlSetStructuredText
  2828. Left Argument: control
  2829. Right Argument: structured text
  2830. Description: "Set the structured text which will be displayed in structured text control."
  2831. Example: _control ctrlSetStructuredText parseText "First line&lt;img image=data\isniper.paa/&gt;&ltbr/&gt;Second line"
  2832. Category: General
  2833. @e
  2834. ctrlSetText
  2835. Left Argument: [idc, text]
  2836. 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."
  2837. Example: ctrlSetText [100, "Hello, world"]
  2838. Category: General
  2839. @e
  2840. ctrlSetText
  2841. Left Argument: control
  2842. Right Argument: text
  2843. Description: "Sets the text that will be shown in given control."
  2844. Example: _control ctrlSetText "Hello, world."
  2845. Category: General
  2846. @e
  2847. ctrlSetTextColor
  2848. Left Argument: display
  2849. Right Argument: color
  2850. Description: "Sets text color of given control. Color is in format <ar>Color</ar>."
  2851. Example: _control ctrlSetTextColor [1, 0, 0, 1]
  2852. Category: General
  2853. @e
  2854. ctrlSetTextColorSecondary
  2855. Left Argument: display
  2856. Right Argument: color
  2857. Description: "Sets text color of the secondary text of given control. Color is in format <ar>Color</ar>."
  2858. Example: _control ctrlSetTextColorSecondary [1, 0, 0, 1]
  2859. Category: General
  2860. @e
  2861. ctrlSetTextSecondary
  2862. Left Argument: control
  2863. Right Argument: text
  2864. Description: "Sets the secondary text that will be shown in given control."
  2865. Example: _control ctrlSetTextSecondary "Hello, world."
  2866. Category: General
  2867. @e
  2868. ctrlSetTooltip
  2869. Left Argument: display
  2870. Right Argument: text
  2871. Description: "Sets tooltip text of given control."
  2872. Example: _control ctrlSetTooltip "tooltip"
  2873. Category: General
  2874. @e
  2875. ctrlSetTooltipColorBox
  2876. Left Argument: display
  2877. Right Argument: color
  2878. Description: "Sets tooltip border color of given control. Color is in format <ar>Color</ar>."
  2879. Example: _control ctrlSetTooltipColorBox [1, 0, 0, 1]
  2880. Category: General
  2881. @e
  2882. ctrlSetTooltipColorShade
  2883. Left Argument: display
  2884. Right Argument: color
  2885. Description: "Sets tooltip background color of given control. Color is in format <ar>Color</ar>."
  2886. Example: _control ctrlSetTooltipColorShade [1, 0, 0, 1]
  2887. Category: General
  2888. @e
  2889. ctrlSetTooltipColorText
  2890. Left Argument: display
  2891. Right Argument: color
  2892. Description: "Sets tooltip text color of given control. Color is in format <ar>Color</ar>."
  2893. Example: _control ctrlSetTooltipColorText [1, 0, 0, 1]
  2894. Category: General
  2895. @e
  2896. ctrlShow
  2897. Left Argument: control
  2898. Right Argument: show
  2899. Description: "Show / hide given control."
  2900. Example: _control ctrlShow false
  2901. Category: General
  2902. @e
  2903. ctrlShow
  2904. Left Argument: [idc, show]
  2905. Description: "Shows / hides the control with id idc of the topmost user dialog."
  2906. Example: ctrlShow [100, true]
  2907. Category: General
  2908. @e
  2909. ctrlShown
  2910. Left Argument: control
  2911. Description: "Returns whether given control is shown."
  2912. Example: _ok = ctrlShown _control
  2913. Category: General
  2914. @e
  2915. ctrlText
  2916. Left Argument: control
  2917. Description: "Returns the text shown in given control."
  2918. Example: _text = ctrlText _control
  2919. Category: General
  2920. @e
  2921. ctrlTextHeight
  2922. Left Argument: structuredText control
  2923. Description: "Returns the text height."
  2924. Example: h = ctrlTextHeight _control
  2925. Category: General
  2926. @e
  2927. ctrlTextSecondary
  2928. Left Argument: control
  2929. Description: "Returns the secondary text of the given control (if control is supporting a secondary text)."
  2930. Example: _text = ctrlTextSecondary _control
  2931. Category: General
  2932. @e
  2933. ctrlType
  2934. Left Argument: control
  2935. Description: "Returns value representing type of control."
  2936. Example: _type = ctrlType _control
  2937. Category: General
  2938. @e
  2939. ctrlVisible
  2940. Left Argument: idc
  2941. Description: "Returns whether the control with id idc of the topmost user dialog is visible."
  2942. Example: _visible = ctrlVisible 100
  2943. Category: General
  2944. @e
  2945. curatorAddons
  2946. Left Argument: curatorObj
  2947. Description: "Return list of addons allowed to given curator."
  2948. Category: General
  2949. @e
  2950. curatorCamera
  2951. Description: "Returns curator camera object."
  2952. Category: General
  2953. @e
  2954. curatorCameraArea
  2955. Left Argument: curatorObj
  2956. Description: "Return all curator camera areas."
  2957. Category: General
  2958. @e
  2959. curatorCameraAreaCeiling
  2960. Left Argument: curatorObj
  2961. Description: "Return ceiling height for curator camera."
  2962. Category: General
  2963. @e
  2964. curatorCoef
  2965. Left Argument: curatorObj
  2966. Right Argument: action
  2967. Description: "Returns current coeficient setting"
  2968. Example: 0 curatorCoef "Place"
  2969. Category: General
  2970. @e
  2971. curatorEditableObjects
  2972. Left Argument: curatorObj
  2973. Description: "Return all editable objects which belongs to a curator."
  2974. Category: General
  2975. @e
  2976. curatorEditingArea
  2977. Left Argument: curatorObj
  2978. Description: "Returns all curator editing areas"
  2979. Category: General
  2980. @e
  2981. curatorEditingAreaType
  2982. Left Argument: obj
  2983. Description: "Returns type of edit areas assigned to curator (blacklist/whitelist)."
  2984. Category: General
  2985. @e
  2986. curatorMouseOver
  2987. Description: "Returns curator mouse over object."
  2988. Category: General
  2989. @e
  2990. curatorPoints
  2991. Left Argument: curatorObj
  2992. Description: "Return number of points that curator have."
  2993. Category: General
  2994. @e
  2995. curatorRegisteredObjects
  2996. Left Argument: curatorObj
  2997. Description: "Returns array with all objects that has curator registered and their settings."
  2998. Category: General
  2999. @e
  3000. curatorSelected
  3001. Description: "Returns list of all curator selected items."
  3002. Category: General
  3003. @e
  3004. curatorWaypointCost
  3005. Left Argument: curatorObj
  3006. Description: "Return current price for placing waypoints (curator specific)."
  3007. Category: General
  3008. @e
  3009. currentCommand
  3010. Left Argument: vehicle
  3011. Description: "Return the current command type (empty string when no command)."
  3012. Category: General
  3013. @e
  3014. currentMagazine
  3015. Left Argument: vehicle
  3016. Description: "Return the name of the type of the currently using magazine (on the primary turret for vehicles)."
  3017. Category: General
  3018. @e
  3019. currentMagazineDetail
  3020. Left Argument: vehicle
  3021. Description: "Return the name of the type of the currently using magazine (on the primary turret for vehicles)."
  3022. Category: General
  3023. @e
  3024. currentMagazineDetailTurret
  3025. Left Argument: vehicle
  3026. Right Argument: turret path
  3027. Description: "Return the name of the type of the currently using magazine on specified turret."
  3028. Example: vehicle currentMagazineDetailTurret [0]
  3029. Category: General
  3030. @e
  3031. currentMagazineTurret
  3032. Left Argument: vehicle
  3033. Right Argument: turret path
  3034. Description: "Return the name of the type of the currently using magazine on specified turret."
  3035. Example: vehicle currentMagazineTurret [0]
  3036. Category: General
  3037. @e
  3038. currentMuzzle
  3039. Left Argument: gunner
  3040. Description: "Returns current muzzle of unit's weapon."
  3041. Category: General
  3042. @e
  3043. currentTask
  3044. Left Argument: person
  3045. Description: "Return current task of given person."
  3046. Category: Identity
  3047. @e
  3048. currentTasks
  3049. Left Argument: teamMember
  3050. Description: "List all uncompleted tasks."
  3051. Category: Identity
  3052. @e
  3053. currentVisionMode
  3054. Left Argument: gunner
  3055. Description: "Returns vision mode of unit's weapon. 0-dayTime, 1-night vision, 2-FLIR "
  3056. Category: General
  3057. @e
  3058. currentWaypoint
  3059. Left Argument: group
  3060. Description: "Return the index of the current waypoint."
  3061. Category: General
  3062. @e
  3063. currentWeapon
  3064. Left Argument: vehicle
  3065. Description: "Return the name of the currently selected weapon (on the primary turret for vehicles)."
  3066. Category: General
  3067. @e
  3068. currentWeaponMode
  3069. Left Argument: gunner
  3070. Description: "Returns current weapon mode of unit's weapon."
  3071. Category: General
  3072. @e
  3073. currentWeaponTurret
  3074. Left Argument: vehicle
  3075. Right Argument: turret path
  3076. Description: "Return the name of the currently selected weapon on specified turret."
  3077. Example: vehicle currentWeaponTurret [0]
  3078. Category: General
  3079. @e
  3080. currentZeroing
  3081. Left Argument: gunner
  3082. Description: "Returns zeroing of unit's weapon."
  3083. Category: General
  3084. @e
  3085. cursorTarget
  3086. Description: "This is the entity pointed to by a players cursor."
  3087. Example: alive cursorTarget
  3088. Category: General
  3089. @e
  3090. customChat
  3091. Left Argument: unit
  3092. Right Argument: [chan ix, string]
  3093. Description: "Sends the chat message to the custom radio channel."
  3094. Example: sweetBoy customChat [1,"Hi, any sweetgirls to chat?"]
  3095. Category: General
  3096. @e
  3097. customRadio
  3098. Left Argument: unit
  3099. Right Argument: [chan ix, string]
  3100. Description: "Sends the message to the custom radio channel. The message is defined in the description.ext file or radio protocol."
  3101. Example: soldierOne customRadio [1,"WordEnemy"]
  3102. Category: General
  3103. @e
  3104. cutFadeOut
  3105. Left Argument: layer
  3106. Right Argument: duration
  3107. Description: "Terminate the effect in the given layer and set duration of the fade out phase to the given time."
  3108. Example: 0 cutFadeIn 1.0
  3109. Category: General
  3110. @e
  3111. cutObj
  3112. Left Argument: layer
  3113. Right Argument: effect
  3114. Description: "Object background - the right argument uses format ["name","type",speed] or ["name","type"]. If speed is not given, it's assumed to be one.
  3115. The left argument define layer in which the effect is show, 0 is the back most.
  3116. The object can be defined in the description.ext file."
  3117. Example: 0 cutObj ["TVSet", "plain"]
  3118. Category: General
  3119. @e
  3120. cutObj
  3121. Left Argument: effect
  3122. 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.
  3123. The object can be defined in the description.ext file."
  3124. Example: cutObj ["TVSet", "plain"]
  3125. Category: General
  3126. @e
  3127. cutRsc
  3128. Left Argument: effect
  3129. 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.
  3130. The resource can be defined in the description.ext file."
  3131. Example: cutRsc ["binocular", "PLAIN"]
  3132. Category: General
  3133. @e
  3134. cutRsc
  3135. Left Argument: layer
  3136. Right Argument: effect
  3137. Description: "Resource background - the right argument uses format ["name","type",speed] or ["name","type"]. If speed is not given, it's assumed to be one.
  3138. The left argument define layer in which the effect is show, 0 is the back most.
  3139. The resource can be defined in the description.ext file."
  3140. Example: 0 cutRsc ["binocular", "PLAIN"]
  3141. Category: General
  3142. @e
  3143. cutText
  3144. Left Argument: effect
  3145. 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"."
  3146. Example: cutText ["", "BLACK OUT"]
  3147. Category: General
  3148. @e
  3149. cutText
  3150. Left Argument: layer
  3151. Right Argument: effect
  3152. Description: "Text background - the right argument uses format ["text","type",speed] 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".
  3153. The left argument define layer in which the effect is show, 0 is the back most."
  3154. Example: 0 cutText ["", "BLACK OUT"]
  3155. Category: General
  3156. @e
  3157. damage
  3158. Left Argument: object
  3159. Description: "Returns the object damage in a range of 0 to 1. Note: this function is identical to <f>getDammage</f>."
  3160. Example: damage player
  3161. Category: General
  3162. @e
  3163. date
  3164. Description: "Return the actual mission date and time as an array [year, month, day, hour, minute]."
  3165. Category: General
  3166. @e
  3167. dateToNumber
  3168. Left Argument: date
  3169. Description: "Convert date to float number."
  3170. Example: time = DateToNumber [year,month,day,hour,minute]
  3171. Category: General
  3172. @e
  3173. dayTime
  3174. Description: "Returns the time in the world, in hours."
  3175. Category: General
  3176. @e
  3177. deActivateKey
  3178. Left Argument: keyName
  3179. 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."
  3180. Example: deActivateKey "M04"
  3181. Category: General
  3182. @e
  3183. debriefingText
  3184. Left Argument: end
  3185. Description: "Return debriefing text."
  3186. Category: General
  3187. @e
  3188. debugFSM
  3189. Left Argument: FSM handle
  3190. Right Argument: true
  3191. Description: "Switch FSM debug log on/off."
  3192. Example: BIS_grpMainFSM debugFSM true
  3193. Category: General
  3194. @e
  3195. debugLog
  3196. Left Argument: anything
  3197. Description: "Dumps the argument's type and value to the debugging output."
  3198. Example: debugLog player
  3199. Category: General
  3200. @e
  3201. default
  3202. Left Argument: a
  3203. Description: "see switch"
  3204. Category: Default
  3205. @e
  3206. default
  3207. Left Argument: a
  3208. Description: "see switch"
  3209. Category: Default
  3210. @e
  3211. deg
  3212. Left Argument: x
  3213. Description: "Converts x from radians to degrees."
  3214. Example: deg 1
  3215. Example Return: 57.295
  3216. Category: Default
  3217. @e
  3218. deg
  3219. Left Argument: x
  3220. Description: "Converts x from radians to degrees."
  3221. Example: deg 1
  3222. Example Return: 57.295
  3223. Category: Default
  3224. @e
  3225. deleteAt
  3226. Left Argument: array
  3227. Right Argument: index
  3228. Description: "Remove element at given index(and use them as a return value)."
  3229. Example: array DeleteAt 4
  3230. Category: Default
  3231. @e
  3232. deleteAt
  3233. Left Argument: array
  3234. Right Argument: index
  3235. Description: "Remove element at given index(and use them as a return value)."
  3236. Example: array DeleteAt 4
  3237. Category: Default
  3238. @e
  3239. deleteCenter
  3240. Left Argument: side
  3241. Description: "Destroys the AI center of the given side."
  3242. Example: deleteCenter East
  3243. Category: General
  3244. @e
  3245. deleteCollection
  3246. Left Argument: object
  3247. Description: "same as hideObject."
  3248. Category: General
  3249. @e
  3250. deleteEditorObject
  3251. Left Argument: map
  3252. Right Argument: object
  3253. Description: "Delete the editor object. Requires all editor object links to be removed prior."
  3254. Category: Editor
  3255. @e
  3256. deleteGroup
  3257. Left Argument: group
  3258. Description: "Destroys the given AI group."
  3259. Example: deleteGroup group
  3260. Category: General
  3261. @e
  3262. deleteIdentity
  3263. Left Argument: identityName
  3264. Description: "Deletes an identity created by saveIdentity from the campaign progress file."
  3265. Example: deleteIdentity "playerIdentity"
  3266. Category: General
  3267. @e
  3268. deleteLocation
  3269. Left Argument: location
  3270. Description: "Delete the given location."
  3271. Category: Location
  3272. @e
  3273. deleteMarker
  3274. Left Argument: name
  3275. Description: "Destroys the given marker. The marker is destroyed on all computers in a network session."
  3276. Example: deleteMarker "Marker1"
  3277. Category: General
  3278. @e
  3279. deleteMarkerLocal
  3280. Left Argument: name
  3281. Description: "Destroys the given marker. The marker is only destroyed on the computer where the command is called."
  3282. Example: deleteMarkerLocal "Marker1"
  3283. Category: General
  3284. @e
  3285. deleteRange
  3286. Left Argument: array
  3287. Right Argument: [index,count]
  3288. Description: "Removes n consequent elements starting at given index."
  3289. Example: array deleteRange [2,8]
  3290. Category: Default
  3291. @e
  3292. deleteRange
  3293. Left Argument: array
  3294. Right Argument: [index,count]
  3295. Description: "Removes n consequent elements starting at given index."
  3296. Example: array deleteRange [2,8]
  3297. Category: Default
  3298. @e
  3299. deleteResources
  3300. Left Argument: teamMember
  3301. Right Argument: [resource1, resource2, ...]
  3302. Description: "Delete (unregister) resources of the team member."
  3303. Example: teamMember _agent deleteResources ["Legs"]
  3304. Category: Agents
  3305. @e
  3306. deleteSite
  3307. Left Argument: site
  3308. Description: "Removes the site."
  3309. Example: deleteSite tank
  3310. Category: General
  3311. @e
  3312. deleteStatus
  3313. Left Argument: statusName
  3314. Description: "Deletes a status created by saveStatus from the campaign progress file."
  3315. Example: deleteStatus "playerState"
  3316. Category: General
  3317. @e
  3318. deleteTeam
  3319. Left Argument: team
  3320. Description: "Destroy given team."
  3321. Example: deleteTeam _team
  3322. Category: Agents
  3323. @e
  3324. deleteVehicle
  3325. Left Argument: object
  3326. 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."
  3327. Example: deleteVehicle tank
  3328. Category: General
  3329. @e
  3330. deleteVehicleCrew
  3331. Left Argument: vehicle
  3332. Right Argument: crew
  3333. Description: "Deletes vehicle from vehicle even if crew is already dead."
  3334. Example: car deleteVehicleCrew soldier
  3335. Category: General
  3336. @e
  3337. deleteWaypoint
  3338. Left Argument: waypoint
  3339. Description: "Removes the waypoint."
  3340. Example: deleteWaypoint [grp, 2]
  3341. Category: General
  3342. @e
  3343. detach
  3344. Left Argument: obj
  3345. Description: "Detaches an object."
  3346. Example: detach player
  3347. Category: General
  3348. @e
  3349. detectedMines
  3350. Left Argument: side
  3351. Description: "Returns list af all mines detected by given side."
  3352. Example: detectedMines (side player)
  3353. Category: General
  3354. @e
  3355. diag_fps
  3356. Description: "Returns average framerate over last 16 frames."
  3357. Category: General
  3358. @e
  3359. diag_fpsmin
  3360. Description: "Returns minimal framerate. Calculated from the longest frame over last 16 frames."
  3361. Category: General
  3362. @e
  3363. diag_frameno
  3364. Description: "Returns number of frame currently displayed ."
  3365. Category: General
  3366. @e
  3367. diag_log
  3368. Left Argument: anything
  3369. Description: "Dumps the argument's type and value to the report file."
  3370. Example: diag_log player
  3371. Category: General
  3372. @e
  3373. diag_tickTime
  3374. Description: "Real time spent from the start of the game."
  3375. Category: General
  3376. @e
  3377. dialog
  3378. Description: "Returns whether a user dialog is present."
  3379. Category: General
  3380. @e
  3381. diarySubjectExists
  3382. Left Argument: person
  3383. Right Argument: name
  3384. Description: "Checks whether given subject is present in the diary of given person."
  3385. Category: Identity
  3386. @e
  3387. difficulty
  3388. Description: "Return difficulty."
  3389. Example: difficulty
  3390. Category: General
  3391. @e
  3392. difficultyEnabled
  3393. Left Argument: flag
  3394. Description: "Check if given difficulty setting is currently enabled. For possible values of flag, see config class Flags in CfgDificulties."
  3395. Category: General
  3396. @e
  3397. difficultyEnabledRTD
  3398. Description: "Returns true if rotorlib simulation is enabled. Forcing by mission is included."
  3399. Category: General
  3400. @e
  3401. direction
  3402. Left Argument: object
  3403. Description: "Returns the object heading in the range of 0 to 360."
  3404. Example: direction player
  3405. Category: General
  3406. @e
  3407. directSay
  3408. Left Argument: unit
  3409. Right Argument: radioName
  3410. Description: "Sends the message to the direct channel. The message is defined in the description.ext file or radio protocol."
  3411. Example: soldierOne directSay "messageOne"
  3412. Category: General
  3413. @e
  3414. disableAI
  3415. Left Argument: unit
  3416. Right Argument: section
  3417. Description: "Disables parts of the AI behaviour to get more control over a unit. Section is one of "TARGET" (disables watching assigned targets), "AUTOTARGET" (disables independed target assigning and watching of unknown targets) or "MOVE" (disables movement)."
  3418. Example: soldierOne disableAI "Move"
  3419. Category: General
  3420. @e
  3421. disableCollisionWith
  3422. Left Argument: vehicle
  3423. Right Argument: vehicle
  3424. Description: "Disable collision between vehicles."
  3425. Category: General
  3426. @e
  3427. disableConversation
  3428. Left Argument: unit
  3429. Right Argument: lock
  3430. Description: "Lock / unlock the unit to using conversation. Implemented by the counter, so lock - unlock need to be matched."
  3431. Example: player disableConversation true
  3432. Category: General
  3433. @e
  3434. disableDebriefingStats
  3435. Description: "Disable debriefing score table."
  3436. Example: disableDebriefingStats
  3437. Category: General
  3438. @e
  3439. disableSerialization
  3440. Description: "Disable saving of script containing this command. After this, script can work with the data types which do not support serialization (UI types)."
  3441. Category: Default
  3442. @e
  3443. disableSerialization
  3444. Description: "Disable saving of script containing this command. After this, script can work with the data types which do not support serialization (UI types)."
  3445. Category: Default
  3446. @e
  3447. disableTIEquipment
  3448. Left Argument: vehicle
  3449. Right Argument: enable/disable
  3450. Description: "Enable/disable transport vision modes(Ti)"
  3451. Category: General
  3452. @e
  3453. disableUAVConnectability
  3454. Left Argument: object
  3455. Right Argument: [uav, checkAllItems]
  3456. Description: "disable unit's AV terminal(s) connecting to UAV"
  3457. Example: unit DisableUAVConnectability [uav, true]
  3458. Category: General
  3459. @e
  3460. disableUserInput
  3461. Left Argument: disable
  3462. Description: "Disables all user input. This is normally used only in cutscenes to disable the player's controls."
  3463. Category: General
  3464. @e
  3465. displayAddEventHandler
  3466. Left Argument: display
  3467. Right Argument: [handler name, function]
  3468. Description: "Add an event handler to the given display. Returns id of the handler or -1 when failed."
  3469. Example: _id = _display displayAddEventHandler ["KeyDown", ""]
  3470. Category: General
  3471. @e
  3472. displayCtrl
  3473. Left Argument: display
  3474. Right Argument: idc
  3475. Description: "Return child control with specified idc."
  3476. Example: _control = _display displayCtrl 101
  3477. Category: General
  3478. @e
  3479. displayNull
  3480. Description: "A non-existing display. This value is not equal to anything, including itself."
  3481. Category: General
  3482. @e
  3483. displayRemoveAllEventHandlers
  3484. Left Argument: display
  3485. Right Argument: handler name
  3486. Description: "Remove all even handlers from the given display."
  3487. Example: _display displayRemoveAllEventHandlers "KeyDown"
  3488. Category: General
  3489. @e
  3490. displayRemoveEventHandler
  3491. Left Argument: display
  3492. Right Argument: [handler name, id]
  3493. Description: "Remove a given event handler from the given display."
  3494. Example: _display displayRemoveEventHandler ["KeyDown", 0]
  3495. Category: General
  3496. @e
  3497. displaySetEventHandler
  3498. Left Argument: display
  3499. Right Argument: [handler name, function]
  3500. Description: "Sets given event handler of given display."
  3501. Example: _control displaySetEventHandler ["KeyDown", ""]
  3502. Category: General
  3503. @e
  3504. dissolveTeam
  3505. Left Argument: team
  3506. Description: "Dissolves the given team. All members become members of the main team. Possible team values are: "RED", "GREEN", "BLUE" or "YELLOW"."
  3507. Example: dissolveTeam "RED"
  3508. Category: General
  3509. @e
  3510. distance
  3511. Left Argument: obj1 or pos1
  3512. Right Argument: obj2 or pos2
  3513. Description: "Computes the distance between two objects or positions."
  3514. Example: player distance leader player
  3515. Category: General
  3516. @e
  3517. distanceSqr
  3518. Left Argument: obj1 or pos1
  3519. Right Argument: obj2 or pos2
  3520. Description: "Computes the distance square between two objects or positions."
  3521. Example: player distanceSqr (leader player)
  3522. Category: General
  3523. @e
  3524. distributionRegion
  3525. Description: "Return the region where the game was sold (based on distribution id)."
  3526. Category: General
  3527. @e
  3528. do
  3529. Left Argument: while
  3530. Right Argument: code
  3531. Description: "Repeats the code while the condition is true. Note: the maximum repeat count for the loop is 10000. If the condition is still true after the loop was repeated 10000 times, the loop will be terminated and an error message is shown."
  3532. Example: while "a>b" do {a=a+1}
  3533. Category: Default
  3534. @e
  3535. do
  3536. Left Argument: while
  3537. Right Argument: code
  3538. Description: "Repeats the code while the condition is true. Note: the maximum repeat count for the loop is 10000. If the condition is still true after the loop was repeated 10000 times, the loop will be terminated and an error message is shown."
  3539. Example: while "a>b" do {a=a+1}
  3540. Category: Default
  3541. @e
  3542. doArtilleryFire
  3543. Left Argument: unit
  3544. Right Argument: [position, type, rounds]
  3545. Description: "Orders a unit to reaload defined magazine commence fire burst on the given position (silently)."
  3546. Example: mortar1 doArtilleryFire [[3000, 120, 1000], "8Rnd_82mm_Mo_shells", 3]
  3547. Category: General
  3548. @e
  3549. doFire
  3550. Left Argument: unit
  3551. Right Argument: target
  3552. Description: "Orders a unit to commence firing on the given target (silently). If the target is objNull, the unit is ordered to commence firing on its current target (set using doTarget or commandTarget)."
  3553. Example: soldierOne doFire objNull
  3554. Category: General
  3555. @e
  3556. doFollow
  3557. Left Argument: unit
  3558. Right Argument: position
  3559. Description: "Orders a unit to follow the given unit (silently)."
  3560. Example: soldierOne doFollow player
  3561. Category: General
  3562. @e
  3563. doFSM
  3564. Left Argument: unit(s)
  3565. Right Argument: [fsm name, position, target]
  3566. Description: "Orders a unit to process command defined by FSM file (silently)."
  3567. Example: soldierOne doFSM ["move.fsm", position player, player]
  3568. Category: General
  3569. @e
  3570. doGetOut
  3571. Left Argument: unit
  3572. Description: "Orders a unit to get out from the vehicle (silently)."
  3573. Example: doGetOut unitOne
  3574. Category: General
  3575. @e
  3576. doMove
  3577. Left Argument: unit
  3578. Right Argument: position
  3579. Description: "Orders the unit to move to the given position (format <ar>Position</ar>) (silently)."
  3580. Example: soldierOne doMove getMarkerPos "MarkerMoveOne"
  3581. Category: General
  3582. @e
  3583. doorPhase
  3584. Left Argument: object
  3585. Right Argument: animation
  3586. Description: "Return animation phase of door on vehicle."
  3587. Example: heli doorPhase "gunnerDoor"
  3588. Category: General
  3589. @e
  3590. doStop
  3591. Left Argument: unit
  3592. Description: "Orders the unit to stop (silently).
  3593. Note: the stop command is never finished; the unit will never be ready."
  3594. Example: doStop unitOne
  3595. Category: General
  3596. @e
  3597. doTarget
  3598. Left Argument: unit
  3599. Right Argument: position
  3600. Description: "Orders the unit to target the given target (silently)."
  3601. Example: soldierOne doTarget player
  3602. Category: General
  3603. @e
  3604. doWatch
  3605. Left Argument: unit
  3606. Right Argument: position
  3607. Description: "Orders the unit to watch the given position (format <ar>Position</ar>) (silently)."
  3608. Example: soldierOne doWatch getMarkerPos "MarkerMoveOne"
  3609. Category: General
  3610. @e
  3611. drawArrow
  3612. Left Argument: map
  3613. Right Argument: [position1, position2, color]
  3614. Description: "Draw arrow in map."
  3615. Category: General
  3616. @e
  3617. drawEllipse
  3618. Left Argument: map
  3619. Right Argument: [center, a, b, angle, color, fill]
  3620. Description: "Draw ellipse in map."
  3621. Category: General
  3622. @e
  3623. drawIcon
  3624. Left Argument: map
  3625. Right Argument: [texture, color, position, width, height, angle, text, shadow, textSize, font, align]
  3626. Description: "Draw icon in map."
  3627. Example: control drawIcon [ "#(argb,8,8,3)color(0,1,0,1)", [1,1,1,1], position player, 10, 10,1, userText, 1, 0.2, "TahomaB", "right"
  3628. Category: General
  3629. @e
  3630. drawIcon3D
  3631. Left Argument: [texture, color, position, width, height, angle, text, shadow, textSize, font]
  3632. Description: "Draws an ingame icon at a given position."
  3633. 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"]
  3634. Category: General
  3635. @e
  3636. drawLine
  3637. Left Argument: map
  3638. Right Argument: [position1, position2, color]
  3639. Description: "Draw line in map."
  3640. Category: General
  3641. @e
  3642. drawLine3D
  3643. Left Argument: [start, end, color]
  3644. Description: "Draws a line of a given COLOR from START to END."
  3645. Example: drawLine3D [position soldier, position cursorTarget, [1,1,1,1]]
  3646. Category: General
  3647. @e
  3648. drawLink
  3649. Left Argument: map
  3650. Right Argument: [from, to, param type, line type, color]
  3651. Description: "The editor will draw a line between the two specified editor objects. Line type can be LINE or ARROW."
  3652. Category: Editor
  3653. @e
  3654. drawLocation
  3655. Left Argument: map
  3656. Right Argument: location
  3657. Description: "Draw location in the map."
  3658. Category: Location PC
  3659. @e
  3660. drawRectangle
  3661. Left Argument: map
  3662. Right Argument: [center, a, b, angle, color, fill]
  3663. Description: "Draw rectangle in map."
  3664. Category: General
  3665. @e
  3666. driver
  3667. Left Argument: vehicle
  3668. Description: "Returns the driver of the vehicle. If the vehicle is not a vehicle, but a person, the person is returned instead."
  3669. Example: driver vehicle player
  3670. Category: General
  3671. @e
  3672. drop
  3673. Left Argument: array
  3674. Description: "Drops a particle into the scene. Array is in format <ar>ParticleArray</ar>."
  3675. Category: General
  3676. @e
  3677. east
  3678. Description: "The East side."
  3679. Category: General
  3680. @e
  3681. echo
  3682. Left Argument: text
  3683. Description: "Sends any text into the debugger console or the logfile."
  3684. Example: echo "Text in logfile"
  3685. Category: Default
  3686. @e
  3687. echo
  3688. Left Argument: text
  3689. Description: "Sends any text into the debugger console or the logfile."
  3690. Example: echo "Text in logfile"
  3691. Category: Default
  3692. @e
  3693. editObject
  3694. Left Argument: map
  3695. Right Argument: object
  3696. Description: "Show the edit object dialog for the given object."
  3697. Category: Editor
  3698. @e
  3699. editorSetEventHandler
  3700. Left Argument: map
  3701. Right Argument: [handler name, function]
  3702. Description: "Sets given event handler of given editor."
  3703. Example: _map editorSetEventHandler ["SelectObject", ""]
  3704. Category: Editor
  3705. @e
  3706. effectiveCommander
  3707. Left Argument: vehicle
  3708. Description: "Returns the effective commander (who really commands) of the vehicle."
  3709. Category: General
  3710. @e
  3711. else
  3712. Left Argument: ifCode
  3713. Right Argument: elseCode
  3714. Description: "Constructs an array that can be processed by <f>then</f>."
  3715. Example: if (a>b) then {c=0} else {c=1}
  3716. Category: Default
  3717. @e
  3718. else
  3719. Left Argument: ifCode
  3720. Right Argument: elseCode
  3721. Description: "Constructs an array that can be processed by <f>then</f>."
  3722. Example: if (a>b) then {c=0} else {c=1}
  3723. Category: Default
  3724. @e
  3725. emptyPositions
  3726. Left Argument: vehicle
  3727. Right Argument: position
  3728. Description: "Returns the number of available cargo, driver, gunner or commander positions in the vehicle."
  3729. Example: _freePositions = (vehicle player) freePositions "cargo"
  3730. Category: General
  3731. @e
  3732. enableAI
  3733. Left Argument: unit
  3734. Right Argument: section
  3735. Description: "Enables parts of the AI behaviour. Section is one of "TARGET" (enables watching assigned targets), "AUTOTARGET" (enables independed target assigning and watching of unknown targets) or "MOVE" (enables movement)."
  3736. Example: soldierOne enableAI "Move"
  3737. Category: General
  3738. @e
  3739. enableAIFeature
  3740. Left Argument: feature
  3741. Right Argument: enabled
  3742. Description: "Enable/disable given AI feature. Feature may be one of: "AwareFormationSoft", "CombatFormationSoft"."
  3743. Example: "AwareFormationSoft" enableAIFeature true
  3744. Category: General
  3745. @e
  3746. enableAttack
  3747. Left Argument: group
  3748. Right Argument: enable
  3749. Description: "Set if leader can issue attack commands."
  3750. Category: General
  3751. @e
  3752. enableAutoStartUpRTD
  3753. Left Argument: RTD_helicopter
  3754. Right Argument: enabled
  3755. Description: "enables automatic start up action,"
  3756. Category: General
  3757. @e
  3758. enableAutoTrimRTD
  3759. Left Argument: RTD_helicopter
  3760. Right Argument: bool
  3761. Description: "eanbles autoTrim"
  3762. Category: General
  3763. @e
  3764. enableCamShake
  3765. Left Argument: true/false
  3766. Description: "Enables/disables camera shakes."
  3767. Category: General
  3768. @e
  3769. enableCaustics
  3770. Left Argument: enable
  3771. Description: "Enable/disable caustics drawing."
  3772. Category: General
  3773. @e
  3774. enableCollisionWith
  3775. Left Argument: vehicle
  3776. Right Argument: vehicle
  3777. Description: "Enable collision between vehicles."
  3778. Category: General
  3779. @e
  3780. enableCopilot
  3781. Left Argument: vehicle
  3782. Right Argument: enable
  3783. Description: "Enables copilot actions."
  3784. Category: General
  3785. @e
  3786. enableDebriefingStats
  3787. Left Argument: [left, top, width, height]
  3788. Description: "Enable debriefing score table. The table will be displayed at specified coordinates."
  3789. Example: enableDebriefingStats [0.1, 0.1, 0.8, 0.8]
  3790. Category: General
  3791. @e
  3792. enableDiagLegend
  3793. Left Argument: true/false
  3794. Description: "Enable or disable legend for diagnostic"
  3795. Example: enableDiagLegend false
  3796. Category: General
  3797. @e
  3798. enableEndDialog
  3799. Description: "Enables the dialog buttons to be shown during the OnPlayerKilled script."
  3800. Category: General
  3801. @e
  3802. enableEngineArtillery
  3803. Left Argument: true/false
  3804. Description: "Enables/disables engine's artillery."
  3805. Category: General
  3806. @e
  3807. enableEnvironment
  3808. Left Argument: enabled
  3809. Description: "Enable/disable environmental effects (ambient life + sound)."
  3810. Example: enableEnvironment false
  3811. Category: General
  3812. @e
  3813. enableFatigue
  3814. Left Argument: unit
  3815. Right Argument: bool
  3816. Description: "Enables/Disables the person's fatigue."
  3817. Example: player enableFatigue false
  3818. Category: General
  3819. @e
  3820. enableGunLights
  3821. Left Argument: group
  3822. Right Argument: mode
  3823. Description: "Tells AI units to force the gun light on (forceOn), off (forceOff) or set it automatically when in combat mode (auto)"
  3824. Example: groupOne enableGunLights "forceOff"
  3825. Category: General
  3826. @e
  3827. enableIRLasers
  3828. Left Argument: group
  3829. Right Argument: enable
  3830. Description: "Enable/disable using IR lasers for AI"
  3831. Example: groupOne enableIRLasers true
  3832. Category: General
  3833. @e
  3834. enableMimics
  3835. Left Argument: unit
  3836. Right Argument: enabled
  3837. Description: "Enables/disables mimics on a given unit"
  3838. Example: cursorTarget enableMimics false
  3839. Category: General
  3840. @e
  3841. enablePersonTurret
  3842. Left Argument: vehicle
  3843. Right Argument: [turret path, enable]
  3844. Description: "Enables/disables usage of PersonTurret"
  3845. Example: heli enablePersonTurret [[1], true]
  3846. Category: General
  3847. @e
  3848. enableRadio
  3849. Left Argument: enable
  3850. Description: "Enables radio transmissions to be heard and seen on screen."
  3851. Category: General
  3852. @e
  3853. enableReload
  3854. Left Argument: object
  3855. Right Argument: enable
  3856. Description: "Enable / disable reload right after magazine is empty."
  3857. Example: _vehicle enableReload false
  3858. Category: General
  3859. @e
  3860. enableRopeAttach
  3861. Left Argument: vehicle
  3862. Right Argument: enable
  3863. Description: "Enable / disable ability to attach ropes or to be attached to ropes for given vehicle"
  3864. Category: General
  3865. @e
  3866. enableSatNormalOnDetail
  3867. Left Argument: true/false
  3868. Description: "Enables/disables satellite normal map od detail maps."
  3869. Category: General
  3870. @e
  3871. enableSaving
  3872. Left Argument: enable or [enable, save]
  3873. Description: "Enable / disable saving of the game. When disabled, the autosave is created (if not forbidden by save == false)."
  3874. Category: General
  3875. @e
  3876. enableSentences
  3877. Left Argument: enable
  3878. Description: "Enables radio transmissions to be heard and seen on screen. It does not affect KBTell conversations."
  3879. Category: General
  3880. @e
  3881. enableSimulation
  3882. Left Argument: entity
  3883. Right Argument: enable
  3884. Description: "Enable / disable simulation for given entity."
  3885. Category: General
  3886. @e
  3887. enableSimulationGlobal
  3888. Left Argument: entity
  3889. Right Argument: enable
  3890. Description: "Enable / disable simulation for given entity globally. Only from server"
  3891. Category: General
  3892. @e
  3893. enableStressDamage
  3894. Left Argument: enable
  3895. Description: "Enable stress damage."
  3896. Category: General
  3897. @e
  3898. enableTeamSwitch
  3899. Left Argument: enable
  3900. Description: "Enable / disable team switch."
  3901. Category: General
  3902. @e
  3903. enableTraffic
  3904. Left Argument: enable
  3905. Description: "Enable ambient traffic."
  3906. Category: General
  3907. @e
  3908. enableUAVConnectability
  3909. Left Argument: object
  3910. Right Argument: [uav, checkAllItems]
  3911. Description: "enable unit's AV terminal(s) connecting to UAV"
  3912. Example: unit enableUAVConnectability [uav, true]
  3913. Category: General
  3914. @e
  3915. enableUAVWaypoints
  3916. Left Argument: vehicle
  3917. Right Argument: bool
  3918. Description: "Enable/disable option to set waypoints for UAV unit in AV terminal"
  3919. Example: vehicle enableUAVWaypoints false
  3920. Category: General
  3921. @e
  3922. endLoadingScreen
  3923. Description: "Finish loading screen displaying (started by startLoadingScreen)."
  3924. Category: General
  3925. @e
  3926. endMission
  3927. Left Argument: end type
  3928. Description: "Finish the mission. The end type can be "CONTINUE", "KILLED", "LOSER", "END1", "END2", "END3", "END4", "END5", or "END6"."
  3929. Category: General
  3930. @e
  3931. engineOn
  3932. Left Argument: vehicle
  3933. Right Argument: on
  3934. Description: "Switches the vehicle's engine on (true) or off (false)."
  3935. Example: vehicle player engineOn false
  3936. Category: General
  3937. @e
  3938. enginesIsOnRTD
  3939. Left Argument: RTD_helicopter
  3940. Description: "Returns which engines are producing some work."
  3941. Category: General
  3942. @e
  3943. enginesPowerRTD
  3944. Left Argument: RTD_Helicopter
  3945. Description: "Power produced by engines in Watts."
  3946. Category: General
  3947. @e
  3948. enginesRpmRTD
  3949. Left Argument: RTD_helicopter
  3950. Description: "Returns all engines RPM."
  3951. Category: General
  3952. @e
  3953. enginesTorqueRTD
  3954. Left Argument: RTD_Helicopter
  3955. Description: "Torque produced by engines in Newton*meter."
  3956. Category: General
  3957. @e
  3958. entities
  3959. Left Argument: type
  3960. Description: "Returns a list of entities with given type. "
  3961. Example: entities "Car"
  3962. Category: General
  3963. @e
  3964. estimatedEndServerTime
  3965. Description: "Estimated end of MP game converted to serverTime."
  3966. Category: General
  3967. @e
  3968. estimatedTimeLeft
  3969. Left Argument: timeLeft
  3970. 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."
  3971. Example: estimatedTimeLeft Param1
  3972. Category: General
  3973. @e
  3974. evalObjectArgument
  3975. Left Argument: map
  3976. Right Argument: [object, argument]
  3977. Description: "Return object argument in mission editor."
  3978. Category: Editor
  3979. @e
  3980. everyBackpack
  3981. Left Argument: box
  3982. Description: "Returns array of backpacks stored in given crate .e.g. used for accessing backpack content of a backpack on ground."
  3983. Example: everyBackpack cursorTarget
  3984. Category: General
  3985. @e
  3986. everyContainer
  3987. Left Argument: box
  3988. 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."
  3989. Example: everyContainer cursorTarget
  3990. Category: General
  3991. @e
  3992. exec
  3993. Left Argument: argument
  3994. Right Argument: script
  3995. Description: "Executes a script. Argument is passed to the script as local variable _this. The script is first searched in the mission folder, then in the campaign scripts subfolder and finally in the global scripts folder."
  3996. Example: [player, jeepOne] exec "getIn.sqs"
  3997. Category: General
  3998. @e
  3999. execEditorScript
  4000. Left Argument: map
  4001. Right Argument: [object, script]
  4002. Description: "Execute an editor script for the specified object."
  4003. Example: _map execEditorScript ["_team_1", "create"]
  4004. Category: Editor
  4005. @e
  4006. execFSM
  4007. Left Argument: filename
  4008. 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."
  4009. Example: execFSM "test.fsm"
  4010. Category: General
  4011. @e
  4012. execFSM
  4013. Left Argument: argument
  4014. Right Argument: filename
  4015. Description: "Execute the scripted FSM. Argument is passed to the FSM as local variable _this. 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."
  4016. Example: player execFSM "test.fsm"
  4017. Category: General
  4018. @e
  4019. execVM
  4020. Left Argument: filename
  4021. 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."
  4022. Example: execVM "test.sqf"
  4023. Category: General
  4024. @e
  4025. execVM
  4026. Left Argument: argument
  4027. Right Argument: filename
  4028. Description: "Compile and execute function (sqf). Argument is passed to the script as local variable _this. The function is first searched in the mission folder, then in the campaign scripts folder and finally in the global scripts folder."
  4029. Example: player execVM "test.sqf"
  4030. Category: General
  4031. @e
  4032. exit
  4033. Description: "Exits the script."
  4034. Category: General
  4035. @e
  4036. exitWith
  4037. Left Argument: if
  4038. Right Argument: code
  4039. Description: "if result of condition is true, evaluates code, and current block with result of code"
  4040. Example: if (_x>5) exitWith {echo "_x is too big";_x}
  4041. Example Return: [when _x is greater then 5, outputs message and terminates code in current level with value of _x
  4042. Category: Default
  4043. @e
  4044. exitWith
  4045. Left Argument: if
  4046. Right Argument: code
  4047. Description: "if result of condition is true, evaluates code, and current block with result of code"
  4048. Example: if (_x>5) exitWith {echo "_x is too big";_x}
  4049. Example Return: [when _x is greater then 5, outputs message and terminates code in current level with value of _x
  4050. Category: Default
  4051. @e
  4052. exp
  4053. Left Argument: x
  4054. Description: "The exponential value of x."
  4055. Example: exp 1
  4056. Example Return: 2.7182
  4057. Category: Default
  4058. @e
  4059. exp
  4060. Left Argument: x
  4061. Description: "The exponential value of x."
  4062. Example: exp 1
  4063. Example Return: 2.7182
  4064. Category: Default
  4065. @e
  4066. expectedDestination
  4067. Left Argument: person
  4068. Description: "Return expected destination of unit as a [position, planningMode, forceReplan]."
  4069. Category: General
  4070. @e
  4071. eyeDirection
  4072. Left Argument: unit
  4073. Description: "Returns the direction object is watching (eyes, or a vehicle primary observer)."
  4074. Example: eyeDirection player
  4075. Category: General
  4076. @e
  4077. eyePos
  4078. Left Argument: obj
  4079. Description: "Returns the position of the object eye in format <ar>PositionASL</ar>."
  4080. Example: eyePos player
  4081. Category: General
  4082. @e
  4083. face
  4084. Left Argument: object
  4085. Description: "Returns the face from identity of given object."
  4086. Example: face player
  4087. Category: General
  4088. @e
  4089. faction
  4090. Left Argument: unit
  4091. Description: "Gets unit faction. If faction is not defined, returns empty string."
  4092. Category: General
  4093. @e
  4094. factor
  4095. Left Argument: expr
  4096. Right Argument: val
  4097. Description: "Extend expression"
  4098. Category: Simple expression
  4099. @e
  4100. fadeMusic
  4101. Left Argument: time
  4102. Right Argument: volume
  4103. Description: "Causes a smooth change in the music volume. The change duration is given by time, the target volume by volume. The default music volume is 0.5."
  4104. Example: 5 fadeMusic 0
  4105. Category: General
  4106. @e
  4107. fadeRadio
  4108. Left Argument: time
  4109. Right Argument: volume
  4110. Description: "Causes a smooth change in the radio volume. The change duration is given by time, the target volume by volume. The default radio volume is 1.0."
  4111. Example: 5 fadeRadio 0.1
  4112. Category: General
  4113. @e
  4114. fadeSound
  4115. Left Argument: time
  4116. Right Argument: volume
  4117. Description: "Causes a smooth change in the master volume. The change duration is given by time, the target volume by volume. The default master volume is 1.0."
  4118. Example: 5 fadeSound 0.1
  4119. Category: General
  4120. @e
  4121. fadeSpeech
  4122. Left Argument: time
  4123. Right Argument: volume
  4124. Description: "Causes a smooth change in the master speech volume. The change duration is given by time, the target volume by volume. The default master volume is 1.0."
  4125. Example: 5 fadeSound 0.1
  4126. Category: General
  4127. @e
  4128. failMission
  4129. Left Argument: end type
  4130. 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."
  4131. Category: General
  4132. @e
  4133. false
  4134. Description: "Always false."
  4135. Category: Default
  4136. @e
  4137. false
  4138. Description: "Always false."
  4139. Category: Default
  4140. @e
  4141. fillWeaponsFromPool
  4142. Left Argument: person
  4143. Description: "Adds magazines from the campaign pool to the person (depending on the weapons the person has)."
  4144. Example: fillWeaponsFromPool victor
  4145. Category: General
  4146. @e
  4147. find
  4148. Left Argument: array
  4149. Right Argument: x
  4150. Description: "Returns the position of the first array element that matches x, returns -1 if not found."
  4151. Example: [0, 1, 2] find 1
  4152. Example Return: 1
  4153. Category: Default
  4154. @e
  4155. find
  4156. Left Argument: array
  4157. Right Argument: x
  4158. Description: "Returns the position of the first array element that matches x, returns -1 if not found."
  4159. Example: [0, 1, 2] find 1
  4160. Example Return: 1
  4161. Category: Default
  4162. @e
  4163. findCover
  4164. Left Argument: object
  4165. Right Argument: [position, hidePosition, maxDist, minDist, visibilityPosition, ignoreObject]
  4166. Description: "Returns the object where the object should search for cover. The minDist, visibilityPosition and ignoreObject parameters are optional. visibilityPosition is used to select cover that can see a certain position. ignoreObject is an object that is ignored in visibility check."
  4167. Category: General
  4168. @e
  4169. findDisplay
  4170. Left Argument: idd
  4171. Description: "Find display by its IDD."
  4172. Example: _display = findDisplay 1
  4173. Category: General
  4174. @e
  4175. findEditorObject
  4176. Left Argument: map
  4177. Right Argument: [type, name1, value1, ...]
  4178. Description: "Return object of given type with given arguments. Use [type, game value] to search by object reference of a specific editor object type."
  4179. Category: Editor
  4180. @e
  4181. findEmptyPosition
  4182. Left Argument: center
  4183. Right Argument: [radius, maxDistance] or [radius, maxDistance, vehicleType]
  4184. Description: "Search for the position nearest (up to maxDistance) to the center, with the free area (vehicle of the given type can be placed anywhere) of the given radius. When not found, empty array is returned."
  4185. Category: General
  4186. @e
  4187. findEmptyPositionReady
  4188. Left Argument: center
  4189. Right Argument: [radius, maxDistance]
  4190. Description: "Check if findEmptyPosition can be called without waiting for files."
  4191. Category: General
  4192. @e
  4193. findNearestEnemy
  4194. Left Argument: object
  4195. Right Argument: position
  4196. Description: "Find the nearest enemy from the specified position."
  4197. Category: General
  4198. @e
  4199. finishMissionInit
  4200. Description: "Finish world initialization before mission is launched."
  4201. Category: General
  4202. @e
  4203. finite
  4204. Left Argument: x
  4205. Description: "True, if number is finite (not infinite and valid number)"
  4206. Example: finite 10/0
  4207. Example Return: false
  4208. Category: Default
  4209. @e
  4210. finite
  4211. Left Argument: x
  4212. Description: "True, if number is finite (not infinite and valid number)"
  4213. Example: finite 10/0
  4214. Example Return: false
  4215. Category: Default
  4216. @e
  4217. fire
  4218. Left Argument: unit
  4219. Right Argument: weaponName
  4220. Description: "The unit will fire from the given weapon."
  4221. Example: soldierOne fire "HandGrenade"
  4222. Category: General
  4223. @e
  4224. fireAtTarget
  4225. Left Argument: vehicle
  4226. Right Argument: [target, weapon]
  4227. Description: "Gunner in unit's vehicle fire at given target. If weapon is not given, current is used."
  4228. Example: bool = vehicle FireAtTarget [target]; bool = player FireAtTarget [target,1]
  4229. Category: General
  4230. @e
  4231. firstBackpack
  4232. Left Argument: box
  4233. Description: "Returns object of the first stored backpack in another weaponholder.e.g. used for accessing backpack content of a backpack on ground."
  4234. Example: firstBackpack cursorTarget
  4235. Category: General
  4236. @e
  4237. flag
  4238. Left Argument: unit
  4239. Description: "If the unit has a flag, this flag is returned.
  4240. If not, objNull is returned."
  4241. Example: flag player
  4242. Category: General
  4243. @e
  4244. flagOwner
  4245. Left Argument: flag
  4246. Description: "When used on a flag, the returned value is the person that has this flag.
  4247. When used on anything else, objNull is returned."
  4248. Example: flagowner flagOne
  4249. Category: General
  4250. @e
  4251. fleeing
  4252. Left Argument: unit
  4253. Description: "Checks whether the unit is fleeing. A dead or empty unit returns false."
  4254. Example: fleeing player
  4255. Category: General
  4256. @e
  4257. floor
  4258. Left Argument: x
  4259. Description: "The floor value of x."
  4260. Example: floor 5.25
  4261. Example Return: 5
  4262. Category: Default
  4263. @e
  4264. floor
  4265. Left Argument: x
  4266. Description: "The floor value of x."
  4267. Example: floor 5.25
  4268. Example Return: 5
  4269. Category: Default
  4270. @e
  4271. flyInHeight
  4272. Left Argument: helicopter
  4273. Right Argument: height
  4274. Description: "Sets the height level for the helicopter. The accepted range is from 50 to 1000."
  4275. Example: cobraOne flyInHeight 150
  4276. Category: General
  4277. @e
  4278. fog
  4279. Description: "Return the current fog."
  4280. Category: General
  4281. @e
  4282. fogForecast
  4283. Description: "Return the fog forecast."
  4284. Category: General
  4285. @e
  4286. fogParams
  4287. Description: "Returns actual params for fog."
  4288. Category: General
  4289. @e
  4290. for
  4291. Left Argument: var
  4292. Description: "Starts for sequence, use in complette form(see example)."
  4293. Example: for "_x" from 1 to 10 do {debugLog _x;}
  4294. Category: Default
  4295. @e
  4296. for
  4297. Left Argument: var
  4298. Description: "Starts for sequence, use in complette form(see example)."
  4299. Example: for "_x" from 1 to 10 do {debugLog _x;}
  4300. Category: Default
  4301. @e
  4302. forceAddUniform
  4303. Left Argument: unit
  4304. Right Argument: type
  4305. Description: "Create a new uniform and hard link it into uniform slot(without any restrictions)."
  4306. Category: General
  4307. @e
  4308. forceAtPositionRTD
  4309. Left Argument: position
  4310. Description: "Add force generator to world. Returns force index."
  4311. Category: General
  4312. @e
  4313. forceEnd
  4314. Description: "Forces the mission to terminate."
  4315. Category: General
  4316. @e
  4317. forceGeneratorRTD
  4318. Left Argument: index
  4319. Description: "Add force generator to world. Returns force index."
  4320. Category: General
  4321. @e
  4322. forceMap
  4323. Left Argument: show
  4324. Description: "Forces the map to display."
  4325. Example: forceMap true
  4326. Category: General
  4327. @e
  4328. forceRespawn
  4329. Left Argument: targetUnit
  4330. Description: "Force respawns given unit (stays old "killed" body). Will not count score"
  4331. Category: General
  4332. @e
  4333. forceSpeed
  4334. Left Argument: object
  4335. Right Argument: speed
  4336. Description: "Force the speed of the given object."
  4337. Category: General
  4338. @e
  4339. forceWalk
  4340. Left Argument: player
  4341. Right Argument: force walk
  4342. Description: "Force player to walk."
  4343. Example: player forceWalk true
  4344. Category: General
  4345. @e
  4346. forceWeaponFire
  4347. Left Argument: unit
  4348. Right Argument: [weapon, mode]
  4349. Description: "The unit will be forced to fire from the given weapon."
  4350. Example: soldierOne forceWeaponFire ["arifle_MX_F",0]
  4351. Category: General
  4352. @e
  4353. forceWeatherChange
  4354. Description: "Forces saved wanted settings for weather to be actual. (BEWARE: Will cause lag)"
  4355. Category: General
  4356. @e
  4357. forEach
  4358. Left Argument: command
  4359. Right Argument: array
  4360. Description: "Executes the given command for each element in array.
  4361. It's executed as follows:
  4362.  
  4363. for each element of array an element is assigned as _x and the command is executed."
  4364. Example: "_x setdammage 1" forEach units group player
  4365. Category: Default
  4366. @e
  4367. forEach
  4368. Left Argument: command
  4369. Right Argument: array
  4370. Description: "Executes the given command for each element in array.
  4371. It's executed as follows:
  4372.  
  4373. for each element of array an element is assigned as _x and the command is executed."
  4374. Example: "_x setdammage 1" forEach units group player
  4375. Category: Default
  4376. @e
  4377. forEachMember
  4378. Left Argument: command
  4379. Right Argument: team
  4380. Description: "Executes the given command for each member of the team (recursively)."
  4381. Category: Agents
  4382. @e
  4383. forEachMemberAgent
  4384. Left Argument: command
  4385. Right Argument: team
  4386. Description: "Executes the given command for each agent member of the team (recursively)."
  4387. Category: Agents
  4388. @e
  4389. forEachMemberTeam
  4390. Left Argument: command
  4391. Right Argument: team
  4392. Description: "Executes the given command for each team member of the team (recursively)."
  4393. Category: Agents
  4394. @e
  4395. format
  4396. Left Argument: format
  4397. 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."
  4398. Example: format ["%1 - %2 - %1", 1, "text"]
  4399. Example Return: "1 - text - 1"
  4400. Category: General
  4401. @e
  4402. formation
  4403. Left Argument: grp
  4404. Description: "Returns the formation of the group ("COLUMN", "STAG COLUMN", "WEDGE", "ECH LEFT", "ECH RIGHT", "VEE" or "LINE")."
  4405. Example: formation group player
  4406. Category: General
  4407. @e
  4408. formationDirection
  4409. Left Argument: person
  4410. Description: "Return the direction unit watching in formation."
  4411. Category: General
  4412. @e
  4413. formationLeader
  4414. Left Argument: person
  4415. Description: "Return leader of the formation."
  4416. Category: General
  4417. @e
  4418. formationMembers
  4419. Left Argument: person
  4420. Description: "Return list of units (drivers) in the formation."
  4421. Category: General
  4422. @e
  4423. formationPosition
  4424. Left Argument: person
  4425. Description: "Return position of unit in the formation."
  4426. Category: General
  4427. @e
  4428. formationTask
  4429. Left Argument: person
  4430. Description: "Return the current task of the unit in the formation."
  4431. Category: General
  4432. @e
  4433. formatText
  4434. Left Argument: [format, arg1, arg2, ...]
  4435. Description: "Creates a structured text by replacing %1, %2, etc. in format by plain or structured texts given as arguments."
  4436. Example: txt = formatText ["Image: %1", image "data\isniper.paa"]
  4437. Category: General
  4438. @e
  4439. formLeader
  4440. Left Argument: unit
  4441. 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."
  4442. Example: formLeader player != leader player
  4443. Category: General
  4444. @e
  4445. freeLook
  4446. Description: "Returns true if freelook is active."
  4447. Category: General
  4448. @e
  4449. from
  4450. Left Argument: for "_var"
  4451. Right Argument: b
  4452. Description: "Continue sequence of 'for' command."
  4453. Example: for "_x" from 10 to 20 do {..code..}
  4454. Category: Default
  4455. @e
  4456. from
  4457. Left Argument: for "_var"
  4458. Right Argument: b
  4459. Description: "Continue sequence of 'for' command."
  4460. Example: for "_x" from 10 to 20 do {..code..}
  4461. Category: Default
  4462. @e
  4463. fromEditor
  4464. Left Argument: teamMember
  4465. Description: "Return if given team was inserted directly from mission editor."
  4466. Example: _fromEditor = fromEditor _member
  4467. Category: Agents
  4468. @e
  4469. fuel
  4470. Left Argument: vehicle
  4471. Description: "Checks how much fuel is left in the gas tank, in the range from 0 to 1."
  4472. Example: fuel vehicle player
  4473. Category: General
  4474. @e
  4475. fullCrew
  4476. Left Argument: vehicle
  4477. Description: "Returns array with all crew inside given vehicle"
  4478. Example: fullCrew vehicle player
  4479. Category: General
  4480. @e
  4481. gearIDCAmmoCount
  4482. Left Argument: control IDC
  4483. Description: "Returns ammo count of assigned magazine."
  4484. Example: ammo = gearSlotAmmoCount IDC
  4485. Category: General
  4486. @e
  4487. gearSlotAmmoCount
  4488. Left Argument: control
  4489. Description: "Returns ammo count of assigned magazine."
  4490. Example: ammo = gearSlotAmmoCount _control
  4491. Category: General
  4492. @e
  4493. gearSlotData
  4494. Left Argument: control
  4495. Description: "Returns gear slot item name."
  4496. Example: weapon = gearSlotData _control
  4497. Category: General
  4498. @e
  4499. getAmmoCargo
  4500. Left Argument: vehicle
  4501. Description: "Returns the amount of ammo resources in the cargo space of a repair vehicle."
  4502. Example: getAmmoCargo vehicle
  4503. Category: General
  4504. @e
  4505. getArray
  4506. Left Argument: config
  4507. Description: "Extract array from config entry."
  4508. Example: _array = getArray (configFile >> "CfgVehicles" >> "Thing" >> "threat")
  4509. Category: General
  4510. @e
  4511. getArtilleryAmmo
  4512. Left Argument: [unitlist]
  4513. Description: "Get list of all available magazines of artillery units in the list."
  4514. Category: General
  4515. @e
  4516. getArtilleryComputerSettings
  4517. Description: "Returns settings from artillery computer currently opened by player."
  4518. Category: General
  4519. @e
  4520. getArtilleryETA
  4521. Left Argument: unit
  4522. Right Argument: [position, magazineType]
  4523. Description: "Get ETA in seconds for given atrillery unit, it's magazineType and target position. Returns negative value if fire is not possible."
  4524. Category: General
  4525. @e
  4526. getAssignedCuratorLogic
  4527. Left Argument: player
  4528. Description: "Returns curator logic to which has given player access."
  4529. Category: General
  4530. @e
  4531. getAssignedCuratorUnit
  4532. Left Argument: curatorObj
  4533. Description: "Returns unit assigned to curator logic."
  4534. Category: General
  4535. @e
  4536. getBackpackCargo
  4537. Left Argument: box
  4538. Description: "Returns all backpacks names and count from ammo box (or any general weapon holder container)."
  4539. Example: getBackpackCargo jeepOne
  4540. Category: General
  4541. @e
  4542. getBleedingRemaining
  4543. Left Argument: unit
  4544. Description: "Return reamining time of bleeding."
  4545. Category: General
  4546. @e
  4547. getBurningValue
  4548. Left Argument: unit
  4549. Description: "Return amount of damage from fire."
  4550. Category: General
  4551. @e
  4552. getCargoIndex
  4553. Left Argument: vehicle
  4554. Right Argument: Unit
  4555. Description: "Returns the index of the unit in Cargo"
  4556. Example: _index = _Jeep getCargoIndex player
  4557. Category: General
  4558. @e
  4559. getCenterOfMass
  4560. Left Argument: object
  4561. Description: "Returns center of mass of an object"
  4562. Example: com = getCenterOfMass myEntity
  4563. Category: General
  4564. @e
  4565. getClientState
  4566. Description: "Return client state in network game"
  4567. Category: General
  4568. @e
  4569. getConnectedUAV
  4570. Left Argument: Unit
  4571. Description: "Returns UAV if unit has connection to some UAV."
  4572. Example: getConnectedUAV player
  4573. Category: General
  4574. @e
  4575. getDammage
  4576. Left Argument: obj
  4577. Description: "Returns the object damage in the range from 0 to 1."
  4578. Example: getDammage player
  4579. Category: General
  4580. @e
  4581. getDescription
  4582. Left Argument: unit
  4583. Description: "Returns the string representation of unit as an four slots array ([unit,uniform,vest,backpack])"
  4584. Example: getDescription player
  4585. Category: General
  4586. @e
  4587. getDir
  4588. Left Argument: obj
  4589. Description: "Returns the object heading in the range from 0 to 360."
  4590. Example: getDir player
  4591. Category: General
  4592. @e
  4593. getDirVisual
  4594. Left Argument: obj
  4595. Description: "Returns the object heading in the range from 0 to 360."
  4596. Example: getDir player
  4597. Category: General
  4598. @e
  4599. getDLCAssetsUsage
  4600. 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], ...]"
  4601. Category: General
  4602. @e
  4603. getDLCAssetsUsageByName
  4604. Left Argument: assetName
  4605. Description: "Returns an array with the session and global time the asset has been used."
  4606. Category: General
  4607. @e
  4608. getDLCs
  4609. Left Argument: filter
  4610. Description: "Returns list of appIds of game DLCs. Use filter param to get only certain DLCs: 0:all, 1:owned, 2:not owned"
  4611. Category: General
  4612. @e
  4613. getDLCUsageTime
  4614. Left Argument: appId
  4615. Description: "Returns total time the assets of the given DLC has been used."
  4616. Category: General
  4617. @e
  4618. getEditorCamera
  4619. Left Argument: map
  4620. Description: "Fetches a reference to the mission editor camera."
  4621. Category: Editor
  4622. @e
  4623. getEditorMode
  4624. Left Argument: map
  4625. Description: "Returns the current mode of the editor."
  4626. Category: Editor
  4627. @e
  4628. getEditorObjectScope
  4629. Left Argument: map
  4630. Right Argument: object
  4631. Description: "Returns the editor object scope of the specified editor object."
  4632. Category: Editor
  4633. @e
  4634. getElevationOffset
  4635. Description: "Returns the map elevation offset from [map]/config.cpp"
  4636. Category: General
  4637. @e
  4638. getEngineTargetRPMRTD
  4639. Left Argument: RTD_helicopter
  4640. Description: "Returns target rpm of all engines."
  4641. Category: General
  4642. @e
  4643. getFatigue
  4644. Left Argument: unit
  4645. Description: "Returns fatigue of given unit."
  4646. Category: General
  4647. @e
  4648. getFieldManualStartPage
  4649. Left Argument: display
  4650. Description: "Returns array of the starting topic and hint the given field manual should display"
  4651. Category: General
  4652. @e
  4653. getFriend
  4654. Left Argument: side1
  4655. Right Argument: side2
  4656. Description: "Returns if sides are friendly or hostile. For a value smaller than 0.6 it results in being enemy, otherwise it's friendly."
  4657. Example: value = west getFriend east
  4658. Category: General
  4659. @e
  4660. getFSMVariable
  4661. Left Argument: FSM handle
  4662. Right Argument: name
  4663. Description: "Return the value of variable in the variable space of given FSM. The FSM handle is the number returned by the execFSM command."
  4664. Category: General
  4665. @e
  4666. getFuelCargo
  4667. Left Argument: vehicle
  4668. Description: "Returns the fuel amount in the cargo space of a refuelling vehicle."
  4669. Example: getFuelCargo vehicle
  4670. Category: General
  4671. @e
  4672. getGroupIcon
  4673. Left Argument: group
  4674. Right Argument: ID
  4675. Description: "Get group icon properties."
  4676. Example: group getGroupIcon id
  4677. Category: General
  4678. @e
  4679. getGroupIconParams
  4680. Left Argument: group
  4681. Description: "Returns group icons params. [color, text,scale, visible]"
  4682. Example: getGroupIconParams group
  4683. Category: General
  4684. @e
  4685. getGroupIcons
  4686. Left Argument: group
  4687. Description: "Returns all group icons.[[id,icon,[offsetx,offsety],[..],..]"
  4688. Example: getGroupIcons group
  4689. Category: General
  4690. @e
  4691. getHideFrom
  4692. Left Argument: object
  4693. Right Argument: enemy
  4694. Description: "Returns the hiding position in format <ar>Position</ar>. If enemy is null it is the some position in front of the object or enemy position otherwise."
  4695. Category: General
  4696. @e
  4697. getHit
  4698. Left Argument: vehicle
  4699. Right Argument: selectionName
  4700. Description: "Return current level of damage for a specific selection."
  4701. Example: (vehicle player) getHit "hitEngine"
  4702. Category: General
  4703. @e
  4704. getHitPointDamage
  4705. Left Argument: vehicle
  4706. Right Argument: hitpointName
  4707. Description: "Return current level of damage for a specific Hit Point (specified by its config class)."
  4708. Example: (vehicle player) getHitPointDamage "hitEngine"
  4709. Category: General
  4710. @e
  4711. getItemCargo
  4712. Left Argument: box
  4713. Description: "Returns all items names and count from ammo box (or any general weapon holder container)."
  4714. Example: getItemCargo jeepOne
  4715. Category: General
  4716. @e
  4717. getMagazineCargo
  4718. Left Argument: box
  4719. Description: "Returns all magazines names and count from ammo box (or any general weapon holder container)."
  4720. Example: getMagazineCargo jeepOne
  4721. Category: General
  4722. @e
  4723. getMarkerColor
  4724. Left Argument: marker
  4725. Description: "Gets the marker color. See <f>setMarkerColor</f>."
  4726. Example: getMarkerColor "MarkerOne"
  4727. Category: General
  4728. @e
  4729. getMarkerPos
  4730. Left Argument: markerName
  4731. Description: "Returns the marker positon in format [x,z,y]."
  4732. Example: getMarkerPos "markerOne"
  4733. Category: General
  4734. @e
  4735. getMarkerSize
  4736. Left Argument: marker
  4737. Description: "Gets the marker size. See <f>setMarkerSize</f>."
  4738. Example: getMarkerSize "MarkerOne"
  4739. Category: General
  4740. @e
  4741. getMarkerType
  4742. Left Argument: marker
  4743. Description: "Gets the type of the marker. See <f>setMarkerType</f>."
  4744. Example: getMarkerType "MarkerOne"
  4745. Category: General
  4746. @e
  4747. getMass
  4748. Left Argument: object
  4749. Description: "Returns mass of an object"
  4750. Example: mass = getMass myEntity
  4751. Category: General
  4752. @e
  4753. getMissionDlcs
  4754. 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!"
  4755. Example: list of DLCs detected for the mission
  4756. Category: General
  4757. @e
  4758. getNumber
  4759. Left Argument: config
  4760. Description: "Extract number from config entry."
  4761. Example: _array = getNumber (configFile >> "CfgVehicles" >> "Thing" >> "maxSpeed")
  4762. Category: General
  4763. @e
  4764. getObjectArgument
  4765. Left Argument: map
  4766. Right Argument: [object, argument]
  4767. Description: "Return name of object argument in mission editor."
  4768. Category: Editor
  4769. @e
  4770. getObjectChildren
  4771. Left Argument: map
  4772. Right Argument: object
  4773. Description: "Return a list of all the children of the specified object."
  4774. Category: Editor
  4775. @e
  4776. getObjectDLC
  4777. Left Argument: Object
  4778. Description: "Returns an appId the object belongs to. The information is taken from it's model."
  4779. Example: getObjectDLC cursorTarget
  4780. Category: General
  4781. @e
  4782. getObjectMaterials
  4783. Left Argument: object
  4784. Description: "Returns a list of all custom materials assigned to given object."
  4785. Example: _materials = getObjectMaterials player;
  4786. Category: General
  4787. @e
  4788. getObjectProxy
  4789. Left Argument: map
  4790. Right Argument: object
  4791. Description: "Return the proxy object associated with the given editor object."
  4792. Category: Editor
  4793. @e
  4794. getObjectTextures
  4795. Left Argument: object
  4796. Description: "Returns a list of all custom textures assigned to given object."
  4797. Example: _textures = getObjectTextures player;
  4798. Category: General
  4799. @e
  4800. getOxygenRemaining
  4801. Left Argument: unit
  4802. Description: "Return amount of remaining oxygen."
  4803. Category: General
  4804. @e
  4805. getPersonUsedDLCs
  4806. Left Argument: Person
  4807. Description: "Returns list of all DLCs (appIds, both owned or not) the person is currently using."
  4808. Example: getPersonUsedDLCs player
  4809. Category: General
  4810. @e
  4811. getPlayerUID
  4812. Left Argument: unit
  4813. Description: "Get unique player id."
  4814. Category: General
  4815. @e
  4816. getPos
  4817. Left Argument: obj
  4818. Description: "Returns the object position in format <ar>Position</ar>."
  4819. Example: getPos player
  4820. Category: General
  4821. @e
  4822. getPosASL
  4823. Left Argument: obj
  4824. Description: "Returns the object position in format <ar>PositionASL</ar>."
  4825. Example: getPosASL player
  4826. Category: General
  4827. @e
  4828. getPosASLVisual
  4829. Left Argument: object
  4830. Description: "Returns the object rendered position in format <ar>PositionASL</ar>."
  4831. Example: visiblePositionASL player
  4832. Category: General
  4833. @e
  4834. getPosASLW
  4835. Left Argument: obj
  4836. Description: "Returns the object position in format <ar>PositionASLW</ar>."
  4837. Example: getPosASLW player
  4838. Category: General
  4839. @e
  4840. getPosATL
  4841. Left Argument: obj
  4842. Description: "Returns the object position in format <ar>PositionATL</ar>."
  4843. Example: getPosATL player
  4844. Category: General
  4845. @e
  4846. getPosATLVisual
  4847. Left Argument: obj
  4848. Description: "Returns the object position in format <ar>PositionATL</ar>."
  4849. Example: getPosATL player
  4850. Category: General
  4851. @e
  4852. getPosVisual
  4853. Left Argument: object
  4854. Description: "Returns the object rendered position in format <ar>Position</ar>."
  4855. Example: visiblePosition player
  4856. Category: General
  4857. @e
  4858. getPosWorld
  4859. Left Argument: obj
  4860. Description: "Returns the object position in format <ar>PositionWorld</ar>."
  4861. Example: getPosWorld player
  4862. Category: General
  4863. @e
  4864. getRepairCargo
  4865. Left Argument: vehicle
  4866. Description: "Returns the amount or repair resources in the cargo space of a repair vehicle."
  4867. Example: getRepairCargo vehicle
  4868. Category: General
  4869. @e
  4870. getResolution
  4871. Description: "returns [width, height, 2D viewport Width, 2D viewport Height, aspect ration, UI scale]"
  4872. Category: General
  4873. @e
  4874. getRotorBrakeRTD
  4875. Left Argument: RTD_helicopter
  4876. Description: "Returns if rotorbrake is on."
  4877. Category: General
  4878. @e
  4879. getShadowDistance
  4880. Description: "Get the shadows rendering distance."
  4881. Example: _dist = getShadowDistance
  4882. Category: General
  4883. @e
  4884. getSlingLoad
  4885. Left Argument: vehicle
  4886. Description: "Return object which is sling loaded by vehicle"
  4887. Example: getSlingLoad veh
  4888. Category: General
  4889. @e
  4890. getSpeed
  4891. Left Argument: object
  4892. Right Argument: speedMode
  4893. Description: "Get the speed for the given speed mode. SpeedMode can be: "AUTO","SLOW","NORMAL","FAST"."
  4894. Category: General
  4895. @e
  4896. getStatValue
  4897. Left Argument: statName
  4898. Description: "Returns value of the given stat. "
  4899. Category: General
  4900. @e
  4901. getTerrainHeightASL
  4902. Left Argument: [x,y]
  4903. Description: "Returns terrain height above sea level."
  4904. Example: z = getTerrainHeightASL [x,y]
  4905. Category: General
  4906. @e
  4907. getText
  4908. Left Argument: config
  4909. Description: "Extract text from config entry."
  4910. Example: _array = getText (configFile >> "CfgVehicles" >> "Thing" >> "icon")
  4911. Category: General
  4912. @e
  4913. getTotalDLCUsageTime
  4914. Description: "Returns total DLC usage time in this game session"
  4915. Category: General
  4916. @e
  4917. getTrimOffsetRTD
  4918. Left Argument: RTD_helicopter
  4919. Description: "Returns controls trim offset."
  4920. Category: General
  4921. @e
  4922. getVariable
  4923. Left Argument: namespace
  4924. Right Argument: name
  4925. Description: "Return the value of variable in the given namespace."
  4926. Category: Default
  4927. @e
  4928. getVariable
  4929. Left Argument: namespace
  4930. Right Argument: name
  4931. Description: "Return the value of variable in the given namespace."
  4932. Category: Default
  4933. @e
  4934. getWeaponCargo
  4935. Left Argument: box
  4936. Description: "Returns all weapons names and count from ammo box (or any general weapon holder container)."
  4937. Example: getWeaponCargo jeepOne
  4938. Category: General
  4939. @e
  4940. getWingsOrientationRTD
  4941. Left Argument: RTD_helicopter
  4942. Description: "Returns orientation of horizontaol stabilizers."
  4943. Category: General
  4944. @e
  4945. getWingsPositionRTD
  4946. Left Argument: RTD_helicopter
  4947. Description: "Returns position of stabilizers."
  4948. Category: General
  4949. @e
  4950. getWPPos
  4951. Left Argument: waypoint
  4952. Description: "Gets the waypoint position. The format of waypoint is <ar>Waypoint</ar>."
  4953. Example: getWPPos [groupOne, 1]
  4954. Category: General
  4955. @e
  4956. glanceAt
  4957. Left Argument: unit(s)
  4958. Right Argument: position
  4959. Description: "Control what the unit is glancing at (target or position) (format <ar>Position</ar>)"
  4960. Example: someSoldier glanceAt otherSoldier; otherSoldier glanceAt getMarkerPos "markerOne"
  4961. Category: General
  4962. @e
  4963. globalChat
  4964. Left Argument: unit
  4965. Right Argument: chatText
  4966. Description: "Types text to the global radio channel.
  4967. 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."
  4968. Example: soldierOne globalChat "Show this text"
  4969. Category: General
  4970. @e
  4971. globalRadio
  4972. Left Argument: unit
  4973. Right Argument: radioName
  4974. Description: "Sends the message to the global radio channel. The message is defined in the description.ext file or radio protocol."
  4975. Example: soldierOne globalRadio "messageOne"
  4976. Category: General
  4977. @e
  4978. goggles
  4979. Left Argument: unit
  4980. Description: "Returns name of currently used goggles."
  4981. Category: General
  4982. @e
  4983. goto
  4984. Left Argument: label
  4985. 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."
  4986. Example: goto "Loop"
  4987. Category: General
  4988. @e
  4989. group
  4990. Left Argument: obj
  4991. Description: "Returns the group to which the given unit is assigned. For dead units, grpNull is returned."
  4992. Example: group player == group leader player
  4993. Category: General
  4994. @e
  4995. groupChat
  4996. Left Argument: unit
  4997. Right Argument: chatText
  4998. Description: "Types text to the group radio channel.
  4999. 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."
  5000. Example: soldierOne groupChat "Show this text"
  5001. Category: General
  5002. @e
  5003. groupFromNetId
  5004. Left Argument: id
  5005. Description: "Get group with given unique ID."
  5006. Example: groupFromNetId (netId group player)
  5007. Example Return: group player
  5008. Category: General
  5009. @e
  5010. groupIconSelectable
  5011. Description: "Return if groups icon raises onClick and onOver events."
  5012. Category: General
  5013. @e
  5014. groupIconsVisible
  5015. Description: "Return group icons are visible."
  5016. Category: General
  5017. @e
  5018. groupID
  5019. Left Argument: group
  5020. Description: "Returns group name."
  5021. Example: name = groupID (group player)
  5022. Category: General
  5023. @e
  5024. groupOwner
  5025. Left Argument: group
  5026. Description: "Returns ID of client to which the group is local. Can be run only from server. When called from client, it always returns 0."
  5027. Category: General
  5028. @e
  5029. groupRadio
  5030. Left Argument: unit
  5031. Right Argument: radioName
  5032. Description: "Sends the message to the group radio channel. The message is defined in the description.ext file or radio protocol."
  5033. Example: soldierOne groupRadio "messageOne"
  5034. Category: General
  5035. @e
  5036. groupSelectedUnits
  5037. Left Argument: unit
  5038. Description: "Returns selected groups in sgroup."
  5039. Example: array = groupSelectedUnits unit
  5040. Category: General
  5041. @e
  5042. groupSelectUnit
  5043. Left Argument: unit
  5044. Right Argument: [unit,bool]
  5045. Description: "Select unit from unit's group."
  5046. Example: player groupSelectUnit [unit,true]
  5047. Category: General
  5048. @e
  5049. grpNull
  5050. Description: "A non-existing group. This value is not equal to anything, including itself."
  5051. Example: group player == objNull
  5052. Example Return: false
  5053. Category: General
  5054. @e
  5055. gunner
  5056. Left Argument: vehicle
  5057. Description: "Returns the gunner of the vehicle. If the vehicle is not a vehicle, but a person, the person is returned."
  5058. Example: gunner vehicle player
  5059. Category: General
  5060. @e
  5061. gusts
  5062. Description: "Return the current gusts value."
  5063. Category: General
  5064. @e
  5065. halt
  5066. Description: "Stops the program into a debugger."
  5067. Example: halt
  5068. Category: Default
  5069. @e
  5070. halt
  5071. Description: "Stops the program into a debugger."
  5072. Example: halt
  5073. Category: Default
  5074. @e
  5075. handgunItems
  5076. Left Argument: unit
  5077. Description: "Get array with all items assigned to a weapon."
  5078. Category: General
  5079. @e
  5080. handgunMagazine
  5081. Left Argument: vehicle
  5082. Description: "Return the names of the types of currently loaded magazines in given weapon."
  5083. Category: General
  5084. @e
  5085. handgunWeapon
  5086. Left Argument: unit
  5087. Description: "Returns the name of a units's handgun (an empty string if there is none)."
  5088. Example: handgunWeapon player
  5089. Category: General
  5090. @e
  5091. handsHit
  5092. Left Argument: soldier
  5093. Description: "Checks whether the soldier's hands are hit (causing inaccurate aiming)."
  5094. Example: handsHit leader player
  5095. Category: General
  5096. @e
  5097. hasInterface
  5098. Description: "Returns true if the computer has an inteface (a real player). False for a dedicated server or for a headless client."
  5099. Category: General
  5100. @e
  5101. hasWeapon
  5102. Left Argument: unit
  5103. Right Argument: weaponName
  5104. Description: "Checks whether the unit has the given weapon."
  5105. Example: player hasWeapon "M16"
  5106. Category: General
  5107. @e
  5108. hcAllGroups
  5109. Left Argument: unit
  5110. Description: "Returns selected groups in high command."
  5111. Example: array = hcAllGroups unit
  5112. Category: General
  5113. @e
  5114. hcGroupParams
  5115. Left Argument: unit
  5116. Right Argument: group
  5117. Description: "Returns parameters describing group in high command bar. Return value is [string,float[4]]"
  5118. Example: unit hcGroupParams group
  5119. Category: General
  5120. @e
  5121. hcLeader
  5122. Left Argument: group
  5123. Description: "Returns group's HC commander."
  5124. Example: hcLeader group
  5125. Category: General
  5126. @e
  5127. hcRemoveAllGroups
  5128. Left Argument: unit
  5129. Description: "Remove all groups from unit's high command bar."
  5130. Example: hcRemoveAllGroups unit
  5131. Category: General
  5132. @e
  5133. hcRemoveGroup
  5134. Left Argument: unit
  5135. Right Argument: group
  5136. Description: "Removes group from unit's high command bar."
  5137. Example: unit HCRemoveGroup group
  5138. Category: General
  5139. @e
  5140. hcSelected
  5141. Left Argument: unit
  5142. Description: "Returns selected groups in high command."
  5143. Example: array = hcSelected unit
  5144. Category: General
  5145. @e
  5146. hcSelectGroup
  5147. Left Argument: unit
  5148. Right Argument: array
  5149. Description: "Select given group in HC bar."
  5150. Example: unit hcSelectGroup [group,true]
  5151. Category: General
  5152. @e
  5153. hcSetGroup
  5154. Left Argument: unit
  5155. Right Argument: array
  5156. Description: "Add group to unit's high command bar. Array parameters are group, group name and team (teammain, teamred, teamgreen, teamblue, teamyellow) . Group is the only necessary parameter."
  5157. Example: unit hcSetGroup [group,"HQ","teamred"]
  5158. or
  5159. player hcSetGroup [group]
  5160. Category: General
  5161. @e
  5162. hcShowBar
  5163. Left Argument: bool
  5164. Description: "Shows or hides HC bar. There must be some groups under hc command to show hc bar."
  5165. Example: hcShowBar true
  5166. Category: General
  5167. @e
  5168. hcShownBar
  5169. Description: "Return true if the HC bar is shown/active."
  5170. Category: General
  5171. @e
  5172. headgear
  5173. Left Argument: unit
  5174. Description: "Returns name of currently used headgear."
  5175. Category: General
  5176. @e
  5177. hideBody
  5178. Left Argument: person
  5179. Description: "Hides the body of the given person."
  5180. Example: hideBody player
  5181. Category: General
  5182. @e
  5183. hideObject
  5184. Left Argument: object
  5185. Description: "Hide object (cannot hide static objects)."
  5186. Category: General
  5187. @e
  5188. hideObject
  5189. Left Argument: object
  5190. Right Argument: hidden
  5191. Description: "Hide object (cannot hide static objects)."
  5192. Example: player hideObject true
  5193. Category: General
  5194. @e
  5195. hideObjectGlobal
  5196. Left Argument: object
  5197. Description: "Hide object globally (cannot hide static objects). Only from server"
  5198. Category: General
  5199. @e
  5200. hideObjectGlobal
  5201. Left Argument: object
  5202. Right Argument: hidden
  5203. Description: "Hide object (cannot hide static objects)."
  5204. Example: player hideObject true
  5205. Category: General
  5206. @e
  5207. hint
  5208. Left Argument: text
  5209. Description: "Shows a text hint. The text can contain several lines. \n is used to indicate the end of a line."
  5210. Example: hint "Press W to move forward"
  5211. Category: General
  5212. @e
  5213. hintC
  5214. Left Argument: title
  5215. Right Argument: text
  5216. Description: "Creates a hint dialog with the given title and text."
  5217. Category: General
  5218. @e
  5219. hintC
  5220. Left Argument: text
  5221. 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."
  5222. Example: hintC "Press W to move forward"
  5223. Category: General
  5224. @e
  5225. hintCadet
  5226. Left Argument: text
  5227. 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."
  5228. Example: hintCadet "Press W to move forward"
  5229. Category: General
  5230. @e
  5231. hintSilent
  5232. Left Argument: text
  5233. Description: "Same as <f>hint</f>, but without a sound."
  5234. Category: General
  5235. @e
  5236. hmd
  5237. Left Argument: unit
  5238. Description: "Returns name of currently used HMD."
  5239. Category: General
  5240. @e
  5241. hostMission
  5242. Left Argument: [Config,Display]
  5243. Description: "Host the MP mission described by config class. Should be called as a reaction to some UI action in some dialog."
  5244. Category: General
  5245. @e
  5246. htmlLoad
  5247. Left Argument: control
  5248. Right Argument: filename
  5249. Description: "Load HTML from file to given control. On dedicated server/client connected to a dedicated server, if allowedHTMLloadExtensions parameter is specified in the DS config file this can only succeed if a given file extension is listed in it. The list should containt at least the following extensions: txt, htm, html, xml. Note, this list may not be completely up to date"
  5250. Example: _control htmlLoad "briefing.html"
  5251. Category: General
  5252. @e
  5253. HUDMovementLevels
  5254. Description: "Returns movement borders for HUD [min speed, max speed, min alt, max alt, min dir, max dir, position[x,y,z] or target]"
  5255. Category: General
  5256. @e
  5257. humidity
  5258. Description: "Return the current humidity value."
  5259. Category: General
  5260. @e
  5261. if
  5262. Left Argument: condition
  5263. Description: "The first part of the if command."
  5264. Example: if (a>b) then {a=b}
  5265. Category: Default
  5266. @e
  5267. if
  5268. Left Argument: condition
  5269. Description: "The first part of the if command."
  5270. Example: if (a>b) then {a=b}
  5271. Category: Default
  5272. @e
  5273. image
  5274. Left Argument: filename
  5275. Description: "Creates a structured text containing the given image."
  5276. Example: txt1 = image "data\isniper.paa"
  5277. Category: General
  5278. @e
  5279. importAllGroups
  5280. Left Argument: map
  5281. Description: "Imports all groups into the RTE."
  5282. Category: Editor
  5283. @e
  5284. importance
  5285. Left Argument: location
  5286. Description: "Return importance of given location."
  5287. Category: Location
  5288. @e
  5289. in
  5290. Left Argument: x
  5291. Right Argument: array
  5292. Description: "Checks whether x is equal to any element in the array."
  5293. Example: 1 in [0, 1, 2]
  5294. Example Return: true
  5295. Category: Default
  5296. @e
  5297. in
  5298. Left Argument: x
  5299. Right Argument: array
  5300. Description: "Checks whether x is equal to any element in the array."
  5301. Example: 1 in [0, 1, 2]
  5302. Example Return: true
  5303. Category: Default
  5304. @e
  5305. incapacitatedState
  5306. Left Argument: unit
  5307. Description: "Returns the incapacitated state of the given unit."
  5308. Category: General
  5309. @e
  5310. independent
  5311. Description: "Pre-defined variable for the independent side."
  5312. Category: General
  5313. @e
  5314. inflame
  5315. Left Argument: fireplace
  5316. Right Argument: burn
  5317. Description: "Controls fireplace buring. Set to true to inflame the fireplace."
  5318. Example: fireplaceOne inflame true
  5319. Category: General
  5320. @e
  5321. inflamed
  5322. Left Argument: fireplace
  5323. Description: "Check if fireplace is inflamed (buring)."
  5324. Example: inflamed fireplaceOne
  5325. Category: General
  5326. @e
  5327. inGameUISetEventHandler
  5328. Left Argument: [handler name, function]
  5329. Description: "Sets given event handler of in-game UI."
  5330. Category: General
  5331. @e
  5332. inheritsFrom
  5333. Left Argument: config
  5334. Description: "Returns base entry of config entry."
  5335. Example: _base = inheritsFrom (configFile >> "CfgVehicles" >> "Car")
  5336. Category: General
  5337. @e
  5338. initAmbientLife
  5339. Description: "Initialize the ambient life."
  5340. Category: General
  5341. @e
  5342. inputAction
  5343. Left Argument: name
  5344. Description: "Return the state of input devices mapped to given input action (see CfgDefaultKeysMapping for action names)."
  5345. Category: General
  5346. @e
  5347. inRangeOfArtillery
  5348. Left Argument: pos
  5349. Right Argument: [[unit1, unit2, ...], magazineType]
  5350. Description: "Returns true if all given units are able to fire at given position with given magazineType."
  5351. Category: General
  5352. @e
  5353. insertEditorObject
  5354. Left Argument: map
  5355. Right Argument: [type, value, [name1, value1, ...], subtype class]
  5356. Description: "Insert an object to the editor and assign arguments. Create script is not called. Returns the ID of the new EditorObject. Subtype class is optional."
  5357. Category: Editor
  5358. @e
  5359. interpolate
  5360. Left Argument: expr
  5361. Right Argument: val
  5362. Description: "Extend expression"
  5363. Category: Simple expression
  5364. @e
  5365. intersect
  5366. Left Argument: [object, lod name]
  5367. Right Argument: [begin, end]
  5368. Description: "Find named selection in object which is in specified lod intersected by given section of a line."
  5369. Example: [tank, "VIEW" intersect [[1500, 1500, 2], [1550, 1500, 2]]
  5370. Category: General
  5371. @e
  5372. isAbleToBreathe
  5373. Left Argument: unit
  5374. Description: "Return whether the unit is diving."
  5375. Category: General
  5376. @e
  5377. isAgent
  5378. Left Argument: teamMember
  5379. Description: "Check if team member is an agent."
  5380. Category: Agents
  5381. @e
  5382. isArray
  5383. Left Argument: config
  5384. Description: "Check if config entry represents array."
  5385. Example: _ok = isArray (configFile >> "CfgVehicles")
  5386. Example Return: false
  5387. Category: General
  5388. @e
  5389. isAutoHoverOn
  5390. Left Argument: vehicle
  5391. Description: "Returns true if vehicle has enabled auto hover"
  5392. Category: General
  5393. @e
  5394. isAutonomous
  5395. Left Argument: Uav
  5396. Description: "Return true if UAV is in autonomous mode."
  5397. Example: uavAuto = isAutonomous uav
  5398. Category: General
  5399. @e
  5400. isAutoStartUpEnabledRTD
  5401. Left Argument: RTD_helicopter
  5402. Description: "Returns true if automatic start up action is enabled."
  5403. Category: General
  5404. @e
  5405. isAutotest
  5406. Description: "Returns true if game was started with autotest parameter"
  5407. Example: isAutotest
  5408. Category: General
  5409. @e
  5410. isAutoTrimOnRTD
  5411. Left Argument: RTD_helicopter
  5412. Description: "Returns true if autotrim is enabled."
  5413. Category: General
  5414. @e
  5415. isBleeding
  5416. Left Argument: unit
  5417. Description: "Return whether the unit is bleeding."
  5418. Category: General
  5419. @e
  5420. isBurning
  5421. Left Argument: unit
  5422. Description: "Return whether the unit is burning."
  5423. Category: General
  5424. @e
  5425. isClass
  5426. Left Argument: config
  5427. Description: "Check if config entry represents config class."
  5428. Example: _ok = isClass (configFile >> "CfgVehicles")
  5429. Example Return: true
  5430. Category: General
  5431. @e
  5432. isCollisionLightOn
  5433. Left Argument: vehicle
  5434. Description: "Checks whether the collision light is on.(non-vehicle param returns false)"
  5435. Example: on = isLightOn vehicle player
  5436. Category: General
  5437. @e
  5438. isCopilotEnabled
  5439. Left Argument: vehicle
  5440. Description: "Returns true if copilots actions are enabled."
  5441. Example: enabled = isCopilotEnabled (vehicle player)
  5442. Category: General
  5443. @e
  5444. isDedicated
  5445. Description: "Return true for dedicated server."
  5446. Category: General
  5447. @e
  5448. isDLCAvailable
  5449. Left Argument: appId
  5450. Description: "Returns true if the DLC is marked as available."
  5451. Example Return: 123896
  5452. Category: General
  5453. @e
  5454. isEngineOn
  5455. Left Argument: vehicle
  5456. Description: "Checks whether the engine is on. "
  5457. Example: on = isEngineOn vehicle player
  5458. Category: General
  5459. @e
  5460. isEqualTo
  5461. Left Argument: var1
  5462. Right Argument: var2
  5463. Description: "Performs strict comparison between var1 and var2 and returns true if equal otherwise false."
  5464. Example: _arr1 = [1,2,[3]];
  5465. _arr2 = [1,2,[3]];
  5466. if (_arr1 isEqualTo _arr2) then {hint "arrays match!"};
  5467. Category: General
  5468. @e
  5469. isFlashlightOn
  5470. Left Argument: unit
  5471. Right Argument: weapon
  5472. Description: "Return if there is a linked and enabled flashlight on a given weapon."
  5473. Example: player IsFlashlightOn (currentWeapon player)
  5474. Category: General
  5475. @e
  5476. isFlatEmpty
  5477. Left Argument: position
  5478. Right Argument: [float minDistance,float precizePos,float maxGradient,float gradientRadius,float onWater,bool onShore,object skipobj]
  5479. Description: "Chek if given area is flat and emty."
  5480. Example: newposition = position isFlatEmpty(10, 0, 0.5, 5, 0, false, player)
  5481. Category: General
  5482. @e
  5483. isForcedWalk
  5484. Left Argument: player
  5485. Description: "Returns true if player is forced to walk"
  5486. Category: General
  5487. @e
  5488. isFormationLeader
  5489. Left Argument: person
  5490. Description: "Returns true if the specified person is subgroup leader."
  5491. Category: General
  5492. @e
  5493. isHidden
  5494. Left Argument: person
  5495. Description: "Return whether the person is hidden (reached the hiding position)."
  5496. Category: General
  5497. @e
  5498. isInRemainsCollector
  5499. Left Argument: object
  5500. Description: "Returns true if object will be managed by the unitRemove manager"
  5501. Example: isInRemainsCollector player
  5502. Category: General
  5503. @e
  5504. isInstructorFigureEnabled
  5505. Description: "True if instructor figure is enabled in Game Options."
  5506. Example: isInstructorFigureEnabled
  5507. Example Return: true or false
  5508. Category: General
  5509. @e
  5510. isIRLaserOn
  5511. Left Argument: unit
  5512. Right Argument: weapon
  5513. Example: Return if there is a linked and enabled IR on a given weapon.
  5514. Example Return: player IsIRLaserOn (currentWeapon player)
  5515. Category: General
  5516. @e
  5517. isKeyActive
  5518. Left Argument: keyName
  5519. Description: "Checks whether the given key is active in the current user profile."
  5520. Example: ok = isKeyActive "M04"
  5521. Category: General
  5522. @e
  5523. isKindOf
  5524. Left Argument: typeName1
  5525. Right Argument: typeName2
  5526. Description: "Checks whether the type typeName1 is inherited from the type typeName1."
  5527. Example: "Tank" isKindOf "Land"
  5528. Example Return: true
  5529. Category: General
  5530. @e
  5531. isLightOn
  5532. Left Argument: vehicle
  5533. Description: "Checks whether the light is on.(non-vehicle param returns false)"
  5534. Example: on = isLightOn vehicle player
  5535. Category: General
  5536. @e
  5537. isLocalized
  5538. Left Argument: stringName
  5539. Description: "Checks whether given string name is localized."
  5540. Example: isLocalized "STR_DN_SNAKE"
  5541. Category: General
  5542. @e
  5543. isManualFire
  5544. Left Argument: vehicle
  5545. Description: "Returns true if manul fire is on."
  5546. Category: General
  5547. @e
  5548. isMarkedForCollection
  5549. Left Argument: object
  5550. Description: "Checks whether the object is marked for weapons collection."
  5551. Example: marked = isMarkedForCollection truck
  5552. Category: General
  5553. @e
  5554. isMultiplayer
  5555. Description: "Return true if multiPlayer."
  5556. Category: General
  5557. @e
  5558. isNil
  5559. Left Argument: variable
  5560. Description: "Tests whether the variable is null. The function returns true if the variable is null and false if it's not."
  5561. Example: if (isNil("_pokus")) then {_pokus=0;}
  5562. Category: Default
  5563. @e
  5564. isNil
  5565. Left Argument: variable
  5566. Description: "Tests whether the variable is null. The function returns true if the variable is null and false if it's not."
  5567. Example: if (isNil("_pokus")) then {_pokus=0;}
  5568. Category: Default
  5569. @e
  5570. isNull
  5571. Left Argument: obj
  5572. Description: "Checks whether the value is equal to objNull.
  5573. Note: a==ObjNull does not work, because objNull is not equal to anything, even to itself."
  5574. Example: isNull objNull
  5575. Example Return: true
  5576. Category: General
  5577. @e
  5578. isNumber
  5579. Left Argument: config
  5580. Description: "Check if config entry represents number."
  5581. Example: _ok = isNumber (configFile >> "CfgVehicles")
  5582. Example Return: false
  5583. Category: General
  5584. @e
  5585. isObjectRTD
  5586. Left Argument: helicopter
  5587. Description: "Returns true if RTD model is loaded."
  5588. Category: General
  5589. @e
  5590. isOnRoad
  5591. Left Argument: position or object
  5592. Description: "Check whether given position is on road."
  5593. Category: General
  5594. @e
  5595. isPipEnabled
  5596. Description: "Returns true if PiP is enabled."
  5597. Category: General
  5598. @e
  5599. isPlayer
  5600. Left Argument: person
  5601. Description: "Check if given person is the player."
  5602. Category: General
  5603. @e
  5604. isRealTime
  5605. Left Argument: map
  5606. Description: "Returns true if the mission editor is operating in real time mode."
  5607. Example: _isRealTime = isRealTime _map
  5608. Category: Editor
  5609. @e
  5610. isServer
  5611. Description: "Returns true if the computer is the server."
  5612. Category: General
  5613. @e
  5614. isShowing3DIcons
  5615. Left Argument: map
  5616. Description: "Returns true if the editor is set to draw 3D icons."
  5617. Category: Editor
  5618. @e
  5619. isSteamMission
  5620. Description: "Returns true if mission is started from the steam."
  5621. Category: General
  5622. @e
  5623. isStreamFriendlyUIEnabled
  5624. Description: "True if stream friendly UI is enabled in Game Options."
  5625. Example: isStreamFriendlyUIEnabled
  5626. Example Return: true or false
  5627. Category: General
  5628. @e
  5629. isStressDamageEnabled
  5630. Description: "Returns true if stress damage is enabled."
  5631. Category: General
  5632. @e
  5633. isText
  5634. Left Argument: config
  5635. Description: "Check if config entry represents text."
  5636. Example: _ok = isText (configFile >> "CfgVehicles")
  5637. Example Return: false
  5638. Category: General
  5639. @e
  5640. isTouchingGround
  5641. Left Argument: object
  5642. Description: "Returns true if object is touching the ground."
  5643. Example: isTouchingGround vehicle
  5644. Category: General
  5645. @e
  5646. isTutHintsEnabled
  5647. Description: "True if tutorial hints are enabled in Game Options."
  5648. Example: isTutHintsEnabled
  5649. Example Return: true or false
  5650. Category: General
  5651. @e
  5652. isUAVConnectable
  5653. Left Argument: object
  5654. Right Argument: [uav, checkAllItems]
  5655. Description: "return true, if UAV is connectable by AV terminal(s)"
  5656. Example: connetable = unit isUAVConnectable [uav, true]
  5657. Category: General
  5658. @e
  5659. isUAVConnected
  5660. Left Argument: Uav
  5661. Description: "Returns true if UAV is connected to some terminal."
  5662. Example: isUAVConnected cursorTarget
  5663. Category: General
  5664. @e
  5665. isUniformAllowed
  5666. Left Argument: unit
  5667. Right Argument: type
  5668. Description: "Check whether given uniform can be dressed by target soldier."
  5669. Category: General
  5670. @e
  5671. isWalking
  5672. Left Argument: soldier
  5673. Description: "Returns true walk is toggled."
  5674. Category: General
  5675. @e
  5676. itemCargo
  5677. Left Argument: box
  5678. Description: "Get array with items from ammo box (or any general weapon holder container). "
  5679. Category: General
  5680. @e
  5681. items
  5682. Left Argument: unit
  5683. Description: "Returns only items that are not magazines/explosives/grenades. Includes also items that are linked on unit (i.e. includes assignedItems array)"
  5684. Category: General
  5685. @e
  5686. itemsWithMagazines
  5687. Left Argument: unit
  5688. Description: "Get array with all inventory items."
  5689. Category: General
  5690. @e
  5691. join
  5692. Left Argument: unitArray
  5693. Right Argument: group
  5694. Description: "Joins all units in the array to the given group.
  5695. Note: the total number of group members cannot exceed 12.
  5696. Note: This function is unsupported in MP in version 1.33 and before."
  5697. Example: [unitOne, unitTwo] join player
  5698. Category: General
  5699. @e
  5700. joinAs
  5701. Left Argument: unit
  5702. Right Argument: [group, id]
  5703. Description: "Joins the unit to the given group, if position id is available, this one is used."
  5704. Example: player joinAs [_group, 4]
  5705. Category: General
  5706. @e
  5707. joinAsSilent
  5708. Left Argument: unit
  5709. Right Argument: [group, id]
  5710. Description: "Joins the unit to the given group, if position id is available, this one is used. Avoid any radio communication related to joining."
  5711. Example: player joinAsSilent [_group, 4]
  5712. Category: General
  5713. @e
  5714. joinSilent
  5715. Left Argument: unitArray
  5716. Right Argument: group
  5717. Description: "Joins all units in the array to the given group. Avoid any radio communication related to joining."
  5718. Example: [unitOne, unitTwo] joinSilent player
  5719. Category: General
  5720. @e
  5721. kbAddDatabase
  5722. Left Argument: person
  5723. Right Argument: filename
  5724. Description: "Register knowledge base database to given person."
  5725. Example: _unit kbAddDatabase "chat.txt"
  5726. Category: General
  5727. @e
  5728. kbAddDatabaseTargets
  5729. Left Argument: person
  5730. Right Argument: filename
  5731. Description: "Register target list knowledge base database to given person."
  5732. Example: _unit kbAddDatabase "chat.txt"
  5733. Category: General
  5734. @e
  5735. kbAddTopic
  5736. Left Argument: person
  5737. Right Argument: [name, filename(, task type(, player event handler))]
  5738. Description: "Register conversation topic to given person."
  5739. Category: General
  5740. @e
  5741. kbHasTopic
  5742. Left Argument: person
  5743. Right Argument: name
  5744. Description: "Check if conversation topic was registered to given person."
  5745. Category: General
  5746. @e
  5747. kbReact
  5748. Left Argument: person
  5749. Right Argument: [receiver, topic, sentence id, [argument name, argument value, argument text, argument speech], ...]
  5750. Description: "Pass a non-verbal communication to the receiver."
  5751. Category: General
  5752. @e
  5753. kbRemoveTopic
  5754. Left Argument: person
  5755. Right Argument: name
  5756. Description: "Unregister conversation topic from given person."
  5757. Category: General
  5758. @e
  5759. kbTell
  5760. Left Argument: person
  5761. Right Argument: [receiver, topic, sentence id, [argument name, argument value, argument text, argument speech], ...]
  5762. Description: "Make the person tell to the receiver the sentence. Last parameter can be false/true to force radio channel selection, or number 1..10 to force possible CustomChannel, or radio channel name 'GLOBAL','SIDE','GROUP','VEHICLE','DIRECT','COMMAND'."
  5763. Category: General
  5764. @e
  5765. kbWasSaid
  5766. Left Argument: person
  5767. Right Argument: [receiver, topic, sentence id, max. age]
  5768. Description: "Check if given item was said by person to someone."
  5769. Category: General
  5770. @e
  5771. keyImage
  5772. Left Argument: dikCode
  5773. 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."
  5774. Example: name = keyImage 28
  5775. Example Return: "Enter"
  5776. Category: General
  5777. @e
  5778. keyName
  5779. Left Argument: dikCode
  5780. Description: "Returns the name of a button (on the keyboard, mouse or joystick) with the given code."
  5781. Example: name = keyName 28
  5782. Example Return: "Enter"
  5783. Category: General
  5784. @e
  5785. knowsAbout
  5786. Left Argument: unit
  5787. Right Argument: target
  5788. Description: "Checks whether the unit knows about the target (and how much). If the unit is a vehicle, the vehicle commander is considered instead."
  5789. Example: soldierOne knowsAbout jeepOne
  5790. Category: General
  5791. @e
  5792. land
  5793. Left Argument: helicopter
  5794. Right Argument: mode
  5795. Description: "Forces a helicopter landing. The landing mode may be "LAND" (a complete stop), "GET IN" (hovering very low for another unit to get in), "GET OUT" (hovering low for another unit to get out) or "NONE" (cancel landing)."
  5796. Example: cobraOne land "LAND"
  5797. Category: General
  5798. @e
  5799. landAt
  5800. Left Argument: airplane
  5801. Right Argument: airportId
  5802. Description: "Order AI airplane to land at given airport"
  5803. Example: plane landAt 0
  5804. Category: General
  5805. @e
  5806. landResult
  5807. Left Argument: helicopter
  5808. 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."
  5809. Category: General
  5810. @e
  5811. language
  5812. Description: "Returns current game language."
  5813. Category: General
  5814. @e
  5815. laserTarget
  5816. Left Argument: vehicle
  5817. Description: "Returns target created by gunner in given vehicle."
  5818. Category: General
  5819. @e
  5820. lbAdd
  5821. Left Argument: [idc, text]
  5822. 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."
  5823. Example: _index = lbAdd [101, "First item"]
  5824. Category: General
  5825. @e
  5826. lbAdd
  5827. Left Argument: control
  5828. Right Argument: text
  5829. Description: "Adds an item with the given text to the given listbox or combobox. It returns the index of the newly added item."
  5830. Example: _index = _control lbAdd "First item"
  5831. Category: General
  5832. @e
  5833. lbClear
  5834. Left Argument: control
  5835. Description: "Clears all items in the given listbox or combobox."
  5836. Example: lbClear _control
  5837. Category: General
  5838. @e
  5839. lbColor
  5840. Left Argument: control
  5841. Right Argument: index
  5842. Description: "Returns the text color of the item with the given index of the given listbox or combobox."
  5843. Example: _color = _control lbColor 0
  5844. Category: General
  5845. @e
  5846. lbColor
  5847. Left Argument: [idc, index]
  5848. 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>."
  5849. Example: _color = lbColor [101, 0]
  5850. Category: General
  5851. @e
  5852. lbColorRight
  5853. Left Argument: control
  5854. Right Argument: index
  5855. Description: "Returns the text color of the secondary text (right aligned) of the item with the given index of the given listbox or combobox."
  5856. Example: _color = _control lbColorRight 0
  5857. Category: General
  5858. @e
  5859. lbColorRight
  5860. Left Argument: [idc, index]
  5861. Description: "Returns the text color of the secondary text (right aligned) 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>."
  5862. Example: _color = lbColorRight [101, 0]
  5863. Category: General
  5864. @e
  5865. lbCurSel
  5866. Left Argument: control
  5867. Description: "Returns the index of the selected item of the given listbox or combobox."
  5868. Example: _index = lbCurSel _control
  5869. Category: General
  5870. @e
  5871. lbData
  5872. Left Argument: control
  5873. Right Argument: index
  5874. Description: "Returns the additional text (invisible) in an item with the given index of the given listbox or combobox."
  5875. Example: _data = _control lbData 0
  5876. Category: General
  5877. @e
  5878. lbData
  5879. Left Argument: [idc, index]
  5880. 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."
  5881. Example: _data = lbData [101, 0]
  5882. Category: General
  5883. @e
  5884. lbDelete
  5885. Left Argument: control
  5886. Right Argument: index
  5887. Description: "Removes the item with the given index from the given listbox or combobox."
  5888. Example: _control lbDelete 0
  5889. Category: General
  5890. @e
  5891. lbDelete
  5892. Left Argument: [idc, index]
  5893. Description: "Removes the item with the given index from the listbox or combobox with id idc of the topmost user dialog."
  5894. Example: lbDelete [101, 0]
  5895. Category: General
  5896. @e
  5897. lbIsSelected
  5898. Left Argument: control
  5899. Right Argument: index
  5900. Description: "Check whether given row of the given listbox is selected."
  5901. Example: _selected = _control lbIsSelected 0
  5902. Category: General
  5903. @e
  5904. lbPicture
  5905. Left Argument: control
  5906. Right Argument: index
  5907. Description: "Returns the picture name of the item with the given index of the given listbox or combobox."
  5908. Example: _picture = _control lbPicture 0
  5909. Category: General
  5910. @e
  5911. lbPicture
  5912. Left Argument: [idc, index]
  5913. 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."
  5914. Example: _picture = lbPicture [101, 0]
  5915. Category: General
  5916. @e
  5917. lbPictureRight
  5918. Left Argument: control
  5919. Right Argument: index
  5920. Description: "Returns the second (right aligned) picture name of the item with the given index of the given listbox or combobox."
  5921. Example: _picture = _control lbPictureRight 0
  5922. Category: General
  5923. @e
  5924. lbPictureRight
  5925. Left Argument: [idc, index]
  5926. Description: "Returns the second (right aligned) picture name of the item with the given index of the listbox or combobox with id idc of the topmost user dialog."
  5927. Example: _picture = lbPictureRight [101, 0]
  5928. Category: General
  5929. @e
  5930. lbSelection
  5931. Left Argument: control
  5932. Description: "Returns the array of selected rows indices in the given listbox."
  5933. Example: _indices = lbSelection _control
  5934. Category: General
  5935. @e
  5936. lbSetColor
  5937. Left Argument: control
  5938. Right Argument: [index, color]
  5939. Description: "Sets the text color of the item with the given index of the given listbox or combobox. Color is in format <ar>Color</ar>."
  5940. Example: _control lbSetColor [0, [0, 1, 0, 0.5]]
  5941. Category: General
  5942. @e
  5943. lbSetColor
  5944. Left Argument: [idc, index, color]
  5945. 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>."
  5946. Example: lbSetColor [101, 0, [0, 1, 0, 0.5]]
  5947. Category: General
  5948. @e
  5949. lbSetColorRight
  5950. Left Argument: [idc, index, color]
  5951. Description: "Sets the color of the secondary text (right aligned) 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>."
  5952. Example: lbSetColorRight [101, 0, [0, 1, 0, 0.5]]
  5953. Category: General
  5954. @e
  5955. lbSetColorRight
  5956. Left Argument: control
  5957. Right Argument: [index, color]
  5958. Description: "Sets the text color of the secondary text (right aligned) of the item with the given index of the given listbox or combobox. Color is in format <ar>Color</ar>."
  5959. Example: _control lbSetColorRight [0, [0, 1, 0, 0.5]]
  5960. Category: General
  5961. @e
  5962. lbSetCurSel
  5963. Left Argument: [idc, index]
  5964. Description: "Selects the item with the given index of the listbox or combobox with id idc of the topmost user dialog."
  5965. Example: lbSetCurSel [101, 0]
  5966. Category: General
  5967. @e
  5968. lbSetCurSel
  5969. Left Argument: control
  5970. Right Argument: index
  5971. Description: "Selects the item with the given index of the given listbox or combobox."
  5972. Example: _control lbSetCurSel 0
  5973. Category: General
  5974. @e
  5975. lbSetData
  5976. Left Argument: control
  5977. Right Argument: [index, data]
  5978. Description: "Sets the additional text (invisible) in the item with the given index of the given listbox or combobox to the given data."
  5979. Example: _control lbSetData [1, "#1"]
  5980. Category: General
  5981. @e
  5982. lbSetData
  5983. Left Argument: [idc, index, data]
  5984. 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."
  5985. Example: lbSetData [101, 1, "#1"]
  5986. Category: General
  5987. @e
  5988. lbSetPicture
  5989. Left Argument: [idc, index, name]
  5990. 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)."
  5991. Example: lbSetPicture [101, 0, "iskoda"]
  5992. Category: General
  5993. @e
  5994. lbSetPicture
  5995. Left Argument: control
  5996. Right Argument: [index, name]
  5997. Description: "Sets the picture in the item with the given index of the given listbox or combobox. 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)."
  5998. Example: _control lbSetPicture [0, "iskoda"]
  5999. Category: General
  6000. @e
  6001. lbSetPictureColor
  6002. Left Argument: control
  6003. Right Argument: [index, color]
  6004. Description: "Sets the color of the picture of the item with the given index of the given listbox or combobox. Color is in format <ar>Color</ar>. (color which consists from only zeros means disable this override)"
  6005. Example: _control lbSetColor [0, [0, 1, 0, 0.5]]
  6006. Category: General
  6007. @e
  6008. lbSetPictureColor
  6009. Left Argument: [idc, index, color]
  6010. 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)"
  6011. Example: lbSetPictureColor [101, 0, [0, 1, 0, 0.5]]
  6012. Category: General
  6013. @e
  6014. lbSetPictureColorDisabled
  6015. Left Argument: control
  6016. Right Argument: [index, color]
  6017. Description: "Sets the color of the picture of the item with the given index of the given listbox or combobox when control is disabled. Color is in format <ar>Color</ar>. (color which consists from only zeros means disable this override)"
  6018. Example: _control lbSetColor [0, [0, 1, 0, 0.5]]
  6019. Category: General
  6020. @e
  6021. lbSetPictureColorDisabled
  6022. Left Argument: [idc, index, color]
  6023. 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)"
  6024. Example: lbSetPictureColorDisabled [101, 0, [0, 1, 0, 0.5]]
  6025. Category: General
  6026. @e
  6027. lbSetPictureColorSelected
  6028. Left Argument: [idc, index, color]
  6029. 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)"
  6030. Example: lbSetPictureColorSelected [101, 0, [0, 1, 0, 0.5]]
  6031. Category: General
  6032. @e
  6033. lbSetPictureColorSelected
  6034. Left Argument: control
  6035. Right Argument: [index, color]
  6036. Description: "Sets the color of the picture of the item with the given index of the given listbox or combobox when item is selected. Color is in format <ar>Color</ar>. (color which consists from only zeros means disable this override)"
  6037. Example: _control lbSetColor [0, [0, 1, 0, 0.5]]
  6038. Category: General
  6039. @e
  6040. lbSetPictureRight
  6041. Left Argument: control
  6042. Right Argument: [index, name]
  6043. Description: "Sets the second (right aligned) picture in the item with the given index of the given listbox or combobox. 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)."
  6044. Example: _control lbSetPictureRight [0, "iskoda"]
  6045. Category: General
  6046. @e
  6047. lbSetPictureRight
  6048. Left Argument: [idc, index, name]
  6049. Description: "Sets the second (right aligned) 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)."
  6050. Example: lbSetPictureRight [101, 0, "iskoda"]
  6051. Category: General
  6052. @e
  6053. lbSetPictureRightColor
  6054. Left Argument: control
  6055. Right Argument: [index, color]
  6056. Description: "Sets the color of the second (right aligned) picture of the of the item with the given index of the given listbox or combobox. Color is in format <ar>Color</ar>. (color which consists from only zeros means disable this override)"
  6057. Example: _control lbSetPictureRightColor [0, [0, 1, 0, 0.5]]
  6058. Category: General
  6059. @e
  6060. lbSetPictureRightColorDisabled
  6061. Left Argument: control
  6062. Right Argument: [index, color]
  6063. Description: "Sets the color of the second (right aligned) picture of the item with the given index of the given listbox or combobox when control is disabled. Color is in format <ar>Color</ar>. (color which consists from only zeros means disable this override)"
  6064. Example: _control lbSetPictureRightColorDisabled [0, [0, 1, 0, 0.5]]
  6065. Category: General
  6066. @e
  6067. lbSetPictureRightColorSelected
  6068. Left Argument: control
  6069. Right Argument: [index, color]
  6070. Description: "Sets the color of the second (right aligned) picture of the item with the given index of the given listbox or combobox when item is selected. Color is in format <ar>Color</ar>. (color which consists from only zeros means disable this override)"
  6071. Example: _control lbSetPictureRightColorSelected [0, [0, 1, 0, 0.5]]
  6072. Category: General
  6073. @e
  6074. lbSetSelected
  6075. Left Argument: control
  6076. Right Argument: [index, selected]
  6077. Description: "Set the selection state of the given row of the given listbox. Listbox must support multiple selection"
  6078. Example: _control lbSetSelection [0, true]
  6079. Category: General
  6080. @e
  6081. lbSetTextRight
  6082. Left Argument: control
  6083. Right Argument: [index, text]
  6084. Description: "Sets the secondary text (right aligned) in the item with the given index of the given listbox or combobox to the given data."
  6085. Example: _control lbSetTextRight [1, "#1"]
  6086. Category: General
  6087. @e
  6088. lbSetTooltip
  6089. Left Argument: [idc, index, tooltip]
  6090. 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."
  6091. Example: lbSetTooltip [101, 1, "tooltip"]
  6092. Category: General
  6093. @e
  6094. lbSetTooltip
  6095. Left Argument: control
  6096. Right Argument: [index, tooltip]
  6097. Description: "Sets tooltip for item with the given index of the given listbox or combobox to the given data."
  6098. Example: _control lbSetData [1, "tooltip"]
  6099. Category: General
  6100. @e
  6101. lbSetValue
  6102. Left Argument: [idc, index, value]
  6103. 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."
  6104. Example: lbSetValue [101, 0, 1]
  6105. Category: General
  6106. @e
  6107. lbSetValue
  6108. Left Argument: control
  6109. Right Argument: [index, value]
  6110. Description: "Sets the additional integer value in the item with the given index of the given listbox or combobox to the given value."
  6111. Example: _control lbSetValue [0, 1]
  6112. Category: General
  6113. @e
  6114. lbSize
  6115. Left Argument: control
  6116. Description: "Returns the number of items in the given listbox or combobox."
  6117. Example: _n = lbSize _control
  6118. Category: General
  6119. @e
  6120. lbSort
  6121. Left Argument: control
  6122. Description: "Sorts the given listbox or combobox by item text."
  6123. Example: lbSort _control
  6124. Category: General
  6125. @e
  6126. lbSortByValue
  6127. Left Argument: control
  6128. Description: "Sorts the given listbox or combobox by item value."
  6129. Example: lbSortByValue _control
  6130. Category: General
  6131. @e
  6132. lbText
  6133. Left Argument: [idc, index]
  6134. 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."
  6135. Example: _text = lbText [101, 0]
  6136. Category: General
  6137. @e
  6138. lbText
  6139. Left Argument: control
  6140. Right Argument: index
  6141. Description: "Returns the shown text in the item with the given index of the given listbox or combobox."
  6142. Example: _text = _control lbText 0
  6143. Category: General
  6144. @e
  6145. lbTextRight
  6146. Left Argument: control
  6147. Right Argument: index
  6148. Description: "Returns the second text (right aligned) in the item with the given index of the given listbox or combobox."
  6149. Example: _text = _control lbTextRight 0
  6150. Category: General
  6151. @e
  6152. lbTextRight
  6153. Left Argument: [idc, index]
  6154. Description: "Returns the secondary shown text in the item with the given index of the listbox or combobox with id idc of the topmost user dialog."
  6155. Example: _text = lbTextRight [101, 0]
  6156. Category: General
  6157. @e
  6158. lbValue
  6159. Left Argument: [idc, index]
  6160. 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."
  6161. Example: _value = lbValue [101, 0]
  6162. Category: General
  6163. @e
  6164. lbValue
  6165. Left Argument: control
  6166. Right Argument: index
  6167. Description: "Returns the additional integer value in the item with the given index of the given listbox or combobox."
  6168. Example: _value = _control lbValue 0
  6169. Category: General
  6170. @e
  6171. leader
  6172. Left Argument: unit
  6173. Description: "Returns the group leader for the given unit. For dead units, objNull is returned."
  6174. Example: leader player
  6175. Category: General
  6176. @e
  6177. leaveVehicle
  6178. Left Argument: group
  6179. Right Argument: vehicle
  6180. Description: "Ceases the using of the vehicle in the group. It unassigns all grouped units from the vehicle."
  6181. Example: soldierOne leaveVehicle jeepOne
  6182. Category: General
  6183. @e
  6184. libraryCredits
  6185. Description: "Copyright information needed by libraries used."
  6186. Example: libraryCredits
  6187. Example Return: [['Real Virtuality','(C) 2012 Bohemia Interactive','All rights reserved']]
  6188. Category: General
  6189. @e
  6190. libraryDisclaimers
  6191. Description: "Disclaimer information needed by libraries used (duplicate disclaimers are removed)."
  6192. Example: libraryDisclaimers
  6193. Example Return: ['All rights reserved']
  6194. Category: General
  6195. @e
  6196. lifeState
  6197. Left Argument: unit
  6198. Description: "Returns the life state of the given unit."
  6199. Category: General
  6200. @e
  6201. lightAttachObject
  6202. Left Argument: light
  6203. Right Argument: [object, position]
  6204. Description: "Attach light to given object (at given position)."
  6205. Category: General
  6206. @e
  6207. lightDetachObject
  6208. Left Argument: light
  6209. Description: "Detach light from object."
  6210. Category: General
  6211. @e
  6212. lightIsOn
  6213. Left Argument: lamppost
  6214. 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)."
  6215. Example: lightIsOn nearestObject [player, "StreetLamp"] != "OFF"
  6216. Category: General
  6217. @e
  6218. lightnings
  6219. Description: "Return lightnings value."
  6220. Category: General
  6221. @e
  6222. limitSpeed
  6223. Left Argument: object
  6224. Right Argument: speed
  6225. Description: "Limit speed of given vehicle to given value (in km/h)."
  6226. Category: General
  6227. @e
  6228. linearConversion
  6229. Left Argument: [min, max, value, newMin, newMax, clamp]
  6230. Description: "Converts value in interval [min, max] to newMin + a*(max-min)/(newMax - newMin), potentially clamps the final value."
  6231. Example: linearConversion [4, 8, 5, 0, 1, false]
  6232. Category: General
  6233. @e
  6234. lineBreak
  6235. Description: "Creates a structured text containing a line break."
  6236. Example: txt3 = lineBreak
  6237. Category: General
  6238. @e
  6239. lineIntersects
  6240. Left Argument: array
  6241. Description: "Returns true, if line intersect with any object."
  6242. Example: lineIntersects [begPos, endPos, withObj, ignoreObj]
  6243. Category: General
  6244. @e
  6245. lineIntersectsObjs
  6246. Left Argument: array
  6247. 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)"
  6248. Example: lineIntersectsObjs [begPos, endPos, withObj, ignoreObj, sortByDist, flags]
  6249. Category: General
  6250. @e
  6251. lineIntersectsWith
  6252. Left Argument: array
  6253. Description: "Returns list of objects intersected by given line."
  6254. Example: lineIntersectsWith [begPos, endPos, withObj, ignoreObj, sortByDist]
  6255. Category: General
  6256. @e
  6257. linkItem
  6258. Left Argument: unit
  6259. Right Argument: item
  6260. Description: "Create and assign new item to the soldier's body.(NVG, radio, ...)"
  6261. Category: General
  6262. @e
  6263. list
  6264. Left Argument: trigger
  6265. 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"."
  6266. Example: list triggerOne
  6267. Category: General
  6268. @e
  6269. listObjects
  6270. Left Argument: map
  6271. Right Argument: type
  6272. Description: "Return the list of all objects of given type."
  6273. Category: Editor
  6274. @e
  6275. ln
  6276. Left Argument: x
  6277. Description: "The natural logarithm of x."
  6278. Example: ln 10
  6279. Example Return: 2.302
  6280. Category: Default
  6281. @e
  6282. ln
  6283. Left Argument: x
  6284. Description: "The natural logarithm of x."
  6285. Example: ln 10
  6286. Example Return: 2.302
  6287. Category: Default
  6288. @e
  6289. lnbAddArray
  6290. Left Argument: [IDC,[[[text,text], [value,..], [data,..]], [[text,text], [value,..], [data,..]],]]
  6291. Description: "Adds list of rows of strings."
  6292. Example: _index = lnbAddArray [idc,[[[text,text,text], [value], [data]], [[text,text,text], [value, value], [data]]]] . Returns row index.
  6293. Category: General
  6294. @e
  6295. lnbAddColumn
  6296. Left Argument: [idc, position]
  6297. Description: "Adds an column at given position. It returns the index of the newly added column."
  6298. Example: _index = lnbAddColumn [105, 0.8]
  6299. Category: General
  6300. @e
  6301. lnbAddColumn
  6302. Left Argument: control
  6303. Right Argument: position
  6304. Description: "Adds an item with the given text to the given listbox or combobox. It returns the index of the newly added item."
  6305. Example: _index = _control lbAdd "First item"
  6306. Category: General
  6307. @e
  6308. lnbAddRow
  6309. Left Argument: [idc, [text, text,...]]
  6310. Description: "Adds an row of strings."
  6311. Example: _index = lnbAddRow [105, ["First column", "second column", ...]]. Returns row index.
  6312. Category: General
  6313. @e
  6314. lnbAddRow
  6315. Left Argument: control
  6316. Right Argument: [text1,text2,...]
  6317. Description: "Adds an row to the end od 2d listbox . It returns the index of the newly added row."
  6318. Example: _index = _control lnbAdd [t1,t2,t3,...]
  6319. Category: General
  6320. @e
  6321. lnbClear
  6322. Left Argument: control
  6323. Description: "Clears all items in the given listbox or combobox."
  6324. Example: lbClear _control
  6325. Category: General
  6326. @e
  6327. lnbColor
  6328. Left Argument: control
  6329. Right Argument: [row, column]
  6330. Description: "Returns the text color of the item with the given position of the given 2D listbox."
  6331. Example: _color = _control lnbColor [row, column]
  6332. Category: General
  6333. @e
  6334. lnbColor
  6335. Left Argument: [idc, [row, column]
  6336. 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>."
  6337. Example: _color = lnbColor [101, [0,1]]
  6338. Category: General
  6339. @e
  6340. lnbColorRight
  6341. Left Argument: [idc, [row, column]
  6342. Description: "Returns the secondary text (right aligned) color of the item with the given position of the 2D listbox. The color is returned in format <ar>Color</ar>."
  6343. Example: _color = lnbColorRight [101, [0,1]]
  6344. Category: General
  6345. @e
  6346. lnbColorRight
  6347. Left Argument: control
  6348. Right Argument: [row, column]
  6349. Description: "Returns the text color of the secondary text (right aligned) of the item with the given position of the given 2D listbox."
  6350. Example: _color = _control lnbColorRight [row, column]
  6351. Category: General
  6352. @e
  6353. lnbCurSelRow
  6354. Left Argument: control
  6355. Description: "Returns the index of the selected item of the given listbox or combobox."
  6356. Example: _index = lbCurSel _control
  6357. Category: General
  6358. @e
  6359. lnbData
  6360. Left Argument: [idc, [row, column]
  6361. Description: "Returns the additional text (invisible) in an item with the given position of the 2D listbox."
  6362. Example: _data = lnbData [101, [0,1]]
  6363. Category: General
  6364. @e
  6365. lnbData
  6366. Left Argument: control
  6367. Right Argument: [row, column]
  6368. Description: "Returns the additional text (invisible) in an item with the given position of the given 2D listbox."
  6369. Example: _data = _control lnbData [row, column]
  6370. Category: General
  6371. @e
  6372. lnbDeleteColumn
  6373. Left Argument: [idc, index]
  6374. Description: "Removes column with given index."
  6375. Example: lnbDeleteColumn [101, 0]
  6376. Category: General
  6377. @e
  6378. lnbDeleteColumn
  6379. Left Argument: control
  6380. Right Argument: index
  6381. Description: "Removes the item with the given index from the given listbox or combobox."
  6382. Example: _control lbDelete 0
  6383. Category: General
  6384. @e
  6385. lnbDeleteRow
  6386. Left Argument: [idc, index]
  6387. Description: "Removes row with given index from the 2D listbox."
  6388. Example: lnbDeleteRow [105, 0]
  6389. Category: General
  6390. @e
  6391. lnbDeleteRow
  6392. Left Argument: control
  6393. Right Argument: row
  6394. Description: "Removes row with the given index from the given listbox or combobox."
  6395. Example: _control lnbDelete 0
  6396. Category: General
  6397. @e
  6398. lnbGetColumnsPosition
  6399. Left Argument: control
  6400. Description: "Returns the index of the selected item of the given listbox or combobox."
  6401. Example: _index = lbCurSel _control
  6402. Category: General
  6403. @e
  6404. lnbPicture
  6405. Left Argument: control
  6406. Right Argument: [row, column]
  6407. Description: "Returns the picture name of the item with the given position of the given listbox or combobox."
  6408. Example: _picture = _control lnbPicture [row, column]
  6409. Category: General
  6410. @e
  6411. lnbPicture
  6412. Left Argument: [idc, [row, column]
  6413. Description: "Returns the picture name of the item with the given position of the 2D listbox."
  6414. Example: _picture = lnbPicture [101, [0,1]]
  6415. Category: General
  6416. @e
  6417. lnbPictureRight
  6418. Left Argument: [idc, [row, column]
  6419. Description: "Returns the second (right aligned) picture name of the item with the given position of the 2D listbox."
  6420. Example: _picture = lnbPictureRight [101, [0,1]]
  6421. Category: General
  6422. @e
  6423. lnbPictureRight
  6424. Left Argument: control
  6425. Right Argument: [row, column]
  6426. Description: "Returns the name of the second (right aligned) picture of the item with the given position of the given listbox or combobox."
  6427. Example: _picture = _control lnbPictureRight [row, column]
  6428. Category: General
  6429. @e
  6430. lnbSetColor
  6431. Left Argument: [idc, [row, column], color]
  6432. Description: "Sets the color of the item with the given position of the 2D listbox. Color is in format <ar>Color</ar>."
  6433. Example: lnbSetColor [101, [0,1], [0, 1, 0, 0.5]]
  6434. Category: General
  6435. @e
  6436. lnbSetColor
  6437. Left Argument: control
  6438. Right Argument: [[row, column], color]
  6439. Description: "Sets the text color of the item with the given position of the given 2D listbox . Color is in format <ar>Color</ar>."
  6440. Example: _control lnbSetColor [[row, column], [0, 1, 0, 0.5]]
  6441. Category: General
  6442. @e
  6443. lnbSetColorRight
  6444. Left Argument: [idc, [row, column], color]
  6445. Description: "Sets the color of the secondary text (right aligned) of the item with the given position of the 2D listbox. Color is in format <ar>Color</ar>."
  6446. Example: lnbSetColorRight [101, [0,1], [0, 1, 0, 0.5]]
  6447. Category: General
  6448. @e
  6449. lnbSetColorRight
  6450. Left Argument: control
  6451. Right Argument: [[row, column], color]
  6452. Description: "Sets the text color of the secondary text (right aligned) of the item with the given position of the given 2D listbox . Color is in format <ar>Color</ar>."
  6453. Example: _control lnbSetColorRight [[row, column], [0, 1, 0, 0.5]]
  6454. Category: General
  6455. @e
  6456. lnbsetColumnsPos
  6457. Left Argument: [idc, [row, column], data]
  6458. Description: "Sets the additional text (invisible) in the item with the given position of the 2D listbox."
  6459. Example: lnbSetData [101, [0,1], "#1"]
  6460. Category: General
  6461. @e
  6462. lnbSetColumnsPos
  6463. Left Argument: control
  6464. Right Argument: [pos1,pos2,...]
  6465. Description: "Set position of 2d listbox columns."
  6466. Example: _control lbSetColumnsPos [pos1,pos2,...]
  6467. Category: General
  6468. @e
  6469. lnbSetCurSelRow
  6470. Left Argument: [idc, index]
  6471. Description: "Selects the row with the given index of the 2D listbox."
  6472. Example: lnbSetCurSel [105, 0]
  6473. Category: General
  6474. @e
  6475. lnbSetCurSelRow
  6476. Left Argument: control
  6477. Right Argument: row
  6478. Description: "Selects the item with the given index of the given listbox or combobox."
  6479. Example: _control lbSetCurSel row
  6480. Category: General
  6481. @e
  6482. lnbSetData
  6483. Left Argument: control
  6484. Right Argument: [[row, column], data]
  6485. Description: "Sets the additional text (invisible) in the item with the given position of the given 2D listbox to the given data."
  6486. Example: _control lnbSetData [[row, column], "#1"]
  6487. Category: General
  6488. @e
  6489. lnbSetData
  6490. Left Argument: [idc, [row, column], data]
  6491. Description: "Sets the additional text (invisible) in the item with the given position of the 2D listbox."
  6492. Example: lnbSetData [101, [0,1], "#1"]
  6493. Category: General
  6494. @e
  6495. lnbSetPicture
  6496. Left Argument: [idc, [row, column], name]
  6497. 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)."
  6498. Example: lnbSetPicture [101, [0,1], "iskoda"]
  6499. Category: General
  6500. @e
  6501. lnbSetPicture
  6502. Left Argument: control
  6503. Right Argument: [[row, column], name]
  6504. Description: "Sets the picture in the item with the given position of the given 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)."
  6505. Example: _control lnbSetPicture [[row, column], "iskoda"]
  6506. Category: General
  6507. @e
  6508. lnbSetPictureColor
  6509. Left Argument: [idc, [row, column], [r,g,b,a]]
  6510. Description: "Sets the picture color in the item with the given position of the 2D listbox."
  6511. Example: lnbSetPictureColor [101, [0,1], [1,0,1,1]]
  6512. Category: General
  6513. @e
  6514. lnbSetPictureColor
  6515. Left Argument: control
  6516. Right Argument: [[row, column], [r,g,b,a]]
  6517. Description: "Sets the picture color in the item with the given position of the given 2D listbox."
  6518. Example: _control lnbSetPictureColor [[row, column], [1,0,1,1]]
  6519. Category: General
  6520. @e
  6521. lnbSetPictureColorRight
  6522. Left Argument: [idc, [row, column], [r,g,b,a]]
  6523. Description: "Sets the second (right aligned) picture color in the item with the given position of the 2D listbox."
  6524. Example: lnbSetPictureColorRight [101, [0,1], [1,0,1,1]]
  6525. Category: General
  6526. @e
  6527. lnbSetPictureColorRight
  6528. Left Argument: control
  6529. Right Argument: [[row, column], [r,g,b,a]]
  6530. Description: "Sets the second (right aligned) picture color in the item with the given position of the given 2D listbox."
  6531. Example: _control lnbSetPictureColorRight [[row, column], [1,0,1,1]]
  6532. Category: General
  6533. @e
  6534. lnbSetPictureColorSelected
  6535. Left Argument: control
  6536. Right Argument: [[row, column], [r,g,b,a]]
  6537. Description: "Sets the picture color in the item with the given position of the given 2D listbox."
  6538. Example: _control lnbSetPictureColor [[row, column], [1,0,1,1]]
  6539. Category: General
  6540. @e
  6541. lnbSetPictureColorSelected
  6542. Left Argument: [idc, [row, column], [r,g,b,a]]
  6543. Description: "Sets the picture color in the item with the given position of the 2D listbox."
  6544. Example: lnbSetPictureColor [101, [0,1], [1,0,1,1]]
  6545. Category: General
  6546. @e
  6547. lnbSetPictureColorSelectedRight
  6548. Left Argument: [idc, [row, column], [r,g,b,a]]
  6549. Description: "Sets the second (right aligned) picture color in the item with the given position of the 2D listbox."
  6550. Example: lnbSetPictureColorRight [101, [0,1], [1,0,1,1]]
  6551. Category: General
  6552. @e
  6553. lnbSetPictureColorSelectedRight
  6554. Left Argument: control
  6555. Right Argument: [[row, column], [r,g,b,a]]
  6556. Description: "Sets the second (right aligned) picture color in the item with the given position of the given 2D listbox."
  6557. Example: _control lnbSetPictureColorRight [[row, column], [1,0,1,1]]
  6558. Category: General
  6559. @e
  6560. lnbSetPictureRight
  6561. Left Argument: [idc, [row, column], name]
  6562. Description: "Sets the second (right aligned) 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)."
  6563. Example: lnbSetPictureRight [101, [0,1], "iskoda"]
  6564. Category: General
  6565. @e
  6566. lnbSetPictureRight
  6567. Left Argument: control
  6568. Right Argument: [[row, column], name]
  6569. Description: "Sets the second (right aligned) picture in the item with the given position of the given 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)."
  6570. Example: _control lnbSetPictureRight [[row, column], "iskoda"]
  6571. Category: General
  6572. @e
  6573. lnbSetText
  6574. Left Argument: [idc, [row, column], data]
  6575. Description: "Sets the additional text (invisible) in the item with the given position of the 2D listbox."
  6576. Example: lnbSetData [101, [0,1], "#1"]
  6577. Category: General
  6578. @e
  6579. lnbSetText
  6580. Left Argument: control
  6581. Right Argument: [[row, column], text]
  6582. Description: "Sets the additional text (invisible) in the item with the given index of the given 2D listbox to the given data."
  6583. Example: _control lnbSetData [[row, column], "#1"]
  6584. Category: General
  6585. @e
  6586. lnbSetTextRight
  6587. Left Argument: [idc, [row, column], data]
  6588. Description: "Sets the additional text (invisible) in the item with the given position of the 2D listbox."
  6589. Example: lnbSetData [101, [0,1], "#1"]
  6590. Category: General
  6591. @e
  6592. lnbSetTextRight
  6593. Left Argument: control
  6594. Right Argument: [[row, column], text]
  6595. Description: "Sets the secondary (right aligned) text in the item with the given index of the given 2D listbox to the given data."
  6596. Example: _control lnbSetTextRight [[row, column], "#1"]
  6597. Category: General
  6598. @e
  6599. lnbSetValue
  6600. Left Argument: control
  6601. Right Argument: [[row, column], value]
  6602. Description: "Sets the additional integer value in the item with the given position of the given 2D listbox to the given value."
  6603. Example: _control lnbSetValue [[row, column], 1]
  6604. Category: General
  6605. @e
  6606. lnbSetValue
  6607. Left Argument: [idc, [row, column], value]
  6608. Description: "Sets the additional integer value in the item with the position index of the 2D listbox."
  6609. Example: lnbSetValue [101, [0,1], 1]
  6610. Category: General
  6611. @e
  6612. lnbSize
  6613. Left Argument: control
  6614. Description: "Returns the number of items in the given listbox or combobox."
  6615. Example: _n = lbSize _control
  6616. Category: General
  6617. @e
  6618. lnbText
  6619. Left Argument: [idc, [row, column]]
  6620. Description: "Returns the shown text in the item with the given position of the 2D listbox."
  6621. Example: _text = lnbText [101, [0,1]]
  6622. Category: General
  6623. @e
  6624. lnbText
  6625. Left Argument: control
  6626. Right Argument: [row, column]
  6627. Description: "Returns the shown text in the item with the given position of the given 2D listbox."
  6628. Example: _text = _control lnbText [row, column]
  6629. Category: General
  6630. @e
  6631. lnbTextRight
  6632. Left Argument: [idc, [row, column]]
  6633. Description: "Returns the shown secondary text (right aligned) in the item with the given position of the 2D listbox."
  6634. Example: _text = lnbTextRight [101, [0,1]]
  6635. Category: General
  6636. @e
  6637. lnbTextRight
  6638. Left Argument: control
  6639. Right Argument: [row, column]
  6640. Description: "Returns the shown secondary (right aligned) text in the item with the given position of the given 2D listbox."
  6641. Example: _text = _control lnbTextRight [row, column]
  6642. Category: General
  6643. @e
  6644. lnbValue
  6645. Left Argument: control
  6646. Right Argument: [row, column]
  6647. Description: "Returns the additional integer value in the item with the given position of the given 2D listbox."
  6648. Example: _value = _control lnbValue [row, column]
  6649. Category: General
  6650. @e
  6651. lnbValue
  6652. Left Argument: [idc, [row, column]
  6653. Description: "Returns the additional integer value in the item with the given position of the 2D listbox."
  6654. Example: _value = lnbValue [101, [0,1]]
  6655. Category: General
  6656. @e
  6657. load
  6658. Left Argument: unit
  6659. Description: "Returns current sum of mass from items stored in all unit's containers."
  6660. Example: load player
  6661. Category: General
  6662. @e
  6663. loadAbs
  6664. Left Argument: unit
  6665. Description: "Returns current sum of mass from items stored in a all unit's containers, linked items and weapons."
  6666. Example: loadAbs player
  6667. Category: General
  6668. @e
  6669. loadBackpack
  6670. Left Argument: unit
  6671. Description: "Returns current sum of mass from items stored in a backpack."
  6672. Example: loadBackpack player
  6673. Category: General
  6674. @e
  6675. loadFile
  6676. Left Argument: filename
  6677. 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"
  6678. Example: loadFile "myFunction.sqf"
  6679. Example Return: "if a>b then {a} else {b}"
  6680. Category: General
  6681. @e
  6682. loadGame
  6683. Description: "Load a game from the autosave, if failed, restart the mission."
  6684. Category: General
  6685. @e
  6686. loadIdentity
  6687. Left Argument: person
  6688. Right Argument: name
  6689. Description: "Loads person's identity from objects.sav file in campaign directory (from entry name)."
  6690. Example: player loadIdentity "playerIdentity"
  6691. Category: General
  6692. @e
  6693. loadMagazine
  6694. Left Argument: vehicle
  6695. Right Argument: [[turret path],magazine name]
  6696. Description: "Initiates the loading action on active weapon of the given turret."
  6697. Example: vehicle player loadMagazine [[0],"m256","20Rnd_120mmHE_M1A2"]
  6698. Category: General
  6699. @e
  6700. loadOverlay
  6701. Left Argument: map
  6702. Right Argument: config
  6703. Description: "Creates the load overlay dialog for the specified type of overlay."
  6704. Category: Editor
  6705. @e
  6706. loadStatus
  6707. Left Argument: object
  6708. Right Argument: name
  6709. Description: "Loads object's properties from objects.sav file in campaign directory (from entry name)."
  6710. Example: player loadStatus "playerState"
  6711. Category: General
  6712. @e
  6713. loadUniform
  6714. Left Argument: unit
  6715. Description: "Returns current sum of mass from items stored in a uniform."
  6716. Example: loadUniform player
  6717. Category: General
  6718. @e
  6719. loadVest
  6720. Left Argument: unit
  6721. Description: "Returns current sum of mass from items stored in a vest."
  6722. Example: loadVest player
  6723. Category: General
  6724. @e
  6725. local
  6726. Left Argument: obj
  6727. 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.
  6728. In SP all objects are local. Note: all static objects are local on all computers."
  6729. Example: local unitName
  6730. Category: General
  6731. @e
  6732. localize
  6733. Left Argument: stringName
  6734. Description: "Replaces the string with the given name with the corresponding localized text from the stringtable.csv file."
  6735. Example: localize "STR_DN_FROG"
  6736. Category: General
  6737. @e
  6738. locationNull
  6739. Description: "A non-existing location. This value is not equal to anything, including itself."
  6740. Category: Location
  6741. @e
  6742. locationPosition
  6743. Left Argument: location
  6744. Description: "Return position of given location."
  6745. Category: Location
  6746. @e
  6747. lock
  6748. Left Argument: vehicle
  6749. Right Argument: lock
  6750. Description: "Locks the vehicle (disables mounting / dismounting) for the player."
  6751. Example: jeepOne lock true
  6752. Category: General
  6753. @e
  6754. lockCameraTo
  6755. Left Argument: transport
  6756. Right Argument: [object/position/objNull, [turretPath]]
  6757. Description: "Lock/unlock camera to target"
  6758. Example: uav lockCameraTo [vehicle, [0, 0]]
  6759. Category: General
  6760. @e
  6761. lockCargo
  6762. Left Argument: vehicle
  6763. Right Argument: [cargo index, lock]
  6764. Description: "Lock the cargo position of the vehicle."
  6765. Category: General
  6766. @e
  6767. lockDriver
  6768. Left Argument: vehicle
  6769. Right Argument: lock
  6770. Description: "Lock the driver position of the vehicle."
  6771. Category: General
  6772. @e
  6773. locked
  6774. Left Argument: unit
  6775. 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"
  6776. Example: locked jeepOne
  6777. Category: General
  6778. @e
  6779. lockedCargo
  6780. Left Argument: vehicle
  6781. Right Argument: cargo index
  6782. Description: "Check whether cargo position of the vehicle is locked."
  6783. Category: General
  6784. @e
  6785. lockedDriver
  6786. Left Argument: vehicle
  6787. Description: "Check whether driver position of the vehicle turret is locked."
  6788. Category: General
  6789. @e
  6790. lockedTurret
  6791. Left Argument: vehicle
  6792. Right Argument: turret path
  6793. Description: "Check whether gunner position of the vehicle turret is locked."
  6794. Category: General
  6795. @e
  6796. lockTurret
  6797. Left Argument: vehicle
  6798. Right Argument: [turret path, lock]
  6799. Description: "Lock the gunner position of the vehicle turret."
  6800. Category: General
  6801. @e
  6802. lockWp
  6803. Left Argument: group
  6804. Right Argument: lockWP
  6805. Description: "Disables switching to the next waypoint (the current waypoint will never complete while lockWp is used). This is sometimes used during cut-scenes."
  6806. Example: groupOne lockWP true
  6807. Category: General
  6808. @e
  6809. log
  6810. Left Argument: x
  6811. Description: "The base-10 logarithm of x."
  6812. Example: log 10
  6813. Example Return: 1
  6814. Category: Default
  6815. @e
  6816. log
  6817. Left Argument: x
  6818. Description: "The base-10 logarithm of x."
  6819. Example: log 10
  6820. Example Return: 1
  6821. Category: Default
  6822. @e
  6823. logEntities
  6824. Description: "Creates a log file containing a list of all game entites in scene.,"
  6825. Category: General
  6826. @e
  6827. lookAt
  6828. Left Argument: unit(s)
  6829. Right Argument: position
  6830. Description: "Control what the unit is looking at (target or position) (format <ar>Position</ar>)"
  6831. Example: someSoldier lookAt otherSoldier; otherSoldier lookAt getMarkerPos "markerOne"
  6832. Category: General
  6833. @e
  6834. lookAtPos
  6835. Left Argument: map
  6836. Right Argument: position
  6837. Description: "Center the map on, and point the camera at, the position."
  6838. Category: Editor
  6839. @e
  6840. magazineCargo
  6841. Left Argument: box
  6842. Description: "Get array with magazines from ammo box (or any general weapon holder container). "
  6843. Category: General
  6844. @e
  6845. magazines
  6846. Left Argument: vehicle
  6847. Description: "Returns an array with the type names of all the vehicle's magazines."
  6848. Example: magazines player
  6849. Category: General
  6850. @e
  6851. magazinesAmmo
  6852. Left Argument: vehicle
  6853. Description: "Returns an array of subarrays with the type names and ammo left of all the vehicle's magazines."
  6854. Example: magazinesAmmo player
  6855. Category: General
  6856. @e
  6857. magazinesAmmoCargo
  6858. Left Argument: vehicle
  6859. Description: "Returns an array of subarrays with the type names and ammo left of all the vehicle's cargo magazines."
  6860. Example: magazinesAmmoCargo vehicle player
  6861. Category: General
  6862. @e
  6863. magazinesAmmoFull
  6864. Left Argument: vehicle
  6865. Description: "Returns an array of subarrays with the type names and ammo left of all the vehicle's magazines."
  6866. Example: magazinesAmmoFull player
  6867. Category: General
  6868. @e
  6869. magazinesDetail
  6870. Left Argument: unit
  6871. Description: "Returns an array with the type names of all the unit's magazines."
  6872. Example: magazines player
  6873. Category: General
  6874. @e
  6875. magazinesDetailBackpack
  6876. Left Argument: unit
  6877. Description: "Returns an array with the type names of all the unit's backpack magazines."
  6878. Example: magazinesBackpack player
  6879. Category: General
  6880. @e
  6881. magazinesDetailUniform
  6882. Left Argument: unit
  6883. Description: "Returns an array with the type names of all the unit's uniform magazines."
  6884. Example: magazinesUniform player
  6885. Category: General
  6886. @e
  6887. magazinesDetailVest
  6888. Left Argument: unit
  6889. Description: "Returns an array with the type names of all the unit's vest magazines."
  6890. Example: magazinesVest player
  6891. Category: General
  6892. @e
  6893. magazinesTurret
  6894. Left Argument: vehicle
  6895. Right Argument: turretPath
  6896. Description: "Returns all magazines of given turret. Use turret path [-1] for drivers turret."
  6897. Example: vehicle player magazinesTurret [0,0]
  6898. Category: General
  6899. @e
  6900. magazineTurretAmmo
  6901. Left Argument: vehicle
  6902. Right Argument: [magazineClass, turretPath]
  6903. Description: "Returns ammo count of given type from given turret."
  6904. Example: vehicle player ammoTurret ["cls", [0]]
  6905. Category: General
  6906. @e
  6907. mapAnimAdd
  6908. Left Argument: frame
  6909. 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>."
  6910. Example: mapAnimAdd [1, 0.1, getMarkerPos "anim1"]
  6911. Category: General
  6912. @e
  6913. mapAnimClear
  6914. Description: "Clears the map animation."
  6915. Category: General
  6916. @e
  6917. mapAnimCommit
  6918. Description: "Plays the map animation."
  6919. Category: General
  6920. @e
  6921. mapAnimDone
  6922. Description: "Checks whether the map animation has finished."
  6923. Category: General
  6924. @e
  6925. mapCenterOnCamera
  6926. Left Argument: control
  6927. Right Argument: enable
  6928. Description: "Enable / disable continuous centering the map on the camera position"
  6929. Category: General
  6930. @e
  6931. mapGridPosition
  6932. Left Argument: object
  6933. Description: "Returns the position as map coords."
  6934. Example: mapGridPosition player
  6935. Category: General
  6936. @e
  6937. markAsFinishedOnSteam
  6938. Description: "Marks current mission and finished on steam. Returns true is Steam query is successfully started or false otherwise."
  6939. Category: General
  6940. @e
  6941. markerAlpha
  6942. Left Argument: markerName
  6943. Description: "Gets the marker alpha. See <f>setMarkerAlpha</f>."
  6944. Example: markerAlpha "MarkerOne"
  6945. Category: General
  6946. @e
  6947. markerBrush
  6948. Left Argument: name
  6949. Description: "Gets the marker brush. See <f>setMarkerBrush</f>."
  6950. Example: markerBrush "MarkerOne"
  6951. Category: General
  6952. @e
  6953. markerColor
  6954. Left Argument: markerName
  6955. Description: "Gets the marker color. See <f>setMarkerColor</f>.
  6956. Note: this function is identical to <f>getMarkerColor</f>."
  6957. Example: markerColor "MarkerOne"
  6958. Category: General
  6959. @e
  6960. markerDir
  6961. Left Argument: markerName
  6962. Description: "Gets the marker direction. See <f>setMarkerDir</f>."
  6963. Example: markerDir "MarkerOne"
  6964. Category: General
  6965. @e
  6966. markerPos
  6967. Left Argument: markerName
  6968. Description: "Returns the marker positon in format [x,z,y].
  6969. Note: this function is identical to <f>getMarkerPos</f>."
  6970. Example: markerPos "markerOne"
  6971. Category: General
  6972. @e
  6973. markerShape
  6974. Left Argument: name
  6975. Description: "Gets the marker shape. See <f>setMarkerShape</f>."
  6976. Example: markerShape "MarkerOne"
  6977. Category: General
  6978. @e
  6979. markerSize
  6980. Left Argument: markerName
  6981. Description: "Gets the marker size. See <f>setMarkerSize</f>.
  6982. Note: this function is identical to <f>getMarkerSize</f>."
  6983. Example: markerSize "MarkerOne"
  6984. Category: General
  6985. @e
  6986. markerText
  6987. Left Argument: markerName
  6988. Description: "Gets the marker text. See <f>setMarkerText</f>."
  6989. Example: markerText "MarkerOne"
  6990. Category: General
  6991. @e
  6992. markerType
  6993. Left Argument: markerName
  6994. Description: "Gets the type of the marker. See <f>setMarkerType</f>.
  6995. Note: this function is identical to <f>getMarkerType</f>."
  6996. Example: markerType "MarkerOne"
  6997. Category: General
  6998. @e
  6999. max
  7000. Left Argument: a
  7001. Right Argument: b
  7002. Description: "The greater of a,b"
  7003. Example: 3 max 2
  7004. Example Return: 3
  7005. Category: Default
  7006. @e
  7007. max
  7008. Left Argument: a
  7009. Right Argument: b
  7010. Description: "The greater of a,b"
  7011. Example: 3 max 2
  7012. Example Return: 3
  7013. Category: Default
  7014. @e
  7015. members
  7016. Left Argument: team
  7017. Description: "Return a list of members in given team."
  7018. Example: _members = members _team
  7019. Category: Agents
  7020. @e
  7021. min
  7022. Left Argument: a
  7023. Right Argument: b
  7024. Description: "The smaller of a,b"
  7025. Example: 3 min 2
  7026. Example Return: 2
  7027. Category: Default
  7028. @e
  7029. min
  7030. Left Argument: a
  7031. Right Argument: b
  7032. Description: "The smaller of a,b"
  7033. Example: 3 min 2
  7034. Example Return: 2
  7035. Category: Default
  7036. @e
  7037. mineActive
  7038. Left Argument: obj
  7039. Description: "Checks whether the given mine is active"
  7040. Example: active mine
  7041. Category: General
  7042. @e
  7043. mineDetectedBy
  7044. Left Argument: mine
  7045. Right Argument: side
  7046. Description: "Returns true if mine is detected by given side"
  7047. Example: mine mineDetectedBy (side player)
  7048. Category: General
  7049. @e
  7050. missionConfigFile
  7051. Description: "Return root of mission description.ext entries hierarchy."
  7052. Category: General
  7053. @e
  7054. missionDifficulty
  7055. 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."
  7056. Example: difficulty
  7057. Category: General
  7058. @e
  7059. missionName
  7060. Description: "Returns the name of the current mission."
  7061. Category: General
  7062. @e
  7063. missionNamespace
  7064. Description: "Return the global namespace attached to mission."
  7065. Category: General
  7066. @e
  7067. missionStart
  7068. Description: "Returns the time of the mission start in format [year, month, day, hour, minute, second]."
  7069. Category: General
  7070. @e
  7071. mod
  7072. Left Argument: a
  7073. Right Argument: b
  7074. Description: "The remainder of a divided by b. Note that the remainer is calculated in the real domain."
  7075. Example: 3 mod 2
  7076. Example Return: 1
  7077. Category: Default
  7078. @e
  7079. mod
  7080. Left Argument: a
  7081. Right Argument: b
  7082. Description: "The remainder of a divided by b. Note that the remainer is calculated in the real domain."
  7083. Example: 3 mod 2
  7084. Example Return: 1
  7085. Category: Default
  7086. @e
  7087. modelToWorld
  7088. Left Argument: object
  7089. Right Argument: modelPos
  7090. Description: "Converts position from object model space to world space."
  7091. Category: General
  7092. @e
  7093. modelToWorldVisual
  7094. Left Argument: object
  7095. Right Argument: modelPos
  7096. Description: "Converts position from object model space to world space in render time."
  7097. Category: General
  7098. @e
  7099. moonIntensity
  7100. Description: "Returns moon light intensity."
  7101. Category: General
  7102. @e
  7103. morale
  7104. Left Argument: unit
  7105. Description: "Checks a current morale level of the unit (-1..+1)."
  7106. Example: morale leader player
  7107. Example Return: 0.5
  7108. Category: General
  7109. @e
  7110. move
  7111. Left Argument: group
  7112. Right Argument: pos
  7113. Description: "Creates a move waypoint on the given position (format <ar>Position</ar>) and makes it the currently active group waypoint."
  7114. Example: groupOne move getPos player
  7115. Category: General
  7116. @e
  7117. moveInAny
  7118. Left Argument: unit
  7119. Right Argument: vehicle
  7120. Description: "Attemps to move unit in any free position in vehicle"
  7121. Example: player moveInAny vehicle
  7122. Category: General
  7123. @e
  7124. moveInCargo
  7125. Left Argument: soldier
  7126. Right Argument: vehicle
  7127. Description: "Moves the soldier into the vehicle's cargo position. (Immediately, without animation)."
  7128. Example: soldierOne moveInCargo jeepOne
  7129. Category: General
  7130. @e
  7131. moveInCommander
  7132. Left Argument: soldier
  7133. Right Argument: vehicle
  7134. Description: "Moves the soldier into the vehicle's commander position. (Immediatetely, without animation)."
  7135. Example: soldierOne moveInCommander jeepOne
  7136. Category: General
  7137. @e
  7138. moveInDriver
  7139. Left Argument: soldier
  7140. Right Argument: vehicle
  7141. Description: "Moves the soldier into the vehicle's driver position. (Immediately, without animation)."
  7142. Example: soldierOne moveInDriver jeepOne
  7143. Category: General
  7144. @e
  7145. moveInGunner
  7146. Left Argument: soldier
  7147. Right Argument: vehicle
  7148. Description: "Moves the soldier into the vehicle's gunner position. (Immediately, without animation)."
  7149. Example: soldierOne moveInGunner jeepOne
  7150. Category: General
  7151. @e
  7152. moveInTurret
  7153. Left Argument: soldier
  7154. Right Argument: [vehicle, turret path]
  7155. Description: "Moves the soldier into the vehicle's turret. (Immediately, without animation)."
  7156. Example: soldierOne moveInTurret [tank, [0, 0]]
  7157. Category: General
  7158. @e
  7159. moveObjectToEnd
  7160. Left Argument: map
  7161. Right Argument: object
  7162. Description: "Shifts an editor object to the end of the objects array. This means that the object will be drawn last (after all other objects)."
  7163. Category: Editor
  7164. @e
  7165. moveOut
  7166. Left Argument: soldier
  7167. Description: "Moves the soldier out of vehicle. (Immediately, without animation)."
  7168. Category: General
  7169. @e
  7170. moveTime
  7171. Left Argument: soldier
  7172. Description: "Returns the current time of the most important RTM animation currently being played on the soldier."
  7173. Example: moveTime player
  7174. Category: General
  7175. @e
  7176. moveTo
  7177. Left Argument: person
  7178. Right Argument: position
  7179. Description: "Low level command to person to move to given position."
  7180. Category: General
  7181. @e
  7182. moveToCompleted
  7183. Left Argument: person
  7184. Description: "Check if latest low level moveTo command is finished."
  7185. Category: General
  7186. @e
  7187. moveToFailed
  7188. Left Argument: person
  7189. Description: "Check if latest low level moveTo command failed."
  7190. Category: General
  7191. @e
  7192. musicVolume
  7193. Description: "Checks the current music volume (set by <f>fadeMusic</f>)."
  7194. Category: General
  7195. @e
  7196. name
  7197. Left Argument: object
  7198. 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)."
  7199. Example: name vehicle player
  7200. Category: General
  7201. @e
  7202. nameSound
  7203. Left Argument: object
  7204. Description: "Returns the nameSound of the variable assigned to the object in the mission editor."
  7205. Example: nameSound player
  7206. Category: General
  7207. @e
  7208. nearEntities
  7209. Left Argument: position
  7210. Right Argument: radius or [typeName, radius] or [[typeName1, typeName2, ...], radius]
  7211. Description: "Find entities in the circle with given radius. If typeName(s) is (are) given, only entities of given type (or its subtype) are listed."
  7212. Example: _list = position player nearObjects 50
  7213. Category: General
  7214. @e
  7215. nearestBuilding
  7216. Left Argument: obj
  7217. Description: "Returns the nearest building to the given object."
  7218. Example: neareastBuilding player
  7219. Category: General
  7220. @e
  7221. nearestLocation
  7222. Left Argument: [position, type]
  7223. Description: "Find the nearest location (to the given position) of given type."
  7224. Category: Location
  7225. @e
  7226. nearestLocations
  7227. Left Argument: [position, [types], distance, <position to sort from>]
  7228. Description: "Find the nearest locations (from the given position) of certain types, within the specified distance. If &lt;position to sort from&gt; is provided, locations will be ordered by distance from this point."
  7229. Category: Location
  7230. @e
  7231. nearestLocationWithDubbing
  7232. Left Argument: position
  7233. Description: "Find the nearest location (to the given position) having it speech non-empty."
  7234. Category: Location
  7235. @e
  7236. nearestObject
  7237. Left Argument: pos
  7238. Description: "Returns the nearest object of the given type to the given position or object.
  7239. Pos may be using format [x,y,z, "type"] or [object, "type"]."
  7240. Example: nearestObject [player, "StreetLamp"]
  7241. Category: General
  7242. @e
  7243. nearestObject
  7244. Left Argument: position
  7245. Right Argument: type
  7246. Description: "Find object nearest to given position with given type."
  7247. Example: obj = position player nearestObject "Building"
  7248. Category: General
  7249. @e
  7250. nearestObjects
  7251. Left Argument: pos
  7252. Description: "Returns a list of nearest objects of the given types to the given position or object, within the specified distance.
  7253. Pos may be using format [x,y,z, ["type",...], limit] or [object, ["type",...], limit]."
  7254. Example: nearestObjects [player, ["Car","Tank"], 200]
  7255. Category: General
  7256. @e
  7257. nearObjects
  7258. Left Argument: position
  7259. Right Argument: radius or [typeName, radius]
  7260. Description: "Find objects in the circle with given radius. If typeName is given, only objects of given type (or its subtype) are listed."
  7261. Example: _list = position player nearObjects 50
  7262. Category: General
  7263. @e
  7264. nearObjectsReady
  7265. Left Argument: position
  7266. Right Argument: radius
  7267. Description: "Check whether all data are loaded to nearObjects will return in reasonable time."
  7268. Example: _ok = position player nearObjectsReady 50
  7269. Category: General
  7270. @e
  7271. nearRoads
  7272. Left Argument: position or object
  7273. Right Argument: radius
  7274. Description: "Find the road segments within the circle of given radius."
  7275. Example: _list = player nearRoads 50
  7276. Category: General
  7277. @e
  7278. nearSupplies
  7279. Left Argument: position
  7280. Right Argument: radius or [typeName, radius]
  7281. Description: "Find objects in the circle with given radius. If typeName is given, only objects of given type (or its subtype) are listed."
  7282. Example: _list = position player nearSuplies 50
  7283. Category: General
  7284. @e
  7285. nearTargets
  7286. Left Argument: unit
  7287. Right Argument: radius
  7288. Description: "Check target database of the unit for all targets in max. distance radius around it. The output is list of items: [position, type, side, subj. cost, object]"
  7289. Category: General
  7290. @e
  7291. needReload
  7292. Left Argument: vehicle
  7293. Description: "Return how much vehicle wants to reload its weapons."
  7294. Category: General
  7295. @e
  7296. netId
  7297. Left Argument: object
  7298. Description: "Unique ID of an object."
  7299. Example: netId player
  7300. Example Return: 1:8965
  7301. Category: General
  7302. @e
  7303. netObjNull
  7304. Description: "A non-existing object. This value is not equal to anything, including itself."
  7305. Example: myNetObject == objNetNull
  7306. Example Return: false
  7307. Category: General
  7308. @e
  7309. newOverlay
  7310. Left Argument: map
  7311. Right Argument: config
  7312. Description: "Creates the new overlay dialog for the specified type of overlay."
  7313. Category: Editor
  7314. @e
  7315. nextMenuItemIndex
  7316. Left Argument: map
  7317. Description: "Returns the next available menu item index."
  7318. Category: Editor
  7319. @e
  7320. nextWeatherChange
  7321. Description: "Return the time (in seconds) when the next weather change will occur."
  7322. Category: General
  7323. @e
  7324. nil
  7325. Description: "Nil value. This value can be used to undefine an existing variable."
  7326. Example: variableToDestroy = nil
  7327. Category: Default
  7328. @e
  7329. nil
  7330. Description: "Nil value. This value can be used to undefine an existing variable."
  7331. Example: variableToDestroy = nil
  7332. Category: Default
  7333. @e
  7334. nMenuItems
  7335. Left Argument: map
  7336. Right Argument: menu index
  7337. Description: "Returns the total number of user-added menu items belonging to the given menu."
  7338. Category: Editor
  7339. @e
  7340. not
  7341. Left Argument: a
  7342. Description: "not a"
  7343. Example: not false
  7344. Example Return: true
  7345. Category: Default
  7346. @e
  7347. not
  7348. Left Argument: a
  7349. Description: "not a"
  7350. Example: not false
  7351. Example Return: true
  7352. Category: Default
  7353. @e
  7354. numberOfEnginesRTD
  7355. Left Argument: RTD_helicopter
  7356. Description: "Returns number of engines helicopter has."
  7357. Category: General
  7358. @e
  7359. numberToDate
  7360. Left Argument: [year,time]
  7361. Description: "Convert float number to date."
  7362. Example: date = NumberToDate [2008,0.5324]
  7363. Category: General
  7364. @e
  7365. objectCurators
  7366. Left Argument: obj
  7367. Description: "Returns array with all curators which can edit given object."
  7368. Category: General
  7369. @e
  7370. objectFromNetId
  7371. Left Argument: id
  7372. Description: "Get object with given unique ID."
  7373. Example: objectFromNetId netId player
  7374. Example Return: player
  7375. Category: General
  7376. @e
  7377. objNull
  7378. Description: "A non-existing object. This value is not equal to anything, including itself."
  7379. Example: player == objNull
  7380. Example Return: false
  7381. Category: General
  7382. @e
  7383. objStatus
  7384. Left Argument: objective
  7385. Right Argument: status
  7386. Description: "Sets the briefing objective status. Status may be one of: "ACTIVE", "FAILED", "DONE" or "HIDDEN"."
  7387. Example: "obj_1" objStatus "FAILED"
  7388. Category: General
  7389. @e
  7390. onBriefingGroup
  7391. Left Argument: sound
  7392. Description: "Defines a sound (voice) that is played the first time when the Group section in the briefing is selected."
  7393. Example: onBriefingGroup "GroupVoiceOver"
  7394. Category: General
  7395. @e
  7396. onBriefingNotes
  7397. Left Argument: sound
  7398. Description: "Defines a sound (voice) that is played the first time when the Notes section in the briefing is selected."
  7399. Example: onBriefingNotes "NotesVoiceOver"
  7400. Category: General
  7401. @e
  7402. onBriefingPlan
  7403. Left Argument: sound
  7404. Description: "Defines a sound (voice) that is played the first time when the Plan section in the briefing is selected."
  7405. Example: onBriefingPlan "PlanVoiceOver"
  7406. Category: General
  7407. @e
  7408. onBriefingTeamSwitch
  7409. Left Argument: sound
  7410. Description: "Defines a sound (voice) that is played the first time when the Team switch section in the briefing is selected."
  7411. Example: onBriefingTeamSwitch "TeamSwitchVoiceOver"
  7412. Category: General
  7413. @e
  7414. onCommandModeChanged
  7415. Left Argument: command
  7416. Description: "Defines an action performed when command mode change. Command receives <br/>
  7417. _isHighCommand <t>bool</t> "
  7418. Category: General
  7419. @e
  7420. onDoubleClick
  7421. Left Argument: map
  7422. Right Argument: command
  7423. Description: "Defines an action performed when the user double clicks on the map. Command receives:<br/>
  7424. <br/>
  7425. _pos <t>array</t> position<br/>
  7426. _units <t>array</t> selected units<br/>
  7427. _shift,_alt <t>bool</t> key state"
  7428. Category: Editor
  7429. @e
  7430. onEachFrame
  7431. Left Argument: command
  7432. Description: "Defines an action performed on each frame (even when game is paused). Code is performed synchronously, cannot contain any sleep or wait."
  7433. Example: onEachFrame {}
  7434. Category: General
  7435. @e
  7436. onGroupIconClick
  7437. Left Argument: command
  7438. Description: "Defines an action performed when player clicked on group marker (3D or in a map)"
  7439. Category: General
  7440. @e
  7441. onGroupIconOverEnter
  7442. Left Argument: command
  7443. Description: "Defines an action performed when player clicked on group marker (3D or in a map)"
  7444. Category: General
  7445. @e
  7446. onGroupIconOverLeave
  7447. Left Argument: command
  7448. Description: "Defines an action performed when player clicked on group marker (3D or in a map)"
  7449. Category: General
  7450. @e
  7451. onHCGroupSelectionChanged
  7452. Left Argument: command
  7453. Description: "Defines an action performed when HC group has been selected. Command receives <br/>
  7454. _group <t>group</t> selected group <br/>
  7455. _isSelected <t>bool</t> new selection state"
  7456. Category: General
  7457. @e
  7458. onMapSingleClick
  7459. Left Argument: command
  7460. Description: "Defines an action performed when the user clicks on the map. Command receives:<br/>
  7461. <br/>
  7462. _pos <t>array</t> position<br/>
  7463. _units <t>array</t> selected units<br/>
  7464. _shift,_alt <t>bool</t> key state<br/>
  7465. <br/>If the click is processed, command should return true."
  7466. Example: onMapSingleClick """SoldierEG"" createUnit [_pos, group player]"
  7467. Category: General
  7468. @e
  7469. onMapSingleClick
  7470. Left Argument: parameters
  7471. Right Argument: command
  7472. Description: "Defines an action performed when the user clicks on the map. Command receives:<br/>
  7473. <br/>
  7474. _pos <t>array</t> position<br/>
  7475. _units <t>array</t> selected units<br/>
  7476. _shift,_alt <t>bool</t> key state<br/>
  7477. _this <t>any</t> parameters passed to this function<br/>
  7478. <br/>If the click is processed, command should return true."
  7479. Example: "SoldierEG" onMapSingleClick "_this createUnit [_pos, group player]"
  7480. Category: General
  7481. @e
  7482. onPlayerConnected
  7483. Left Argument: statement
  7484. 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."
  7485. Category: General
  7486. @e
  7487. onPlayerDisconnected
  7488. Left Argument: statement
  7489. Description: "This statement is launched whenever a player is disconnected from a MP session. Variables _id, _name and _uid are set."
  7490. Category: General
  7491. @e
  7492. onPreloadFinished
  7493. Left Argument: command
  7494. Description: "Defines an action performed after the preload screen finished."
  7495. Category: General
  7496. @e
  7497. onPreloadStarted
  7498. Left Argument: command
  7499. Description: "Defines an action performed just before the preload screen started."
  7500. Category: General
  7501. @e
  7502. onShowNewObject
  7503. Left Argument: map
  7504. Right Argument: command
  7505. Description: "Defines an action performed when the user right clicks on the map and selects New Object. Set to empty for default behavior. Command receives:<br/>
  7506. <br/>
  7507. _pos <t>array</t> position"
  7508. Category: Editor
  7509. @e
  7510. onTeamSwitch
  7511. Left Argument: command
  7512. Description: "Defines an action performed when the team switch is finished. Command receives:<br/>
  7513. <br/>
  7514. _from <t>object</t> previous unit<br/>
  7515. _to <t>object</t> current units<br/>
  7516. <br/>"
  7517. Category: General
  7518. @e
  7519. openCuratorInterface
  7520. Description: "Force opens curator interface."
  7521. Category: General
  7522. @e
  7523. openDlcPage
  7524. Left Argument: appId
  7525. Description: "Opens a Steam page of the app with given appId. Only works for known appId (game + linked DLCs)"
  7526. Example: openDlcPage 288520
  7527. Category: General
  7528. @e
  7529. openMap
  7530. Left Argument: [show, forced]
  7531. Description: "Show player's map. If forced, cannot be closed."
  7532. Example: openMap [true,true]
  7533. Category: General
  7534. @e
  7535. openYoutubeVideo
  7536. Left Argument: youTubeUrl
  7537. 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'"
  7538. Category: General
  7539. @e
  7540. opfor
  7541. Description: "Pre-defined variable for the opfor side."
  7542. Category: General
  7543. @e
  7544. or
  7545. Left Argument: a
  7546. Right Argument: b
  7547. Description: "a or b"
  7548. Example: not alive player or not alive leader player
  7549. Category: Default
  7550. @e
  7551. or
  7552. Left Argument: a
  7553. Right Argument: b
  7554. Description: "a or b"
  7555. Example: not alive player or not alive leader player
  7556. Category: Default
  7557. @e
  7558. orderGetIn
  7559. Left Argument: unitArray
  7560. Right Argument: order
  7561. Description: "Forces all units in the list to get in their assigned vehicle."
  7562. Example: [unitOne, unitTwo] orderGetIn true
  7563. Category: General
  7564. @e
  7565. overcast
  7566. Description: "Return the current overcast."
  7567. Category: General
  7568. @e
  7569. overcastForecast
  7570. Description: "Return the overcast forecast."
  7571. Category: General
  7572. @e
  7573. owner
  7574. Left Argument: object
  7575. Description: "On server machine, return the ID of the client where the object is local. Otherwise return 0."
  7576. Category: General
  7577. @e
  7578. parseNumber
  7579. Left Argument: string
  7580. Description: "Parse string containing real number."
  7581. Example: parseNumber "0.125"
  7582. Category: Default
  7583. @e
  7584. parseNumber
  7585. Left Argument: string
  7586. Description: "Parse string containing real number."
  7587. Example: parseNumber "0.125"
  7588. Category: Default
  7589. @e
  7590. parseText
  7591. Left Argument: text
  7592. Description: "Creates a structured text by parsing the given XML description."
  7593. Example: txt = parseText "First line&lt;img image=data\isniper.paa/&gt;&ltbr/&gt;Second line"
  7594. Category: General
  7595. @e
  7596. parsingNamespace
  7597. Description: "Return the global namespace attached to config parser."
  7598. Category: General
  7599. @e
  7600. particlesQuality
  7601. Description: "Return current settings for particles quality."
  7602. Category: General
  7603. @e
  7604. pi
  7605. Description: "pi (180 degrees converted to radians)"
  7606. Example: pi
  7607. Example Return: 3.1415
  7608. Category: Default
  7609. @e
  7610. pi
  7611. Description: "pi (180 degrees converted to radians)"
  7612. Example: pi
  7613. Example Return: 3.1415
  7614. Category: Default
  7615. @e
  7616. pickWeaponPool
  7617. Left Argument: obj
  7618. 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)."
  7619. Category: General
  7620. @e
  7621. pitch
  7622. Left Argument: object
  7623. Description: "Returns the pitch of the variable assigned to the object in the mission editor."
  7624. Example: pitch player
  7625. Category: General
  7626. @e
  7627. playableSlotsNumber
  7628. Left Argument: side
  7629. 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."
  7630. Category: General
  7631. @e
  7632. playableUnits
  7633. Description: "Return a list of playable units (occupied by both AI or players)."
  7634. Category: General
  7635. @e
  7636. playAction
  7637. Left Argument: soldier
  7638. Right Argument: action
  7639. Description: "When used on a person, a smooth transition to the given action will be initiated."
  7640. Example: soldierOne playAction "SitDown"
  7641. Category: General
  7642. @e
  7643. playActionNow
  7644. Left Argument: soldier
  7645. Right Argument: action
  7646. Description: "When used on a person, a smooth transition to the given action will be initiated, but all previous playAction are discarded."
  7647. Example: soldierOne playActionNow "SitDown"
  7648. Category: General
  7649. @e
  7650. player
  7651. Description: "This is the person controlled by the player. In MP this value is different on each computer."
  7652. Example: alive player
  7653. Category: General
  7654. @e
  7655. playerRespawnTime
  7656. Description: "Return the player remaining time to respawn."
  7657. Category: General
  7658. @e
  7659. playerSide
  7660. Description: "Returns the player's side. This is valid even when the player controlled person is dead (a difference from player side)."
  7661. Category: General
  7662. @e
  7663. playersNumber
  7664. Left Argument: side
  7665. Description: "Returns the number of players playing on the given side."
  7666. Category: General
  7667. @e
  7668. playGesture
  7669. Left Argument: soldier
  7670. Right Argument: moveName
  7671. Description: "When used on a person, a smooth transition to the given move will be initiated."
  7672. Example: soldierOne playGesture "Wave"
  7673. Category: General
  7674. @e
  7675. playMission
  7676. Left Argument: [campaign, mission] or [campaign, mission, skipBriefing]
  7677. 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."
  7678. Example: playMission["XOutrage","x05Negotiator.Noe"]
  7679. Category: General
  7680. @e
  7681. playMove
  7682. Left Argument: soldier
  7683. Right Argument: moveName
  7684. Description: "When used on a person, a smooth transition to the given move will be initiated."
  7685. Example: soldierOne playMove "Stand"
  7686. Category: General
  7687. @e
  7688. playMoveNow
  7689. Left Argument: soldier
  7690. Right Argument: moveName
  7691. Description: "When used on a person, a smooth transition to the given move will be initiated, but all previous playAction are discarded."
  7692. Example: soldierOne playMoveNow "Stand"
  7693. Category: General
  7694. @e
  7695. playMusic
  7696. Left Argument: name
  7697. Description: "Plays music defined in the description.ext file."
  7698. Example: playMusic "musicname"
  7699. Category: General
  7700. @e
  7701. playScriptedMission
  7702. Left Argument: [world, expression, config, (ignoreChildWindow)]
  7703. 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."
  7704. Category: General
  7705. @e
  7706. playSound
  7707. Left Argument: name
  7708. Description: "Plays a sound defined in the description.ext file."
  7709. Example: playSound "soundname"
  7710. Category: General
  7711. @e
  7712. playSound3D
  7713. Left Argument: ["filename", source, isInside, position, volume, frequency, distance]
  7714. 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."
  7715. Example: playSound3D ["A3\Sounds_F\sfx\blip1.wav", player] or playSound3D ["A3\Sounds_F\sfx\blip1.wav", player, false, getPos player, 1, 1, 0]
  7716. Category: General
  7717. @e
  7718. position
  7719. Left Argument: object
  7720. Description: "Returns the object position in format <ar>Position</ar>."
  7721. Example: position player
  7722. Category: General
  7723. @e
  7724. positionCameraToWorld
  7725. Left Argument: position
  7726. Description: "Transform position from camera coordinate space to world coordinate space."
  7727. Example: _worldPos = positionCameraToWorld _cameraPos
  7728. Category: General
  7729. @e
  7730. posScreenToWorld
  7731. Left Argument: map
  7732. Right Argument: [x, y]
  7733. Description: "Convert screen coordinates in map to world coordinates."
  7734. Category: General
  7735. @e
  7736. posWorldToScreen
  7737. Left Argument: map
  7738. Right Argument: position
  7739. Description: "Convert world coordinates to screen coordinates in map."
  7740. Category: General
  7741. @e
  7742. ppEffectAdjust
  7743. Left Argument: string
  7744. Right Argument: array
  7745. Description: "Adjust parameters for specified post process effect"
  7746. Example: "radialBlurr" ppEffectEnable []
  7747. Category: Visual
  7748. @e
  7749. ppEffectCommit
  7750. Left Argument: string
  7751. Right Argument: number
  7752. Description: "Set time when old pars are replaced by last set, if 0 set immediately"
  7753. Example: ...
  7754. Category: Visual
  7755. @e
  7756. ppEffectCommitted
  7757. Left Argument: effect
  7758. Description: "Check whether given post process effect is commited"
  7759. Category: Visual
  7760. @e
  7761. ppEffectCreate
  7762. Left Argument: effect
  7763. Description: "Create post process effect specified by name and priority"
  7764. Category: Visual
  7765. @e
  7766. ppEffectDestroy
  7767. Left Argument: effect
  7768. Description: "Destroy post process effect given by handle"
  7769. Category: Visual
  7770. @e
  7771. ppEffectEnable
  7772. Left Argument: string
  7773. Right Argument: bool
  7774. Description: "Enable/disable specified post process effect, is overloaded form multiple effects."
  7775. Example: "radialBlurr" ppEffectEnable true, ["chromAberration", "radialBlurr"] ppEffectEnable true
  7776. Category: Visual
  7777. @e
  7778. ppEffectForceInNVG
  7779. Left Argument: number
  7780. Right Argument: bool
  7781. Description: "Forces to use PP effect in NVG"
  7782. Category: Visual
  7783. @e
  7784. precision
  7785. Left Argument: entity
  7786. Description: "Return the precision of the given entity."
  7787. Category: General
  7788. @e
  7789. preloadCamera
  7790. Left Argument: position
  7791. Description: "Preload all textures and models around given position"
  7792. Category: General
  7793. @e
  7794. preloadObject
  7795. Left Argument: distance
  7796. Right Argument: object
  7797. Description: "Preload all data for given object."
  7798. Category: General
  7799. @e
  7800. preloadSound
  7801. Left Argument: sound
  7802. Description: "Make sure sound can start playing without any delay once we need it."
  7803. Category: General
  7804. @e
  7805. preloadTitleObj
  7806. Left Argument: effect
  7807. Description: "Object title - argument uses format ["text","type",speed, showInMap] or ["name","type"]. Speed is ignored.
  7808. Preload data
  7809. The object can be defined in the description.ext file."
  7810. Example: titleObj ["BISLogo","plain"]
  7811. Category: General
  7812. @e
  7813. preloadTitleRsc
  7814. Left Argument: effect
  7815. Description: "Resource title - argument uses format ["name","type",speed, showInMap] or ["name","type"]. Speed is ignored.
  7816. Preload data
  7817. The resource can be defined in the description.ext file."
  7818. Example: titleRsc ["BIS", "PLAIN"]
  7819. Category: General
  7820. @e
  7821. preprocessFile
  7822. Left Argument: filename
  7823. 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"
  7824. Example: preprocessFile "myFunction.sqf"
  7825. Example Return: "if a>b then {a} else {b}"
  7826. Category: General
  7827. @e
  7828. preprocessFileLineNumbers
  7829. Left Argument: filename
  7830. 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."
  7831. Example: preprocessFileLineNumbers "myFunction.sqf"
  7832. Example Return: "if a>b then {a} else {b}"
  7833. Category: General
  7834. @e
  7835. primaryWeapon
  7836. Left Argument: vehicle
  7837. Description: "Returns the name of the vehicle's primary weapon (an empty string if there is none)."
  7838. Example: primaryWeapon player
  7839. Category: General
  7840. @e
  7841. primaryWeaponItems
  7842. Left Argument: unit
  7843. Description: "Get array with all items assigned to a weapon."
  7844. Category: General
  7845. @e
  7846. primaryWeaponMagazine
  7847. Left Argument: vehicle
  7848. Description: "Return the names of the types of currently loaded magazines in given weapon."
  7849. Category: General
  7850. @e
  7851. priority
  7852. Left Argument: task
  7853. Description: "Return the priority of the task."
  7854. Category: Identity
  7855. @e
  7856. private
  7857. Left Argument: variable
  7858. Description: "Introduces one or more local variables in the innermost scope."
  7859. Category: Default
  7860. @e
  7861. private
  7862. Left Argument: variable
  7863. Description: "Introduces one or more local variables in the innermost scope."
  7864. Category: Default
  7865. @e
  7866. processDiaryLink
  7867. Left Argument: link
  7868. Description: "Open the diary screen on the record specified by link."
  7869. Category: Identity
  7870. @e
  7871. productVersion
  7872. Description: "Return the product name, version, branch and flag if game is modded in form ["product name","product short name",version*100,build,"branche",customMods]"
  7873. Example: productVersion
  7874. Example Return: ["ArmA 3", "Arma3", 137, 87840, "Development", true]
  7875. Category: General
  7876. @e
  7877. profileName
  7878. Description: "Return profile name."
  7879. Category: General
  7880. @e
  7881. profileNamespace
  7882. Description: "Return the global namespace attached to user profile."
  7883. Category: General
  7884. @e
  7885. progressLoadingScreen
  7886. Left Argument: progress
  7887. Description: "If loading screen is show, set progress bar to the given value (from interval [0, 1])"
  7888. Category: General
  7889. @e
  7890. progressPosition
  7891. Left Argument: control
  7892. Description: "Returns the current position in the progress bar."
  7893. Example: _pos = progressPosition _control
  7894. Category: General
  7895. @e
  7896. progressSetPosition
  7897. Left Argument: control
  7898. Right Argument: pos
  7899. Description: "Sets the current position in the progress bar."
  7900. Example: _control sliderSetPosition 0
  7901. Category: General
  7902. @e
  7903. publicVariable
  7904. Left Argument: varName
  7905. Description: "Broadcasts the variable value to all computers.
  7906. Only type <t>Number</t> is supported in versions 1.33 and before.
  7907. The following types are supported since 1.34:
  7908. <t>Number</t>, <t>Boolean</t>, <t>Object</t> and <t>Group</t>."
  7909. Example: publicVariable "CTFscoreOne"
  7910. Category: General
  7911. @e
  7912. publicVariableClient
  7913. Left Argument: clientId
  7914. Right Argument: varName
  7915. Description: "Send the variable value to the client computer.
  7916. Only type <t>Number</t> is supported in versions 1.33 and before.
  7917. The following types are supported since 1.34:
  7918. <t>Number</t>, <t>Boolean</t>, <t>Object</t> and <t>Group</t>."
  7919. Example: 3 publicVariableClient "CTFscoreOne"
  7920. Category: General
  7921. @e
  7922. publicVariableServer
  7923. Left Argument: varName
  7924. Description: "Send the variable value to the server computer.
  7925. Only type <t>Number</t> is supported in versions 1.33 and before.
  7926. The following types are supported since 1.34:
  7927. <t>Number</t>, <t>Boolean</t>, <t>Object</t> and <t>Group</t>."
  7928. Example: publicVariableServer "CTFscoreOne"
  7929. Category: General
  7930. @e
  7931. pushBack
  7932. Left Argument: array
  7933. Right Argument: element
  7934. Description: "Add and element into the end of a given array."
  7935. Example: array push_back "Hello"
  7936. Category: Default
  7937. @e
  7938. pushBack
  7939. Left Argument: array
  7940. Right Argument: element
  7941. Description: "Add and element into the end of a given array."
  7942. Example: array push_back "Hello"
  7943. Category: Default
  7944. @e
  7945. putWeaponPool
  7946. Left Argument: obj
  7947. 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."
  7948. Category: General
  7949. @e
  7950. queryItemsPool
  7951. Left Argument: name
  7952. Description: "Returns the number of items of type name in the weapon pool (used in campaigns to transfer weapons to the next mission)."
  7953. Category: General
  7954. @e
  7955. queryMagazinePool
  7956. Left Argument: name
  7957. Description: "Returns the number of magazines of type name in the weapon pool (used in campaigns to transfer weapons to the next mission)."
  7958. Category: General
  7959. @e
  7960. queryWeaponPool
  7961. Left Argument: name
  7962. Description: "Returns the number of weapons of type name in the weapon pool (used in campaigns to transfer weapons to the next mission)."
  7963. Category: General
  7964. @e
  7965. rad
  7966. Left Argument: x
  7967. Description: "Converts x from degrees to radians."
  7968. Example: rad 180
  7969. Example Return: 3.1415
  7970. Category: Default
  7971. @e
  7972. rad
  7973. Left Argument: x
  7974. Description: "Converts x from degrees to radians."
  7975. Example: rad 180
  7976. Example Return: 3.1415
  7977. Category: Default
  7978. @e
  7979. radioChannelAdd
  7980. Left Argument: chan ix
  7981. Right Argument: [units]
  7982. Description: "Add the units to the custom radio channel."
  7983. Category: General
  7984. @e
  7985. radioChannelCreate
  7986. Left Argument: [[r,g,b,a], label, callSign, [unit1,unit2,...], sentenceColorType]
  7987. 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."
  7988. Category: General
  7989. @e
  7990. radioChannelRemove
  7991. Left Argument: chan ix
  7992. Right Argument: [units]
  7993. Description: "Remove the units from the custom radio channel."
  7994. Category: General
  7995. @e
  7996. radioChannelSetCallSign
  7997. Left Argument: chan ix
  7998. Right Argument: callSign
  7999. Description: "Set the custom channel call sign."
  8000. Category: General
  8001. @e
  8002. radioChannelSetLabel
  8003. Left Argument: chan ix
  8004. Right Argument: label
  8005. Description: "Set the custom channel label."
  8006. Category: General
  8007. @e
  8008. radioVolume
  8009. Description: "Checks the current radio volume (set by <f>setRadioVolume</f>)."
  8010. Category: General
  8011. @e
  8012. rain
  8013. Description: "Return the current rain."
  8014. Category: General
  8015. @e
  8016. rainbow
  8017. Description: "Return the current rainbow intensity."
  8018. Category: General
  8019. @e
  8020. random
  8021. Left Argument: x
  8022. Description: "The random real value from 0 to x. (0&lt;=random&lt;1)"
  8023. Example: random 1
  8024. Category: Default
  8025. @e
  8026. random
  8027. Left Argument: x
  8028. Description: "The random real value from 0 to x. (0&lt;=random&lt;1)"
  8029. Example: random 1
  8030. Category: Default
  8031. @e
  8032. randomGen
  8033. Left Argument: multiplier
  8034. Description: "Create expression which will generate random number from interval &lt;0, multiplier)"
  8035. Example: randomGen 5
  8036. Category: Simple expression
  8037. @e
  8038. rank
  8039. Left Argument: unit
  8040. Description: "Return the rank of the given unit."
  8041. Category: General
  8042. @e
  8043. rankId
  8044. Left Argument: unit
  8045. Description: "Return the rank of the given unit for comparison."
  8046. Category: General
  8047. @e
  8048. rating
  8049. Left Argument: unit
  8050. Description: "Checks the unit rating. This rating is increased for killing enemies, decreased for killing friendlies and can be changed by a mission designer."
  8051. Example: rating player
  8052. Category: General
  8053. @e
  8054. rectangular
  8055. Left Argument: location
  8056. Description: "Check if given location has rectangular shape."
  8057. Category: Location
  8058. @e
  8059. registeredTasks
  8060. Left Argument: teamMember
  8061. Description: "List all registered task types."
  8062. Category: Identity
  8063. @e
  8064. registerTask
  8065. Left Argument: teamMember
  8066. Right Argument: entry name
  8067. Description: "Register a new task type. Parameters are defined in the given config class (subclass of CfgTasks)."
  8068. Category: Identity
  8069. @e
  8070. reload
  8071. Left Argument: vehicle
  8072. Description: "Reload all weapons."
  8073. Category: General
  8074. @e
  8075. reloadEnabled
  8076. Left Argument: vehicle
  8077. Description: "Check whether magazine is reloaded whenever emptied."
  8078. Category: General
  8079. @e
  8080. remoteControl
  8081. Left Argument: who
  8082. Right Argument: whom
  8083. Description: "Switch on remote control of the unit."
  8084. Example: player remoteControl gunner _uav
  8085. Category: General
  8086. @e
  8087. removeAction
  8088. Left Argument: unit
  8089. Right Argument: index
  8090. Description: "Removes the action with the given id."
  8091. Example: player removeAction 0
  8092. Category: General
  8093. @e
  8094. removeAllActions
  8095. Left Argument: unit
  8096. Description: "Removes the action with the given id."
  8097. Example: removeAllActions player
  8098. Category: General
  8099. @e
  8100. removeAllAssignedItems
  8101. Left Argument: unit
  8102. Description: "Removes all linked items from gear (map, compass, headgear, goggles etc.)."
  8103. Category: General
  8104. @e
  8105. removeAllContainers
  8106. Left Argument: unit
  8107. Description: "Removes all containers from the unit."
  8108. Example: removeAllContainers player
  8109. Category: General
  8110. @e
  8111. removeAllCuratorAddons
  8112. Left Argument: curatorObj
  8113. Description: "Restrict access to all addons for given curator."
  8114. Category: General
  8115. @e
  8116. removeAllCuratorCameraAreas
  8117. Left Argument: curatorObj
  8118. Description: "Delete all curator camera areas."
  8119. Category: General
  8120. @e
  8121. removeAllCuratorEditingAreas
  8122. Left Argument: curatorObj
  8123. Description: "Delete all curator edit areas."
  8124. Category: General
  8125. @e
  8126. removeAllEventHandlers
  8127. Left Argument: object
  8128. Right Argument: handlerType
  8129. Description: "Removes all event handlers of the given type which were added by <f>addEventHandler</f>."
  8130. Example: player removeAllEventHandlers "killed"
  8131. Category: General
  8132. @e
  8133. removeAllHandgunItems
  8134. Left Argument: unit
  8135. Description: "Removes all items from weapon except magazine."
  8136. Category: General
  8137. @e
  8138. removeAllItems
  8139. Left Argument: unit
  8140. Description: "Removes all items from the uniform, vest and backpack."
  8141. Category: General
  8142. @e
  8143. removeAllItemsWithMagazines
  8144. Left Argument: unit
  8145. Description: "Removes all items from the uniform, vest and backpack."
  8146. Category: General
  8147. @e
  8148. removeAllMissionEventHandlers
  8149. Left Argument: type
  8150. Description: "Removes all event handlers of the given type which were added by <f>addMissionEventHandler</f>."
  8151. Example: removeAllMissionEventHandlers "ended"
  8152. Category: General
  8153. @e
  8154. removeAllMPEventHandlers
  8155. Left Argument: object
  8156. Right Argument: handlerType
  8157. Description: "Removes all MP event handlers of the given type which were added by <f>addMPEventHandler</f>."
  8158. Example: player removeAllMPEventHandlers "mpkilled"
  8159. Category: General
  8160. @e
  8161. removeAllMusicEventHandlers
  8162. Left Argument: type
  8163. Description: "Remove all music track event handlers."
  8164. Example: removeAllMusicEventHandlers "MusicStart"
  8165. Category: General
  8166. @e
  8167. removeAllPrimaryWeaponItems
  8168. Left Argument: unit
  8169. Description: "Removes all items from weapon except magazine."
  8170. Category: General
  8171. @e
  8172. removeAllWeapons
  8173. Left Argument: unit
  8174. Description: "Removes all weapons from the unit."
  8175. Example: removeAllWeapons player
  8176. Category: General
  8177. @e
  8178. removeBackpack
  8179. Left Argument: unit
  8180. Description: "Remove backpack from unit."
  8181. Example: removeBackpack player
  8182. Category: General
  8183. @e
  8184. removeBackpackGlobal
  8185. Left Argument: unit
  8186. Description: "Remove backpack from unit(even non-local)."
  8187. Example: removeBackpackGlobal player
  8188. Category: General
  8189. @e
  8190. removeCuratorAddons
  8191. Left Argument: curatorObj
  8192. Right Argument: [addons]
  8193. Description: "Restrict curator use of given addon."
  8194. Example: curator removeCuratorAddons [addon1, addon2]
  8195. Category: General
  8196. @e
  8197. removeCuratorCameraArea
  8198. Left Argument: curatorObj
  8199. Right Argument: cameraAreaID
  8200. Description: "Removes curator camera area"
  8201. Category: General
  8202. @e
  8203. removeCuratorEditableObjects
  8204. Left Argument: curatorObj
  8205. Right Argument: [[object],removeCrew = true]
  8206. Description: "Unregister objects which can be edited by a curator."
  8207. Example: 0 removeCuratorEditableObjects [cursorTarget, true]
  8208. Category: General
  8209. @e
  8210. removeCuratorEditingArea
  8211. Left Argument: curatorObj
  8212. Right Argument: editAreaID
  8213. Description: "Removes editing area for given curator"
  8214. Category: General
  8215. @e
  8216. removeDrawIcon
  8217. Left Argument: map
  8218. Right Argument: [object, string identifier]
  8219. Description: "Removes an icon for an editor object."
  8220. Category: Editor
  8221. @e
  8222. removeDrawLinks
  8223. Left Argument: map
  8224. Right Argument: [from, param type]
  8225. Description: "Remove all drawn links for the given editor object for the given editor object type. Pass an empty string as param type to remove all draw links for an object."
  8226. Category: Editor
  8227. @e
  8228. removeEventHandler
  8229. Left Argument: object
  8230. Right Argument: handler
  8231. Description: "Removes event handler added by <f>addEventHandler</f>. Format of handler is [type,index]. Index is returned by addEventHandler. When any handler is removed, all handler indices higher that the deleted one should be decremented."
  8232. Example: player removeEventHandler ["killed",0]
  8233. Category: General
  8234. @e
  8235. removeFromRemainsCollector
  8236. Left Argument: array
  8237. Description: "Removes flag from given objects to be managed by unitRemove manager"
  8238. Example: removeFromRemainsCollector [unit1, unit2]
  8239. Category: General
  8240. @e
  8241. removeGoggles
  8242. Left Argument: unit
  8243. Description: "Remove goggles from unit."
  8244. Example: removeBackpack player
  8245. Category: General
  8246. @e
  8247. removeGroupIcon
  8248. Left Argument: group
  8249. Right Argument: icon ID
  8250. Description: "Remove icon with given ID from group."
  8251. Example: group removeGroupIcon id
  8252. Category: General
  8253. @e
  8254. removeHandgunItem
  8255. Left Argument: unit
  8256. Right Argument: item
  8257. Description: "Removes given item from the weapon cargo space."
  8258. Example: player removeHandgunItem "ItemClassName"
  8259. Category: General
  8260. @e
  8261. removeHeadgear
  8262. Left Argument: unit
  8263. Description: "Remove headgear from unit."
  8264. Example: removeBackpack player
  8265. Category: General
  8266. @e
  8267. removeItem
  8268. Left Argument: unit
  8269. Right Argument: item
  8270. Description: "Remove item from the inventory."
  8271. Category: General
  8272. @e
  8273. removeItemFromBackpack
  8274. Left Argument: unit
  8275. Right Argument: item
  8276. Description: "Remove item from soldier's uniform."
  8277. Category: General
  8278. @e
  8279. removeItemFromUniform
  8280. Left Argument: unit
  8281. Right Argument: item
  8282. Description: "Remove item from soldier's uniform."
  8283. Category: General
  8284. @e
  8285. removeItemFromVest
  8286. Left Argument: unit
  8287. Right Argument: item
  8288. Description: "Remove item from soldier's uniform."
  8289. Category: General
  8290. @e
  8291. removeItems
  8292. Left Argument: unit
  8293. Right Argument: item
  8294. Description: "Remove all items with given template from the inventory."
  8295. Category: General
  8296. @e
  8297. removeMagazine
  8298. Left Argument: unit
  8299. Right Argument: weaponName
  8300. Description: "Removes the magazine from the unit. Note: you may create invalid combinations by using this function. When doing so, application behaviour is undefined."
  8301. Example: player removeMagazine "M16"
  8302. Category: General
  8303. @e
  8304. removeMagazineGlobal
  8305. Left Argument: unit
  8306. Right Argument: weaponName
  8307. Description: "Removes the magazine from the unit. Note: you may create invalid combinations by using this function. When doing so, application behaviour is undefined."
  8308. Example: player removeMagazineGlobal "M16"
  8309. Category: General
  8310. @e
  8311. removeMagazines
  8312. Left Argument: unit
  8313. Right Argument: weaponName
  8314. Description: "Removes all magazines of the given type from the unit. Note: you may create invalid combinations by using this function. When doing so, application behaviour is undefined."
  8315. Example: player removeMagazines "M16"
  8316. Category: General
  8317. @e
  8318. removeMagazinesTurret
  8319. Left Argument: transport
  8320. Right Argument: [weaponName, turret path]
  8321. Description: "Removes all magazines of the given type from the unit. Use turret path [-1] for driver's turret. Note: you may create invalid combinations by using this function. When doing so, application behaviour is undefined."
  8322. Example: vehicle player removeMagazines ["60rnd_cmflaremagazine",,[-1]]
  8323. Category: General
  8324. @e
  8325. removeMagazineTurret
  8326. Left Argument: transport
  8327. Right Argument: [weaponName, turret path]
  8328. Description: "Removes the magazine from the turret. Use turret path [-1] for driver's turret. Note: you may create invalid combinations by using this function. When doing so, application behaviour is undefined."
  8329. Example: vehicle player removeMagazine ["60rnd_cmflaremagazine",[-1]]
  8330. Category: General
  8331. @e
  8332. removeMenuItem
  8333. Left Argument: map
  8334. Right Argument: index of menu item to delete
  8335. Description: "Removes a previously added menu item."
  8336. Category: Editor
  8337. @e
  8338. removeMissionEventHandler
  8339. Left Argument: [type, id]
  8340. 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."
  8341. Example: removeMissionEventHandler ["ended",0]
  8342. Category: General
  8343. @e
  8344. removeMPEventHandler
  8345. Left Argument: object
  8346. Right Argument: handler
  8347. Description: "Removes MP event handler added by <f>addMPEventHandler</f>. Format of handler is [type,index]. Index is returned by addMPEventHandler. When any handler is removed, all handler indices higher that the deleted one should be decremented."
  8348. Example: player removeMPEventHandler ["killed",0]
  8349. Category: General
  8350. @e
  8351. removeMusicEventHandler
  8352. Left Argument: [type, id]
  8353. Description: "Remove specified music track event handler."
  8354. Example: removeMusicEventHandler ["MusicTerminate", "1"]
  8355. Category: General
  8356. @e
  8357. removePrimaryWeaponItem
  8358. Left Argument: unit
  8359. Right Argument: item
  8360. Description: "Removes given item from the weapon cargo space."
  8361. Example: player removePrimaryWeaponItem "ItemClassName"
  8362. Category: General
  8363. @e
  8364. removeSecondaryWeaponItem
  8365. Left Argument: unit
  8366. Right Argument: item
  8367. Description: "Removes given item from the weapon cargo space."
  8368. Example: player removeSecondaryWeaponItem "ItemClassName"
  8369. Category: General
  8370. @e
  8371. removeSimpleTask
  8372. Left Argument: person
  8373. Right Argument: task
  8374. Description: "Remove a simple task from the list of simple tasks."
  8375. Category: Identity
  8376. @e
  8377. removeSwitchableUnit
  8378. Left Argument: person
  8379. Description: "Remove a unit from the list of units available for team switch."
  8380. Category: General
  8381. @e
  8382. removeTeamMember
  8383. Left Argument: team
  8384. Right Argument: member
  8385. Description: "Remove given member from given team."
  8386. Example: _team removeTeamMember _teamMember
  8387. Category: Agents
  8388. @e
  8389. removeUniform
  8390. Left Argument: unit
  8391. Description: "Remove uniform from unit."
  8392. Example: removeBackpack player
  8393. Category: General
  8394. @e
  8395. removeVest
  8396. Left Argument: unit
  8397. Description: "Remove vest from unit."
  8398. Example: removeBackpack player
  8399. Category: General
  8400. @e
  8401. removeWeapon
  8402. Left Argument: unit
  8403. Right Argument: weaponName
  8404. Description: "Removes the weapon from the unit. Note: you may create invalid combinations by using this function. When doing so, application behaviour is undefined."
  8405. Example: player removeWeapon "M16"
  8406. Category: General
  8407. @e
  8408. removeWeaponAttachmentCargo
  8409. Left Argument: vehicle(with supply)
  8410. Right Argument: [weaponID,creatorID,"weaponAttachment"]
  8411. Description: "Remove attachment linked to a weapon from the vehicle cargo space."
  8412. Example: rearmTruckOne RemoveWeaponAttachment[weaponID,creatorID,"attachment"]
  8413. Category: General
  8414. @e
  8415. removeWeaponCargo
  8416. Left Argument: vehicle(with supply)
  8417. Right Argument: [weaponID,creatorID]
  8418. Description: "Remove weapon from the vehicle cargo space."
  8419. Example: rearmTruckOne removeWeaponCargo [19, 1]
  8420. Category: General
  8421. @e
  8422. removeWeaponGlobal
  8423. Left Argument: unit
  8424. Right Argument: weaponName
  8425. Description: "Removes the weapon from the unit. Note: you may create invalid combinations by using this function. When doing so, application behaviour is undefined."
  8426. Example: player removeWeaponGobal "M16"
  8427. Category: General
  8428. @e
  8429. removeWeaponTurret
  8430. Left Argument: vehicle
  8431. Right Argument: [weaponName,turret array]
  8432. Description: "Removes the weapon from the given vehicle's turret. "
  8433. Example: vehicle player aremoveWeaponTurret ["Horn",[0,0]]
  8434. Category: General
  8435. @e
  8436. requiredVersion
  8437. Left Argument: version
  8438. 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"."
  8439. Example: requiredVersion "1.30"
  8440. Category: General
  8441. @e
  8442. resetCamShake
  8443. Description: "Resets all camera shakes."
  8444. Category: General
  8445. @e
  8446. resetSubgroupDirection
  8447. Left Argument: subgroup member
  8448. Description: "Reset direction of subgroup."
  8449. Example: resetSubgroupDirection unit
  8450. Category: General
  8451. @e
  8452. resistance
  8453. Description: "The Resistance side."
  8454. Category: General
  8455. @e
  8456. resize
  8457. Left Argument: array
  8458. Right Argument: count
  8459. Description: "Changes the array size. This function can be used to add or remove elements from the array."
  8460. Example: array resize 2
  8461. Category: Default
  8462. @e
  8463. resize
  8464. Left Argument: array
  8465. Right Argument: count
  8466. Description: "Changes the array size. This function can be used to add or remove elements from the array."
  8467. Example: array resize 2
  8468. Category: Default
  8469. @e
  8470. resources
  8471. Left Argument: teamMember
  8472. Description: "Return a list of the resources belonging to a team."
  8473. Category: Agents
  8474. @e
  8475. respawnVehicle
  8476. Left Argument: vehicle
  8477. Right Argument: [delay = -1, count = 0]
  8478. Description: "Set vehicle as respawnable in MP games. Delay is respawn delay, default respawnDelay from description.ext is used. Count tells how many respawns is processed (default unlimited)."
  8479. Example: car respawnVehicle [5.0, 3]
  8480. Category: General
  8481. @e
  8482. restartEditorCamera
  8483. Left Argument: map
  8484. Description: "Restarts the mission editor camera (if it was deleted by a script, for example)."
  8485. Category: Editor
  8486. @e
  8487. reveal
  8488. Left Argument: group
  8489. Right Argument: unit
  8490. Description: "Reveals the unit to the group. It does not matter whether the group can know about the unit or not."
  8491. Example: soldierOne reveal soldierTwo
  8492. Category: General
  8493. @e
  8494. revealMine
  8495. Left Argument: side
  8496. Right Argument: mine
  8497. Description: "Sets given mine as known to the side."
  8498. Category: General
  8499. @e
  8500. reverse
  8501. Left Argument: array
  8502. Description: "Reverse elements position in the array([0,1,2] -> [2,1,0])."
  8503. Example: reverse [0,1,2]
  8504. Category: Default
  8505. @e
  8506. reverse
  8507. Left Argument: array
  8508. Description: "Reverse elements position in the array([0,1,2] -> [2,1,0])."
  8509. Example: reverse [0,1,2]
  8510. Category: Default
  8511. @e
  8512. reversedMouseY
  8513. Description: "Return if mouse vertical axe is inverted."
  8514. Category: General
  8515. @e
  8516. roadsConnectedTo
  8517. Left Argument: road segment
  8518. Description: "Find the road segments connected to the given road segment."
  8519. Category: General
  8520. @e
  8521. ropeAttachedObjects
  8522. Left Argument: vehicle
  8523. Description: "Returns list of attached objects on ropes"
  8524. Example: ropeAttachedObjects obj
  8525. Category: General
  8526. @e
  8527. ropeAttachedTo
  8528. Left Argument: vehicle
  8529. Description: "Returns the object it is attached to by rope"
  8530. Example: ropeAttachedTo obj
  8531. Category: General
  8532. @e
  8533. ropeAttachEnabled
  8534. Left Argument: vehicle
  8535. Description: "Check if the vehicle can be attached to ropes"
  8536. Category: General
  8537. @e
  8538. ropeAttachTo
  8539. Left Argument: [vehicle, (toPoint), (ropeEndDownDir)]
  8540. Right Argument: rope
  8541. Description: "Attach vehicle to rope with optional offset"
  8542. Example: [veh, [0,0,0], [0,0,-1]] ropeAttachTo rope
  8543. Category: General
  8544. @e
  8545. ropeCreate
  8546. Left Argument: [fromObject, fromPoint, toObject, toPoint, (length), ([ropeStart, downDir]), ([ropeEnd, downDir])]
  8547. Description: "Create instance of rope object attached on vehicle"
  8548. 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]]]
  8549. Category: General
  8550. @e
  8551. ropeCut
  8552. Left Argument: [rope, distance]
  8553. Description: "Cut rope and detach rope from vehicle"
  8554. Example: ropeCut [rope, 5]
  8555. Category: General
  8556. @e
  8557. ropeDestroy
  8558. Left Argument: rope
  8559. Description: "Destroy rope and detach rope from vehicle"
  8560. Example: ropeDestroy rope
  8561. Category: General
  8562. @e
  8563. ropeDetach
  8564. Left Argument: vehicle
  8565. Right Argument: rope
  8566. Description: "Detach vehicle from rope"
  8567. Example: vehicle ropeDetachFrom rope
  8568. Category: General
  8569. @e
  8570. ropeEndPosition
  8571. Left Argument: rope
  8572. Description: "Return rope end positions"
  8573. Example: [start position, end position] ropeEndPosition ropeObj
  8574. Category: General
  8575. @e
  8576. ropeLength
  8577. Left Argument: rope
  8578. Description: "Return rope length (set by ropeCreate, ropeCut, ropeUnwind)"
  8579. Example: ropeLength rope
  8580. Category: General
  8581. @e
  8582. ropes
  8583. Left Argument: vehicle
  8584. Description: "Return vehicle ropes"
  8585. Example: ropes vehicle player
  8586. Category: General
  8587. @e
  8588. ropeUnwind
  8589. Left Argument: [rope, speed, targetLength, (relative)]
  8590. Description: "Unwind rope to target length. Use relative parameter for change rope length +/- from current length"
  8591. Example: ropeUnwind [rope, 3, 10]
  8592. Category: General
  8593. @e
  8594. ropeUnwound
  8595. Left Argument: rope
  8596. Description: "False if unwiding in progress, otherwise true"
  8597. Example: ropeUnwound rope
  8598. Category: General
  8599. @e
  8600. rotorsForcesRTD
  8601. Left Argument: RTD_helicopter
  8602. Description: "Returns force produced by rotors."
  8603. Category: General
  8604. @e
  8605. rotorsRpmRTD
  8606. Left Argument: RTD_helicopter
  8607. Description: "Returns rotors RPM."
  8608. Category: General
  8609. @e
  8610. round
  8611. Left Argument: x
  8612. Description: "The round value of x."
  8613. Example: round -5.25
  8614. Example Return: -5
  8615. Category: Default
  8616. @e
  8617. round
  8618. Left Argument: x
  8619. Description: "The round value of x."
  8620. Example: round -5.25
  8621. Example Return: -5
  8622. Category: Default
  8623. @e
  8624. runInitScript
  8625. Description: "Launch init.sqs script."
  8626. Category: General
  8627. @e
  8628. safeZoneH
  8629. Category: General
  8630. @e
  8631. safeZoneW
  8632. Category: General
  8633. @e
  8634. safeZoneWAbs
  8635. Category: General
  8636. @e
  8637. safeZoneX
  8638. Category: General
  8639. @e
  8640. safeZoneXAbs
  8641. Category: General
  8642. @e
  8643. safeZoneY
  8644. Category: General
  8645. @e
  8646. saveGame
  8647. Description: "Creates an autosave game (used for Retry)."
  8648. Category: General
  8649. @e
  8650. saveIdentity
  8651. Left Argument: person
  8652. Right Argument: name
  8653. Description: "Saves person's identity to objects.sav file in campaign directory as entry name."
  8654. Example: player saveIdentity "playerIdentity"
  8655. Category: General
  8656. @e
  8657. saveJoysticks
  8658. Description: "Saves joysticks key mappings into the joysticks.cfg file. Engine add these joysticks to the Joystick Scheme mapping dialog in options controls section."
  8659. Category: General
  8660. @e
  8661. saveOverlay
  8662. Left Argument: map
  8663. Description: "Save the current overlay."
  8664. Example: saveOverlay _map
  8665. Category: Editor
  8666. @e
  8667. saveProfileNamespace
  8668. Description: "Saves the variables stored in profileNamespace to user profile."
  8669. Category: General
  8670. @e
  8671. saveStatus
  8672. Left Argument: object
  8673. Right Argument: name
  8674. Description: "Saves object's properties to objects.sav file in campaign directory as entry name."
  8675. Example: player saveStatus "playerState"
  8676. Category: General
  8677. @e
  8678. saveVar
  8679. Left Argument: varName
  8680. Description: "Saves the variable value into the global campaign space. The variable is then available to all following missions in the campaign."
  8681. Example: saveVar "varOne"
  8682. Category: General
  8683. @e
  8684. savingEnabled
  8685. Description: "Check if saving the game is enabled."
  8686. Category: General
  8687. @e
  8688. say
  8689. Left Argument: unit or [unit, target]
  8690. Right Argument: speechName
  8691. Description: "The unit will play the given sound. If the unit is a person, it will also pefrorm the corresponding lipsync effect. The sound is defined in the description.ext file. If target is given, titles will be written to the conversation history."
  8692. Example: soldierOne say "speechId"
  8693. Category: General
  8694. @e
  8695. say2D
  8696. Left Argument: unit or [unit, target]
  8697. Right Argument: speechName
  8698. Description: "Functionally same as Say, only difference is sound played as 2D (mono) allways."
  8699. Example: soldierOne say "speechId"
  8700. Category: General
  8701. @e
  8702. say3D
  8703. Left Argument: unit or [unit, target]
  8704. Right Argument: speechName
  8705. Description: "Functionally same as Say, only difference is sound played as 3D allways."
  8706. Example: soldierOne say "speechId"
  8707. Category: General
  8708. @e
  8709. scopeName
  8710. Left Argument: name
  8711. Description: "defines name of current scope. Name is visible in debugger, and name is also used as reference in some commands. Scope name can be defined only once per scope."
  8712. Category: Default
  8713. @e
  8714. scopeName
  8715. Left Argument: name
  8716. Description: "defines name of current scope. Name is visible in debugger, and name is also used as reference in some commands. Scope name can be defined only once per scope."
  8717. Category: Default
  8718. @e
  8719. score
  8720. Left Argument: unit
  8721. Description: "MP: returns the unit's score."
  8722. Example: score unitOne
  8723. Category: General
  8724. @e
  8725. scoreSide
  8726. Left Argument: side
  8727. Description: "MP: returns side score."
  8728. Example: score west
  8729. Category: General
  8730. @e
  8731. screenToWorld
  8732. Left Argument: position
  8733. Description: "Returns the position on landscape (in world coordinates) corresponding to the given point on screen (in UI coordinates)."
  8734. Category: General
  8735. @e
  8736. scriptDone
  8737. Left Argument: script
  8738. Description: "Check if script is already finished"
  8739. Category: General
  8740. @e
  8741. scriptName
  8742. Left Argument: name
  8743. Description: "Assign a friendly name to the VM script thjis command is executed from."
  8744. Example: scriptName "Trading"
  8745. Category: Default
  8746. @e
  8747. scriptName
  8748. Left Argument: name
  8749. Description: "Assign a friendly name to the VM script thjis command is executed from."
  8750. Example: scriptName "Trading"
  8751. Category: Default
  8752. @e
  8753. scriptNull
  8754. Description: "A non-existing script. This value is not equal to anything, including itself."
  8755. Example: script == scriptNull
  8756. Example Return: false
  8757. Category: General
  8758. @e
  8759. scudState
  8760. Left Argument: scud
  8761. 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."
  8762. Example: scudState scudOne>=4
  8763. Category: General
  8764. @e
  8765. secondaryWeapon
  8766. Left Argument: vehicle
  8767. Description: "Returns the name of a vehicle's secondary weapon (an empty string if there is none)."
  8768. Example: secondaryWeapon player
  8769. Category: General
  8770. @e
  8771. secondaryWeaponItems
  8772. Left Argument: unit
  8773. Description: "Get array with all items assigned to a weapon."
  8774. Category: General
  8775. @e
  8776. secondaryWeaponMagazine
  8777. Left Argument: vehicle
  8778. Description: "Return the names of the types of currently loaded magazines in given weapon."
  8779. Category: General
  8780. @e
  8781. select
  8782. Left Argument: array
  8783. Right Argument: index
  8784. Description: "Selects index element of the array. Index 0 denotes the first element, 1 the second, etc."
  8785. Example: [1, 2, 3] select 1
  8786. Example Return: 2
  8787. Category: Default
  8788. @e
  8789. select
  8790. Left Argument: array
  8791. Right Argument: index
  8792. Description: "Selects index element of the array. Index 0 denotes the first element, 1 the second, etc."
  8793. Example: [1, 2, 3] select 1
  8794. Example Return: 2
  8795. Category: Default
  8796. @e
  8797. selectBestPlaces
  8798. Left Argument: [_position, _radius, _expression, _precision, _sourcesCount]
  8799. Description: "Find the places with the max. value of _expression in the given area."
  8800. Category: General
  8801. @e
  8802. selectDiarySubject
  8803. Left Argument: person
  8804. Right Argument: subject
  8805. Description: "Select the subject page in a log."
  8806. Category: Identity
  8807. @e
  8808. selectedEditorObjects
  8809. Left Argument: map
  8810. Description: "Returns a list of currently selected editor objects."
  8811. Category: Editor
  8812. @e
  8813. selectEditorObject
  8814. Left Argument: map
  8815. Right Argument: object
  8816. Description: "Select an editor object. Does not un-select previously selected objects."
  8817. Category: Editor
  8818. @e
  8819. selectionPosition
  8820. Left Argument: object
  8821. Right Argument: selection name
  8822. Description: "Search for selection in the object model (first in the memory level, then in other levels). Returns position in model space."
  8823. Category: General
  8824. @e
  8825. selectLeader
  8826. Left Argument: group
  8827. Right Argument: unit
  8828. Description: "Select group leader."
  8829. Example: group player selectLeader player
  8830. Category: General
  8831. @e
  8832. selectNoPlayer
  8833. Description: "Switch player to no unit."
  8834. Category: General
  8835. @e
  8836. selectPlayer
  8837. Left Argument: unit
  8838. Description: "Switch player to given unit."
  8839. Example: selectPlayer aP
  8840. Category: General
  8841. @e
  8842. selectWeapon
  8843. Left Argument: unit
  8844. Right Argument: weapon
  8845. Description: "Selects the given weapon.
  8846. For weapon values see <cl>CfgWeapons</cl>."
  8847. Example: soldierOne selectWeapon "LAWLauncher"
  8848. Category: General
  8849. @e
  8850. selectWeaponTurret
  8851. Left Argument: vehicle
  8852. Right Argument: [weapon, turret path]
  8853. Description: "Selects the given weapon on specified turret"
  8854. Example: tank selectWeaponTurret ["LAWLauncher", [0]]
  8855. Category: General
  8856. @e
  8857. sendAUMessage
  8858. Left Argument: [count|[clientList], "command"]
  8859. Description: "Send the command to the list of clients or some count of clients."
  8860. Example: SendAUMessage [[dpnid1, dpnid2], "ConnectTo: 192.168.1.66"]
  8861. Category: General
  8862. @e
  8863. sendSimpleCommand
  8864. Left Argument: object
  8865. Right Argument: command
  8866. Description: "Sends a simple command to the vehicle's driver / gunner."
  8867. Example: vehicle player sendSimpleCommand "STOP"
  8868. Category: General
  8869. @e
  8870. sendTask
  8871. Left Argument: sender
  8872. Right Argument: [receiver, [type] or [type, parentTask], priority, name1, value1, name2, value2, ...]
  8873. Description: "Create a new AI task (subtask of parentTask). Type is name of registered task type."
  8874. Category: Identity
  8875. @e
  8876. sendTaskResult
  8877. Left Argument: task
  8878. Right Argument: [state, result, sentence]
  8879. Description: "Send a result of the task to the task sender."
  8880. Category: Identity
  8881. @e
  8882. sendUDPMessage
  8883. Left Argument: [ip,port,"message"]
  8884. Description: "Send message to given adress using UDP protocol."
  8885. Category: General
  8886. @e
  8887. serverCommand
  8888. Left Argument: server command
  8889. Description: "Process the specified server command.
  8890. The Server command string is identical to that used in chat line in MP.
  8891. This command needs to be executed from UI handler to succeed."
  8892. Example: serverCommand "#kick friendlykiller"
  8893. Category: General
  8894. @e
  8895. serverCommandAvailable
  8896. Left Argument: server command
  8897. Description: "Checks whether current user is able to process the specified server command. See also <f>serverCommand</f>"
  8898. Example: serverCommandAvailable "#kick"
  8899. Category: General
  8900. @e
  8901. serverCommandExecutable
  8902. Left Argument: server command
  8903. Description: "Checks whether current user is able to execute the specified server command.
  8904. This command needs to be executed from UI handler to succeed and mirrors serverCommand behavior. See also <f>serverCommand</f>"
  8905. Example: serverCommandExecutable "#kick"
  8906. Category: General
  8907. @e
  8908. serverTime
  8909. Description: "Server time synchronized to clients."
  8910. Category: General
  8911. @e
  8912. set
  8913. Left Argument: array
  8914. Right Argument: element
  8915. Description: "Format of element is [index, value].
  8916. Changes an element of the given array. If the element does not exist, index+1 is called to create it."
  8917. Example: array set [0, "Hello"]
  8918. Category: Default
  8919. @e
  8920. set
  8921. Left Argument: array
  8922. Right Argument: element
  8923. Description: "Format of element is [index, value].
  8924. Changes an element of the given array. If the element does not exist, index+1 is called to create it."
  8925. Example: array set [0, "Hello"]
  8926. Category: Default
  8927. @e
  8928. setAccTime
  8929. Left Argument: accFactor
  8930. Description: "Sets the time acceleration coeficient. It can also be used to slow down time in cutscenes."
  8931. Example: setAccTime 0.1
  8932. Category: General
  8933. @e
  8934. setActualCollectiveRTD
  8935. Left Argument: RTD_helicopter
  8936. Right Argument: Set starting collective.
  8937. Description: "Set wanted RPM of given motor, use index -1 for all motors."
  8938. Category: General
  8939. @e
  8940. setAirportSide
  8941. Left Argument: airportId
  8942. Right Argument: side
  8943. Description: "Set owner of the airport"
  8944. Example: 0 setAirportSide east
  8945. Category: General
  8946. @e
  8947. setAmmo
  8948. Left Argument: unit
  8949. Right Argument: [weapon, count]
  8950. Description: "Set how many shots the unit has left for the loaded magazine in the given weapon type."
  8951. Example: player setAmmo ["M16",5]
  8952. Category: General
  8953. @e
  8954. setAmmoCargo
  8955. Left Argument: vehicle
  8956. Right Argument: ammoCargo
  8957. Description: "Sets the amount of ammo resources in the cargo space of a repair vehicle. Ammo resources are used to resupply vehicles; soldiers use individual magazines instead. An amount of one indicates a full cargo."
  8958. Example: rearmTruckOne setAmmoCargo 0
  8959. Category: General
  8960. @e
  8961. setAperture
  8962. Left Argument: set
  8963. Description: "Sets custom camera apreture (-1 to do it automatically)."
  8964. Category: General
  8965. @e
  8966. setApertureNew
  8967. Left Argument: [min, std, max, std lum]
  8968. Description: "Sets custom camera apreture (-1 to do it automatically)."
  8969. Category: General
  8970. @e
  8971. setArmoryPoints
  8972. Left Argument: points
  8973. Description: "Store the given amount of armory points."
  8974. Category: General
  8975. @e
  8976. setAttributes
  8977. Left Argument: text
  8978. Right Argument: [name1, value1, name2, value2, ...]
  8979. Description: "Returns a structured text created by the given structured or plain text by setting attributes to the given values."
  8980. Example: txt = img setAttributes ["image", "data\iSoldier.paa"]
  8981. Category: General
  8982. @e
  8983. setAutonomous
  8984. Left Argument: uav
  8985. Right Argument: autonomous
  8986. Description: "Set UAV autonomous mode."
  8987. Example: uav setAutonomous true
  8988. Category: General
  8989. @e
  8990. setBehaviour
  8991. Left Argument: group
  8992. Right Argument: behaviour
  8993. Description: "Sets the group behaviour mode. Behaviour is one of: "CARELESS", "SAFE", "AWARE", "COMBAT" or "STEALTH"."
  8994. Example: groupOne setBehaviour "SAFE"
  8995. Category: General
  8996. @e
  8997. setBleedingRemaining
  8998. Left Argument: obj
  8999. Right Argument: time
  9000. Description: "Sets bleeding time remaining."
  9001. Example: player setBleedingRemaining 1.0
  9002. Category: General
  9003. @e
  9004. setBrakesRTD
  9005. Left Argument: RTD_helicopter
  9006. Right Argument: [value, index]
  9007. Description: "Set brakes. If value 1.0f, brakes are on, If value 0.0f, brakes are off. index = 1 - left; index = 2 - right; index = 3 - both sides"
  9008. Category: General
  9009. @e
  9010. setCameraInterest
  9011. Left Argument: entity
  9012. Right Argument: interest
  9013. Description: "Set camera interest for given entity."
  9014. Example: _soldier setCameraInterest 50
  9015. Category: General
  9016. @e
  9017. setCamShakeDefParams
  9018. Left Argument: [power, duration, maxDistance, frequency, minSpeed, minMass, caliberCoefHit, caliberCoefFire, vehicleCoef]
  9019. Description: "Sets camera shake default params."
  9020. Category: General
  9021. @e
  9022. setCamShakeParams
  9023. Left Argument: [posCoef, rotXCoef, rotYCoef, rotZCoef, interp]
  9024. Description: "Sets camera shake params."
  9025. Category: General
  9026. @e
  9027. setCamUseTi
  9028. Left Argument: bool
  9029. Right Argument: mode index
  9030. Description: "Activate camera thermal vision"
  9031. Category: General
  9032. @e
  9033. setCaptive
  9034. Left Argument: person
  9035. Right Argument: captive
  9036. Description: "Marks the unit as captive. If the unit is a vehicle, the vehicle commander is marked instead.
  9037. A captive is neutral to everyone.
  9038. Note: This function does not remove the unit's weapons."
  9039. Example: setCaptive player
  9040. Category: General
  9041. @e
  9042. setCenterOfMass
  9043. Left Argument: object
  9044. Right Argument: com or [com, time]; com: vector
  9045. Description: "Changes the center of mass of an object smoothly during the given time (in seconds). A time of zero means an immediate change."
  9046. Example: myObject setCenterOfMass [[0,-1,0],0.5]
  9047. Category: General
  9048. @e
  9049. setCollisionLight
  9050. Left Argument: vehicle
  9051. Right Argument: true/false
  9052. Description: "Sets vehicle collision lights(true-on, false-off)."
  9053. Example: vehicle player SetCollisionLight true
  9054. Category: General
  9055. @e
  9056. setCombatMode
  9057. Left Argument: group
  9058. Right Argument: mode
  9059. Description: "Sets the group's combat mode (engagement rules). Mode can be one of: "BLUE" (Never fire), "GREEN" (Hold fire - defend only), "WHITE" (Hold fire, engage at will), "YELLOW" (Fire at will) or "RED" (Fire at will, engage at will)."
  9060. Example: groupOne setCombatMode "BLUE"
  9061. Category: General
  9062. @e
  9063. setCompassOscillation
  9064. Left Argument: [angle, frequencyMin, frequencyMax]
  9065. Description: "Set Compass Oscilation."
  9066. Category: General
  9067. @e
  9068. setCuratorCameraAreaCeiling
  9069. Left Argument: curatorObj
  9070. Right Argument: height
  9071. Description: "Sets maximal height where curator can fly"
  9072. Category: General
  9073. @e
  9074. setCuratorCoef
  9075. Left Argument: curatorObj
  9076. Right Argument: [action, coefficient/enabled?]
  9077. Description: "Sets coef for some action (coef have to be bigger than -1 000 000 anything lower is considered as disabled action)"
  9078. Example: 0 setCuratorCoef [0, 1] or 0 setCuratorCoef [0, false]
  9079. Category: General
  9080. @e
  9081. setCuratorEditingAreaType
  9082. Left Argument: curatorObj
  9083. Right Argument: whitelist?
  9084. Description: "Set curator areas to act like whitelist(true)/blacklist(false)."
  9085. Example: curator setCuratorEditingAreaType true
  9086. Category: General
  9087. @e
  9088. setCuratorWaypointCost
  9089. Left Argument: curatorObj
  9090. Right Argument: price
  9091. Description: "Sets price for waypoint placement."
  9092. Example: 0 setCuratorWaypointCost 0.1
  9093. Category: General
  9094. @e
  9095. setCurrentTask
  9096. Left Argument: person
  9097. Right Argument: task
  9098. Description: "Set the task as a current task of the person."
  9099. Category: Identity
  9100. @e
  9101. setCurrentWaypoint
  9102. Left Argument: group
  9103. Right Argument: waypoint
  9104. Description: "Switch the group to process the given waypoint."
  9105. Category: General
  9106. @e
  9107. setCustomWeightRTD
  9108. Left Argument: RTD_helicopter
  9109. Right Argument: weight
  9110. Description: "Add weight to helicopter."
  9111. Category: General
  9112. @e
  9113. setDamage
  9114. Left Argument: object
  9115. Right Argument: damage
  9116. Description: "Damages / repairs the object. Damage 0 means the object is fully functional, damage 1 means it's completely destroyed / dead.
  9117. Note: this function is identical to <f>setDammage</f>. It was introduced to fix a spelling error in the original function name."
  9118. Example: player setdamage 1
  9119. Category: General
  9120. @e
  9121. setDammage
  9122. Left Argument: obj
  9123. Right Argument: dammage
  9124. Description: "Damages / repairs the object. Damage 0 means the object is fully functional, damage 1 means it's completely destroyed / dead."
  9125. Example: player setdammage 1
  9126. Category: General
  9127. @e
  9128. setDate
  9129. Left Argument: [year, month, day, hour, minute]
  9130. Description: "Sets the actual mission date and time."
  9131. Category: General
  9132. @e
  9133. setDebriefingText
  9134. Left Argument: endType
  9135. Right Argument: [title, description]
  9136. Description: "Sets debriefing text."
  9137. Example: "end1" setDebriefingText ["Title", "Description"]
  9138. Category: General
  9139. @e
  9140. setDefaultCamera
  9141. Left Argument: [ position, direction = [0,0,-1]]
  9142. Description: "Sets the position and direction for camera used after camera is set on no object (e.g. leaving a multiplayer game)."
  9143. Example: setDefaultCamera [ [ 5000,5000,200], [1,1,-1] ]
  9144. Category: General
  9145. @e
  9146. setDestination
  9147. Left Argument: object
  9148. Right Argument: [position, planningMode, forceReplan]
  9149. Description: "Set the destination for path planning of the pilot."
  9150. Category: General
  9151. @e
  9152. setDetailMapBlendPars
  9153. Left Argument: [fullDetail, noDetail]
  9154. Description: "Sets the detail texture map blend pars."
  9155. Example: setDetailMapBlendPars [20, 50]
  9156. Category: General
  9157. @e
  9158. setDir
  9159. Left Argument: obj
  9160. Right Argument: heading
  9161. Description: "Sets the object heading. The accepted heading range is from 0 to 360."
  9162. Example: player setDir 180
  9163. Category: General
  9164. @e
  9165. setDirection
  9166. Left Argument: location
  9167. Right Argument: direction
  9168. Description: "Set a new direction (angle) of given location."
  9169. Category: Location
  9170. @e
  9171. setDrawIcon
  9172. Left Argument: map
  9173. Right Argument: [object, texture, color, offset, width, height, maintain size?, angle, string identifier, shadow, is3D, draw line?, priority]
  9174. Description: "Set the icon to be shown in 2D editor for the specified editor object. If maintain size is false, icon will not scale depending on the scale of the map. If maintain size is a number, the icon will maintain size if map scale is below that number. is3D, show line and priority are optional."
  9175. Category: Editor
  9176. @e
  9177. setDropInterval
  9178. Left Argument: particleSource
  9179. Right Argument: interval
  9180. Description: "Set interval of emitting particles from particle source."
  9181. Example: _source setDropInterval 0.05
  9182. Category: General
  9183. @e
  9184. setEditorMode
  9185. Left Argument: map
  9186. Right Argument: mode
  9187. Description: "Sets map mode to MAP, 3D or PREVIEW."
  9188. Category: Editor
  9189. @e
  9190. setEditorObjectScope
  9191. Left Argument: map
  9192. Right Argument: [objects,editor type,condition,scope,subordinates also]
  9193. Description: "This command defines the level of access a user has to editor objects. objects is an array of either Editor Objects (eg [_unit_0]) or actual Game Objects (eg [player]). If the array is empty then the command will automatically parse all editor objects. editor type is the editor type to effect (eg unit), or for none. condition is an executable string that must evaluate to true or false. If true, the scope of the evaluated editor object will be modified. scope is one of HIDE, VIEW, SELECT, LINKTO, LINKFROM, ALLNODRAG, ALLNOTREE or ALL. subordinates also is a boolean value, if true then subordinates in the editor will be assigned the same scope as the parent."
  9194. Example: _map setEditorObjectScope [[],vehicle,side effectiveCommander _x != side player,HIDE,false];
  9195. Category: Editor
  9196. @e
  9197. setEffectCondition
  9198. Left Argument: trigger or waypoint
  9199. Right Argument: statement
  9200. Description: "The statement is executed when the trigger or waypoint is activated and the effects are launched depending on the result. If the result is a boolean and true, the effect was launched. If the result is an object, the effect was launched if the result is the player or the player vehicle. If the result is an array, the effect was launched if the result contains the player or the player vehicle."
  9201. Example: trigger setEffectCondition "thisList"
  9202. Category: General
  9203. @e
  9204. setEngineRpmRTD
  9205. Left Argument: RTD_helicopter
  9206. Right Argument: [value, motor index]
  9207. Description: "Set engines rpm. Index = -1 for all."
  9208. Category: General
  9209. @e
  9210. setFace
  9211. Left Argument: person
  9212. Right Argument: soldier
  9213. Description: "Sets the person's face."
  9214. Example: setFace "Face10"
  9215. Category: General
  9216. @e
  9217. setFaceanimation
  9218. Left Argument: person
  9219. Right Argument: blink
  9220. Description: "Sets the facial animation phase (eye blinking). Blink is in the range from 0 to 1."
  9221. Example: setFaceAnimation 0.5
  9222. Category: General
  9223. @e
  9224. setFatigue
  9225. Left Argument: unit
  9226. Right Argument: value
  9227. Description: "Sets the person's fatigue."
  9228. Example: player setFatigue 0.5
  9229. Category: General
  9230. @e
  9231. setFlagOwner
  9232. Left Argument: flag
  9233. Right Argument: owner
  9234. Description: "Sets the flag owner. When the owner is set to objNull, the flag is returned to the flagpole."
  9235. Example: setFlagOwner objNull
  9236. Category: General
  9237. @e
  9238. setFlagSide
  9239. Left Argument: flag
  9240. Right Argument: side
  9241. Description: "Sets the flag side."
  9242. Example: setFlagSide east
  9243. Category: General
  9244. @e
  9245. setFlagTexture
  9246. Left Argument: flag
  9247. Right Argument: texture
  9248. Description: "Sets the flag texture. If the texture is "", the flag is not drawn."
  9249. Example: setFlagTexture "usa_vlajka.pac"
  9250. Category: General
  9251. @e
  9252. setFog
  9253. Left Argument: time
  9254. Right Argument: fog
  9255. Description: "Changes the fog value smoothly during the given time (in seconds). A time of zero means there will be an immediate change. Fog can be either a single value indicating fog density or an array [fog, decay, base]: fog - indicates fog density, 0 - no fog, 1 - maximum fog; decay - indicates density falloff with altitude; base - indicates altitude at which fog will have its nominal density."
  9256. Example: 1800 setFog 0.5
  9257. Category: General
  9258. @e
  9259. setForceGeneratorRTD
  9260. Category: General
  9261. @e
  9262. setFormation
  9263. Left Argument: group
  9264. Right Argument: formation
  9265. Description: "Sets the group formation. Formation is one of: "COLUMN", "STAG COLUMN", "WEDGE", "ECH LEFT", "ECH RIGHT", "VEE" or "LINE"."
  9266. Example: groupOne setFormation "LINE"
  9267. Category: General
  9268. @e
  9269. setFormationTask
  9270. Left Argument: object
  9271. Right Argument: task
  9272. Description: "Set the current task of the formation member."
  9273. Category: General
  9274. @e
  9275. setFormDir
  9276. Left Argument: group
  9277. Right Argument: heading
  9278. Description: "Sets the formation heading. The accepted heading range is from 0 to 360. The formation is facing this direction unless an enemy is seen. When the group is moving, this value is overridden by the movement direction."
  9279. Example: player setformdir 180
  9280. Category: General
  9281. @e
  9282. setFriend
  9283. Left Argument: side1
  9284. Right Argument: [side2, value]
  9285. Description: "Sets how friendly side1 is with side2. For a value smaller than 0.6 it results in being enemy, otherwise it's friendly."
  9286. Category: General
  9287. @e
  9288. setFromEditor
  9289. Left Argument: teamMember
  9290. Right Argument: fromEditor
  9291. Description: "Set if given team member was inserted directly from editor."
  9292. Example: _teamMember setFromEditor true
  9293. Category: Agents
  9294. @e
  9295. setFSMVariable
  9296. Left Argument: FSM handle
  9297. Right Argument: [name, value]
  9298. Description: "Set variable to given value in the variable space of given FSM. The FSM handle is the number returned by the execFSM command."
  9299. Category: General
  9300. @e
  9301. setFuel
  9302. Left Argument: vehicle
  9303. Right Argument: amount
  9304. Description: "Sets the fuel amount. A fuel level of one is a full gas tank."
  9305. Example: jeepOne setFuel 0
  9306. Category: General
  9307. @e
  9308. setFuelCargo
  9309. Left Argument: vehicle
  9310. Right Argument: amount
  9311. Description: "Sets the fuel amount in the cargo space of a refuelling vehicle. A fuel level of one is a full gas tank."
  9312. Example: refuelTruckOne setFuelCargo 0
  9313. Category: General
  9314. @e
  9315. setGroupIcon
  9316. Left Argument: group
  9317. Right Argument: properties
  9318. Description: "Set group icons properties."
  9319. Example: setGroupIcon[id,"b_inf",[offsetX,ofsetY]]
  9320. Category: General
  9321. @e
  9322. setGroupIconParams
  9323. Left Argument: group
  9324. Right Argument: properties
  9325. Description: "Set group icons parameters. [color,string,float,bool]"
  9326. Example: group setGroupIconParams [[1,1,1,1],"text",scale,show]
  9327. Category: General
  9328. @e
  9329. setGroupIconsSelectable
  9330. Left Argument: bool
  9331. Description: "Sets if group icons raises onclick and onover events."
  9332. Example: selectableGroupIcons true
  9333. Category: General
  9334. @e
  9335. setGroupIconsVisible
  9336. Left Argument: array
  9337. Description: "Sets if group icons are visible."
  9338. Example: showGroupIcons [true,true]
  9339. Category: General
  9340. @e
  9341. setGroupid
  9342. Left Argument: group
  9343. Right Argument: [nameFomat, nameParam1, ...]
  9344. Description: "Sets the group identity. nameFormat contains strings "%CLASS_NAME" where CLASS_NAME is name of class in CfgWorlds, parameters are names of subclasses of CLASS_NAME with the description of the name subpart."
  9345. Category: General
  9346. @e
  9347. setGroupOwner
  9348. Left Argument: group
  9349. Right Argument: clientId
  9350. Description: "Changes the ownership of a group to a given client. Group leader can't be a player. Only works when called from a server. Returns true if locality was changed."
  9351. Category: General
  9352. @e
  9353. setGusts
  9354. Left Argument: time
  9355. Right Argument: gusts
  9356. Description: "Changes the gusts value smoothly during the given time (in seconds). A time of zero means there will be an immediate change."
  9357. Example: 1800 setGusts 0.5
  9358. Category: General
  9359. @e
  9360. setHideBehind
  9361. Left Argument: object
  9362. Right Argument: [objectWhereHide, hidePosition]
  9363. Description: "It sets the data for hiding. ObjectWhereHide can be taken using findCover. HidePosition can be taken using getHideFrom."
  9364. Category: General
  9365. @e
  9366. setHit
  9367. Left Argument: object
  9368. Right Argument: [part, damage]
  9369. Description: "Damage / repair part of object. Damage 0 means fully functional, damage 1 means completely destroyed / dead."
  9370. Example: vehicle player setHit ["engine", 1]
  9371. Category: General
  9372. @e
  9373. setHitPointDamage
  9374. Left Argument: object
  9375. Right Argument: [part, damage]
  9376. Description: "Damage / repair part of object. Damage 0 means fully functional, damage 1 means completely destroyed / dead. Use name of hit point."
  9377. Example: vehicle player setHit ["engine", 1]
  9378. Category: General
  9379. @e
  9380. setHorizonParallaxCoef
  9381. Left Argument: coef
  9382. Description: "Sets coef used to shift horizon position based on camera height (use 0 to disable shifting)."
  9383. Category: General
  9384. @e
  9385. setHUDMovementLevels
  9386. Left Argument: [min speed, max speed, min alt, max alt, min dir, max dir, position[x,y,z] or target]
  9387. 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"
  9388. Example: SetHUDMovementLevels [20,30,-1,-1,0.23,2.1]
  9389. Category: General
  9390. @e
  9391. setIdentity
  9392. Left Argument: person
  9393. Right Argument: identity
  9394. Description: "Sets the identity of a person. Identities are defined in the descripion.ext file of the mission or campaign."
  9395. Example: setIdentity "JohnDoe"
  9396. Category: General
  9397. @e
  9398. setImportance
  9399. Left Argument: location
  9400. Right Argument: importance
  9401. Description: "Set a new importance of given location."
  9402. Category: Location
  9403. @e
  9404. setLeader
  9405. Left Argument: team
  9406. Right Argument: leader
  9407. Description: "Set the leader of given team."
  9408. Category: Agents
  9409. @e
  9410. setLightAmbient
  9411. Left Argument: light
  9412. Right Argument: [r, g, b]
  9413. Description: "Set ambient color of light."
  9414. Category: General
  9415. @e
  9416. setLightAttenuation
  9417. Left Argument: light
  9418. Right Argument: [startAttenuation, constantAttenuation, linearAttenuation, quadraticAttenuation, hardLimitStart, hardLimitEnd]
  9419. Description: "Set attenuation of light."
  9420. Category: General
  9421. @e
  9422. setLightBrightness
  9423. Left Argument: light
  9424. Right Argument: brightness
  9425. Description: "Set brightness of light."
  9426. Category: General
  9427. @e
  9428. setLightColor
  9429. Left Argument: light
  9430. Right Argument: [r, g, b]
  9431. Description: "Set diffuse color of light."
  9432. Category: General
  9433. @e
  9434. setLightDayLight
  9435. Left Argument: light
  9436. Right Argument: bool
  9437. Description: "Sets if light can be used during day."
  9438. Category: General
  9439. @e
  9440. setLightFlareMaxDistance
  9441. Left Argument: light
  9442. Right Argument: flareMaxDistance
  9443. Description: "Sets max distance where the flare is visible."
  9444. Category: General
  9445. @e
  9446. setLightFlareSize
  9447. Left Argument: light
  9448. Right Argument: flareSize
  9449. Description: "Sets relative size of the flare for the light."
  9450. Category: General
  9451. @e
  9452. setLightIntensity
  9453. Left Argument: light
  9454. Right Argument: intensity
  9455. Description: "Set intensity of light."
  9456. Category: General
  9457. @e
  9458. setLightnings
  9459. Left Argument: time
  9460. Right Argument: value
  9461. Description: "Changes the lightnings value smoothly during the given time (in seconds). A time of zero means there will be an immediate change."
  9462. Example: 1800 setLightnings 0.5
  9463. Category: General
  9464. @e
  9465. setLightUseFlare
  9466. Left Argument: light
  9467. Right Argument: useFlare
  9468. Description: "Sets if light should use flare."
  9469. Category: General
  9470. @e
  9471. setLocalWindParams
  9472. Left Argument: [strength, diameter]
  9473. Description: "Sets parameters for local wind emiters (like helicopters). Default [1.0, 1.0]"
  9474. Category: General
  9475. @e
  9476. setMagazineTurretAmmo
  9477. Left Argument: vehicle
  9478. Right Argument: [magazineClass, ammoCount, turretPath]
  9479. Description: "Sets ammo count to given amount for given turret."
  9480. Example: vehicle player ammoTurret ["cls", [0]]
  9481. Category: General
  9482. @e
  9483. setMarkerAlpha
  9484. Left Argument: marker
  9485. Right Argument: alpha
  9486. Description: "Sets the marker alpha. The marker is modified on all computers in a network session."
  9487. Example: "MarkerOne" setMarkerAlpha 0.5
  9488. Category: General
  9489. @e
  9490. setMarkerAlphaLocal
  9491. Left Argument: marker
  9492. Right Argument: alpha
  9493. Description: "Sets the marker alpha. The marker is only modified on the computer where the command is called."
  9494. Example: "MarkerOne" setMarkerAlpha 0.5
  9495. Category: General
  9496. @e
  9497. setMarkerBrush
  9498. Left Argument: name
  9499. Right Argument: brush
  9500. Description: "Selects the fill texture for the marker ("RECTANGLE" or "ELLIPSE"). Brush is the name of the subclass in CfgMarkerBrushes. The marker is modified on all computers in a network session."
  9501. Example: "Marker1" setMarkerBrush "DiagGrid"
  9502. Category: General
  9503. @e
  9504. setMarkerBrushLocal
  9505. Left Argument: name
  9506. Right Argument: brush
  9507. Description: "Selects the fill texture for the marker ("RECTANGLE" or "ELLIPSE"). Brush is the name of the subclass in CfgMarkerBrushes. The marker is only modified on the computer where the command is called."
  9508. Example: "Marker1" setMarkerBrushLocal "DiagGrid"
  9509. Category: General
  9510. @e
  9511. setMarkerColor
  9512. Left Argument: marker
  9513. Right Argument: color
  9514. Description: "Sets the marker color. Color is one of: "Default", "ColorBlack", "ColorRed", "ColorRedAlpha", "ColorGreen", "ColorGreenAlpha", "ColorBlue", "ColorYellow" or "ColorWhite". The marker is modified on all computers in a network session."
  9515. Example: "MarkerOne" setMarkerColor "ColorBlack"
  9516. Category: General
  9517. @e
  9518. setMarkerColorLocal
  9519. Left Argument: marker
  9520. Right Argument: color
  9521. Description: "Sets the marker color. Color is one of: "Default", "ColorBlack", "ColorRed", "ColorRedAlpha", "ColorGreen", "ColorGreenAlpha", "ColorBlue", "ColorYellow" or "ColorWhite". The marker is only modified on the computer where the command is called."
  9522. Example: "MarkerOne" setMarkerColorLocal "ColorBlack"
  9523. Category: General
  9524. @e
  9525. setMarkerDir
  9526. Left Argument: name
  9527. Right Argument: angle
  9528. Description: "Sets the orientation of the marker. Angle is in degrees. The marker is modified on all computers in a network session."
  9529. Example: "Marker1" setMarkerDir 90
  9530. Category: General
  9531. @e
  9532. setMarkerDirLocal
  9533. Left Argument: name
  9534. Right Argument: angle
  9535. Description: "Sets the orientation of the marker. Angle is in degrees. The marker is only modified on the computer where the command is called."
  9536. Example: "Marker1" setMarkerDirLocal 90
  9537. Category: General
  9538. @e
  9539. setMarkerPos
  9540. Left Argument: markerName
  9541. Right Argument: pos
  9542. Description: "Moves the marker. The format of pos is <ar>Position2D</ar>. The marker is modified on all computers in a network session."
  9543. Example: "MarkerOne" setMarkerPos getMarkerPos "MarkerTwo"
  9544. Category: General
  9545. @e
  9546. setMarkerPosLocal
  9547. Left Argument: markerName
  9548. Right Argument: pos
  9549. Description: "Moves the marker. The format of pos is <ar>Position2D</ar>. The marker is only modified on the computer where the command is called."
  9550. Example: "MarkerOne" setMarkerPosLocal getMarkerPos "MarkerTwo"
  9551. Category: General
  9552. @e
  9553. setMarkerShape
  9554. Left Argument: name
  9555. Right Argument: shape
  9556. Description: "Selects the shape (type) of the marker. Shape can be "ICON", "RECTANGLE" or "ELLIPSE". The marker is modified on all computers in a network session."
  9557. Example: "Marker1" setMarkerShape "RECTANGLE"
  9558. Category: General
  9559. @e
  9560. setMarkerShapeLocal
  9561. Left Argument: name
  9562. Right Argument: shape
  9563. Description: "Selects the shape (type) of the marker. Shape can be "ICON", "RECTANGLE" or "ELLIPSE". The marker is only modified on the computer where the command is called."
  9564. Example: "Marker1" setMarkerShapeLocal "RECTANGLE"
  9565. Category: General
  9566. @e
  9567. setMarkerSize
  9568. Left Argument: marker
  9569. Right Argument: size
  9570. Description: "Sets the marker size. Size is in format [a-axis, b-axis]. The marker is modified on all computers in a network session."
  9571. Example: "MarkerOne" setMarkerSize [100, 200]
  9572. Category: General
  9573. @e
  9574. setMarkerSizeLocal
  9575. Left Argument: marker
  9576. Right Argument: size
  9577. Description: "Sets the marker size. Size is in format [a-axis, b-axis]. The marker is only modified on the computer where the command is called."
  9578. Example: "MarkerOne" setMarkerSizeLocal [100, 200]
  9579. Category: General
  9580. @e
  9581. setMarkerText
  9582. Left Argument: name
  9583. Right Argument: text
  9584. Description: "Sets the text label of an existing marker. The marker is modified on all computers in a network session."
  9585. Example: "Marker1" setMarkerText You are here.
  9586. Category: General
  9587. @e
  9588. setMarkerTextLocal
  9589. Left Argument: name
  9590. Right Argument: text
  9591. Description: "Sets the text label of an existing marker. The marker is only modified on the computer where the command is called."
  9592. Example: "Marker1" setMarkerTextLocal You are here.
  9593. Category: General
  9594. @e
  9595. setMarkerType
  9596. Left Argument: markerName
  9597. Right Argument: markerType
  9598. Description: "Sets the marker type. Type may be any of: "Flag", "Flag1", "Dot", "Destroy", "Start", "End", "Warning", "Join", "Pickup", "Unknown", "Marker", "Arrow" or "Empty". The marker is modified on all computers in a network session."
  9599. Example: "MarkerOne" setMarkerType "Arrow"
  9600. Category: General
  9601. @e
  9602. setMarkerTypeLocal
  9603. Left Argument: markerName
  9604. Right Argument: markerType
  9605. Description: "Sets the marker type. Type may be any of: "Flag", "Flag1", "Dot", "Destroy", "Start", "End", "Warning", "Join", "Pickup", "Unknown", "Marker", "Arrow" or "Empty". The marker is only modified on the computer where the command is called."
  9606. Example: "MarkerOne" setMarkerTypeLocal "Arrow"
  9607. Category: General
  9608. @e
  9609. setMass
  9610. Left Argument: object
  9611. Right Argument: mass or [mass, time]
  9612. Description: "Changes the mass of an object smoothly during the given time (in seconds). A time of zero means an immediate change."
  9613. Example: myObject setMass [10,0.5]
  9614. Category: General
  9615. @e
  9616. setMimic
  9617. Left Argument: person
  9618. Right Argument: mimic
  9619. Description: "Sets a unit's mimic. The following values are recognized: "Default", "Normal", "Smile", "Hurt", "Ironic", "Sad", "Cynic", "Surprised", "Agresive" and "Angry"."
  9620. Example: setMimic "Angry"
  9621. Category: General
  9622. @e
  9623. setMousePosition
  9624. Left Argument: [x, y]
  9625. Description: "Move (UI) mouse pointer to specified position of the screen."
  9626. Example: setMousePosition [0.5, 0.5]
  9627. Category: General
  9628. @e
  9629. setMusicEffect
  9630. Left Argument: trigger or waypoint
  9631. Right Argument: track
  9632. Description: "Defines the music track played on activation. Track is a subclass name of CfgMusic. "$NONE$" (no change) or "$STOP$" (stops the current music track)."
  9633. Example: trigger setMusicEffect "Track1"
  9634. Category: General
  9635. @e
  9636. setMusicEventHandler
  9637. Left Argument: [type, function]
  9638. Description: "Sets given music track event handler."
  9639. Example: setMusicEventHandler ["MusicTerminate", ""]
  9640. Category: General
  9641. @e
  9642. setName
  9643. Left Argument: person
  9644. Right Argument: name
  9645. Description: "Sets the name of a person."
  9646. Example: setName "JohnDee"
  9647. Category: General
  9648. @e
  9649. setNameSound
  9650. Left Argument: person
  9651. Right Argument: nameSound
  9652. Description: "Sets the nameSound of a person."
  9653. Example: nameSound "JohnDeeSound"
  9654. Category: General
  9655. @e
  9656. setObjectArguments
  9657. Left Argument: map
  9658. Right Argument: [object, [name1, value1, ...]]
  9659. Description: "Set object arguments in mission editor."
  9660. Category: Editor
  9661. @e
  9662. setObjectMaterial
  9663. Left Argument: object
  9664. Right Argument: material
  9665. Category: General
  9666. @e
  9667. setObjectProxy
  9668. Left Argument: map
  9669. Right Argument: [object, proxy object]
  9670. Description: "Set the proxy object associated with the given editor object."
  9671. Category: Editor
  9672. @e
  9673. setObjectTexture
  9674. Left Argument: object
  9675. Right Argument: texture
  9676. Category: General
  9677. @e
  9678. setObjectTextureGlobal
  9679. Left Argument: obj
  9680. Right Argument: [selection,texture]
  9681. Description: "Set the texture of the given selection on all computers in a network session"
  9682. Example: player setObjectTextureGlobal [0,"\MyAddon\blue.pac"]
  9683. Category: General
  9684. @e
  9685. setObjectViewDistance
  9686. Left Argument: distance
  9687. Description: "Sets the rendering distance of objects."
  9688. Example: setobjectviewdistance 2000
  9689. Category: General
  9690. @e
  9691. setOvercast
  9692. Left Argument: time
  9693. Right Argument: overcast
  9694. Description: "Changes the overcast level to the given value smoothly during the given time (in seconds). A time of zero means an immediate change. An overcast level of zero means clear (sunny) weather and with an overcast level of one, storms and showers are very likely."
  9695. Example: 1800 setOvercast 0.5
  9696. Category: General
  9697. @e
  9698. setOwner
  9699. Left Argument: object
  9700. Right Argument: clientId
  9701. Description: "On server machine, change ownership of a non-AI object or an agent to a given client. Returns true if locality was changed."
  9702. Category: General
  9703. @e
  9704. setOxygenRemaining
  9705. Left Argument: unit
  9706. Right Argument: oxygen
  9707. Description: "Sets oxygen remaining. It has no effect when soldier is not diving."
  9708. Example: player setOxygenRemaining 0.5
  9709. Category: General
  9710. @e
  9711. setParticleCircle
  9712. Left Argument: particleSource
  9713. Right Argument: [radius, velocity]
  9714. Description: "Update particle source to create particles on circle with given radius. Velocity is transformed and added to total velocity."
  9715. Category: General
  9716. @e
  9717. setParticleClass
  9718. Left Argument: particleSource
  9719. Right Argument: className
  9720. Description: "Set parameters from config class. className is name of the class from CfgCloudlets."
  9721. Category: General
  9722. @e
  9723. setParticleFire
  9724. Left Argument: particleSource
  9725. Right Argument: [coreIntensity, coreDistance, damageTime]
  9726. Category: General
  9727. @e
  9728. setParticleParams
  9729. Left Argument: particleSource
  9730. Right Argument: array
  9731. Description: "Set parameters to particle source. Array is in format <ar>ParticleArray</ar>."
  9732. Category: General
  9733. @e
  9734. setParticleRandom
  9735. Left Argument: particleSource
  9736. Right Argument: [lifeTime, position, moveVelocity, rotationVelocity, size, color, randomDirectionPeriod, randomDirectionIntensity, {angle}]
  9737. Description: "Set randomization of particle source parameters."
  9738. Category: General
  9739. @e
  9740. setPilotLight
  9741. Left Argument: vehicle
  9742. Right Argument: true/false
  9743. Description: "Sets vehicle pilot lights(true-on, false-off)."
  9744. Example: vehicle player SetPilotLight true
  9745. Category: General
  9746. @e
  9747. setPiPEffect
  9748. Left Argument: pipTargetName
  9749. Right Argument: [effect, optionalParam1, ..., optionalParamN]
  9750. Description: "Set a Render Target's visual effect (Picture-in-Picture)."
  9751. Example: rendertarget0 setPiPEffect [0, 0, [], [], []]
  9752. Category: General
  9753. @e
  9754. setPitch
  9755. Left Argument: person
  9756. Right Argument: pitch
  9757. Description: "Sets the pitch of a persons voice."
  9758. Example: setName 1
  9759. Category: General
  9760. @e
  9761. setPlayable
  9762. Left Argument: unit
  9763. Description: "Create MP role for the unit."
  9764. Example: setPlayable aP
  9765. Category: General
  9766. @e
  9767. setPlayerRespawnTime
  9768. Left Argument: time interval
  9769. Description: "Set the time interval to wait on player respawn. It is set to mission default on mission start again."
  9770. Category: General
  9771. @e
  9772. setPos
  9773. Left Argument: obj
  9774. Right Argument: pos
  9775. Description: "Sets the object position. The pos array uses the <ar>Position</ar> format."
  9776. Example: player setPos [getpos player select 0, getpos player select 1 + 10]
  9777. Category: General
  9778. @e
  9779. setPosASL
  9780. Left Argument: obj
  9781. Right Argument: pos
  9782. Description: "Sets the object position. The pos array uses the <ar>PositionASL</ar> format."
  9783. Example: player setPosASL [getPosASL player select 0, getPosASL player select 1 + 10, getPosASL select 2]
  9784. Category: General
  9785. @e
  9786. setPosASL2
  9787. Left Argument: obj
  9788. Right Argument: pos
  9789. Description: "Sets the object position. The pos array uses the <ar>PositionASL</ar> format. The version of the command does not offset based on object center."
  9790. Category: General
  9791. @e
  9792. setPosASLW
  9793. Left Argument: obj
  9794. Right Argument: pos
  9795. Description: "Sets the object position above sea surface. The pos array uses the <ar>PositionASLW</ar> format."
  9796. Example: player setPosASLW [getPosASLW player select 0, getPosASLW player select 1 + 10, getPosASLW select 2]
  9797. Category: General
  9798. @e
  9799. setPosATL
  9800. Left Argument: obj
  9801. Right Argument: pos
  9802. Description: "Sets the object position. The pos array uses the <ar>PositionATL</ar> format."
  9803. Example: player setPosASL [getPosATL player select 0, getPosATL player select 1 + 10, getPosATL select 2]
  9804. Category: General
  9805. @e
  9806. setPosition
  9807. Left Argument: location
  9808. Right Argument: position
  9809. Description: "Set a new position of given location."
  9810. Category: Location
  9811. @e
  9812. setPosWorld
  9813. Left Argument: obj
  9814. Right Argument: pos
  9815. Description: "Sets the object position without any additional adjustations. The pos array uses the <ar>Position</ar> format."
  9816. Example: player setPosWorld [getposWorld player select 0, getposWorld player select 1 + 10]
  9817. Category: General
  9818. @e
  9819. setRadioMsg
  9820. Left Argument: index
  9821. Right Argument: text
  9822. Description: "Sets the radio message (0, 0, map radio) to the given text. Use "NULL" to disable the radio slot."
  9823. Example: 0 setRadioMsg "Alpha Radio"
  9824. Category: General
  9825. @e
  9826. setRain
  9827. Left Argument: time
  9828. Right Argument: rainDensity
  9829. Description: "Changes the rain density smoothly during the given time (in seconds). A time of zero means an immediate change. A rain level of zero is no rain and a rain level of one is maximum rain. Rain is not possible when overcast is smaller than 0.7."
  9830. Example: 60 setRain 1
  9831. Category: General
  9832. @e
  9833. setRainbow
  9834. Left Argument: time
  9835. Right Argument: rainbow
  9836. Description: "Changes the rainbow value smoothly during the given time (in seconds). A time of zero means there will be an immediate change."
  9837. Example: 1800 setWindStr 0.5
  9838. Category: General
  9839. @e
  9840. setRandomLip
  9841. Left Argument: person
  9842. Right Argument: bool
  9843. Description: "Enables/Disables random lip."
  9844. Category: General
  9845. @e
  9846. setRank
  9847. Left Argument: unit
  9848. Right Argument: rank
  9849. Description: "Sets rank of given unit. Possible values: PRIVATE, CORPORAL, SERGEANT, LIEUTENANT, CAPTAIN, MAJOR or COLONEL."
  9850. Example: player setRank "COLONEL"
  9851. Category: General
  9852. @e
  9853. setRectangular
  9854. Left Argument: location
  9855. Right Argument: rectangular
  9856. Description: "Set if given location has rectangular shape."
  9857. Category: Location
  9858. @e
  9859. setRepairCargo
  9860. Left Argument: vehicle
  9861. Right Argument: amount
  9862. Description: "Sets the amount or repair resources in the cargo space of a repair vehicle. An amount of one is a full cargo space."
  9863. Example: repairTruckOne setRepairCargo 0
  9864. Category: General
  9865. @e
  9866. setRotorBrakeRTD
  9867. Left Argument: RTD_helicopter
  9868. Category: General
  9869. @e
  9870. setShadowDistance
  9871. Left Argument: newDistance
  9872. Description: "Sets the shadows rendering distance."
  9873. Example: setShadowDistance 1000
  9874. Category: General
  9875. @e
  9876. setSide
  9877. Left Argument: location
  9878. Right Argument: side
  9879. Description: "Set a new target side of given location."
  9880. Category: Location
  9881. @e
  9882. setSimpleTaskDescription
  9883. Left Argument: task
  9884. Right Argument: [description, descriptionShort, descriptionHUD]
  9885. Description: "Attach descriptions to the simple task."
  9886. Category: Identity
  9887. @e
  9888. setSimpleTaskDestination
  9889. Left Argument: task
  9890. Right Argument: position
  9891. Description: "Attach a destination to the simple task. Overrides setSimpleTaskTarget."
  9892. Category: Identity
  9893. @e
  9894. setSimpleTaskTarget
  9895. Left Argument: task
  9896. Right Argument: [target,precise position]
  9897. Description: "Attach a target to the simple task. Overrides setSimpleTaskDestination."
  9898. Example: task setSimpleTaskTarget [vehicle, true]
  9899. Category: Identity
  9900. @e
  9901. setSimulWeatherLayers
  9902. Left Argument: layers
  9903. Description: "Sets simul weather layers"
  9904. Category: General
  9905. @e
  9906. setSize
  9907. Left Argument: location
  9908. Right Argument: [sizeX, sizeZ]
  9909. Description: "Set a new size (width, height) of given location."
  9910. Category: Location
  9911. @e
  9912. setSkill
  9913. Left Argument: vehicle
  9914. Right Argument: [type, skill]
  9915. Description: "Sets skill of given type of person (commander unit). Value of skill may vary from 0 to 1."
  9916. Example: hero setSkill ["Endurance", 1]
  9917. Category: General
  9918. @e
  9919. setSlingLoad
  9920. Left Argument: vehicle
  9921. Right Argument: cargo
  9922. Description: "Create sling loading from first object to second if possible"
  9923. Example: veh1 setSlingLoad veh2
  9924. Category: General
  9925. @e
  9926. setSoundEffect
  9927. Left Argument: trigger or waypoint
  9928. Right Argument: [sound, voice, soundEnv, soundDet]
  9929. Description: "Defines the different sound effects. Sound / voice plays a 2D / 3D sound from CfgSounds. SoundEnv plays an enviromental sound from CfgEnvSounds. SoundDet (only for triggers) creates a dynamic sound object attached to a trigger defined in CfgSFX."
  9930. Example: trigger setSoundEffect ["Alarm", "", "", ""]
  9931. Category: General
  9932. @e
  9933. setSpeaker
  9934. Left Argument: person
  9935. Right Argument: speaker
  9936. Description: "Sets the speaker of a person."
  9937. Example: setSpeaker "JohnDee"
  9938. Category: General
  9939. @e
  9940. setSpeech
  9941. Left Argument: location
  9942. Right Argument: speech
  9943. Description: "Add speech to location."
  9944. Category: Location
  9945. @e
  9946. setSpeedMode
  9947. Left Argument: group
  9948. Right Argument: mode
  9949. Description: "Sets the group speed mode. Mode may be one of: "LIMITED" (half speed), "NORMAL" (full speed, maintain formation) or "FULL" (do not wait for any other units in the formation)."
  9950. Example: groupOne setSpeedMode "LIMITED"
  9951. Category: General
  9952. @e
  9953. setStatValue
  9954. Left Argument: [statName, value]
  9955. Description: "Sets a value to given stat. "
  9956. Category: General
  9957. @e
  9958. setSystemOfUnits
  9959. Left Argument: value
  9960. Description: "Set system of units. 0 for metric, 1 for mixed, 2 for imperial."
  9961. Category: General
  9962. @e
  9963. setTargetAge
  9964. Left Argument: object
  9965. Right Argument: age
  9966. Description: "Sets how the target is known to the other centers. They behave like the target was seen age seconds ago. Possible age values are: "ACTUAL", "5 MIN", "10 MIN", "15 MIN", "30 MIN", "60 MIN", "120 MIN" or "UNKNOWN"."
  9967. Example: player setTargetAge "10 MIN"
  9968. Category: General
  9969. @e
  9970. setTaskResult
  9971. Left Argument: task
  9972. Right Argument: [state, result]
  9973. Description: "Set a result of the task."
  9974. Category: Identity
  9975. @e
  9976. setTaskState
  9977. Left Argument: task
  9978. Right Argument: state
  9979. Description: "Set a new state of the task."
  9980. Category: Identity
  9981. @e
  9982. setTerrainGrid
  9983. Left Argument: grid
  9984. 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."
  9985. Example: setTerrainGrid 12.5
  9986. Category: General
  9987. @e
  9988. setText
  9989. Left Argument: location
  9990. Right Argument: text
  9991. Description: "Set a new text attached to given location."
  9992. Category: Location
  9993. @e
  9994. setTimeMultiplier
  9995. Left Argument: multiplier
  9996. Description: "Time multiplier for in game time."
  9997. Example: setTimeMultiplier 60
  9998. Category: General
  9999. @e
  10000. setTitleEffect
  10001. Left Argument: trigger or waypoint
  10002. Right Argument: [type, effect, text]
  10003. Description: "Defines the title effect. Type can be "NONE", "OBJECT", "RES" or "TEXT". For "TEXT", the effect defines a subtype: "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" or "WHITE IN". Text is shown as text itself. For "OBJECT", text defines the shown object, a subclass of CfgTitles. For "RES", text defines a resource class, a subclass of RscTitles."
  10004. Example: trigger setTitleEffect ["TEXT", "PLAIN DOWN", "Hello world."]
  10005. Category: General
  10006. @e
  10007. setTrafficDensity
  10008. Left Argument: [density, xMin, xMax, zMin, zMax]
  10009. Description: "Set the density of ambient cars in a rectangle (in cars per kilometer)."
  10010. Category: General
  10011. @e
  10012. setTrafficDistance
  10013. Left Argument: distance
  10014. Description: "Set maximum ambient traffic draw distance (in 2D)."
  10015. Category: General
  10016. @e
  10017. setTrafficGap
  10018. Left Argument: [gap, xMin, xMax, zMin, zMax]
  10019. Description: "Set the average gap between ambient cars in a rectangle (in meters)."
  10020. Category: General
  10021. @e
  10022. setTrafficSpeed
  10023. Left Argument: [speed, xMin, xMax, zMin, zMax]
  10024. Description: "Set ambient traffic speed in a rectangle (in kilometers per hour)."
  10025. Category: General
  10026. @e
  10027. setTriggerActivation
  10028. Left Argument: trigger
  10029. Right Argument: [by, type, repeating]
  10030. Description: "Defines the trigger activation type. The first argument - who activates trigger (side, radio, vehicle or group member): "NONE", "EAST", "WEST", "GUER", "CIV", "LOGIC", "ANY", "ALPHA", "BRAVO", "CHARLIE", "DELTA", "ECHO", "FOXTROT", "GOLF", "HOTEL", "INDIA", "JULIET", "STATIC", "VEHICLE", "GROUP", "LEADER" or "MEMBER". The second argument - when is it activated (presention or detection by the specified side): "PRESENT", "NOT PRESENT", "WEST D", "EAST D", "GUER D" or "CIV D". The third argument - whether the activation is repeating."
  10031. Example: trigger setTriggerActivation ["WEST", "EAST D", true]
  10032. Category: General
  10033. @e
  10034. setTriggerArea
  10035. Left Argument: trigger
  10036. Right Argument: [a, b, angle, rectangle]
  10037. Description: "Defines the area controlled by the trigger. The area is rectangular or elliptic, the width is 2 * a, the height is 2 * b. It is rotated angle degrees."
  10038. Example: trigger setTriggerArea [100, 50, 45, false]
  10039. Category: General
  10040. @e
  10041. setTriggerStatements
  10042. Left Argument: trigger
  10043. Right Argument: [cond, activ, desactiv]
  10044. Description: "The first argument can modify the condition of when the trigger is activated. The result of the activation defined by trigger activation is in variable this. Variable thisList contains all vehicles which caused the activation. Activ and desactiv expressions are launched upon trigger activation / deactivation."
  10045. Example: trigger setTriggerStatements ["this", "ok = true", "ok = false"]
  10046. Category: General
  10047. @e
  10048. setTriggerText
  10049. Left Argument: trigger
  10050. Right Argument: text
  10051. Description: "Sets the text label attached to the trigger object. This is used for example as a radio slot label for radio activated triggers."
  10052. Example: trigger setTriggerText "Call for support"
  10053. Category: General
  10054. @e
  10055. setTriggerTimeout
  10056. Left Argument: trigger
  10057. Right Argument: [min, mid, max, interruptable]
  10058. Description: "Defines the time between condition satisfaction and trigger activation (randomly from min to max, with an average value mid). If the last argument is true, the condition must be fullfilled all the time."
  10059. Example: trigger setTriggerTimeout [5, 10, 7, false]
  10060. Category: General
  10061. @e
  10062. setTriggerType
  10063. Left Argument: trigger
  10064. Right Argument: action
  10065. Description: "Sets the type of action processed by the trigger after activation (no action, a waypoints switch or an end of mission): "NONE", "SWITCH", "END1", "END2", "END3", "END4", "END5", "END6", "LOOSE" or "WIN"."
  10066. Example: trigger setTriggerType "END1"
  10067. Category: General
  10068. @e
  10069. setType
  10070. Left Argument: location
  10071. Right Argument: type
  10072. Description: "Set a new type of given location."
  10073. Category: Location
  10074. @e
  10075. setUnconscious
  10076. Left Argument: unit
  10077. Right Argument: set
  10078. Description: "Set / reset the unconscious life state of the given unit (in MP works only for a local unit)."
  10079. Category: General
  10080. @e
  10081. setUnitAbility
  10082. Left Argument: unit
  10083. Right Argument: skill
  10084. Description: "Sets skill of given unit. Skill may vary from 0.2 to 1.0."
  10085. Example: player setUnitSkill 1.0
  10086. Category: General
  10087. @e
  10088. setUnitPos
  10089. Left Argument: unit
  10090. Right Argument: mode
  10091. Description: "Sets the unit position rules. Mode may be one of: "DOWN", "UP" or "AUTO"."
  10092. Example: soldierOne setUnitPos "Down"
  10093. Category: General
  10094. @e
  10095. setUnitPosWeak
  10096. Left Argument: unit
  10097. Right Argument: mode
  10098. Description: "Equal to setUnitPos, for usage in formation FSM (to avoid collision with setUnitPos used by the mission)."
  10099. Example: soldierOne setUnitPosWeak "Down"
  10100. Category: General
  10101. @e
  10102. setUnitRank
  10103. Left Argument: unit
  10104. Right Argument: rank
  10105. Description: "Sets rank of given unit. Possible values: PRIVATE, CORPORAL, SERGEANT, LIEUTENANT, CAPTAIN, MAJOR or COLONEL."
  10106. Example: player setUnitRank "COLONEL"
  10107. Category: General
  10108. @e
  10109. setUnitRecoilCoefficient
  10110. Left Argument: unit
  10111. Right Argument: coefficient
  10112. Description: "Proportionaly increase/decrease unit's recoil."
  10113. Example: soldier setUnitRecoilCoefficient 0.5
  10114. Category: General
  10115. @e
  10116. setUnloadInCombat
  10117. Left Argument: vehicle
  10118. Right Argument: [allowCargo, allowTurrets]
  10119. Description: "Check if cargo of this vehicle want to get out when in combat. Vehicle has to be local."
  10120. Example: vehicle setUnloadInCombat [true, false]
  10121. Category: General
  10122. @e
  10123. setUserActionText
  10124. Left Argument: unit
  10125. Right Argument: [action index, "text", "textDefault", "textToolTip"]
  10126. Description: "Change action texts."
  10127. Example: player VehSetUserActionText [0, "hello"]
  10128. Category: General
  10129. @e
  10130. setVariable
  10131. Left Argument: namespace
  10132. Right Argument: [name, value]
  10133. Description: "Set variable to given value in the given namespace."
  10134. Category: Default
  10135. @e
  10136. setVariable
  10137. Left Argument: namespace
  10138. Right Argument: [name, value]
  10139. Description: "Set variable to given value in the given namespace."
  10140. Category: Default
  10141. @e
  10142. setVectorDir
  10143. Left Argument: object
  10144. Right Argument: [x, z, y]
  10145. Description: "Set object's direction vector. Up vector will remain unchanged."
  10146. Category: General
  10147. @e
  10148. setVectorDirAndUp
  10149. Left Argument: object
  10150. Right Argument: [[x, z, y],[x, y, z]]
  10151. Description: "Set object's direction and up vector"
  10152. Category: General
  10153. @e
  10154. setVectorUp
  10155. Left Argument: object
  10156. Right Argument: [x, z, y]
  10157. Description: "Set object's up vector. Direction vector will remain unchanged."
  10158. Category: General
  10159. @e
  10160. setVehicleAmmo
  10161. Left Argument: object
  10162. Right Argument: value
  10163. Description: "Sets how much ammunition (compared to the current stored magazines, but fully loaded) the vehicle has. The value ranges from 0 to 1."
  10164. Example: player setVehicleAmmo 0
  10165. Category: General
  10166. @e
  10167. setVehicleAmmoDef
  10168. Left Argument: unit
  10169. Right Argument: value
  10170. Description: "Sets how much ammunition (compared to the current configuration of magazines, but fully loaded) the vehicle has. The value ranges from 0 to 1."
  10171. Example: player setVehicleAmmoDef 0
  10172. Category: General
  10173. @e
  10174. setVehicleArmor
  10175. Left Argument: object
  10176. Right Argument: value
  10177. Description: "Sets the armor (or health for men) state of the vehicle (a value from 0 to 1)."
  10178. Example: player setVehicleArmor 0.5
  10179. Category: General
  10180. @e
  10181. setVehicleId
  10182. Left Argument: object
  10183. Right Argument: id
  10184. Description: "Sets id (integer value) to vehicle. By this id vehicle is referenced by triggers and waypoints."
  10185. Example: player setVehicleId 1
  10186. Category: General
  10187. @e
  10188. setVehicleLock
  10189. Left Argument: vehicle
  10190. Right Argument: state
  10191. Description: "Set how vehicle is locked for player. Possible values: UNLOCKED, DEFAULT or LOCKED."
  10192. Example: veh1 setVehicleLock "LOCKED"
  10193. Category: General
  10194. @e
  10195. setVehiclePosition
  10196. Left Argument: object
  10197. Right Argument: [position, markers, placement]
  10198. Description: "Changes the object position. If the markers array contains more than one marker names, the position of a random one is used. Otherwise, the given position is used. The object is placed inside a circle with this position as its center and placement as its radius."
  10199. Example: player setVehiclePosition [[0, 0, 0], ["Marker1"], 0]
  10200. Category: General
  10201. @e
  10202. setVehicleTiPars
  10203. Left Argument: vehicle
  10204. Right Argument: tiParams
  10205. Description: "Set ti parameters for specified vehicle, pars: engine/body, tracks/wheels, main gun."
  10206. Category: General
  10207. @e
  10208. setVehicleVarName
  10209. Left Argument: object
  10210. Right Argument: name
  10211. Description: "Sets the name of the variable which contains a reference to this object. It is necessary in MP to change the variable content after a respawn."
  10212. Example: player setVehicleVarName "aP"
  10213. Category: General
  10214. @e
  10215. setVelocity
  10216. Left Argument: vehicle
  10217. Right Argument: [x, z, y]
  10218. Description: "Sets the velocity (speed vector) of a vehicle."
  10219. Category: General
  10220. @e
  10221. setVelocityTransformation
  10222. Left Argument: soldier
  10223. Right Argument: [position1, position2, velocity1, velocity2, direction1, direction2, up1, up2, time]
  10224. Description: "interpolates and sets vectors. Time has to be from &lt;0,1&gt;."
  10225. Category: General
  10226. @e
  10227. setViewDistance
  10228. Left Argument: distance
  10229. Description: "Sets the rendering distance. Default is 900 meters. The accepted range is from 500 to 5000 meters."
  10230. Example: setviewdistance 2000
  10231. Category: General
  10232. @e
  10233. setVisibleIfTreeCollapsed
  10234. Left Argument: map
  10235. Right Argument: [object, visible if tree collapsed]
  10236. Description: "Sets whether or not the object is visible even if the tree is collapsed."
  10237. Category: Editor
  10238. @e
  10239. setWantedRPMRTD
  10240. Left Argument: RTD_helicopter
  10241. Right Argument: [value <0,1>, time to reach, motor index]
  10242. Description: "Set wanted RPM of given motor, use index -1 for all motors."
  10243. Category: General
  10244. @e
  10245. setWaves
  10246. Left Argument: time
  10247. Right Argument: waves
  10248. Description: "Changes the waves value smoothly during the given time (in seconds). A time of zero means there will be an immediate change."
  10249. Example: 1800 setWaves 0.5
  10250. Category: General
  10251. @e
  10252. setWaypointBehaviour
  10253. Left Argument: waypoint
  10254. Right Argument: mode
  10255. Description: "Switches the unit behaviour when the waypoint becomes active. Possible values are: "UNCHANGED", "CARELESS", "SAFE", "AWARE", "COMBAT" and "STEALTH"."
  10256. Example: [grp, 2] setWaypointBehaviour "AWARE"
  10257. Category: General
  10258. @e
  10259. setWaypointCombatMode
  10260. Left Argument: waypoint
  10261. Right Argument: mode
  10262. Description: "The group combat mode is switched when the waypoint becomes active. Possible values are: "NO CHANGE", "BLUE", "GREEN", "WHITE", "YELLOW" and "RED"."
  10263. Example: [grp, 2] setWaypointCombatMode "RED"
  10264. Category: General
  10265. @e
  10266. setWaypointCompletionRadius
  10267. Left Argument: waypoint
  10268. Right Argument: radius
  10269. Description: "Set the radius around the waypoint where is the waypoint completed."
  10270. Example: [grp, 2] setWaypointCompletionRadius 30
  10271. Category: General
  10272. @e
  10273. setWaypointDescription
  10274. Left Argument: waypoint
  10275. Right Argument: text
  10276. Description: "Sets the description shown in the HUD while the waypoint is active."
  10277. Example: [grp, 2] setWaypointDescription "Move here."
  10278. Category: General
  10279. @e
  10280. setWaypointFormation
  10281. Left Argument: waypoint
  10282. Right Argument: formation
  10283. Description: "Switches the group formation when the waypoint becomes active. Possible values are: "NO CHANGE", "COLUMN", "STAG COLUMN", "WEDGE", "ECH LEFT", "ECH RIGHT", "VEE" and "LINE"."
  10284. Example: [grp, 2] setWaypointFormation "LINE"
  10285. Category: General
  10286. @e
  10287. setWaypointHousePosition
  10288. Left Argument: waypoint
  10289. Right Argument: pos
  10290. Description: "For waypoints attached to a house, this defines the target house position."
  10291. Example: [grp, 2] setWaypointHousePosition 1
  10292. Category: General
  10293. @e
  10294. setWaypointLoiterRadius
  10295. Left Argument: waypoint
  10296. Right Argument: loiter radius
  10297. Description: "Assignes loiter radius to waypoint"
  10298. Example: [_grp, 2] setWaypointLoiterRadius 200
  10299. Category: General
  10300. @e
  10301. setWaypointLoiterType
  10302. Left Argument: waypoint
  10303. Right Argument: loiter type
  10304. Description: "Assignes loiter type to waypoint"
  10305. Example: [_grp, 2] setWaypointLoiterType "CIRCLE"
  10306. Category: General
  10307. @e
  10308. setWaypointName
  10309. Left Argument: waypoint
  10310. Right Argument: name
  10311. Description: "Changes the waypoint name."
  10312. Example: [grp, 2] WaypointSetName "someName"
  10313. Category: General
  10314. @e
  10315. setWaypointPosition
  10316. Left Argument: waypoint
  10317. Right Argument: [center, radius]
  10318. Description: "Moves the waypoint to a random position in a circle with the given center and radius."
  10319. Example: [grp, 2] setWaypointPosition [position player, 0]
  10320. Category: General
  10321. @e
  10322. setWaypointScript
  10323. Left Argument: waypoint
  10324. Right Argument: command
  10325. Description: "Attaches a script to a scripted waypoint. Command consist of a script name and additional script arguments."
  10326. Example: [grp, 2] setWaypointScript "find.sqs player"
  10327. Category: General
  10328. @e
  10329. setWaypointSpeed
  10330. Left Argument: waypoint
  10331. Right Argument: mode
  10332. Description: "Switches the group speed mode when the waypoint becomes active. Possible values are: "UNCHANGED", "LIMITED", "NORMAL" and "FULL"."
  10333. Example: [grp, 2] setWaypointSpeed "FULL"
  10334. Category: General
  10335. @e
  10336. setWaypointStatements
  10337. Left Argument: waypoint
  10338. Right Argument: [condition, statement]
  10339. Description: "The waypoint is done only when the condition is fulfilled. When the waypoint is done, the statement expression is executed."
  10340. Example: [grp, 2] setWaypointStatements ["true", ""]
  10341. Category: General
  10342. @e
  10343. setWaypointTimeout
  10344. Left Argument: waypoint
  10345. Right Argument: [min, mid, max]
  10346. Description: "Defines the time between condition satisfaction and waypoint finish (randomly from min to max, with an average value mid)."
  10347. Example: [grp, 2] setWaypointTimeout [5, 10, 6]
  10348. Category: General
  10349. @e
  10350. setWaypointType
  10351. Left Argument: waypoint
  10352. Right Argument: type
  10353. Description: "Changes the waypoint type. Type can be: "MOVE", "DESTROY", "GETIN", "SAD", "JOIN", "LEADER", "GETOUT", "CYCLE", "LOAD", "UNLOAD", "TR UNLOAD", "HOLD", "SENTRY", "GUARD", "TALK", "SCRIPTED", "SUPPORT", "GETIN NEAREST", "AND" or "OR"."
  10354. Example: [grp, 2] setWaypointType "HOLD"
  10355. Category: General
  10356. @e
  10357. setWaypointVisible
  10358. Left Argument: waypoint
  10359. Right Argument: visible
  10360. Description: "Set waypoint's visibility."
  10361. Example: [grp, 2] setWaypointVisible false
  10362. Category: General
  10363. @e
  10364. setWeaponReloadingTime
  10365. Left Argument: vehicle
  10366. Right Argument: [gunner unit, weaponName, reloadTime <0-1>]
  10367. Description: "Set phase of weapon reloading. ReloadTime goes from 0 to 1, where 1 is the end of loading procedure. Return values tells if given weapon was found for given gunner"
  10368. Example: _done = _vehicle setWeaponReloadingTime [gunner, , 0.5]
  10369. Category: General
  10370. @e
  10371. setWind
  10372. Left Argument: [x, z, forced]
  10373. Description: "Set current (forced == false) or permanent (forced == true) wind direction and force."
  10374. Category: General
  10375. @e
  10376. setWindDir
  10377. Left Argument: time
  10378. Right Argument: azimut
  10379. Description: "Changes the wind direction smoothly during the given time (in seconds). A time of zero means there will be an immediate change."
  10380. Example: 1800 setWindDir 120
  10381. Category: General
  10382. @e
  10383. setWindDir
  10384. Left Argument: [x, z]
  10385. Description: "Set current wind direction and force."
  10386. Category: General
  10387. @e
  10388. setWindForce
  10389. Left Argument: time
  10390. Right Argument: wind
  10391. Description: "Set max. wind overall wind changes in time. A time of zero means there will be an immediate change. A wind level of zero is minimal changes and a wind level of one means that wind can chage rapidly and max. wind speed i 35m/s."
  10392. Example: 1800 setFog 0.5
  10393. Category: General
  10394. @e
  10395. setWindStr
  10396. Left Argument: time
  10397. Right Argument: value
  10398. Description: "Changes the wind strength smoothly during the given time (in seconds). A time of zero means there will be an immediate change."
  10399. Example: 1800 setWindStr 0.5
  10400. Category: General
  10401. @e
  10402. setWingForceScaleRTD
  10403. Left Argument: RTD_helicopter
  10404. Right Argument: [left horizontal, right horizontal, vertical]
  10405. Description: "Set effectivity of wings. Values <0.0,1.0>. Use -1 to keep original value."
  10406. Category: General
  10407. @e
  10408. setWPPos
  10409. Left Argument: wapoint
  10410. Right Argument: position
  10411. Description: "Sets the waypoint position. Waypoint uses format <ar>Waypoint</ar>. Position uses format <ar>Position2D</ar>."
  10412. Example: [groupOne, 1] setWPPos getMarkerPos "MarkerOne"
  10413. Category: General
  10414. @e
  10415. show3DIcons
  10416. Left Argument: map
  10417. Right Argument: bool
  10418. Description: "Toggle the drawing of 3D icons."
  10419. Category: Editor
  10420. @e
  10421. showChat
  10422. Left Argument: true/false
  10423. Description: "Shows/hides the whole chat window."
  10424. Example: showChat false
  10425. Category: General
  10426. @e
  10427. showCinemaBorder
  10428. Left Argument: show
  10429. Description: "Forces drawing of the cinema borders. This is normally used in cutscenes to indicate the player has no control."
  10430. Category: General
  10431. @e
  10432. showCommandingMenu
  10433. Left Argument: class name
  10434. Description: "Create the commanding menu described by the given config class. When class name is empty, current commanding menu is hidden."
  10435. Category: General
  10436. @e
  10437. showCompass
  10438. Left Argument: show
  10439. Description: "Enables the compass (the default is true)."
  10440. Category: General
  10441. @e
  10442. showCuratorCompass
  10443. Left Argument: show?
  10444. Description: "Hides or shows compass in curator interface."
  10445. Category: General
  10446. @e
  10447. showGps
  10448. Left Argument: show
  10449. Description: "Enables the GPS receiver (the default is false)."
  10450. Category: General
  10451. @e
  10452. showHUD
  10453. Left Argument: enable
  10454. Description: "Enable / disable showing of HUD."
  10455. Category: General
  10456. @e
  10457. showLegend
  10458. Left Argument: map
  10459. Right Argument: bool
  10460. Description: "Show/hide map legend."
  10461. Category: Editor
  10462. @e
  10463. showMap
  10464. Left Argument: show
  10465. Description: "Enables the map (the default is true)."
  10466. Example: showMap true
  10467. Category: General
  10468. @e
  10469. shownArtilleryComputer
  10470. Description: "Checks whether the player has the artillery computer currently enabled."
  10471. Category: General
  10472. @e
  10473. shownChat
  10474. Description: "Checks whether the player chat is visible."
  10475. Category: General
  10476. @e
  10477. shownCompass
  10478. Description: "Checks whether the player has the compass enabled."
  10479. Category: General
  10480. @e
  10481. shownCuratorCompass
  10482. Description: "Returns true if compass is shown."
  10483. Category: General
  10484. @e
  10485. showNewEditorObject
  10486. Left Argument: map
  10487. Right Argument: [type, class, side, position]
  10488. Description: "Show the add editor object dialog, type is editor object type, class is class definition to automatically select, side filters by a certain side, pos is position to create the object."
  10489. Category: Editor
  10490. @e
  10491. shownGps
  10492. Description: "Checks whether the player has the GPS receiver enabled."
  10493. Category: General
  10494. @e
  10495. shownMap
  10496. Description: "Checks whether the player has the map enabled."
  10497. Category: General
  10498. @e
  10499. shownPad
  10500. Description: "Checks whether the player has the notebook enabled."
  10501. Category: General
  10502. @e
  10503. shownRadio
  10504. Description: "Checks whether the player has the radio transmitter enabled."
  10505. Category: General
  10506. @e
  10507. shownUAVFeed
  10508. Description: "True if UAV view is visible."
  10509. Category: General
  10510. @e
  10511. shownWarrant
  10512. Description: "Checks whether the player has the ID card enabled.
  10513. (Obsolete)."
  10514. Category: General
  10515. @e
  10516. shownWatch
  10517. Description: "Checks whether the player has the watch enabled."
  10518. Category: General
  10519. @e
  10520. showPad
  10521. Left Argument: show
  10522. Description: "Enables the notepad (the default is true)."
  10523. Category: General
  10524. @e
  10525. showRadio
  10526. Left Argument: show
  10527. Description: "Enables the radio (the default is false)."
  10528. Category: General
  10529. @e
  10530. showSubtitles
  10531. Left Argument: enable
  10532. Description: "Enable / disable showing of subtitles. Return the previous state."
  10533. Category: General
  10534. @e
  10535. showUAVFeed
  10536. Left Argument: show
  10537. Description: "Show UAV view."
  10538. Example: showUAVFeed true
  10539. Category: General
  10540. @e
  10541. showWarrant
  10542. Left Argument: show
  10543. Description: "Obsolete.
  10544. Enables the ID card (the default is false)."
  10545. Category: General
  10546. @e
  10547. showWatch
  10548. Left Argument: show
  10549. Description: "Enables the watch (the default is true)."
  10550. Category: General
  10551. @e
  10552. showWaypoint
  10553. Left Argument: waypoint
  10554. Right Argument: show
  10555. Description: "Sets the condition determining when the waypoint is shown. Possible values are: "NEVER", "EASY" and "ALWAYS"."
  10556. Example: [grp, 2] showWaypoint "ALWAYS"
  10557. Category: General
  10558. @e
  10559. side
  10560. Left Argument: unit
  10561. Description: "Returns the side of the unit."
  10562. Example: side player == west
  10563. Category: General
  10564. @e
  10565. sideChat
  10566. Left Argument: unit
  10567. Right Argument: chatText
  10568. Description: "Types text to the side radio channel.
  10569. 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."
  10570. Example: soldierOne sideChat "Show this text"
  10571. Category: General
  10572. @e
  10573. sideEnemy
  10574. Description: "The Enemy side (used for renegades)."
  10575. Category: General
  10576. @e
  10577. sideFriendly
  10578. Description: "The Friendly side (used for captives)."
  10579. Category: General
  10580. @e
  10581. sideLogic
  10582. Description: "The Logic side."
  10583. Category: General
  10584. @e
  10585. sideRadio
  10586. Left Argument: unit
  10587. Right Argument: radioName
  10588. Description: "Sends the message to the side radio channel. The message is defined in the description.ext file or radio protocol."
  10589. Example: soldierOne sideRadio "messageOne"
  10590. Category: General
  10591. @e
  10592. sideUnknown
  10593. Description: "The unknown side."
  10594. Category: General
  10595. @e
  10596. simpleTasks
  10597. Left Argument: person
  10598. Description: "Return all simple tasks assigned to given person."
  10599. Category: Identity
  10600. @e
  10601. simulationEnabled
  10602. Left Argument: entity
  10603. Description: "Check if the entity has enabled simulation."
  10604. Category: General
  10605. @e
  10606. simulCloudDensity
  10607. Left Argument: position
  10608. Description: "Returns density of clouds at given position."
  10609. Category: General
  10610. @e
  10611. simulCloudOcclusion
  10612. Left Argument: [position1, position2]
  10613. Description: "Returns clouds occlusion between two given points (0 = no clouds, 1 = full clouds)."
  10614. Category: General
  10615. @e
  10616. simulInClouds
  10617. Left Argument: position
  10618. Description: "Returns if given position is in clouds."
  10619. Category: General
  10620. @e
  10621. simulWeatherSync
  10622. Description: "Synchronizes SW with arma weather, generates all keyframes."
  10623. Category: General
  10624. @e
  10625. sin
  10626. Left Argument: x
  10627. Description: "The sine of x, the argument is in degrees."
  10628. Example: sin 30
  10629. Example Return: 0.5
  10630. Category: Default
  10631. @e
  10632. sin
  10633. Left Argument: x
  10634. Description: "The sine of x, the argument is in degrees."
  10635. Example: sin 30
  10636. Example Return: 0.5
  10637. Category: Default
  10638. @e
  10639. size
  10640. Left Argument: location
  10641. Description: "Return size of given location (width, height)."
  10642. Category: Location
  10643. @e
  10644. sizeOf
  10645. Left Argument: typeName
  10646. Description: "Return the size of the entity of given type."
  10647. Category: General
  10648. @e
  10649. skill
  10650. Left Argument: vehicle
  10651. Right Argument: type
  10652. Description: "Returns skill of given type of person (commander unit). Value of skill may vary from 0 to 1."
  10653. Example: hero skill "Endurance"
  10654. Category: General
  10655. @e
  10656. skill
  10657. Left Argument: person
  10658. Description: "Returns the current level of ability of the person."
  10659. Example: skill player
  10660. Category: General
  10661. @e
  10662. skillFinal
  10663. Left Argument: vehicle
  10664. Right Argument: type
  10665. Description: "Returns final (calculated) skill of given type of person (commander unit). Value of skill may vary from 0 to 1."
  10666. Example: hero skill "Endurance"
  10667. Category: General
  10668. @e
  10669. skipTime
  10670. Left Argument: duration
  10671. 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."
  10672. Example: skipTime 2.5
  10673. Category: General
  10674. @e
  10675. sleep
  10676. Left Argument: delay
  10677. Description: "Suspend execution of script for given time."
  10678. Example: sleep 0.5
  10679. Category: General
  10680. @e
  10681. sliderPosition
  10682. Left Argument: control
  10683. Description: "Returns the current thumb position of the given slider."
  10684. Example: _pos = sliderPosition _control
  10685. Category: General
  10686. @e
  10687. sliderRange
  10688. Left Argument: control
  10689. Description: "Returns the limits (as an array [min, max]) of the given slider."
  10690. Example: _limits = sliderRange _control
  10691. Category: General
  10692. @e
  10693. sliderSetPosition
  10694. Left Argument: control
  10695. Right Argument: pos
  10696. Description: "Sets the current thumb position of the given slider."
  10697. Example: _control sliderSetPosition 0
  10698. Category: General
  10699. @e
  10700. sliderSetPosition
  10701. Left Argument: [idc, pos]
  10702. Description: "Sets the current thumb position of the slider with id idc of the topmost user dialog."
  10703. Example: sliderSetPosition [100, 0]
  10704. Category: General
  10705. @e
  10706. sliderSetRange
  10707. Left Argument: [idc, min, max]
  10708. Description: "Sets the limits of the slider with id idc of the topmost user dialog."
  10709. Example: sliderSetRange [100, 0, 10]
  10710. Category: General
  10711. @e
  10712. sliderSetRange
  10713. Left Argument: control
  10714. Right Argument: [min, max]
  10715. Description: "Sets the limits of the slider with id idc of the given slider."
  10716. Example: _control sliderSetRange [0, 10]
  10717. Category: General
  10718. @e
  10719. sliderSetSpeed
  10720. Left Argument: control
  10721. Right Argument: [line, page]
  10722. 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 given slider."
  10723. Example: _control sliderSetSpeed [0.5, 2.0]
  10724. Category: General
  10725. @e
  10726. sliderSetSpeed
  10727. Left Argument: [idc, line, page]
  10728. 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."
  10729. Example: sliderSetSpeed [100, 0.5, 2.0]
  10730. Category: General
  10731. @e
  10732. sliderSpeed
  10733. Left Argument: control
  10734. Description: "Returns the speed (as an array [line, page]) of the given slider."
  10735. Example: _speed = sliderSpeed _control
  10736. Category: General
  10737. @e
  10738. slingLoadAssistantShown
  10739. Description: "Return true if Sling Load Assistant is shown."
  10740. Example: slingLoadAssistantShown
  10741. Category: General
  10742. @e
  10743. SoldierMagazines
  10744. Left Argument: unit
  10745. Description: "Get array with all magazines from vest."
  10746. Category: General
  10747. @e
  10748. someAmmo
  10749. Left Argument: unit
  10750. Description: "Checks whether the unit has some ammo remaining."
  10751. Example: someAmmo vehicle player
  10752. Category: General
  10753. @e
  10754. soundVolume
  10755. Description: "Checks the current sound volume (set by <f>setSoundVolume</f>)."
  10756. Category: General
  10757. @e
  10758. spawn
  10759. Left Argument: arguments
  10760. Right Argument: script
  10761. Description: "Executes a script. Argument is passed to the script as local variable _this."
  10762. Category: General
  10763. @e
  10764. speaker
  10765. Left Argument: object
  10766. Description: "Returns the speaker of the variable assigned to the object in the mission editor."
  10767. Example: speaker player
  10768. Category: General
  10769. @e
  10770. speed
  10771. Left Argument: obj
  10772. Description: "Returns the object speed (in km/h)."
  10773. Example: speed player
  10774. Category: General
  10775. @e
  10776. speedMode
  10777. Left Argument: grp
  10778. Description: "Returns the speed mode of the group ("LIMITED", "NORMAL" or "FULL")."
  10779. Example: speedMode group player
  10780. Category: General
  10781. @e
  10782. sqrt
  10783. Left Argument: x
  10784. Description: "The square root of x."
  10785. Example: sqrt 9
  10786. Example Return: 3
  10787. Category: Default
  10788. @e
  10789. sqrt
  10790. Left Argument: x
  10791. Description: "The square root of x."
  10792. Example: sqrt 9
  10793. Example Return: 3
  10794. Category: Default
  10795. @e
  10796. squadParams
  10797. Left Argument: unit
  10798. Description: "Returns data about squad of given unit loaded from squad.xml"
  10799. Category: General
  10800. @e
  10801. stance
  10802. Left Argument: unit
  10803. Description: "Returns the stance of the given unit."
  10804. Category: General
  10805. @e
  10806. startLoadingScreen
  10807. Left Argument: [text] or [text, resource]
  10808. 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."
  10809. Category: General
  10810. @e
  10811. step
  10812. Left Argument: for /.../
  10813. Right Argument: step
  10814. Description: "Optionaly can set step. If you want to count down, step must be specified, and set negative. Default value is 1."
  10815. Example: for "_x" from 20 to 10 step -2 do {..code..}
  10816. Category: Default
  10817. @e
  10818. step
  10819. Left Argument: for /.../
  10820. Right Argument: step
  10821. Description: "Optionaly can set step. If you want to count down, step must be specified, and set negative. Default value is 1."
  10822. Example: for "_x" from 20 to 10 step -2 do {..code..}
  10823. Category: Default
  10824. @e
  10825. stop
  10826. Left Argument: unit
  10827. Right Argument: stop
  10828. Description: "Stops an AI unit. This function is obsolete. Use disableAI to get better control over stopping a unit."
  10829. Example: soldierOne stop true
  10830. Category: General
  10831. @e
  10832. stopEngineRTD
  10833. Left Argument: RTD_helicopter
  10834. Description: "Instant engines stop."
  10835. Category: General
  10836. @e
  10837. stopped
  10838. Left Argument: unit
  10839. Description: "Checks whether the unit is stopped using the "stop" command."
  10840. Example: stopped jeepOne
  10841. Category: General
  10842. @e
  10843. str
  10844. Left Argument: any value
  10845. Description: "Converts any variable to a string."
  10846. Example: str(2+3)
  10847. Example Return: "5"
  10848. Category: Default
  10849. @e
  10850. str
  10851. Left Argument: any value
  10852. Description: "Converts any variable to a string."
  10853. Example: str(2+3)
  10854. Example Return: "5"
  10855. Category: Default
  10856. @e
  10857. sunOrMoon
  10858. Description: "Returns sun to moon transition state."
  10859. Category: General
  10860. @e
  10861. supportInfo
  10862. Left Argument: mask
  10863. Description: "Creates list of supported operators and type. Each field of array has format: "x:name" where x is 't' - type, 'n' - nullary operator, 'u' - unary operator, 'b' - binary operator. 'name' is operator's/type's name (in case operator, type of input operands is included). `mask` parameter can be empty string, or one of field. In this case, function returns empty array, if operator is not included in list. `mask` can contain wildcards, for example: *:name, t:*, t:name* or *:*."
  10864. Example: supportInfo "b:select*"
  10865. Example Return: ["b:ARRAY select SCALAR","b:ARRAY select BOOL"]
  10866. Category: Default
  10867. @e
  10868. supportInfo
  10869. Left Argument: mask
  10870. Description: "Creates list of supported operators and type. Each field of array has format: "x:name" where x is 't' - type, 'n' - nullary operator, 'u' - unary operator, 'b' - binary operator. 'name' is operator's/type's name (in case operator, type of input operands is included). `mask` parameter can be empty string, or one of field. In this case, function returns empty array, if operator is not included in list. `mask` can contain wildcards, for example: *:name, t:*, t:name* or *:*."
  10871. Example: supportInfo "b:select*"
  10872. Example Return: ["b:ARRAY select SCALAR","b:ARRAY select BOOL"]
  10873. Category: Default
  10874. @e
  10875. suppressFor
  10876. Left Argument: unit
  10877. Right Argument: timeToSuppress
  10878. Description: "Makes the unit to apply suppressive fire on known enemies."
  10879. Category: General
  10880. @e
  10881. surfaceIsWater
  10882. Left Argument: [x, y]
  10883. Description: "Returns whether water is on given position."
  10884. Category: General
  10885. @e
  10886. surfaceNormal
  10887. Left Argument: [x, y]
  10888. Description: "Returns surface normal on given position."
  10889. Category: General
  10890. @e
  10891. surfaceType
  10892. Left Argument: [x, y]
  10893. Description: "Returns what surface is on given position."
  10894. Category: General
  10895. @e
  10896. SwimInDepth
  10897. Left Argument: unit
  10898. Right Argument: height
  10899. Description: "Sets the target depth level for swimming soldier."
  10900. Example: soldier SwimInDepth -20
  10901. Category: General
  10902. @e
  10903. switch
  10904. Left Argument: exp
  10905. Description: "Begins switch form"
  10906. Example: switch (_a) do { case 1: {block}; case 2 : {block}; default {block};}
  10907. Category: Default
  10908. @e
  10909. switch
  10910. Left Argument: exp
  10911. Description: "Begins switch form"
  10912. Example: switch (_a) do { case 1: {block}; case 2 : {block}; default {block};}
  10913. Category: Default
  10914. @e
  10915. switchableUnits
  10916. Description: "Return a list of units accessible through team switch."
  10917. Category: General
  10918. @e
  10919. switchAction
  10920. Left Argument: soldier
  10921. Right Argument: action
  10922. Description: "When used on a person, the given action is started immediately (there is no transition). Use switchmove "" to switch back to the default movement if there is no transition back, otherwise the person may be stuck."
  10923. Example: soldierOne switchAction "SitDown"
  10924. Category: General
  10925. @e
  10926. switchCamera
  10927. Left Argument: unit
  10928. Right Argument: mode
  10929. Description: "Switches the camera to the given vehicle / camera. Mode is one of: "INTERNAL" (1st person), "GUNNER" (optics / sights), "EXTERNAL" (3rd person) or "GROUP" (group)."
  10930. Example: sniperOne switchCamera "gunner"
  10931. Category: General
  10932. @e
  10933. switchGesture
  10934. Left Argument: soldier
  10935. Right Argument: moveName
  10936. Description: "When used on a person, the given move is started immediately (there is no transition)."
  10937. Example: soldierOne switchGesture "Wave"
  10938. Category: General
  10939. @e
  10940. switchLight
  10941. Left Argument: lamppost
  10942. Right Argument: mode
  10943. Description: "Controls the lamppost mode. Mode may be "ON", "OFF" and "AUTO". "AUTO" is default and means the lampost is only on during nighttime."
  10944. Example: nearestObject [player, "StreetLamp"] switchLight "Off"
  10945. Category: General
  10946. @e
  10947. switchMove
  10948. Left Argument: soldier
  10949. Right Argument: moveName
  10950. Description: "When used on a person, the given move is started immediately (there is no transition). Use switchmove "" to switch back to the default movement if there is no transition back, otherwise the person may be stuck."
  10951. Example: soldierOne switchMove "FXStandDip"
  10952. Category: General
  10953. @e
  10954. synchronizedObjects
  10955. Left Argument: unit/trigger
  10956. Description: "Return the list of objects synchronized with the given unit/trigger."
  10957. Category: General
  10958. @e
  10959. synchronizedTriggers
  10960. Left Argument: waypoint
  10961. Description: "Return the list of triggers synchronized with a given waypoint."
  10962. Example: synchronizedTriggers [group player, 1]
  10963. Category: General
  10964. @e
  10965. synchronizedWaypoints
  10966. Left Argument: trigger
  10967. Description: "Return the list of waypoints synchronized with a given trigger."
  10968. Example: synchronizedWaypoints trigger1
  10969. Category: General
  10970. @e
  10971. synchronizeObjectsAdd
  10972. Left Argument: unit/trigger
  10973. Right Argument: [objects]
  10974. Description: "Add given objects to the unit/trigger's list of synchronized objects."
  10975. Example: player synchronizeObjectsAdd cursorTarget
  10976. Category: General
  10977. @e
  10978. synchronizeObjectsRemove
  10979. Left Argument: unit/trigger
  10980. Right Argument: [objects]
  10981. Description: "Remove given objects from the unit/trigger's list of synchronized objects."
  10982. Example: player syncrhonizeObjectsRemove cursorTarget
  10983. Category: General
  10984. @e
  10985. synchronizeTrigger
  10986. Left Argument: trigger
  10987. Right Argument: [waypoint1, waypoint2, ...]
  10988. Description: "Synchronizes the trigger with waypoints. Each waypoint is given as an array [group, index]."
  10989. Example: trigger synchronizeWaypoint []
  10990. Category: General
  10991. @e
  10992. synchronizeWaypoint
  10993. Left Argument: waypoint
  10994. Right Argument: [waypoint1, waypoint2, ...]
  10995. Description: "Synchronizes the waypoint with other waypoints. Each waypoint is given as an array [group, index]."
  10996. Example: [group1, 2] synchronizeWaypoint [[group2, 3]]
  10997. Category: General
  10998. @e
  10999. systemChat
  11000. Left Argument: chatText
  11001. Description: "Types text to the system radio channel.
  11002. 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."
  11003. Example: systemChat "Dam of Peace"
  11004. Category: General
  11005. @e
  11006. systemOfUnits
  11007. Description: "Returns 0 for metric, 1 for mixed (ground units uses metric, air units uses imperial) and 2 for imperial."
  11008. Category: General
  11009. @e
  11010. tan
  11011. Left Argument: x
  11012. Description: "The tangens of x, the argument is in degrees."
  11013. Example: tan 45
  11014. Example Return: 1
  11015. Category: Default
  11016. @e
  11017. tan
  11018. Left Argument: x
  11019. Description: "The tangens of x, the argument is in degrees."
  11020. Example: tan 45
  11021. Example Return: 1
  11022. Category: Default
  11023. @e
  11024. targetsAggregate
  11025. Left Argument: [speaker, side, unit, place, time]
  11026. Right Argument: candidates
  11027. Description: "Aggregate candidates."
  11028. Category: Conversations
  11029. @e
  11030. targetsQuery
  11031. Left Argument: speaker
  11032. Right Argument: [receiver, side, unit, place, time]
  11033. Description: "Find all targets known to sender matching given query."
  11034. Category: Conversations
  11035. @e
  11036. taskChildren
  11037. Left Argument: task
  11038. Description: "Return the child tasks of the specified task."
  11039. Category: Identity
  11040. @e
  11041. taskCompleted
  11042. Left Argument: task
  11043. Description: "Return if task is completed. (state Succeeded, Failed or Canceled)"
  11044. Category: Identity
  11045. @e
  11046. taskDescription
  11047. Left Argument: task
  11048. Description: "Returns the descripction of the task."
  11049. Category: Identity
  11050. @e
  11051. taskDestination
  11052. Left Argument: task
  11053. Description: "Returns the position of the task (as specified by destination parameter in config)."
  11054. Category: Identity
  11055. @e
  11056. taskHint
  11057. Left Argument: text
  11058. 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."
  11059. Example: taskHint "Capture town."
  11060. Category: General
  11061. @e
  11062. taskNull
  11063. Description: "A non-existing task. This value is not equal to anything, including itself."
  11064. Example: taskNull == taskNull
  11065. Example Return: false
  11066. Category: Identity
  11067. @e
  11068. taskParent
  11069. Left Argument: task
  11070. Description: "Return the parent task of the specified task."
  11071. Category: Identity
  11072. @e
  11073. taskResult
  11074. Left Argument: task
  11075. Description: "Return the result of the given task."
  11076. Category: Identity
  11077. @e
  11078. taskState
  11079. Left Argument: task
  11080. Description: "Return the state of the given task."
  11081. Category: Identity
  11082. @e
  11083. teamMember
  11084. Left Argument: person
  11085. Description: "Return an agent for given person."
  11086. Example: _agent = teamMember player
  11087. Category: Agents
  11088. @e
  11089. teamMemberNull
  11090. Description: "A non-existing team member. This value is not equal to anything, including itself."
  11091. Example: _teamMember == teamMemberNull
  11092. Example Return: false
  11093. Category: Agents
  11094. @e
  11095. teamName
  11096. Left Argument: team
  11097. Description: "Return a name of given team."
  11098. Example: _name = teamName _team
  11099. Category: Agents
  11100. @e
  11101. teams
  11102. Description: "Return a list of teams in the current mission."
  11103. Example: _teams = teams
  11104. Category: Agents
  11105. @e
  11106. teamSwitch
  11107. Description: "Invoke the team switch dialog (force it even when conditions are not met)."
  11108. Category: General
  11109. @e
  11110. teamSwitchEnabled
  11111. Description: "Check if tam switch is currently enabled."
  11112. Category: General
  11113. @e
  11114. teamType
  11115. Left Argument: team
  11116. Description: "Return a type of given team."
  11117. Example: _type = teamType _team
  11118. Category: Agents
  11119. @e
  11120. terminate
  11121. Left Argument: script
  11122. Description: "Terminate (abort) the script"
  11123. Category: General
  11124. @e
  11125. terrainIntersect
  11126. Left Argument: [ position begin, position end ]
  11127. Description: "Checks for intersection of terrain between two positions. Returns true if intersects with terrain"
  11128. Example: _doesIntersect = terrainIntersect [ position player, position enemy1 ];
  11129. Category: General
  11130. @e
  11131. terrainIntersectASL
  11132. Left Argument: [ positionASL begin, positionASL end ]
  11133. Description: "Checks for intersection of terrain between two positions. Returns true if intersects with terrain"
  11134. Example: _doesIntersect = terrainIntersectASL [ getposAsl player, getposAsl enemy1 ];
  11135. Category: General
  11136. @e
  11137. text
  11138. Left Argument: text
  11139. Description: "Creates a structured text containing the given plain text."
  11140. Example: txt2 = text "Hello world."
  11141. Category: General
  11142. @e
  11143. textLog
  11144. Left Argument: anything
  11145. Description: "Dumps the argument value into the debugging output."
  11146. Example: textLog player
  11147. Category: General
  11148. @e
  11149. textLogFormat
  11150. Left Argument: [format, arg1, arg2, ...]
  11151. Description: "Shortcut to textLog format [format, arg1, arg2, ...] (for better performance in retail version)."
  11152. Category: General
  11153. @e
  11154. tg
  11155. Left Argument: x
  11156. Description: "The tangens of x, the argument is in degrees."
  11157. Example: tg 45
  11158. Example Return: 1
  11159. Category: Default
  11160. @e
  11161. tg
  11162. Left Argument: x
  11163. Description: "The tangens of x, the argument is in degrees."
  11164. Example: tg 45
  11165. Example Return: 1
  11166. Category: Default
  11167. @e
  11168. then
  11169. Left Argument: if
  11170. Right Argument: codeToExecute
  11171. Description: "The code is executed when the if condition is met. If the code is executed, the last value calculated in the code is returned. If the code is not executed, <t>nothing</t> is returned."
  11172. Example: if (a>b) then {c=1}
  11173. Category: Default
  11174. @e
  11175. then
  11176. Left Argument: if
  11177. Right Argument: codeToExecute
  11178. Description: "The code is executed when the if condition is met. If the code is executed, the last value calculated in the code is returned. If the code is not executed, <t>nothing</t> is returned."
  11179. Example: if (a>b) then {c=1}
  11180. Category: Default
  11181. @e
  11182. throw
  11183. Left Argument: expression
  11184. Description: "Throws an exception. The exception is processed by first catch block. See <f>try</f>."
  11185. Example: throw "invalid argument"
  11186. Category: Default
  11187. @e
  11188. throw
  11189. Left Argument: expression
  11190. Description: "Throws an exception. The exception is processed by first catch block. See <f>try</f>."
  11191. Example: throw "invalid argument"
  11192. Category: Default
  11193. @e
  11194. time
  11195. Description: "Returns the time that elapsed since the mission started (in seconds)."
  11196. Category: General
  11197. @e
  11198. timeMultiplier
  11199. Description: "Returns game time multiplier setted to speed up game time"
  11200. Example: multiplier
  11201. Category: General
  11202. @e
  11203. titleCut
  11204. Left Argument: effect
  11205. Description: "Obsolete."
  11206. Category: General
  11207. @e
  11208. titleFadeOut
  11209. Left Argument: duration
  11210. Description: "Terminate the title effect and set duration of the fade out phase to the given time."
  11211. Example: titleFadeIn 1.0
  11212. Category: General
  11213. @e
  11214. titleObj
  11215. Left Argument: effect
  11216. 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.
  11217. The object can be defined in the description.ext file."
  11218. Example: titleObj ["BISLogo","plain"]
  11219. Category: General
  11220. @e
  11221. titleRsc
  11222. Left Argument: effect
  11223. 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.
  11224. Resource can be defined in the description.ext file."
  11225. Example: titleRsc ["BIS", "PLAIN"]
  11226. Category: General
  11227. @e
  11228. titleText
  11229. Left Argument: effect
  11230. 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."
  11231. Example: titleText ["Show this text", "PLAIN"]
  11232. Category: General
  11233. @e
  11234. to
  11235. Left Argument: for "_var" from a
  11236. Right Argument: b
  11237. Description: "Continue sequence of 'for' command."
  11238. Example: for "_x" from 10 to 20 do {..code..}
  11239. Category: Default
  11240. @e
  11241. to
  11242. Left Argument: for "_var" from a
  11243. Right Argument: b
  11244. Description: "Continue sequence of 'for' command."
  11245. Example: for "_x" from 10 to 20 do {..code..}
  11246. Category: Default
  11247. @e
  11248. toArray
  11249. Left Argument: string
  11250. Description: "Convert the string to the array of characters."
  11251. Example: toArray "ArmA"
  11252. Example Return: [65, 114, 109, 65]
  11253. Category: Default
  11254. @e
  11255. toArray
  11256. Left Argument: string
  11257. Description: "Convert the string to the array of characters."
  11258. Example: toArray "ArmA"
  11259. Example Return: [65, 114, 109, 65]
  11260. Category: Default
  11261. @e
  11262. toLower
  11263. Left Argument: string
  11264. Description: "Convert the string to lower case."
  11265. Example: toLower "ArmA"
  11266. Example Return: "arma"
  11267. Category: Default
  11268. @e
  11269. toLower
  11270. Left Argument: string
  11271. Description: "Convert the string to lower case."
  11272. Example: toLower "ArmA"
  11273. Example Return: "arma"
  11274. Category: Default
  11275. @e
  11276. toString
  11277. Left Argument: characters
  11278. Description: "Convert the array of characters to the string."
  11279. Example: toString [65, 114, 109, 65]
  11280. Example Return: "ArmA"
  11281. Category: Default
  11282. @e
  11283. toString
  11284. Left Argument: characters
  11285. Description: "Convert the array of characters to the string."
  11286. Example: toString [65, 114, 109, 65]
  11287. Example Return: "ArmA"
  11288. Category: Default
  11289. @e
  11290. toUpper
  11291. Left Argument: string
  11292. Description: "Convert the string to upper case."
  11293. Example: toUpper "ArmA"
  11294. Example Return: "ARMA"
  11295. Category: Default
  11296. @e
  11297. toUpper
  11298. Left Argument: string
  11299. Description: "Convert the string to upper case."
  11300. Example: toUpper "ArmA"
  11301. Example Return: "ARMA"
  11302. Category: Default
  11303. @e
  11304. triggerActivated
  11305. Left Argument: trigger
  11306. Description: "Returns true if the trigger has been activated."
  11307. Category: General
  11308. @e
  11309. triggerActivation
  11310. Left Argument: trigger
  11311. Description: "Returns trigger activation in the form [by, type, repeating]"
  11312. Category: General
  11313. @e
  11314. triggerArea
  11315. Left Argument: trigger
  11316. Description: "Returns trigger area in the form [a, b, angle, rectangle]"
  11317. Category: General
  11318. @e
  11319. triggerAttachedVehicle
  11320. Left Argument: trigger
  11321. Description: "Returns vehicle attached to the trigger (for example using <f>triggerAttachVehicle</f>)"
  11322. Category: General
  11323. @e
  11324. triggerAttachObject
  11325. Left Argument: trigger
  11326. Right Argument: objectId
  11327. Description: "Assigns a static object to the trigger. The activation source is changed to "STATIC"."
  11328. Example: trigger triggerAttachObject 1234
  11329. Category: General
  11330. @e
  11331. triggerAttachVehicle
  11332. Left Argument: trigger
  11333. Right Argument: [] or [vehicle]
  11334. Description: "If [] is given, the trigger is detached from the assigned vehicle. If the activation source is "VEHICLE", "GROUP", "LEADER" or "MEMBER", it's changed to "NONE". If [vehicle] is given, the trigger is attached to the vehicle or its group. When the source is "GROUP", "LEADER" or "MEMBER", it's attached to the group, otherwise it's attached to the vehicle and the source is changed to "VEHICLE"."
  11335. Example: trigger triggerAttachVehicle [player]
  11336. Category: General
  11337. @e
  11338. triggerStatements
  11339. Left Argument: trigger
  11340. Description: "Returns trigger statements in the form [cond, activ, desactiv]"
  11341. Category: General
  11342. @e
  11343. triggerText
  11344. Left Argument: trigger
  11345. Description: "Returns trigger text."
  11346. Category: General
  11347. @e
  11348. triggerTimeout
  11349. Left Argument: trigger
  11350. Description: "Returns trigger timeout in the form [min, mid, max, interruptable]"
  11351. Category: General
  11352. @e
  11353. triggerTimeoutCurrent
  11354. Left Argument: trigger
  11355. Description: "Returns trigger timeout or -1 if countdown is not in progress."
  11356. Example: triggerTimeoutCurrent triggerOne
  11357. Category: General
  11358. @e
  11359. triggerType
  11360. Left Argument: trigger
  11361. Description: "Returns trigger type."
  11362. Category: General
  11363. @e
  11364. true
  11365. Description: "Always true."
  11366. Category: Default
  11367. @e
  11368. true
  11369. Description: "Always true."
  11370. Category: Default
  11371. @e
  11372. try
  11373. Left Argument: code
  11374. Description: "Defines try-catch structure. This is structured exception block. Any thrown exception in try block is caught in catch block. The structured exception block has following form<pre>try //begin of try-catch block
  11375. {
  11376. //block, that can throw exception
  11377. }
  11378. catch{
  11379. //block, that process an exception. Exception is described in _exception variable
  11380. }</pre>;
  11381. "
  11382. Category: Default
  11383. @e
  11384. try
  11385. Left Argument: code
  11386. Description: "Defines try-catch structure. This is structured exception block. Any thrown exception in try block is caught in catch block. The structured exception block has following form<pre>try //begin of try-catch block
  11387. {
  11388. //block, that can throw exception
  11389. }
  11390. catch{
  11391. //block, that process an exception. Exception is described in _exception variable
  11392. }</pre>;
  11393. "
  11394. Category: Default
  11395. @e
  11396. turretLocal
  11397. Left Argument: vehicle
  11398. Right Argument: turret array
  11399. Description: "Checks whether the given vehicle's turret is local or is not."
  11400. Example: vehicle player isTurretLocal [0,0]
  11401. Category: General
  11402. @e
  11403. turretOwner
  11404. Left Argument: vehicle
  11405. Right Argument: [turret path]
  11406. Description: "Returns id of owner of given turret"
  11407. Example: vehicle turretOwner [0]
  11408. Category: General
  11409. @e
  11410. turretUnit
  11411. Left Argument: vehicle
  11412. Right Argument: turret path
  11413. Description: "Returns the unit in the vehicle turret."
  11414. Category: General
  11415. @e
  11416. tvAdd
  11417. Left Argument: control
  11418. Right Argument: [[path], text]
  11419. Description: "Adds an item with given text to Tree View under specified path (zero based)."
  11420. Example: _control tvAdd [[0], "text"]
  11421. Category: General
  11422. @e
  11423. tvAdd
  11424. Left Argument: [idc, [path], text]
  11425. Description: "Adds an item with given text to Tree View with given idc under specified path (zero based)."
  11426. Example: tvAdd [101, [0], "First item"]
  11427. Category: General
  11428. @e
  11429. tvClear
  11430. Left Argument: idc
  11431. Description: "Removes all items from Tree View with given idc."
  11432. Example: tvClear 101
  11433. Category: General
  11434. @e
  11435. tvCollapse
  11436. Left Argument: control
  11437. Right Argument: [path]
  11438. Description: "Collapses given path."
  11439. Example: _control tvCollapse [0]
  11440. Category: General
  11441. @e
  11442. tvCollapse
  11443. Left Argument: [idc, [path]]
  11444. Description: "Collapses tree item pointed to by path. IDC means id of parent Tree View."
  11445. Example: tvCollapse [101,[0]]
  11446. Category: General
  11447. @e
  11448. tvCount
  11449. Left Argument: control
  11450. Right Argument: [path]
  11451. Description: "Returns count of items in given path."
  11452. Example: _control tvCount [0]
  11453. Category: General
  11454. @e
  11455. tvCount
  11456. Left Argument: [idc, [path]]
  11457. Description: "Returns childrens count of item on given path. IDC means id of parent Tree View."
  11458. Example: tvCount [101,[0]]
  11459. Category: General
  11460. @e
  11461. tvCurSel
  11462. Left Argument: idc
  11463. Description: "Returns path to currently selected item. IDC means id of parent Tree View."
  11464. Example: tvCurSel 101
  11465. Category: General
  11466. @e
  11467. tvData
  11468. Left Argument: [idc, [path]]
  11469. Description: "Returns string data from item on given path. IDC means id of parent Tree View."
  11470. Example: tvData [101,[0]]
  11471. Category: General
  11472. @e
  11473. tvData
  11474. Left Argument: control
  11475. Right Argument: [path]
  11476. Description: "Returns string from given path."
  11477. Example: _control tvData [0]
  11478. Category: General
  11479. @e
  11480. tvDelete
  11481. Left Argument: control
  11482. Right Argument: [path]
  11483. Description: "Deletes item in given path."
  11484. Example: _control tvDelete [0]
  11485. Category: General
  11486. @e
  11487. tvDelete
  11488. Left Argument: [idc, [path]]
  11489. Description: "Removes an item on given path from Tree View with given idc."
  11490. Example: tvDelete [101, [0,0]]
  11491. Category: General
  11492. @e
  11493. tvExpand
  11494. Left Argument: [idc, [path]]
  11495. Description: "Expands tree item pointed to by path. IDC means id of parent Tree View."
  11496. Example: tvExpand [101,[0]]
  11497. Category: General
  11498. @e
  11499. tvExpand
  11500. Left Argument: control
  11501. Right Argument: [path]
  11502. Description: "Expands given path."
  11503. Example: _control tvExpand [0]
  11504. Category: General
  11505. @e
  11506. tvPicture
  11507. Left Argument: control
  11508. Right Argument: [path]
  11509. Description: "Returns picture on given path of tree."
  11510. Example: _control tvPicture [0]
  11511. Category: General
  11512. @e
  11513. tvPicture
  11514. Left Argument: [idc, [path]]
  11515. Description: "Returns name of picture from item pointed to by path. IDC means id of parent Tree View."
  11516. Example: tvPicture [101,[0]]
  11517. Category: General
  11518. @e
  11519. tvSetCurSel
  11520. Left Argument: [idc, [path]]
  11521. Description: "Sets cursor to given item on given path. IDC means id of parent Tree View."
  11522. Example: tvSetCurSel [101,[0]]
  11523. Category: General
  11524. @e
  11525. tvSetCurSel
  11526. Left Argument: control
  11527. Right Argument: [path]
  11528. Description: "Sets cursor to given path."
  11529. Example: _control tvSetCurSel [0]
  11530. Category: General
  11531. @e
  11532. tvSetData
  11533. Left Argument: [idc, [path], "data"]
  11534. Description: "Sets string data to item on given path. IDC means id of parent Tree View."
  11535. Example: tvSetData [101,[0],"Test data"]
  11536. Category: General
  11537. @e
  11538. tvSetData
  11539. Left Argument: control
  11540. Right Argument: [[path], text]
  11541. Description: "Sets data to given path."
  11542. Example: _control tvSetData [[0], "text"]
  11543. Category: General
  11544. @e
  11545. tvSetPicture
  11546. Left Argument: control
  11547. Right Argument: [[path], name]
  11548. Description: "Sets picture to item selected by path."
  11549. Example: _control tvSetPicture [[0], "picture"]
  11550. Category: General
  11551. @e
  11552. tvSetPicture
  11553. Left Argument: [idc, [path],name]
  11554. 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"
  11555. Example: tvSetPicture [101,[0],"picture"]
  11556. Category: General
  11557. @e
  11558. tvSetPictureColor
  11559. Left Argument: [idc, [path], [r,g,b,a]]
  11560. Description: "Sets color of picture to item selected by path. IDC means id of parent Tree View."
  11561. Example: tvSetPictureColor [101,[0],[1,0,1,1]]
  11562. Category: General
  11563. @e
  11564. tvSetPictureColor
  11565. Left Argument: control
  11566. Right Argument: [[path], [r,g,b,a]]
  11567. Description: "Sets color of picture to item selected by path."
  11568. Example: _control tvSetPicture [[0], [1,0,1,1]]
  11569. Category: General
  11570. @e
  11571. tvSetTooltip
  11572. Left Argument: control
  11573. Right Argument: [[path], tooltip]
  11574. Description: "Sets tooltip for item in the given path of the given ctree control to the given data."
  11575. Example: _control lbSetData [1, "tooltip"]
  11576. Category: General
  11577. @e
  11578. tvSetTooltip
  11579. Left Argument: [idc, index, tooltip]
  11580. 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."
  11581. Example: tvSetTooltip [101, 1, "tooltip"]
  11582. Category: General
  11583. @e
  11584. tvSetValue
  11585. Left Argument: [idc, [path], val]
  11586. Description: "Sets scalar data to item on given path. IDC means id of parent Tree View."
  11587. Example: tvSetValue [101,[0], 555]
  11588. Category: General
  11589. @e
  11590. tvSetValue
  11591. Left Argument: control
  11592. Right Argument: [[path], val]
  11593. Description: "Sets value to given path."
  11594. Example: _control tvSetValue [[0], 1]
  11595. Category: General
  11596. @e
  11597. tvSort
  11598. Left Argument: [idc,[path],reversed]
  11599. Description: "Sorts childrens of given item by data. Param reversed is optional. IDC means id of parent Tree View."
  11600. Example: tvSort [101,[0],false]
  11601. Category: General
  11602. @e
  11603. tvSort
  11604. Left Argument: control
  11605. Right Argument: [[path], reversed]
  11606. Description: "Sorts childrens of given item by data."
  11607. Example: _control tvSort [[0], true]
  11608. Category: General
  11609. @e
  11610. tvSortByValue
  11611. Left Argument: [idc,[path],reversed]
  11612. Description: "Sorts childrens of given item by value. Param reversed is optional. IDC means id of parent Tree View."
  11613. Example: tvSort [101,[0],false]
  11614. Category: General
  11615. @e
  11616. tvSortByValue
  11617. Left Argument: control
  11618. Right Argument: [[path], reversed]
  11619. Description: "Sorts childrens of given item by value."
  11620. Example: _control tvSortByValue [[0], true]
  11621. Category: General
  11622. @e
  11623. tvText
  11624. Left Argument: control
  11625. Right Argument: [path]
  11626. Description: "Gets text from given path"
  11627. Example: _control tvText [0]
  11628. Category: General
  11629. @e
  11630. tvText
  11631. Left Argument: [idc, [path]]
  11632. Description: "Returns shown text in the item on given path. IDC means id of parent Tree View."
  11633. Example: tvText [101,[0]]
  11634. Category: General
  11635. @e
  11636. tvTooltip
  11637. Left Argument: control
  11638. Right Argument: [path]
  11639. Description: "Returns the tooltip in the path of given ctree."
  11640. Example: _text = _control tvText [0]
  11641. Category: General
  11642. @e
  11643. tvTooltip
  11644. Left Argument: [idc, path]
  11645. Description: "Returns the tooltip of the item in the given path of the treeview with id idc of the topmost user dialog."
  11646. Example: _text = lbText [101, 0]
  11647. Category: General
  11648. @e
  11649. tvValue
  11650. Left Argument: [idc, [path]]
  11651. Description: "Returns scalar data from item on given path. IDC means id of parent Tree View."
  11652. Example: tvValue [101,[0]]
  11653. Category: General
  11654. @e
  11655. tvValue
  11656. Left Argument: control
  11657. Right Argument: [path]
  11658. Description: "Reads value from given path."
  11659. Example: _control tvValue [0]
  11660. Category: General
  11661. @e
  11662. type
  11663. Left Argument: task
  11664. Description: "Return the type of the task."
  11665. Category: Identity
  11666. @e
  11667. typeName
  11668. Left Argument: any
  11669. Description: "Returns type-name of expression. Type is returned as string"
  11670. Example: typeName "hello"
  11671. Example Return: "string"
  11672. Category: Default
  11673. @e
  11674. typeName
  11675. Left Argument: any
  11676. Description: "Returns type-name of expression. Type is returned as string"
  11677. Example: typeName "hello"
  11678. Example Return: "string"
  11679. Category: Default
  11680. @e
  11681. typeOf
  11682. Left Argument: object
  11683. Description: "Returns the name of the type of the given object."
  11684. Example: typeOf player
  11685. Example Return: "SoldierWB"
  11686. Category: General
  11687. @e
  11688. UAVControl
  11689. Left Argument: Uav
  11690. Description: "Get list with unit connected to vehicle and position in that vehicle."
  11691. Example: UAVControl cameraOn
  11692. Category: General
  11693. @e
  11694. uiNamespace
  11695. Description: "Return the global namespace attached to user interface."
  11696. Category: General
  11697. @e
  11698. uisleep
  11699. Left Argument: delay
  11700. Description: "Suspend execution of script for given uitime."
  11701. Example: uisleep 0.5
  11702. Category: General
  11703. @e
  11704. unassignCurator
  11705. Left Argument: curatorObj
  11706. Description: "Unassign curator (will destroy both sides of connection)."
  11707. Category: General
  11708. @e
  11709. unassignItem
  11710. Left Argument: unit
  11711. Right Argument: item
  11712. Description: "Unassign existing item to the soldier's containers. "
  11713. Category: General
  11714. @e
  11715. unassignTeam
  11716. Left Argument: vehicle
  11717. Description: "Unassigns the vehicle (its commander unit) from his team. This is equal to vehicle assignTeam "MAIN"."
  11718. Example: unassignTeam soldier2
  11719. Category: General
  11720. @e
  11721. unassignVehicle
  11722. Left Argument: unit
  11723. Description: "The person is unassigned from the vehicle. If he is currently inside, the group leader will issue an order to disembark."
  11724. Example: unassignVehicle player
  11725. Category: General
  11726. @e
  11727. underwater
  11728. Left Argument: object
  11729. Description: "Return whether object is fully underwater."
  11730. Category: General
  11731. @e
  11732. uniform
  11733. Left Argument: unit
  11734. Description: "Returns name of currently used uniform."
  11735. Category: General
  11736. @e
  11737. uniformContainer
  11738. Left Argument: unit
  11739. Description: "Returns container of currently used uniform."
  11740. Category: General
  11741. @e
  11742. uniformItems
  11743. Left Argument: unit
  11744. Description: "Get array with all items from uniform."
  11745. Category: General
  11746. @e
  11747. uniformMagazines
  11748. Left Argument: unit
  11749. Description: "Get array with all magazines from vest."
  11750. Category: General
  11751. @e
  11752. unitAddons
  11753. Left Argument: unitClass
  11754. Description: "Get list with addons which unitClass belongs to."
  11755. Example: unitAddons unitClass
  11756. Category: General
  11757. @e
  11758. unitBackpack
  11759. Left Argument: unit
  11760. Description: "Returns unit's backpack."
  11761. Category: General
  11762. @e
  11763. unitPos
  11764. Left Argument: person
  11765. Description: "Return the unit position rules."
  11766. Category: General
  11767. @e
  11768. unitReady
  11769. Left Argument: unit
  11770. Description: "Checks whether the unit is ready. A unit is busy when it's given an order like "move", until the command is finished."
  11771. Example: unitReady player
  11772. Category: General
  11773. @e
  11774. unitRecoilCoefficient
  11775. Left Argument: soldier
  11776. Description: "Returns unit's custom recoil coefficient."
  11777. Example: coef = unitRecoilCoefficient player
  11778. Category: General
  11779. @e
  11780. units
  11781. Left Argument: grp
  11782. Description: "Returns an array with all the units in the group."
  11783. Example: player in units group player
  11784. Category: General
  11785. @e
  11786. unitsBelowHeight
  11787. Left Argument: group
  11788. Right Argument: height
  11789. Description: "Return units in group below passed height."
  11790. Example: group player unitsBelowHeight 50
  11791. Category: General
  11792. @e
  11793. unlinkItem
  11794. Left Argument: unit
  11795. Right Argument: item
  11796. Description: "Unlink and remove existing linked item from soldier"
  11797. Category: General
  11798. @e
  11799. unlockAchievement
  11800. Left Argument: name
  11801. Description: "Unlock the given achievement."
  11802. Category: General
  11803. @e
  11804. unregisterTask
  11805. Left Argument: teamMember
  11806. Right Argument: name
  11807. Description: "Unregister a task type."
  11808. Category: Identity
  11809. @e
  11810. updateDrawIcon
  11811. Left Argument: map
  11812. Right Argument: [object, string identifier, color, offset, width, height, maintain size?, angle, shadow]
  11813. Description: "Updates the icon to be shown in 2D editor for the specified editor object. If maintain size is false, icon will not scale depending on the scale of the map. If maintain size is a number, the icon will maintain size if map scale is below that number."
  11814. Category: Editor
  11815. @e
  11816. updateMenuItem
  11817. Left Argument: map
  11818. Right Argument: [menu item index,text,command]
  11819. Description: "Sets the text and command for the menu item. index is index as returned from addMenuItem command. command is optional."
  11820. Category: Editor
  11821. @e
  11822. updateObjectTree
  11823. Left Argument: map
  11824. Description: "Update the editor object tree."
  11825. Category: Editor
  11826. @e
  11827. useAudioTimeForMoves
  11828. Left Argument: soldier
  11829. Right Argument: toggle
  11830. Description: "Switch between elapsed gamet time and audio time being used as animation timer. Used for audio/animation synchronization."
  11831. Example: player useAudioTimeForMoves true
  11832. Category: General
  11833. @e
  11834. vectorAdd
  11835. Left Argument: vector
  11836. Right Argument: vector
  11837. Description: "Adds two 3D vectors"
  11838. Example: vector1 vectorAdd vector2
  11839. Category: General
  11840. @e
  11841. vectorCos
  11842. Left Argument: vector
  11843. Right Argument: vector
  11844. Description: "Cosine of angle between 2 vectors"
  11845. Example: vector1 vectorCos vector2
  11846. Category: General
  11847. @e
  11848. vectorCrossProduct
  11849. Left Argument: vector
  11850. Right Argument: vector
  11851. Description: "Cross product of two 3D vectors"
  11852. Example: left vectorCrossProduct right
  11853. Category: General
  11854. @e
  11855. vectorDiff
  11856. Left Argument: vector
  11857. Right Argument: vector
  11858. Description: "Subtracts right 3D vector from left"
  11859. Example: left vectorDiff right
  11860. Category: General
  11861. @e
  11862. vectorDir
  11863. Left Argument: obj
  11864. Description: "Return object's direction vector in world coordinates as [x, z, y]."
  11865. Category: General
  11866. @e
  11867. vectorDirVisual
  11868. Left Argument: obj
  11869. Description: "Return object's direction vector in world coordinates as [x, z, y]."
  11870. Category: General
  11871. @e
  11872. vectorDistance
  11873. Left Argument: vector
  11874. Right Argument: vector
  11875. Description: "Squared distance between 2 vectors"
  11876. Example: vector1 vectorDistance vector2
  11877. Category: General
  11878. @e
  11879. vectorDistanceSqr
  11880. Left Argument: vector
  11881. Right Argument: vector
  11882. Description: "Squared distance between 2 vectors"
  11883. Example: vector1 vectorDistanceSqr vector2
  11884. Category: General
  11885. @e
  11886. vectorDotProduct
  11887. Left Argument: vector
  11888. Right Argument: vector
  11889. Description: "Dot product of two 3D vectors"
  11890. Example: vector1 vectorDotProduct vector2
  11891. Category: General
  11892. @e
  11893. vectorFromTo
  11894. Left Argument: vector
  11895. Right Argument: vector
  11896. Description: "Unit vector equal to direction from left to right vector"
  11897. Example: vector1 vectorFromTo vector2
  11898. Category: General
  11899. @e
  11900. vectorMagnitude
  11901. Left Argument: array
  11902. Description: "Magnitude of a vector"
  11903. Example: vectorMagnitude [0,8,7]
  11904. Category: General
  11905. @e
  11906. vectorMagnitudeSqr
  11907. Left Argument: array
  11908. Description: "Squared magnitude of a vector"
  11909. Example: vectorMagnitudeSqr [4,1,3]
  11910. Category: General
  11911. @e
  11912. vectorMultiply
  11913. Left Argument: vector
  11914. Right Argument: scalar
  11915. Description: "Multiplies vector by a scalar"
  11916. Example: vector1 vectorMultiply 3.14
  11917. Category: General
  11918. @e
  11919. vectorNormalized
  11920. Left Argument: array
  11921. Description: "Normalized vector (unit vector), if original vector is zero, result is a zero vector as well"
  11922. Example: vectorNormalized [4,1,3]
  11923. Category: General
  11924. @e
  11925. vectorUp
  11926. Left Argument: obj
  11927. Description: "Return object's up vector in world coordinates as [x, z, y]."
  11928. Category: General
  11929. @e
  11930. vectorUpVisual
  11931. Left Argument: obj
  11932. Description: "Return object's up vector in world coordinates as [x, z, y]."
  11933. Category: General
  11934. @e
  11935. vehicle
  11936. Left Argument: unit
  11937. Description: "Returns the vehicle in which the given unit is mounted. If there is none, the unit is returned."
  11938. Example: vehicle player != player
  11939. Category: General
  11940. @e
  11941. vehicleChat
  11942. Left Argument: unit
  11943. Right Argument: chatText
  11944. Description: "Types text to the vehicle radio channel.
  11945. 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."
  11946. Example: soldierOne vehicleChat "Show this text"
  11947. Category: General
  11948. @e
  11949. vehicleRadio
  11950. Left Argument: unit
  11951. Right Argument: radioName
  11952. Description: "Sends the message to the vehicle radio channel. The message is defined in the description.ext file or radio protocol."
  11953. Example: soldierOne vehicleRadio "messageOne"
  11954. Category: General
  11955. @e
  11956. vehicles
  11957. Description: "Return a list of vehicles in the current mission."
  11958. Example: _vehicles = vehicles
  11959. Category: General
  11960. @e
  11961. vehicleVarName
  11962. Left Argument: object
  11963. Description: "Returns the name of the variable which contains a reference to this object."
  11964. Category: General
  11965. @e
  11966. velocity
  11967. Left Argument: vehicle
  11968. Description: "Returns the velocity (speed vector) of the vehicle as an array with format [x, z, y]."
  11969. Category: General
  11970. @e
  11971. velocityModelSpace
  11972. Left Argument: vehicle
  11973. Description: "Returns the velocity (speed vector) of the vehicle as an array with format [x, z, y]. Vector is in model space"
  11974. Category: General
  11975. @e
  11976. verifySignature
  11977. Left Argument: filename
  11978. 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."
  11979. Category: General
  11980. @e
  11981. vest
  11982. Left Argument: unit
  11983. Description: "Returns name of currently used vest."
  11984. Category: General
  11985. @e
  11986. vestContainer
  11987. Left Argument: unit
  11988. Description: "Returns container of currently used vest."
  11989. Category: General
  11990. @e
  11991. vestItems
  11992. Left Argument: unit
  11993. Description: "Get array with all items from vest."
  11994. Category: General
  11995. @e
  11996. vestMagazines
  11997. Left Argument: unit
  11998. Description: "Get array with all magazines from vest."
  11999. Category: General
  12000. @e
  12001. viewDistance
  12002. Description: "Returns the rendering distance."
  12003. Category: General
  12004. @e
  12005. visibleCompass
  12006. Description: "Checks whether the player has the compass opened and visible."
  12007. Category: General
  12008. @e
  12009. visibleGps
  12010. Description: "Checks whether the player has the GPS receiver opened and visible."
  12011. Category: General
  12012. @e
  12013. visibleMap
  12014. Description: "Return true if the main map is shown (active)."
  12015. Category: General
  12016. @e
  12017. visiblePosition
  12018. Left Argument: object
  12019. Description: "Returns the object rendered position in format <ar>Position</ar>."
  12020. Example: visiblePosition player
  12021. Category: General
  12022. @e
  12023. visiblePositionASL
  12024. Left Argument: object
  12025. Description: "Returns the object rendered position in format <ar>PositionASL</ar>."
  12026. Example: visiblePositionASL player
  12027. Category: General
  12028. @e
  12029. visibleWatch
  12030. Description: "Checks whether the player has the watch opened and visible."
  12031. Category: General
  12032. @e
  12033. waitUntil
  12034. Left Argument: condition
  12035. Description: "Suspend execution of script until condition is satisfied."
  12036. Example: _i = 0; waitUntil {_i = _i + 1; _i >= 100}
  12037. Category: Default
  12038. @e
  12039. waitUntil
  12040. Left Argument: condition
  12041. Description: "Suspend execution of script until condition is satisfied."
  12042. Example: _i = 0; waitUntil {_i = _i + 1; _i >= 100}
  12043. Category: Default
  12044. @e
  12045. waves
  12046. Description: "Return waves value."
  12047. Category: General
  12048. @e
  12049. waypointAttachedObject
  12050. Left Argument: waypoint
  12051. Description: "Gets the object attached to the waypoint."
  12052. Example: waypointAttachedObject [groupOne, 1]
  12053. Category: General
  12054. @e
  12055. waypointAttachedVehicle
  12056. Left Argument: waypoint
  12057. Description: "Gets the vehicle attached to the waypoint."
  12058. Example: waypointAttachedVehicle [groupOne, 1]
  12059. Category: General
  12060. @e
  12061. waypointAttachObject
  12062. Left Argument: waypoint
  12063. Right Argument: idStatic or object
  12064. Description: "Attaches a static object to the given waypoint."
  12065. Example: [grp, 2] waypointAttachObject 1234
  12066. Category: General
  12067. @e
  12068. waypointAttachVehicle
  12069. Left Argument: waypoint
  12070. Right Argument: vehicle
  12071. Description: "Attaches a vehicle to the given waypoint."
  12072. Example: [grp, 2] waypointAttachVehicle vehicle player
  12073. Category: General
  12074. @e
  12075. waypointBehaviour
  12076. Left Argument: waypoint
  12077. Description: "Gets the waypoint behavior."
  12078. Example: waypointBehaviour [groupOne, 1]
  12079. Category: General
  12080. @e
  12081. waypointCombatMode
  12082. Left Argument: waypoint
  12083. Description: "Gets the waypoint combat mode."
  12084. Example: waypointCombatMode [groupOne, 1]
  12085. Category: General
  12086. @e
  12087. waypointCompletionRadius
  12088. Left Argument: waypoint
  12089. Description: "Gets the radius around the waypoint where is the waypoint completed."
  12090. Example: _radius = waypointCompletionRadius [groupOne, 1]
  12091. Category: General
  12092. @e
  12093. waypointDescription
  12094. Left Argument: waypoint
  12095. Description: "Gets the waypoint description."
  12096. Example: waypointDescription [groupOne, 1]
  12097. Category: General
  12098. @e
  12099. waypointFormation
  12100. Left Argument: waypoint
  12101. Description: "Gets the waypoint formation."
  12102. Example: waypointFormation [groupOne, 1]
  12103. Category: General
  12104. @e
  12105. waypointHousePosition
  12106. Left Argument: waypoint
  12107. Description: "Gets the house position assigned to the waypoint."
  12108. Example: waypointHousePosition [groupOne, 1]
  12109. Category: General
  12110. @e
  12111. waypointLoiterRadius
  12112. Left Argument: waypoint
  12113. Description: "Gets the waypoint loiter radius. Waypoint uses format <ar>Waypoint</ar>.
  12114. "
  12115. Example: waypointLoiterRadius [groupOne, 1]
  12116. Category: General
  12117. @e
  12118. waypointLoiterType
  12119. Left Argument: waypoint
  12120. Description: "Gets the waypoint loiter type. Waypoint uses format <ar>Waypoint</ar>.
  12121. "
  12122. Example: waypointLoiterRadius [groupOne, 1]
  12123. Category: General
  12124. @e
  12125. waypointName
  12126. Left Argument: waypoint
  12127. Description: "Gets the waypoint name."
  12128. Example: waypointName [groupOne, 1]
  12129. Category: General
  12130. @e
  12131. waypointPosition
  12132. Left Argument: waypoint
  12133. Description: "Gets the waypoint position. Waypoint uses format <ar>Waypoint</ar>.
  12134. Note: this function is identical to <f>getWaypointPosition</f>."
  12135. Example: waypointPosition [groupOne, 1]
  12136. Category: General
  12137. @e
  12138. waypoints
  12139. Left Argument: group
  12140. Description: "Return the list of waypoints for given group."
  12141. Category: General
  12142. @e
  12143. waypointScript
  12144. Left Argument: waypoint
  12145. Description: "Gets the waypoint script."
  12146. Example: waypointScript [groupOne, 1]
  12147. Category: General
  12148. @e
  12149. waypointsEnabledUAV
  12150. Left Argument: vehicle
  12151. Description: "Returns if player can set waypoints for given UAV in AV terminal"
  12152. Example: waypointsEnabledUAV vehicle
  12153. Category: General
  12154. @e
  12155. waypointShow
  12156. Left Argument: waypoint
  12157. Description: "Gets the waypoint show/hide status."
  12158. Example: waypointShow [groupOne, 1]
  12159. Category: General
  12160. @e
  12161. waypointSpeed
  12162. Left Argument: waypoint
  12163. Description: "Gets the waypoint speed."
  12164. Example: waypointSpeed [groupOne, 1]
  12165. Category: General
  12166. @e
  12167. waypointStatements
  12168. Left Argument: waypoint
  12169. Description: "Gets the waypoint statements."
  12170. Example: waypointStatements [groupOne, 1]
  12171. Category: General
  12172. @e
  12173. waypointTimeout
  12174. Left Argument: waypoint
  12175. Description: "Gets the waypoint timeout values."
  12176. Example: waypointTimeout [groupOne, 1]
  12177. Category: General
  12178. @e
  12179. waypointTimeoutCurrent
  12180. Left Argument: waypoint
  12181. Description: "Gets the current waypoint timeout or -1 if countdown is not in progress."
  12182. Example: waypointTimeoutCurrent groupOne
  12183. Category: General
  12184. @e
  12185. waypointType
  12186. Left Argument: waypoint
  12187. Description: "Gets the waypoint type."
  12188. Example: waypointType [groupOne, 1]
  12189. Category: General
  12190. @e
  12191. waypointVisible
  12192. Left Argument: waypoint
  12193. Description: "Gets waypoint visibility."
  12194. Example: visible = waypointVisible [groupOne, 1]
  12195. Category: General
  12196. @e
  12197. weaponAccessories
  12198. Left Argument: vehicle
  12199. Right Argument: weapon
  12200. Description: "Get array with all items linked to a given weapon."
  12201. Category: General
  12202. @e
  12203. weaponAccessoriesCargo
  12204. Left Argument: vehicle
  12205. Right Argument: [weaponId,creatorId]
  12206. Description: "Show list of attachments linked to a given weapon"
  12207. Category: General
  12208. @e
  12209. weaponCargo
  12210. Left Argument: box
  12211. Description: "Get array with weapons from ammo box (or any general weapon holder container). "
  12212. Category: General
  12213. @e
  12214. weaponDirection
  12215. Left Argument: vehicle
  12216. Right Argument: weaponName
  12217. Description: "Returns direction where is given weapon aiming."
  12218. Example: _dir = _vehicle weaponDirection "M16"
  12219. Category: General
  12220. @e
  12221. weaponInertia
  12222. Left Argument: soldier
  12223. Description: "Returns current rate of how much the weapon view is distorted because of quick aiming"
  12224. Example: weaponInertia player
  12225. Category: General
  12226. @e
  12227. weaponLowered
  12228. Left Argument: soldier
  12229. Description: "True if given soldier's weapon is lowered."
  12230. Example: weaponLowered player
  12231. Category: General
  12232. @e
  12233. weapons
  12234. Left Argument: vehicle
  12235. Description: "Returns an array of names of all the vehicle's weapons."
  12236. Example: weapons player
  12237. Category: General
  12238. @e
  12239. weaponsItems
  12240. Left Argument: vehicle
  12241. 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]]]"
  12242. Example: weaponsItems player
  12243. Category: General
  12244. @e
  12245. weaponsItemsCargo
  12246. Left Argument: vehicle
  12247. 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]]]"
  12248. Example: weaponsItemsCargo vehicle player
  12249. Category: General
  12250. @e
  12251. weaponState
  12252. Left Argument: Gunner or [veh,turret path]
  12253. Description: "Returns the current weapon state as an array of strings in the follow format [WeaponName, MuzzleName, ModeName, MagazineName]."
  12254. Example: weaponState player or weaponState [vehicle player,[0]]
  12255. Category: General
  12256. @e
  12257. weaponsTurret
  12258. Left Argument: vehicle
  12259. Right Argument: turretPath
  12260. Description: "Returns all weapons of given turret. Use turret path [-1] for drivers turret."
  12261. Example: vehicle player weaponsTurret [0,0]
  12262. Category: General
  12263. @e
  12264. weightRTD
  12265. Left Argument: helicopter
  12266. Description: "Returns weight of helicopter."
  12267. Example: [fuselage weight, crew weight, fuel weight, custom weight, weapons weight]
  12268. Category: General
  12269. @e
  12270. west
  12271. Description: "The West side."
  12272. Category: General
  12273. @e
  12274. WFSideText
  12275. Left Argument: object
  12276. Description: "Returns the unlocalized text value of a object's side as: East, West, Resistance, Civilian, or Unknown."
  12277. Example: WFSideText player
  12278. Category: General
  12279. @e
  12280. while
  12281. Left Argument: condition
  12282. Description: "The first part of the while contruct."
  12283. Example: while "x<10" do {x=x+1}
  12284. Category: Default
  12285. @e
  12286. while
  12287. Left Argument: condition
  12288. Description: "The first part of the while contruct."
  12289. Example: while "x<10" do {x=x+1}
  12290. Category: Default
  12291. @e
  12292. wind
  12293. Description: "Return the current wind vector."
  12294. Category: General
  12295. @e
  12296. windDir
  12297. Description: "Return the current wind azimut."
  12298. Category: General
  12299. @e
  12300. windRTD
  12301. Description: "Returns wind strength and direction."
  12302. Category: General
  12303. @e
  12304. windStr
  12305. Description: "Return the current wind strength."
  12306. Category: General
  12307. @e
  12308. wingsForcesRTD
  12309. Left Argument: RTD_helicopter
  12310. Description: "Returns force produced by wings."
  12311. Category: General
  12312. @e
  12313. with
  12314. Left Argument: namespace
  12315. Description: "The first part of the with contruct."
  12316. Example: with missionNamespace do {global=global+1}
  12317. Category: Default
  12318. @e
  12319. with
  12320. Left Argument: namespace
  12321. Description: "The first part of the with contruct."
  12322. Example: with missionNamespace do {global=global+1}
  12323. Category: Default
  12324. @e
  12325. worldName
  12326. Description: "Return the name of the currently loaded world."
  12327. Category: General
  12328. @e
  12329. worldToModel
  12330. Left Argument: object
  12331. Right Argument: worldPos
  12332. Description: "Converts position from world space to object model space."
  12333. Category: General
  12334. @e
  12335. worldToModelVisual
  12336. Left Argument: object
  12337. Right Argument: worldPos
  12338. Description: "Converts position from world space to object model space in render time."
  12339. Category: General
  12340. @e
  12341. worldToScreen
  12342. Left Argument: position
  12343. Description: "Converts position in world space into screen (UI) space."
  12344. Category: General
  12345. @e
Add Comment
Please, Sign In to add comment