Guest User

Untitled

a guest
Jun 6th, 2015
404
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 169.57 KB | None | 0 0
  1. <funcs>
  2. <group name="Audio functions">
  3. <function name="playSoundFrontEnd" ret="bool">
  4. <param name="int sound" type="required" />
  5. <description>This function plays a frontend sound for the specified player.</description>
  6. </function>
  7. <function name="getRadioChannel" ret="int">
  8. <description>This function retrieves the ID of the currently active radio channel.</description>
  9. </function>
  10. <function name="getRadioChannelName" ret="string">
  11. <param name="int id" type="required" />
  12. <description>This function gets the given radio channel name.</description>
  13. </function>
  14. <function name="getSoundLength" ret="int">
  15. <param name="element theSound" type="required" />
  16. <description>This function is used to return the playback length of the specified sound element.</description>
  17. </function>
  18. <function name="getSoundMaxDistance" ret="int">
  19. <param name="element sound" type="required" />
  20. <description>Gets a custom sound max distance at which the sound stops.</description>
  21. </function>
  22. <function name="getSoundMinDistance" ret="int">
  23. <param name="element sound" type="required" />
  24. <description>Gets a custom sound Minimum distance at which the sound stops getting louder.</description>
  25. </function>
  26. <function name="getSoundPosition" ret="int">
  27. <param name="element theSound" type="required" />
  28. <description>This function is used to return the current seek position of the specified sound element.</description>
  29. </function>
  30. <function name="getSoundVolume" ret="float">
  31. <param name="element theSound" type="required" />
  32. <description>This function is used to return the volume level of the specified sound element.</description>
  33. </function>
  34. <function name="isSoundPaused" ret="bool">
  35. <param name="element theSound" type="required" />
  36. <description>This function is used to return the current pause state of the specified sound element.</description>
  37. </function>
  38. <function name="playSound" ret="element">
  39. <param name="string soundPath" type="required" />
  40. <param name="bool looped" type="optional" />
  41. <description>Creates a sound element and plays it immediately after creation for the local player. Supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT and S3M.</description>
  42. </function>
  43. <function name="playSound3D" ret="element">
  44. <param name="string soundPath" type="required" />
  45. <param name="float x" type="required" />
  46. <param name="float y" type="required" />
  47. <param name="float z" type="required" />
  48. <param name="bool looped" type="optional" />
  49. <description>Creates a sound element in the GTA world and plays it immediately after creation for the local player. setElementPosition can be used to move the sound element around after it has been created. Supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT and S3M.</description>
  50. </function>
  51. <function name="setRadioChannel" ret="bool">
  52. <param name="int ID" type="required" />
  53. <description>This function sets the currently active radio channel.</description>
  54. </function>
  55. <function name="setSoundMaxDistance" ret="bool">
  56. <param name="element sound" type="required" />
  57. <param name="int distance" type="required" />
  58. <description>Sets a custom sound max distance at which the sound stops.</description>
  59. </function>
  60. <function name="setSoundMinDistance" ret="bool">
  61. <param name="element sound" type="required" />
  62. <param name="int distance" type="required" />
  63. <description>Sets a custom sound Minimum distance at which the sound stops getting louder.</description>
  64. </function>
  65. <function name="setSoundPaused" ret="bool">
  66. <param name="element theSound" type="required" />
  67. <param name="bool paused" type="required" />
  68. <description>This function is used to either pause or unpause the playback of the specified sound element.</description>
  69. </function>
  70. <function name="setSoundPosition" ret="bool">
  71. <param name="element theSound" type="required" />
  72. <param name="int pos" type="required" />
  73. <description>This function is used to change the seek position of the specified sound element.</description>
  74. </function>
  75. <function name="setSoundVolume" ret="bool">
  76. <param name="element theSound" type="required" />
  77. <param name="float volume" type="required" />
  78. <description>This function is used to change the volume level of the specified sound element.</description>
  79. </function>
  80. <function name="stopSound" ret="bool">
  81. <param name="element theSound" type="required" />
  82. <description>Stops the sound playback for specified sound element.</description>
  83. </function>
  84. </group>
  85. <group name="Blip functions">
  86. <function name="createBlip" ret="blip">
  87. <param name="float x" type="required" />
  88. <param name="float y" type="required" />
  89. <param name="float z" type="required" />
  90. <param name="int icon=0" type="optional" />
  91. <param name="int size=2" type="optional" />
  92. <param name="int r=255" type="optional" />
  93. <param name="int g=0" type="optional" />
  94. <param name="int b=0" type="optional" />
  95. <param name="int a=255" type="optional" />
  96. <param name="int ordering=0 *" type="optional" />
  97. <param name="float visibleDistance=99999.0" type="optional" />
  98. <description>This function creates a blip element, which is displayed as an icon on the client's radar.</description>
  99. </function>
  100. <function name="createBlipAttachedTo" ret="blip">
  101. <param name="element elementToAttachTo" type="required" />
  102. <param name="int icon=0" type="optional" />
  103. <param name="int size=2" type="optional" />
  104. <param name="int r=255" type="optional" />
  105. <param name="int g=0" type="optional" />
  106. <param name="int b=0" type="optional" />
  107. <param name="int a=255" type="optional" />
  108. <param name="int ordering=0" type="optional" />
  109. <param name="float visibleDistance=99999.0" type="optional" />
  110. <description>This function creates a blip that is attached to an element. This blip is displayed as an icon on the client's radar and will 'follow' the element that it is attached to around.</description>
  111. </function>
  112. <function name="getBlipColor" ret="int, int, int, int">
  113. <param name="blip theBlip" type="required" />
  114. <description>This function will tell you what color a blip is. This color is only applicable to the default blip icon. All other icons will ignore this.</description>
  115. </function>
  116. <function name="getBlipIcon" ret="int">
  117. <param name="blip theBlip" type="required" />
  118. <description>This function returns the icon a blip currently has.</description>
  119. </function>
  120. <function name="getBlipSize" ret="int">
  121. <param name="blip theBlip" type="required" />
  122. <description>This function gets the size of a blip.</description>
  123. </function>
  124. <function name="setBlipColor" ret="bool">
  125. <param name="blip theBlip" type="required" />
  126. <param name="int red" type="required" />
  127. <param name="int green" type="required" />
  128. <param name="int blue" type="required" />
  129. <param name="int alpha" type="required" />
  130. <description>This function will let you change the color of a blip. This color is only applicable to the default blip icon. All other icons will ignore this.</description>
  131. </function>
  132. <function name="setBlipIcon" ret="bool">
  133. <param name="blip theBlip" type="required" />
  134. <param name="int icon" type="required" />
  135. <description>This function sets the icon for an existing blip element.</description>
  136. </function>
  137. <function name="setBlipSize" ret="bool">
  138. <param name="blip theBlip" type="required" />
  139. <param name="int iconSize" type="required" />
  140. <description>This function sets the size of a blip's icon.</description>
  141. </function>
  142. <function name="getBlipOrdering" ret="int">
  143. <param name="blip theBlip" type="required" />
  144. <description>This function gets the Z ordering value of a blip. The Z ordering determines if a blip appears on top of or below other blips. Blips with a higher Z ordering value appear on top of blips with a lower value. The default value for all blips is 0.</description>
  145. </function>
  146. <function name="setBlipOrdering" ret="bool">
  147. <param name="blip theBlip" type="required" />
  148. <param name="int ordering" type="required" />
  149. <description>This function sets the Z ordering of a blip. It allows you to make a blip appear on top of or below other blips.</description>
  150. </function>
  151. </group>
  152. <group name="Camera functions">
  153. <function name="fadeCamera" ret="bool">
  154. <param name="bool fadeIn" type="required" />
  155. <param name="float timeToFade=1.0" type="optional" />
  156. <param name="int red=0" type="optional" />
  157. <param name="int green=0" type="optional" />
  158. <param name="int blue=0" type="optional" />
  159. <description>This function will fade the local player's camera to a color or back to normal over a specified time period. This will also affect the sound volume for the player (50% faded=50% volume, full fade=no sound). For clientside scripts you can perform 2 fade ins or fade outs in a row, but for serverside scripts you must use one then the other.</description>
  160. </function>
  161. <function name="getCameraTarget" ret="element">
  162. <description>This function returns an element that corresponds to the current target of the specified player's camera (i.e. what it is following).</description>
  163. </function>
  164. <function name="setCameraTarget" ret="bool">
  165. <param name="element target" type="required" />
  166. <description>This function allows you to set the local player's camera to follow other elements instead.</description>
  167. </function>
  168. <function name="getCameraInterior" ret="int">
  169. <description>Returns the interior of the local camera (independent of the interior of the local player).</description>
  170. </function>
  171. <function name="getCameraMatrix" ret="float, float, float, float, float, float, float, float">
  172. <description>This function gets the position of the camera and the position of the point it is facing.</description>
  173. </function>
  174. <function name="setCameraInterior" ret="bool">
  175. <param name="int, interior" type="required" />
  176. <description>Sets the interior of the local camera. Only the interior of the camera is changed, the local player stays in the interior he was in.</description>
  177. </function>
  178. <function name="setCameraMatrix" ret="bool">
  179. <param name="float positionX" type="required" />
  180. <param name="float positionY" type="required" />
  181. <param name="float positionZ" type="required" />
  182. <param name="float lookAtX" type="optional" />
  183. <param name="float lookAtY" type="optional" />
  184. <param name="float lookAtZ" type="optional" />
  185. <param name="float roll=0" type="optional" />
  186. <param name="float fov=70" type="optional" />
  187. <description>This function sets the camera's position and direction. The first three arguments are the point at which the camera lies, the last three are the point the camera faces (or the point it "looks at").</description>
  188. </function>
  189. </group>
  190. <group name="Clothes and body functions">
  191. <function name="addPedClothes" ret="bool">
  192. <param name="ped thePed" type="required" />
  193. <param name="string clothesTexture" type="required" />
  194. <param name="string clothesModel" type="required" />
  195. <param name="int clothesType" type="required" />
  196. <description>This function is used to set the current clothes of a certain type on a ped. It can only be used on peds with the CJ skin (id 0).</description>
  197. </function>
  198. <function name="getBodyPartName" ret="string">
  199. <param name="int bodyPartID" type="required" />
  200. <description>This function is used to get the name of a body part on a player.</description>
  201. </function>
  202. <function name="getClothesByTypeIndex" ret="string, string">
  203. <param name="int clothesType" type="required" />
  204. <param name="int clothesIndex" type="required" />
  205. <description>This function is used to get the texture and model of clothes by the clothes type and index.</description>
  206. </function>
  207. <function name="getClothesTypeName" ret="string">
  208. <param name="int clothesType" type="required" />
  209. <description>This function is used to get the name of a certain clothes type.</description>
  210. </function>
  211. <function name="getPedClothes" ret="string, string">
  212. <param name="ped thePed" type="required" />
  213. <param name="int clothesType" type="required" />
  214. <description>This function is used to get the current clothes texture and model of a certain type on a ped.</description>
  215. </function>
  216. <function name="getTypeIndexFromClothes" ret="int, int">
  217. <param name="string clothesTexture" type="required" />
  218. <param name="string clothesModel" type="required" />
  219. <description>This function is used to get the clothes type and index from the texture and model.</description>
  220. </function>
  221. <function name="removePedClothes" ret="bool">
  222. <param name="ped thePed" type="required" />
  223. <param name="int clothesType" type="required" />
  224. <param name="string clothesTexture" type="optional" />
  225. <param name="string clothesModel" type="optional" />
  226. <description>This function is used to remove the current clothes of a certain type on a ped. It will remove them if the clothesTexture and clothesModel aren't specified, or if they match the current clothes on that slot.</description>
  227. </function>
  228. </group>
  229. <group name="Collision shape functions">
  230. <function name="createColCircle" ret="colshape">
  231. <param name="float fX" type="required" />
  232. <param name="float fY" type="required" />
  233. <param name="float radius" type="required" />
  234. <description>This function creates a collision circle. This is a shape that has a position and a radius and infinite height that you can use to detect a player's presence. Events will be triggered when a player enters or leaves it.</description>
  235. </function>
  236. <function name="createColCuboid" ret="colshape">
  237. <param name="float fX" type="required" />
  238. <param name="float fY" type="required" />
  239. <param name="float fZ" type="required" />
  240. <param name="float fWidth" type="required" />
  241. <param name="float fDepth" type="required" />
  242. <param name="float fHeight" type="required" />
  243. <description>This function creates a collision cuboid. This is a shape that has a position, width, depth and height. See Wikipedia for a definition of a cuboid. The XYZ of the col starts at the southwest bottom corner of the shape.</description>
  244. </function>
  245. <function name="createColRectangle" ret="colshape">
  246. <param name="float fX" type="required" />
  247. <param name="float fY" type="required" />
  248. <param name="float fWidth" type="required" />
  249. <param name="float fDepth" type="required" />
  250. <description>This function creates a collision rectangle. This is a shape that has a position and a width and a depth. See Rectangle for a definition of a rectangle. XY marks on the south west corner of the colshape.</description>
  251. </function>
  252. <function name="createColSphere" ret="colshape">
  253. <param name="float fX" type="required" />
  254. <param name="float fY" type="required" />
  255. <param name="float fZ" type="required" />
  256. <param name="float fRadius" type="required" />
  257. <description>This function creates a collision sphere. This is a shape that has a position and a radius. See Wikipedia for a definition of a sphere.</description>
  258. </function>
  259. <function name="createColTube" ret="colshape">
  260. <param name="float fX" type="required" />
  261. <param name="float fY" type="required" />
  262. <param name="float fZ" type="required" />
  263. <param name="float fRadius" type="required" />
  264. <param name="float fHeight" type="required" />
  265. <description>This function creates a collision tube. This is a shape that has a position and a 2D (X/Y) radius and a height. See Tube for a definition of a tube. A tube is similar to a colcircle, except that it has a limited height, this means you can limit the distance above the position defined by (fX, fY, fZ) that the collision is detected.</description>
  266. </function>
  267. <function name="createColPolygon" ret="colshape">
  268. <param name="float fX" type="required" />
  269. <param name="float fY" type="required" />
  270. <param name="float fX1" type="required" />
  271. <param name="float fY1" type="required" />
  272. <param name="float fX2" type="required" />
  273. <param name="float fY2" type="required" />
  274. <param name="float fX3" type="required" />
  275. <param name="float fY3" type="required" />
  276. <param name="..." type="required" />
  277. <description>This function creates a collision polygon. See Wikipedia for a definition of a polygon. The first set of X Y of this shape is not part of the colshape bounds, so can set anywhere in the game world, however for performance, place it somewhere within the polygon. It should be noted this shape is 2D. There should be at least 3 bound points set.</description>
  278. </function>
  279. </group>
  280. <group name="Cursor functions">
  281. <function name="getCursorPosition" ret="float, float, float, float, float">
  282. <description>This function gets the current position of the mouse cursor.</description>
  283. </function>
  284. <function name="isCursorShowing" ret="bool">
  285. <description>This function is used to determine whether or not the local player's cursor is showing.</description>
  286. </function>
  287. <function name="showCursor" ret="bool">
  288. <param name="bool show" type="required" />
  289. <param name="bool toggleControls=true" type="optional" />
  290. <description>This function is used to show or hide the local player's cursor.</description>
  291. </function>
  292. </group>
  293. <group name="Drawing functions">
  294. <function name="dxDrawImage" ret="bool">
  295. <param name="float posX" type="required" />
  296. <param name="float posY" type="required" />
  297. <param name="float width" type="required" />
  298. <param name="float height" type="required" />
  299. <param name="string filepath" type="required" />
  300. <param name="float rotation=0" type="optional" />
  301. <param name="float rotationCenterOffsetX=0" type="optional" />
  302. <param name="float rotationCenterOffsetY=0" type="optional" />
  303. <param name="int color=white" type="optional" />
  304. <param name="bool postGUI=false" type="optional" />
  305. <description>Draws an image on the screen for a single frame. In order for the image to stay visible continuously, you need to call this function with the same parameters on each frame update (see onClientRender).</description>
  306. </function>
  307. <function name="dxDrawLine" ret="bool">
  308. <param name="int startX" type="required" />
  309. <param name="int startY" type="required" />
  310. <param name="int endX" type="required" />
  311. <param name="int endY" type="required" />
  312. <param name="int color" type="required" />
  313. <param name="float width=1" type="optional" />
  314. <param name="bool postGUI=false" type="optional" />
  315. <description>This function draws a 2D line across the screen - rendered for one frame. This should be used in conjunction with onClientRender in order to display continuously.</description>
  316. </function>
  317. <function name="dxDrawLine3D" ret="bool">
  318. <param name="float startX" type="required" />
  319. <param name="float startY" type="required" />
  320. <param name="float startZ" type="required" />
  321. <param name="float endX" type="required" />
  322. <param name="float endY" type="required" />
  323. <param name="float endZ" type="required" />
  324. <param name="int color" type="required" />
  325. <param name="int width" type="optional" />
  326. <param name="bool postGUI" type="optional" />
  327. <param name="float zBuffer" type="optional" />
  328. <description>This function draws a 3D line between two points in the 3D world - rendered for one frame. This should be used in conjunction with onClientRender in order to display continuously.</description>
  329. </function>
  330. <function name="dxDrawRectangle" ret="bool">
  331. <param name="int startX" type="required" />
  332. <param name="startY" type="required" />
  333. <param name="float width" type="required" />
  334. <param name="float height" type="required" />
  335. <param name="int color=white" type="optional" />
  336. <param name="bool postGUI=false" type="optional" />
  337. <description>This function draws a 2D rectangle across the screen - rendered for one frame. This should be used in conjunction with onClientRender in order to display continuously.</description>
  338. </function>
  339. <function name="dxDrawText" ret="bool">
  340. <param name="string text" type="required" />
  341. <param name="int left" type="required" />
  342. <param name="int top" type="required" />
  343. <param name="int right=left" type="optional" />
  344. <param name="int bottom=top" type="optional" />
  345. <param name="int color=white" type="optional" />
  346. <param name="float scale=1" type="optional" />
  347. <param name="string font=default" type="optional" />
  348. <param name="string alignX=left" type="optional" />
  349. <param name="string alignY=top" type="optional" />
  350. <param name="bool clip=false" type="optional" />
  351. <param name="bool wordBreak=false" type="optional" />
  352. <param name="bool postGUI" type="optional" />
  353. <description>Draws a string of text on the screen for one frame. In order for the text to stay visible continuously, you need to call this function with the same parameters on each frame update (see onClientRender).</description>
  354. </function>
  355. <function name="dxGetFontHeight" ret="int">
  356. <param name="float scale=1" type="optional" />
  357. <param name="string font=default" type="optional" />
  358. <description>This function retrieves the theoretical height of a certain piece of text, if it were to be drawn using dxDrawText.</description>
  359. </function>
  360. <function name="dxGetTextWidth" ret="float">
  361. <param name="string text" type="required" />
  362. <param name="float scale=1" type="optional" />
  363. <param name="string font=default" type="optional" />
  364. <description>This function retrieves the theoretical width of a certain piece of text, if it were to be drawn using dxDrawText.</description>
  365. </function>
  366. </group>
  367. <group name="Effects functions">
  368. <function name="fxAddBlood" ret="bool">
  369. <param name="float posX" type="required" />
  370. <param name="float posY" type="required" />
  371. <param name="float posZ" type="required" />
  372. <param name="float dirX" type="required" />
  373. <param name="float dirY" type="required" />
  374. <param name="float dirZ" type="required" />
  375. <param name="int count=1" type="optional" />
  376. <param name="float brightness=1.0" type="optional" />
  377. <description>Creates a blood splatter particle effect.</description>
  378. </function>
  379. <function name="fxAddBulletImpact" ret="bool">
  380. <param name="float posX" type="required" />
  381. <param name="float posY" type="required" />
  382. <param name="float posZ" type="required" />
  383. <param name="float dirX" type="required" />
  384. <param name="float dirY" type="required" />
  385. <param name="float dirZ" type="required" />
  386. <param name="int smokeSize=1" type="optional" />
  387. <param name="int sparkCount=1" type="optional" />
  388. <param name="float smokeIntensity=1.0" type="optional" />
  389. <description>Creates a bullet impact particle effect, consisting of a small smoke cloud and a number of sparks.</description>
  390. </function>
  391. <function name="fxAddBulletSplash" ret="bool">
  392. <param name="float posX" type="required" />
  393. <param name="float posY" type="required" />
  394. <param name="float posZ" type="required" />
  395. <description>This function creates a bullet splash particle effect, normally created when shooting into water.</description>
  396. </function>
  397. <function name="fxAddDebris" ret="bool">
  398. <param name="float posX" type="required" />
  399. <param name="float posY" type="required" />
  400. <param name="float posZ" type="required" />
  401. <param name="int colorR=255" type="optional" />
  402. <param name="int colorG=0" type="optional" />
  403. <param name="int colorB=0" type="optional" />
  404. <param name="int colorA=255" type="optional" />
  405. <param name="float scale=1.0" type="optional" />
  406. <param name="int count=1" type="optional" />
  407. <description>Creates a debris particle effect (e.g. bits that fly off a car when ramming a wall).</description>
  408. </function>
  409. <function name="fxAddFootSplash" ret="bool">
  410. <param name="float posX" type="required" />
  411. <param name="float posY" type="required" />
  412. <param name="float posZ" type="required" />
  413. <description>This function creates a foot splash particle effect, normally created when walking into water.</description>
  414. </function>
  415. <function name="fxAddGlass" ret="bool">
  416. <param name="float posX" type="required" />
  417. <param name="float posY" type="required" />
  418. <param name="float posZ" type="required" />
  419. <param name="int colorR=255" type="optional" />
  420. <param name="int colorG=0" type="optional" />
  421. <param name="int colorB=0" type="optional" />
  422. <param name="int colorA=255" type="optional" />
  423. <param name="float scale=1.0" type="optional" />
  424. <param name="int count=1" type="optional" />
  425. <description>This function creates a glass particle effect.</description>
  426. </function>
  427. <function name="fxAddGunshot" ret="bool">
  428. <param name="float posX" type="required" />
  429. <param name="float posY" type="required" />
  430. <param name="float posZ" type="required" />
  431. <param name="float dirX" type="required" />
  432. <param name="float dirY" type="required" />
  433. <param name="float dirZ" type="required" />
  434. <param name="bool includeSparks=true" type="optional" />
  435. <description>This function creates a gunshot particle effect.</description>
  436. </function>
  437. <function name="fxAddPunchImpact" ret="bool">
  438. <param name="float posX" type="required" />
  439. <param name="float posY" type="required" />
  440. <param name="float posZ" type="required" />
  441. <param name="float dirX" type="required" />
  442. <param name="float dirY" type="required" />
  443. <param name="float dirZ" type="required" />
  444. <description>Creates a punch impact particle effect (a small dust cloud).</description>
  445. </function>
  446. <function name="fxAddSparks" ret="bool">
  447. <param name="float posX" type="required" />
  448. <param name="float posY" type="required" />
  449. <param name="float posZ" type="required" />
  450. <param name="float dirX" type="required" />
  451. <param name="float dirY" type="required" />
  452. <param name="float dirZ" type="required" />
  453. <param name="float force=1" type="optional" />
  454. <param name="int count=1" type="optional" />
  455. <param name="float acrossLineX=0" type="optional" />
  456. <param name="float acrossLineY=0" type="optional" />
  457. <param name="float acrossLineZ=0" type="optional" />
  458. <param name="bool blur=false" type="optional" />
  459. <param name="float spread=1" type="optional" />
  460. <param name="float life=1" type="optional" />
  461. <description>Creates a number of sparks originating from a point or along a line.</description>
  462. </function>
  463. <function name="fxAddTankFire" ret="bool">
  464. <param name="float posX" type="required" />
  465. <param name="float posY" type="required" />
  466. <param name="float posZ" type="required" />
  467. <param name="float dirX" type="required" />
  468. <param name="float dirY" type="required" />
  469. <param name="float dirZ" type="required" />
  470. <description>This function creates a tank firing particle effect.</description>
  471. </function>
  472. <function name="fxAddTyreBurst" ret="bool">
  473. <param name="float posX" type="required" />
  474. <param name="float posY" type="required" />
  475. <param name="float posZ" type="required" />
  476. <param name="float dirX" type="required" />
  477. <param name="float dirY" type="required" />
  478. <param name="float dirZ" type="required" />
  479. <description>Creates a tyre burst particle effect (a small white smoke puff).</description>
  480. </function>
  481. <function name="fxAddWaterHydrant" ret="bool">
  482. <param name="float posX" type="required" />
  483. <param name="float posY" type="required" />
  484. <param name="float posZ" type="required" />
  485. <description>This function creates a water hydrant particle effect.</description>
  486. </function>
  487. <function name="fxAddWaterSplash" ret="bool">
  488. <param name="float posX" type="required" />
  489. <param name="float posY" type="required" />
  490. <param name="float posZ" type="required" />
  491. <description>This function creates a water splash particle effect.</description>
  492. </function>
  493. <function name="fxAddWood" ret="bool">
  494. <param name="float posX" type="required" />
  495. <param name="float posY" type="required" />
  496. <param name="float posZ" type="required" />
  497. <param name="float dirX" type="required" />
  498. <param name="float dirY" type="required" />
  499. <param name="float dirZ" type="required" />
  500. <param name="int count=1" type="optional" />
  501. <param name="float brightness=1.0" type="optional" />
  502. <description>Creates a wood splinter particle effect.</description>
  503. </function>
  504. </group>
  505. <group name="Element functions">
  506. <function name="createElement" ret="element">
  507. <param name="string elementType" type="required" />
  508. <param name="string elementID" type="optional" />
  509. <description>This function is used to create a new dummy element in the element tree which do not necessarily represent an entity within the San Andreas world. A common use for this function is for creating custom elements, such as a Flag or a Base.</description>
  510. </function>
  511. <function name="destroyElement" ret="bool">
  512. <param name="element elementToDestroy" type="required" />
  513. <description>This function destroys an element and all elements withinn it in the hierarchy (its children, the children of those children etc). Player elements cannot be destroyed using this function. A player can only be removed from the hierarchy when they quit or are kicked. The root element also cannot be destroyed, however, passing the root as an argument will wipe all elements from the server, except for the players and clients, which will become direct descendants of the root node, and other elements that cannot be destroyed, such as resource root elements.</description>
  514. </function>
  515. <function name="getAttachedElements" ret="table">
  516. <param name="element theElement" type="required" />
  517. <description>This function returns a table of all the elements attached to the specified element</description>
  518. </function>
  519. <function name="getElementAttachedTo" ret="element">
  520. <param name="element theElement" type="required" />
  521. <description>This function determines the element that the specified element is attached to.</description>
  522. </function>
  523. <function name="getElementBoundingBox" ret="float, float, float, float, float, float">
  524. <param name="element theElement" type="required" />
  525. <description>This function returns the minimum and maximum coordinates of an element's bounding box.</description>
  526. </function>
  527. <function name="getElementByID" ret="element">
  528. <param name="string id" type="required" />
  529. <description>This function returns an element from the specified ID. If more than one element with the same ID exists, only the first one in the order it appears in the XML tree will be returned by this function.</description>
  530. </function>
  531. <function name="getElementChild" ret="element">
  532. <param name="element parent" type="required" />
  533. <param name="int index" type="required" />
  534. <description>This function returns one of the child elements of a given parent element. The child element is selected by its index (0 for the first child, 1 for the second and so on).</description>
  535. </function>
  536. <function name="getElementChildren" ret="table">
  537. <param name="element parent" type="required" />
  538. <description>This function is used to retrieve a list of the child elements of a given parent element.</description>
  539. </function>
  540. <function name="getElementChildrenCount" ret="int">
  541. <param name="element parent" type="required" />
  542. <description>This function returns the number of children an element has.</description>
  543. </function>
  544. <function name="getElementData" ret="var">
  545. <param name="element theElement" type="required" />
  546. <param name="string key" type="required" />
  547. <param name="inherit=true" type="optional" />
  548. <description>This function retrieves element data attached to an element under a certain key.</description>
  549. </function>
  550. <function name="getElementDimension" ret="int">
  551. <param name="element theElement" type="required" />
  552. <description>This function allows you to retrieve the dimension of any element. The dimension determines what/who the element is visible to.</description>
  553. </function>
  554. <function name="getElementDistanceFromCentreOfMassToBaseOfModel" ret="float">
  555. <param name="element theElement" type="required" />
  556. <description>This function is used to retrieve the distance between a element's centre of mass to the base of the model. This can be used to calculate the position the element has to be set to, to have it on ground level.</description>
  557. </function>
  558. <function name="getElementHealth" ret="float">
  559. <param name="element theElement" type="required" />
  560. <description>This function returns the current health for the specified element. This can be a player or a vehicle.</description>
  561. </function>
  562. <function name="getElementID" ret="string">
  563. <param name="element theElement" type="required" />
  564. <description>This function gets the ID of an element. This is the "id" attribute of the element and is a string, NOT a number like a model ID, weapons ID or similar.</description>
  565. </function>
  566. <function name="getElementInterior" ret="int">
  567. <param name="element theElement" type="required" />
  568. <description>This function allows you to retrieve the interior of any element. An interior is the current loaded place, 0 being outside.</description>
  569. </function>
  570. <function name="getElementParent" ret="element">
  571. <param name="element theElement" type="required" />
  572. <description>This function is used to determine the parent of an element.</description>
  573. </function>
  574. <function name="getElementPosition" ret="float, float, float">
  575. <param name="element theElement" type="required" />
  576. <description>The getElementPosition function allows you to retrieve the position coordinates of an element. This can be any real world element, including:</description>
  577. </function>
  578. <function name="getElementRadius" ret="float">
  579. <param name="element theElement" type="required" />
  580. <description>This function gets the radius from a element.</description>
  581. </function>
  582. <function name="getElementsByType" ret="table">
  583. <param name="string type" type="required" />
  584. <param name="element startat=getRootElement()" type="optional" />
  585. <description>This function is used to retrieve a list of all elements of the specified type. This can be useful, as it disregards where in the element tree it is. It can be used with either the built in types (listed below) or with any custom type used in a .map file. For example, if there is an element of type "flag" (e.g. &lt;flag /&gt;) in the .map file, the using "flag" as the type argument would find it.</description>
  586. </function>
  587. <function name="getElementsWithinColShape" ret="table">
  588. <param name="colshape shape" type="required" />
  589. <param name="string elemType" type="optional" />
  590. <description>This function is used to retrieve a list of all elements in a colshape, of the specified type.</description>
  591. </function>
  592. <function name="getElementType" ret="string">
  593. <param name="element theElement" type="required" />
  594. <description>This function is used to retrieve the type of an element.</description>
  595. </function>
  596. <function name="getElementVelocity" ret="float, float, float">
  597. <param name="element theElement" type="required" />
  598. <description>This function returns three floats containing the velocity (movement speeds) along the X, Y, and Z axis respectively. This means that velocity values can be positive and negative for each axis.</description>
  599. </function>
  600. <function name="getRootElement" ret="element">
  601. <description>This function returns the root node of the element tree, called root. This node contains every other element: all resource root elements, players and remote clients. It is never destroyed and cannot be destroyed using destroyElement.</description>
  602. </function>
  603. <function name="isElement" ret="bool">
  604. <param name="var theValue" type="required" />
  605. <description>This function checks if a value is an element or not.</description>
  606. </function>
  607. <function name="isElementAttached" ret="bool">
  608. <param name="element theElement" type="required" />
  609. <description>This functions checks whether or not an element is attached to another element.</description>
  610. </function>
  611. <function name="isElementLocal" ret="bool">
  612. <param name="element theElement" type="required" />
  613. <description>This function checks whether a clientside element is local to the client (doesn't exist in the server) or not.</description>
  614. </function>
  615. <function name="isElementOnScreen" ret="bool">
  616. <param name="element theElement" type="required" />
  617. <description>This function checks wether an element is on the screen.</description>
  618. </function>
  619. <function name="isElementStreamable" ret="bool">
  620. <param name="element theElement" type="required" />
  621. <description>This function checks whether an element is streamable as set by setElementStreamable or not.</description>
  622. </function>
  623. <function name="isElementStreamedIn" ret="bool">
  624. <param name="element theElement" type="required" />
  625. <description>This function checks whether an element is currently streamed in (not virtualized) and are actual GTA objects in the world. You can force an element to be streamed in using setElementStreamable.</description>
  626. </function>
  627. <function name="isElementWithinColShape" ret="bool">
  628. <param name="element theElement" type="required" />
  629. <param name="colshape theShape" type="required" />
  630. <description>This function is used to determine if an element is within a collision shape.</description>
  631. </function>
  632. <function name="setElementAlpha" ret="bool">
  633. <param name="element theElement" type="required" />
  634. <param name="int alpha" type="required" />
  635. <description>This function sets the alpha(transparency) value for the specified element. This can be a player or a vehicle.</description>
  636. </function>
  637. <function name="setElementCollisionsEnabled" ret="bool">
  638. <param name="element theElement" type="required" />
  639. <param name="bool enabled" type="required" />
  640. <description>This function can disable or enable an element's collisions. An element without collisions does not interact with the physical environment and remains static.</description>
  641. </function>
  642. <function name="setElementData" ret="bool">
  643. <param name="element theElement" type="required" />
  644. <param name="string key" type="required" />
  645. <param name="var value" type="optional" />
  646. <param name="bool synchronize" type="optional" />
  647. <description>This function stores element data under a certain key, attached to an element. Element data set using this is then synced with all clients or the server (depending if used client-side or not). As such you should avoid passing data that is not able to be synced into this function (i.e. xmlnodes, acls, aclgroups etc.) Server-created elements are able to be synced.</description>
  648. </function>
  649. <function name="setElementDimension" ret="bool">
  650. <param name="element theElement" type="required" />
  651. <param name="int dimension" type="required" />
  652. <description>This function allows you to set the dimension of any element. The dimension determines what/who the element is visible to.</description>
  653. </function>
  654. <function name="setElementHealth" ret="bool">
  655. <param name="element theElement" type="required" />
  656. <param name="float newHealth" type="required" />
  657. <description>This function sets the health for the specified element. This can be a player or a vehicle.</description>
  658. </function>
  659. <function name="setElementInterior" ret="bool">
  660. <param name="element theElement" type="required" />
  661. <param name="int, interior" type="required" />
  662. <param name="float x" type="optional" />
  663. <param name="float y" type="optional" />
  664. <param name="float z" type="optional" />
  665. <description>This function allows you to set the interior of any element. An interior is the current loaded place, 0 being outside.</description>
  666. </function>
  667. <function name="setElementParent" ret="bool">
  668. <param name="element theElement" type="required" />
  669. <param name="element parent" type="required" />
  670. <description>This function is used for setting an element as the parent of another element.</description>
  671. </function>
  672. <function name="setElementPosition" ret="bool">
  673. <param name="element theElement" type="required" />
  674. <param name="float x" type="required" />
  675. <param name="float y" type="required" />
  676. <param name="float z" type="required" />
  677. <param name="bool warp=true" type="optional" />
  678. <description>This function sets the position of an element to the specified coordinates.</description>
  679. </function>
  680. <function name="setElementStreamable" ret="bool">
  681. <param name="element theElement" type="required" />
  682. <param name="bool streamable" type="required" />
  683. <description>This function can be used to disable streaming for an element. This will make sure the element is not virtualized (streamed out from GTA) when the player moves far away from it. If the limit for that element type is reached, the furthest away elements that are streamable will be streamed out until it's below the limit.</description>
  684. </function>
  685. <function name="setElementVelocity" ret="bool">
  686. <param name="element theElement" type="required" />
  687. <param name="float speedX" type="required" />
  688. <param name="float speedY" type="required" />
  689. <param name="float speedZ" type="required" />
  690. <description>This function sets the velocity (movement speeds) along each axis, for an element.</description>
  691. </function>
  692. <function name="attachElements" ret="bool">
  693. <param name="element theElement" type="required" />
  694. <param name="element theAttachToElement" type="required" />
  695. <param name="float xPosOffset" type="optional" />
  696. <param name="float yPosOffset" type="optional" />
  697. <param name="float zPosOffset" type="optional" />
  698. <param name="float xRotOffset" type="optional" />
  699. <param name="float yRotOffset" type="optional" />
  700. <param name="float zRotOffset" type="optional" />
  701. <description>This function attaches one element to another, so that the first one follows the second whenever it moves.</description>
  702. </function>
  703. <function name="detachElements" ret="bool">
  704. <param name="element theElement" type="required" />
  705. <param name="element theAttachToElement" type="optional" />
  706. <description>This function detaches attached elements from one another.</description>
  707. </function>
  708. <function name="getElementColShape" ret="colshape">
  709. <param name="element theElement" type="required" />
  710. <description>This function is used to get element's colshape.</description>
  711. </function>
  712. <function name="getElementMatrix" ret="table">
  713. <param name="element theElement" type="required" />
  714. <description>This function gets an element's transform matrix. This contains 16 float values that multiplied to a point will give you the point transformed. It is most useful for matrix calculations such as calculating offsets. For further information, please refer to a tutorial of matrices in computer graphics programming.</description>
  715. </function>
  716. <function name="getElementModel" ret="int">
  717. <param name="element theElement" type="required" />
  718. <description>Returns the model ID of a given element. This can be a player/ped skin, a pickup model, an object model or a vehicle model.</description>
  719. </function>
  720. <function name="getElementRotation" ret="float, float, float">
  721. <param name="element theElement" type="required" />
  722. <description>Retrieve the rotation of elements.</description>
  723. </function>
  724. <function name="isElementInWater" ret="bool">
  725. <param name="element theElement" type="required" />
  726. <description>This function checks whether an element is submerged in water.</description>
  727. </function>
  728. <function name="isElementSyncer" ret="bool">
  729. <param name="element theElement" type="required" />
  730. <description>This function checks whether an element is a syncer or not. Accepted elements are ped's and vehicle's.</description>
  731. </function>
  732. <function name="setElementModel" ret="bool">
  733. <param name="element theElement" type="required" />
  734. <param name="int model" type="required" />
  735. <description>Sets the model of a given element. This allows you to change the model of a player (or ped), a vehicle or an object.</description>
  736. </function>
  737. <function name="setElementRotation" ret="bool">
  738. <param name="element theElement" type="required" />
  739. <param name="float rotX" type="required" />
  740. <param name="float rotY" type="required" />
  741. <param name="float rotZ" type="required" />
  742. <description>Sets the rotation of elements according to the world (does not work with players that are on the ground).</description>
  743. </function>
  744. </group>
  745. <group name="Engine functions">
  746. <function name="engineImportCOL" ret="bool">
  747. <param name="col" type="required" />
  748. <param name="int model_id" type="required" />
  749. <description>This function imports a RenderWare Collision into the model identified by the model id. This function does not replace the collisions of all models of this type in-game.</description>
  750. </function>
  751. <function name="engineImportTXD" ret="bool">
  752. <param name="txd texture" type="required" />
  753. <param name="int model_id" type="required" />
  754. <description>This function imports (adds) a loaded RenderWare Texture Dictionary into a specific model. This is necessary in order for the DFF loader to find any new textures. Please call this function before loading the DFF model file, in order to allow the DFF loading process to find the new textures.</description>
  755. </function>
  756. <function name="engineLoadCOL" ret="col">
  757. <param name="string col_file" type="required" />
  758. <description>This function loads a RenderWare Collision (COL 1/2/3) file into GTA. The collisions can then be used to provide collisions for in-game objects.</description>
  759. </function>
  760. <function name="engineLoadDFF" ret="dff">
  761. <param name="string dff_file" type="required" />
  762. <param name="int model_id" type="required" />
  763. <description>This function loads a RenderWare Model (DFF) file into GTA.</description>
  764. </function>
  765. <function name="engineLoadTXD" ret="txd">
  766. <param name="string txd_file" type="required" />
  767. <description>This function loads a RenderWare Texture Dictionary (TXD) file into GTA. The texture dictionary can then be used to provide textures.</description>
  768. </function>
  769. <function name="engineReplaceCOL" ret="bool">
  770. <param name="col theCol" type="required" />
  771. <param name="int modelID" type="required" />
  772. <description>This function replaces the collision file of the given model id to the collision file passed. Use engineLoadCOL to load the collision file first.</description>
  773. </function>
  774. <function name="engineReplaceModel" ret="bool">
  775. <param name="dff theModel" type="required" />
  776. <param name="int modelID" type="required" />
  777. <description>This function replaces the given model in the given model ID with the DFF file passed. This function supports vehicles and objects at the moment.</description>
  778. </function>
  779. <function name="engineRestoreCOL" ret="bool">
  780. <param name="int modelID" type="required" />
  781. <description>This function restores the original collision model of the given model ID. Reverses the effect of engineReplaceCOL.</description>
  782. </function>
  783. <function name="engineRestoreModel" ret="bool">
  784. <param name="int modelID" type="required" />
  785. <description>This function restores the visual DFF model of the given model ID. This restores the result of engineReplaceModel.</description>
  786. </function>
  787. <function name="engineSetModelLODDistance" ret="bool">
  788. <param name="int model" type="required" />
  789. <param name="float distance" type="required" />
  790. <description>This function sets a custom LOD distance for any object / model ID. LOD distance is basically the same as draw distance. Objects with high LOD value can be seen from great distances.</description>
  791. </function>
  792. </group>
  793. <group name="Event functions">
  794. <function name="addEvent" ret="bool">
  795. <param name="string eventName" type="required" />
  796. <param name="bool allowRemoteTrigger=false" type="optional" />
  797. <description>This function allows you to register a custom event. Custom events function exactly like the built-in events. See event system for more information on the event system.</description>
  798. </function>
  799. <function name="addEventHandler" ret="bool">
  800. <param name="string eventName" type="required" />
  801. <param name="element attachedTo" type="required" />
  802. <param name="function handlerFunction" type="required" />
  803. <param name="bool getPropagated=true" type="optional" />
  804. <description>This function will add an event handler. An event handler is a function that will be called when the event it's attached to is triggered. See event system for more information on how the event system works.</description>
  805. </function>
  806. <function name="cancelEvent" ret="bool">
  807. <param name="bool cancel" type="optional" />
  808. <param name="string reason" type="optional" />
  809. <description>This function is used to stop the automatic internal handling of events, for example this can be used to prevent an item being given to a player when they walk over a pickup, by canceling the onPickupUse event.</description>
  810. </function>
  811. <function name="removeEventHandler" ret="bool">
  812. <param name="string eventName" type="required" />
  813. <param name="element attachedTo" type="required" />
  814. <param name="function functionVar" type="required" />
  815. <description>This functions removes a handler function from an event, so that the function is not called anymore when the event is triggered. See event system for more information on how the event system works.</description>
  816. </function>
  817. <function name="triggerEvent" ret="bool">
  818. <param name="string eventName" type="required" />
  819. <param name="element baseElement" type="required" />
  820. <param name="var argument1" type="optional" />
  821. <param name="..." type="optional" />
  822. <description>This function will trigger a named event on a specific element in the element tree. See event system for more information on how the event system works.</description>
  823. </function>
  824. <function name="triggerServerEvent" ret="bool">
  825. <param name="string event" type="required" />
  826. <param name="element theElement" type="required" />
  827. <param name="arguments..." type="optional" />
  828. <description>This function triggers an event previously registered on the server. This is the primary means of passing information between the client and the server. Servers have a similar triggerClientEvent function that can do the reverse. You can treat this function as if it was an asynchronous function call, using triggerClientEvent to pass back any returned information if necessary.</description>
  829. </function>
  830. <function name="wasEventCanceled" ret="bool">
  831. <description>This function checks whether or not the currently active event has been canceled. This is mainly useful for custom events created by scripts.</description>
  832. </function>
  833. </group>
  834. <group name="Explosion functions">
  835. <function name="createExplosion" ret="bool">
  836. <param name="float x" type="required" />
  837. <param name="float y" type="required" />
  838. <param name="float z" type="required" />
  839. <param name="int type" type="required" />
  840. <param name="bool makesound=true" type="optional" />
  841. <param name="float camshake=-1.0" type="optional" />
  842. <param name="bool damaging=true" type="optional" />
  843. <description>Creates an explosion of a certain type at a specified point in the world.</description>
  844. </function>
  845. </group>
  846. <group name="Fire functions">
  847. <function name="createFire" ret="bool">
  848. <param name="float x" type="required" />
  849. <param name="float y" type="required" />
  850. <param name="float z" type="required" />
  851. <param name="float size=1.8" type="optional" />
  852. <description>Creates a patch of fire that will spread a bit and die out after a while.</description>
  853. </function>
  854. </group>
  855. <group name="GUI functions">
  856. <function name="guiBringToFront" ret="bool">
  857. <param name="element guiElement" type="required" />
  858. <description>This function brings a GUI element on top of others.</description>
  859. </function>
  860. <function name="guiGetAlpha" ret="int">
  861. <param name="element guiElement" type="required" />
  862. <description>Alpha represents the transparency of a gui element. This function allows retrieval of a gui element's current alpha.</description>
  863. </function>
  864. <function name="guiGetEnabled" ret="bool">
  865. <param name="element guiElement" type="required" />
  866. <description>This function determines if a GUI element is enabled.</description>
  867. </function>
  868. <function name="guiGetFont" ret="string">
  869. <param name="element guiElement" type="required" />
  870. <description>This function is used to get the current font that is used to draw text in GUI elements.</description>
  871. </function>
  872. <function name="guiGetInputEnabled" ret="bool">
  873. <description>This function checks whether user input is focused on the GUI or the game.</description>
  874. </function>
  875. <function name="guiGetPosition" ret="float, float">
  876. <param name="element guiElement" type="required" />
  877. <param name="bool relative" type="required" />
  878. <description>This function allows retrieval of a GUI element's current position, relative to its parent.</description>
  879. </function>
  880. <function name="guiGetProperties" ret="table">
  881. <param name="element guiElement" type="required" />
  882. <description>This function gets a list of the CEGUI property names and values of a GUI element. To find out what the different properties mean, check out the CEGUI properties wiki page.</description>
  883. </function>
  884. <function name="guiGetProperty" ret="string">
  885. <param name="element guiElement" type="required" />
  886. <param name="string property" type="required" />
  887. <description>This function gets the value of a specific CEGUI property of a GUI element. For a list of properties and their meaning, see the CEGUI properties wiki page.</description>
  888. </function>
  889. <function name="guiGetScreenSize" ret="float, float">
  890. <description>This function retrieves the local screen size according to the resolution they are using.</description>
  891. </function>
  892. <function name="guiGetSize" ret="float, float">
  893. <param name="element theElement" type="required" />
  894. <param name="bool relative" type="required" />
  895. <description>This function gets the size of a GUI element.</description>
  896. </function>
  897. <function name="guiGetText" ret="string">
  898. <param name="element guiElement" type="required" />
  899. <description>This function is used to get the text of GUI elements like edit boxes, labels, buttons etc.</description>
  900. </function>
  901. <function name="guiGetVisible" ret="bool">
  902. <param name="element guiElement" type="required" />
  903. <description>This function determines if a GUI element is visible.</description>
  904. </function>
  905. <function name="guiMoveToBack" ret="bool">
  906. <param name="element guiElement" type="required" />
  907. <description>This function moves a GUI element to the very back of all other GUI elements.</description>
  908. </function>
  909. <function name="guiSetAlpha" ret="bool">
  910. <param name="element guielement" type="required" />
  911. <param name="float alpha" type="required" />
  912. <description>This changes the alpha level (the visibleness/transparency) of a GUI element</description>
  913. </function>
  914. <function name="guiSetEnabled" ret="bool">
  915. <param name="element guiElement" type="required" />
  916. <param name="bool enabled" type="required" />
  917. <description>This function enables/disables a GUI element. A disabled GUI element can't be used, gets a gray aspect and doesn't receive any events.</description>
  918. </function>
  919. <function name="guiSetFont" ret="bool">
  920. <param name="element guiElement" type="required" />
  921. <param name="string font" type="required" />
  922. <description>This function sets the font of a GUI element to be used when drawing text.</description>
  923. </function>
  924. <function name="guiSetInputEnabled" ret="bool">
  925. <param name="bool enabled" type="required" />
  926. <description>This function enables or disables input focus for the GUI. This means that any keybinds or MTA binds are overidden so that text can be input into an editbox, for example. In other words, keys such as t and y which activate the chatbox are disabled.</description>
  927. </function>
  928. <function name="guiSetPosition" ret="bool">
  929. <param name="element theElement" type="required" />
  930. <param name="float x" type="required" />
  931. <param name="float y" type="required" />
  932. <param name="bool relative" type="required" />
  933. <description>This function sets the position of a GUI element.</description>
  934. </function>
  935. <function name="guiSetProperty" ret="bool">
  936. <param name="element guiElement" type="required" />
  937. <param name="string property" type="required" />
  938. <param name="string value" type="required" />
  939. <description>This function sets the value of a specific CEGUI property of a GUI element. For a list of properties and their meaning, see the CEGUI properties wiki page.</description>
  940. </function>
  941. <function name="guiSetSize" ret="bool">
  942. <param name="element gui" type="required" />
  943. <param name="float width" type="required" />
  944. <param name="float height" type="required" />
  945. <param name="bool relative" type="required" />
  946. <description>This function sets the dimensions (size) of a GUI element</description>
  947. </function>
  948. <function name="guiSetText" ret="bool">
  949. <param name="element guiElement" type="required" />
  950. <param name="string text" type="required" />
  951. <description>This function sets the text of a GUI element.</description>
  952. </function>
  953. <function name="guiSetVisible" ret="bool">
  954. <param name="element guiElement" type="required" />
  955. <param name="bool state" type="required" />
  956. <description>This function changes the visibility state of a GUI element.</description>
  957. </function>
  958. <function name="isChatBoxInputActive" ret="bool">
  959. <description>This function returns whether the ingame chatbox is being used (accepting chatbox input) or not.</description>
  960. </function>
  961. <function name="isConsoleActive" ret="bool">
  962. <description>This function returns whether the ingame console window is visible or not.</description>
  963. </function>
  964. <function name="isDebugViewActive" ret="bool">
  965. <description>This function returns whether the ingame debug window is visible or not. This is the debugwindow visible using the "debugscript &lt;level&gt;" command.</description>
  966. </function>
  967. <function name="isMainMenuActive" ret="bool">
  968. <description>This function returns whether the user is in the mainmenu or not.</description>
  969. </function>
  970. <function name="isMTAWindowActive" ret="bool">
  971. <description>This function returns whether the any system windows that take focus are active. This includes the chatbox input, console window, main menu and transferbox.</description>
  972. </function>
  973. <function name="isTransferBoxActive" ret="bool">
  974. <description>This function returns whether the transferbox is visible or not.</description>
  975. </function>
  976. </group>
  977. <group name="Buttons">
  978. <function name="guiCreateButton" ret="element">
  979. <param name="float x" type="required" />
  980. <param name="float y" type="required" />
  981. <param name="float width" type="required" />
  982. <param name="float height" type="required" />
  983. <param name="string text" type="required" />
  984. <param name="bool relative" type="required" />
  985. <param name="element parent=nil" type="optional" />
  986. <description>This function allows creation of a GUI Button, which is a clickable item as part of GUI.</description>
  987. </function>
  988. </group>
  989. <group name="Checkboxes">
  990. <function name="guiCheckBoxGetSelected" ret="bool">
  991. <param name="element theCheckbox" type="required" />
  992. <description>This function gets a checkbox's selection state.</description>
  993. </function>
  994. <function name="guiCheckBoxSetSelected" ret="bool">
  995. <param name="element theCheckbox" type="required" />
  996. <param name="bool state" type="required" />
  997. <description>This function selects (ticks) or unselects a checkbox.</description>
  998. </function>
  999. <function name="guiCreateCheckBox" ret="element">
  1000. <param name="float x" type="required" />
  1001. <param name="float y" type="required" />
  1002. <param name="float width" type="required" />
  1003. <param name="float height" type="required" />
  1004. <param name="string text" type="required" />
  1005. <param name="bool selected" type="required" />
  1006. <param name="bool relative" type="required" />
  1007. <param name="element parent=nil" type="optional" />
  1008. <description>This function creates a checkbox.</description>
  1009. </function>
  1010. <function name="guiCreateEdit" ret="gui-edit">
  1011. <param name="float x" type="required" />
  1012. <param name="float y" type="required" />
  1013. <param name="float width" type="required" />
  1014. <param name="float height" type="required" />
  1015. <param name="string text" type="required" />
  1016. <param name="bool relative" type="required" />
  1017. <param name="element parent=nil" type="optional" />
  1018. <description>This function is for creating a new GUI edit box. This is a text box in which the user can input text. Edit boxes only allow a single line of text. If you want to allow multiple lines of text create a memo box using guiCreateMemo.</description>
  1019. </function>
  1020. <function name="guiEditSetMasked" ret="bool">
  1021. <param name="element theElement" type="required" />
  1022. <param name="bool status" type="required" />
  1023. <description>This function sets or removes masking (covering up the text being typed) for password text fields.</description>
  1024. </function>
  1025. <function name="guiEditSetMaxLength" ret="bool">
  1026. <param name="element theElement" type="required" />
  1027. <param name="int length" type="required" />
  1028. <description>This function sets the maximum text length that can be typed into an edit box.</description>
  1029. </function>
  1030. <function name="guiEditSetReadOnly" ret="bool">
  1031. <param name="element editField" type="required" />
  1032. <param name="bool status" type="required" />
  1033. <description>This function allows you to set or remove read-only status for an edit box. If read-only is set to true, the box is not editable.</description>
  1034. </function>
  1035. <function name="guiEditSetCaretIndex" ret="bool">
  1036. <param name="element theElement" type="required" />
  1037. <param name="int index" type="required" />
  1038. <description>This function sets the current position of the caret (the text cursor) within the edit box.</description>
  1039. </function>
  1040. </group>
  1041. <group name="Gridlists">
  1042. <function name="guiCreateGridList" ret="element">
  1043. <param name="float x" type="required" />
  1044. <param name="float y" type="required" />
  1045. <param name="float width" type="required" />
  1046. <param name="float height" type="required" />
  1047. <param name="bool relative" type="required" />
  1048. <param name="element parent=nil" type="optional" />
  1049. <description>This function creates a grid list GUI element. These are menu's which are designed in lists and can have multiple columns. A good example of a gridlist element can be found in MTA's settings box, under Controls.</description>
  1050. </function>
  1051. <function name="guiGridListAddColumn" ret="int">
  1052. <param name="element gridList" type="required" />
  1053. <param name="string title" type="required" />
  1054. <param name="float width" type="required" />
  1055. <description>This function is used to create columns in grid lists.</description>
  1056. </function>
  1057. <function name="guiGridListAddRow" ret="int">
  1058. <param name="element gridList" type="required" />
  1059. <description>Adds a row to a grid list.</description>
  1060. </function>
  1061. <function name="guiGridListAutoSizeColumn" ret="bool">
  1062. <param name="element gridList" type="required" />
  1063. <param name="int columnIndex" type="required" />
  1064. <description>This allows you to automatically size a column to display everything in it correctly, with the most minimal width.</description>
  1065. </function>
  1066. <function name="guiGridListClear" ret="bool">
  1067. <param name="element gridList" type="required" />
  1068. <description>This function clears all the data from a grid list.</description>
  1069. </function>
  1070. <function name="guiGridListGetItemData" ret="string">
  1071. <param name="element gridList" type="required" />
  1072. <param name="int rowIndex" type="required" />
  1073. <param name="int columnIndex" type="required" />
  1074. <description>With this function you can retrieve the string data associated with an item in a grid list. This is not the text that is displayed on the item, but an internal string that you can use to hold extra information about the item.</description>
  1075. </function>
  1076. <function name="guiGridListGetItemText" ret="string">
  1077. <param name="element gridList" type="required" />
  1078. <param name="int rowIndex" type="required" />
  1079. <param name="int columnIndex" type="required" />
  1080. <description>This function retrieves the text from a specific grid list item.</description>
  1081. </function>
  1082. <function name="guiGridListGetRowCount" ret="int">
  1083. <param name="element theList" type="required" />
  1084. <description>This function returns the number of rows in a grid list.</description>
  1085. </function>
  1086. <function name="guiGridListGetSelectedItem" ret="int, int">
  1087. <param name="element gridList" type="required" />
  1088. <description>This function returns the row and colum indexes of the selected item in a grid list.</description>
  1089. </function>
  1090. <function name="guiGridListInsertRowAfter" ret="int">
  1091. <param name="element gridList" type="required" />
  1092. <param name="int rowIndex" type="required" />
  1093. <description>This allows you to insert a new row after a specified row. Good for inserting new rows in the middle of existing rows.</description>
  1094. </function>
  1095. <function name="guiGridListRemoveColumn" ret="bool">
  1096. <param name="element gridList" type="required" />
  1097. <param name="int columnIndex" type="required" />
  1098. <description>This allows you to delete columns that exist in grid lists.</description>
  1099. </function>
  1100. <function name="guiGridListRemoveRow" ret="bool">
  1101. <param name="element gridList" type="required" />
  1102. <param name="int rowIndex" type="required" />
  1103. <description>This allows you to delete rows that exist in grid lists.</description>
  1104. </function>
  1105. <function name="guiGridListSetItemData" ret="bool">
  1106. <param name="element gridList" type="required" />
  1107. <param name="int rowIndex" type="required" />
  1108. <param name="int columnIndex" type="required" />
  1109. <param name="var data" type="required" />
  1110. <description>This function sets a Item Data associated to a grid list item.</description>
  1111. </function>
  1112. <function name="guiGridListSetItemText" ret="bool">
  1113. <param name="element gridList" type="required" />
  1114. <param name="int rowIndex" type="required" />
  1115. <param name="int columnIndex" type="required" />
  1116. <param name="string text" type="required" />
  1117. <param name="bool section" type="required" />
  1118. <param name="bool number" type="required" />
  1119. <description>This function changes the text of a gridlist item.</description>
  1120. </function>
  1121. <function name="guiGridListSetScrollBars" ret="bool">
  1122. <param name="element guiGridlist" type="required" />
  1123. <param name="bool horizontalBar" type="required" />
  1124. <param name="bool verticalBar" type="required" />
  1125. <description>This function allows a gridlist's scrollbar to be forced on, or returned to default.</description>
  1126. </function>
  1127. <function name="guiGridListSetSelectedItem" ret="bool">
  1128. <param name="element gridList" type="required" />
  1129. <param name="int rowIndex" type="required" />
  1130. <param name="int columnIndex" type="required" />
  1131. <description>This function selects an item from a gridlist. If you wish to deselect whatever item is selected, pass 0 as both the rowIndex and columnIndex arguments.</description>
  1132. </function>
  1133. <function name="guiGridListSetSelectionMode" ret="bool">
  1134. <param name="guiElement gridlist" type="required" />
  1135. <param name="int mode" type="required" />
  1136. <description>This function sets the selection mode of a gui gridlist. For example, the MTA server browser selects a whole row, while the Controls dialog selects a single cell.</description>
  1137. </function>
  1138. <function name="guiGridListSetSortingEnabled" ret="bool">
  1139. <param name="element guiGridlist" type="required" />
  1140. <param name="bool enabled" type="required" />
  1141. <description>This function allows the disabling or enabling of sorting within a gridlist. Sorting is achieved by clicking a column header. Gridlist items will be sorted according to the clicked column. By default, gridlists have sorting enabled. This function will allow you to toggle this.</description>
  1142. </function>
  1143. <function name="guiGridListGetSelectedCount" ret="int">
  1144. <param name="element gridList" type="required" />
  1145. <description>This function returns the amount of options selected in the specified grid list.</description>
  1146. </function>
  1147. <function name="guiGridListGetSelectedItems" ret="table">
  1148. <param name="element gridList" type="required" />
  1149. <description>This function returns the items selected in the specified grid list.</description>
  1150. </function>
  1151. <function name="guiGridListSetColumnWidth" ret="bool">
  1152. <param name="element gridList" type="required" />
  1153. <param name="int columnIndex" type="required" />
  1154. <param name="number width" type="required" />
  1155. <param name="bool relative=true" type="optional" />
  1156. <description>This allows you to set the width of an existing column in a gridlist.</description>
  1157. </function>
  1158. </group>
  1159. <group name="Memos">
  1160. <function name="guiCreateMemo" ret="gui-memo">
  1161. <param name="float x" type="required" />
  1162. <param name="float y" type="required" />
  1163. <param name="float width" type="required" />
  1164. <param name="float height" type="required" />
  1165. <param name="string text" type="required" />
  1166. <param name="bool relative" type="required" />
  1167. <param name="element parent=nil" type="optional" />
  1168. <description>This function creates a new GUI memo. This is a multiline edit box in which the user can input text.</description>
  1169. </function>
  1170. <function name="guiMemoSetReadOnly" ret="bool">
  1171. <param name="gui-memo theMemo" type="required" />
  1172. <param name="bool status" type="required" />
  1173. <description>This function allows you to set or remove read-only status for a GUI memo. If read-only is set to true, the contents are not editable.</description>
  1174. </function>
  1175. <function name="guiMemoSetCaretIndex" ret="bool">
  1176. <param name="gui-memo theMemo" type="required" />
  1177. <param name="int index" type="required" />
  1178. <description>This function sets the current position of the caret (the text cursor) within the memo.</description>
  1179. </function>
  1180. </group>
  1181. <group name="Progress bars">
  1182. <function name="guiCreateProgressBar" ret="element">
  1183. <param name="float x" type="required" />
  1184. <param name="float y" type="required" />
  1185. <param name="float width" type="required" />
  1186. <param name="float height" type="required" />
  1187. <param name="bool relative" type="required" />
  1188. <param name="element parent=nil" type="optional" />
  1189. <description>This function creates a progress bar.</description>
  1190. </function>
  1191. <function name="guiProgressBarGetProgress" ret="float">
  1192. <param name="progressBar theProgressbar" type="required" />
  1193. <description>This function gets the progress of a progress bar as a percentage</description>
  1194. </function>
  1195. <function name="guiProgressBarSetProgress" ret="bool">
  1196. <param name="progressBar theProgressbar" type="required" />
  1197. <param name="float progress" type="required" />
  1198. <description>This function is used to set the progress of a progressbar as a percentage.</description>
  1199. </function>
  1200. </group>
  1201. <group name="Radio buttons">
  1202. <function name="guiCreateRadioButton" ret="element">
  1203. <param name="float x" type="required" />
  1204. <param name="float y" type="required" />
  1205. <param name="float width" type="required" />
  1206. <param name="float height" type="required" />
  1207. <param name="string text" type="required" />
  1208. <param name="bool relative" type="required" />
  1209. <param name="element parent=nil" type="optional" />
  1210. <description>This function creates a radio button.</description>
  1211. </function>
  1212. <function name="guiRadioButtonGetSelected" ret="bool">
  1213. <param name="element guiRadioButton" type="required" />
  1214. <description>This function gets a radio button's selection state.</description>
  1215. </function>
  1216. <function name="guiRadioButtonSetSelected" ret="bool">
  1217. <param name="element guiRadioButton" type="required" />
  1218. <param name="bool state" type="required" />
  1219. <description>This function selects or unselects a radio button.</description>
  1220. </function>
  1221. </group>
  1222. <group name="Scrollbars">
  1223. <function name="guiCreateScrollBar" ret="gui-scrollbar">
  1224. <param name="float x" type="required" />
  1225. <param name="float y" type="required" />
  1226. <param name="float width" type="required" />
  1227. <param name="float height" type="required" />
  1228. <param name="bool horizontal" type="required" />
  1229. <param name="bool relative" type="required" />
  1230. <param name="gui-element parent=nil" type="optional" />
  1231. <description>This function creates a GUI scrollbar. You can use the functions guiScrollPaneSetHorizontalScrollPosition, guiScrollPaneSetVerticalScrollPosition, guiScrollPaneGetHorizontalScrollPosition and guiScrollPaneGetVerticalScrollPosition to read and modify the scrollbar's scroll.</description>
  1232. </function>
  1233. <function name="guiScrollBarGetScrollPosition" ret="float">
  1234. <param name="gui-scrollBar theScrollBar" type="required" />
  1235. <description>This function gets the scroll amount of a scrollbar as a percentage.</description>
  1236. </function>
  1237. <function name="guiScrollBarSetScrollPosition" ret="bool">
  1238. <param name="gui-scrollBar theScrollBar" type="required" />
  1239. <param name="float amount" type="required" />
  1240. <description>This function is used to set the scroll amount of a scrollbar as a percentage.</description>
  1241. </function>
  1242. </group>
  1243. <group name="Scroll panes">
  1244. <function name="guiCreateScrollPane" ret="element">
  1245. <param name="float x" type="required" />
  1246. <param name="float y" type="required" />
  1247. <param name="float width" type="required" />
  1248. <param name="float height" type="required" />
  1249. <param name="bool relative" type="required" />
  1250. <param name="gui-element parent=nil" type="optional" />
  1251. <description>This creates a GUI scroll pane.</description>
  1252. </function>
  1253. <function name="guiScrollPaneSetScrollBars" ret="bool">
  1254. <param name="element scrollPane" type="required" />
  1255. <param name="bool horizontal" type="required" />
  1256. <param name="bool vertical" type="required" />
  1257. <description>This function allows a scrollpane's scrollbars to be forced on, or returned to default.</description>
  1258. </function>
  1259. </group>
  1260. <group name="Static images">
  1261. <function name="guiCreateStaticImage" ret="element">
  1262. <param name="float x" type="required" />
  1263. <param name="float y" type="required" />
  1264. <param name="float width" type="required" />
  1265. <param name="float height" type="required" />
  1266. <param name="string path" type="required" />
  1267. <param name="bool relative" type="required" />
  1268. <param name="element parent=nil" type="optional" />
  1269. <description>This function creates a static image using a .png image in the resource.</description>
  1270. </function>
  1271. <function name="guiStaticImageLoadImage" ret="bool">
  1272. <param name="element theElement" type="required" />
  1273. <param name="string filename" type="required" />
  1274. <description>This function allows you to change the image in GUI static image element to another one.</description>
  1275. </function>
  1276. </group>
  1277. <group name="Tab panels">
  1278. <function name="guiCreateTabPanel" ret="element">
  1279. <param name="float x" type="required" />
  1280. <param name="float y" type="required" />
  1281. <param name="float width" type="required" />
  1282. <param name="float height" type="required" />
  1283. <param name="bool relative" type="required" />
  1284. <param name="element parent=nil" type="optional" />
  1285. <description>This function creates a Tab Panel, which acts as a template to create Tabs upon.</description>
  1286. </function>
  1287. <function name="guiGetSelectedTab" ret="element">
  1288. <param name="element tabPanel" type="required" />
  1289. <description>This function returns the currently selected tab in the specified tab panel.</description>
  1290. </function>
  1291. <function name="guiSetSelectedTab" ret="bool">
  1292. <param name="element tabPanel" type="required" />
  1293. <param name="element theTab" type="required" />
  1294. <description>This function is used to change the currently selected tab in a tab panel.</description>
  1295. </function>
  1296. </group>
  1297. <group name="Tabs">
  1298. <function name="guiCreateTab" ret="element">
  1299. <param name="string text" type="required" />
  1300. <param name="element parent" type="required" />
  1301. <description>This function creates a tab on a pre-existing tab panel. A tab is a button as well as a 'dimension' that can be used to switch between information by clicking on the tabs. Tabs are sorted on a tab panel in the order that they are created.</description>
  1302. </function>
  1303. <function name="guiDeleteTab" ret="bool">
  1304. <param name="element tabToDelete" type="required" />
  1305. <description>This function deletes a tab from a tab panel.</description>
  1306. </function>
  1307. </group>
  1308. <group name="Text labels">
  1309. <function name="guiCreateLabel" ret="element">
  1310. <param name="float x" type="required" />
  1311. <param name="float y" type="required" />
  1312. <param name="float width" type="required" />
  1313. <param name="float height" type="required" />
  1314. <param name="string text" type="required" />
  1315. <param name="bool relative" type="required" />
  1316. <param name="element parent=nil" type="optional" />
  1317. <description>This function is for creating a new GUI label. A label is simply a piece of text that cannot be edited by the user. If you would like to have a bigger text you'd have to change its font because font size is not supported.</description>
  1318. </function>
  1319. <function name="guiLabelGetFontHeight" ret="float">
  1320. <param name="element theLabel" type="required" />
  1321. <description>This function returns the height of the font currently used in a GUI text label.</description>
  1322. </function>
  1323. <function name="guiLabelGetTextExtent" ret="float">
  1324. <param name="element theLabel" type="required" />
  1325. <description>This function returns the extent, or width, of the current text inside a GUI text label.</description>
  1326. </function>
  1327. <function name="guiLabelSetColor" ret="bool">
  1328. <param name="element theElement" type="required" />
  1329. <param name="int red" type="required" />
  1330. <param name="int green" type="required" />
  1331. <param name="int blue" type="required" />
  1332. <description>This function allows you to set the color of a GUI label.</description>
  1333. </function>
  1334. <function name="guiLabelSetHorizontalAlign" ret="bool">
  1335. <param name="element theLabel" type="required" />
  1336. <param name="string align" type="required" />
  1337. <param name="bool wordwrap=false" type="optional" />
  1338. <description>This function sets the horizontal alignment of a text label.</description>
  1339. </function>
  1340. <function name="guiLabelSetVerticalAlign" ret="bool">
  1341. <param name="element theLabel" type="required" />
  1342. <param name="string align" type="required" />
  1343. <description>This function sets the vertical alignment of a text label.</description>
  1344. </function>
  1345. </group>
  1346. <group name="Windows">
  1347. <function name="guiCreateWindow" ret="element">
  1348. <param name="float x" type="required" />
  1349. <param name="float y" type="required" />
  1350. <param name="float width" type="required" />
  1351. <param name="float height" type="required" />
  1352. <param name="string titleBarText" type="required" />
  1353. <param name="bool relative" type="required" />
  1354. <description>This function is for creating a new GUI window. This provides a base for other gui elements to be created within. However, windows do not have a parent and cannot be created in any GUI elements.</description>
  1355. </function>
  1356. <function name="guiWindowSetMovable" ret="bool">
  1357. <param name="element theElement" type="required" />
  1358. <param name="bool status" type="required" />
  1359. <description>This function allows you to specify whether or not a user can move a GUI window.</description>
  1360. </function>
  1361. <function name="guiWindowSetSizable" ret="bool">
  1362. <param name="element theElement" type="required" />
  1363. <param name="bool status" type="required" />
  1364. <description>This function enables or disables user resizing of a GUI window.</description>
  1365. </function>
  1366. </group>
  1367. <group name="Input functions">
  1368. <function name="bindKey" ret="bool">
  1369. <param name="string key" type="required" />
  1370. <param name="string keyState" type="required" />
  1371. <param name="function handlerFunction" type="required" />
  1372. <param name="var arguments" type="optional" />
  1373. <param name="..." type="optional" />
  1374. <description>Binds the local player's key to a handler function or command, which will be called when the key is pressed.</description>
  1375. </function>
  1376. <function name="unbindKey" ret="bool">
  1377. <param name="string key" type="required" />
  1378. <param name="string keyState" type="optional" />
  1379. <param name="function handler" type="optional" />
  1380. <description>Removes an existing key bind from the specified player.</description>
  1381. </function>
  1382. <function name="getKeyState" ret="bool">
  1383. <param name="string keyName" type="required" />
  1384. <description>This function determines if a certain key is pressed or not.</description>
  1385. </function>
  1386. <function name="getControlState" ret="bool">
  1387. <param name="string controlName" type="required" />
  1388. <description>This function will check if the local player is pressing a particular control. Controls are those that affect GTA. If you wish to get the state of another key, use bindKey and a command function.</description>
  1389. </function>
  1390. <function name="isControlEnabled" ret="bool">
  1391. <param name="string control" type="required" />
  1392. <description>Checks whether a GTA control is enabled or disabled for a certain player.</description>
  1393. </function>
  1394. <function name="setControlState" ret="bool">
  1395. <param name="string control" type="required" />
  1396. <param name="bool state" type="required" />
  1397. <description>Sets a state of a specified player's control, as if they pressed or released it.</description>
  1398. </function>
  1399. <function name="toggleControl" ret="bool">
  1400. <param name="string control" type="required" />
  1401. <param name="bool enabled" type="required" />
  1402. <description>Enables or disables the use of a GTA control for a specific player.</description>
  1403. </function>
  1404. <function name="toggleAllControls" ret="bool">
  1405. <param name="bool enabled" type="required" />
  1406. <param name="bool gtaControls=true" type="optional" />
  1407. <param name="bool mtaControls=true" type="optional" />
  1408. <description>Enables or disables the use of all GTA controls for a specified player.</description>
  1409. </function>
  1410. <function name="getCursorPosition" ret="float, float, float, float, float">
  1411. <description>This function gets the current position of the mouse cursor.</description>
  1412. </function>
  1413. <function name="addCommandHandler" ret="bool">
  1414. <param name="string commandName" type="required" />
  1415. <param name="function handlerFunction" type="required" />
  1416. <param name="bool caseSensitive=true" type="optional" />
  1417. <description>This function will attach a scripting function (handler) to a console command, so that whenever the local player uses the command the function is called.</description>
  1418. </function>
  1419. <function name="removeCommandHandler" ret="bool">
  1420. <param name="string commandName" type="required" />
  1421. <param name="function handler" type="optional" />
  1422. <description>This function removes a command handler, that is one that has been added using addCommandHandler. This function can only remove command handlers that were added by the resource that it is called in.</description>
  1423. </function>
  1424. <function name="executeCommandHandler" ret="bool">
  1425. <param name="string commandName" type="required" />
  1426. <param name="string args" type="optional" />
  1427. <description>This function will call all the attached functions of an existing console command, for a specified player.</description>
  1428. </function>
  1429. <function name="getBoundKeys" ret="table">
  1430. <param name="string command/control" type="required" />
  1431. <description>Returns a list of key names that are bound to the specified game control or console command.</description>
  1432. </function>
  1433. <function name="getAnalogControlState" ret="float">
  1434. <param name="string controlName" type="required" />
  1435. <description>This retrieves the analog control state of a control. This is useful for detecting sensitive controls, such as those used on a joypad.</description>
  1436. </function>
  1437. <function name="setCursorPosition" ret="bool">
  1438. <param name="int cursorX" type="required" />
  1439. <param name="int cursorY" type="required" />
  1440. <description>This function sets the current position of the mouse cursor.</description>
  1441. </function>
  1442. </group>
  1443. <group name="Marker functions">
  1444. <function name="createMarker" ret="marker">
  1445. <param name="float x" type="required" />
  1446. <param name="float y" type="required" />
  1447. <param name="float z" type="required" />
  1448. <param name="string type" type="optional" />
  1449. <param name="int size" type="optional" />
  1450. <param name="int r" type="optional" />
  1451. <param name="int g" type="optional" />
  1452. <param name="int b" type="optional" />
  1453. <param name="int a" type="optional" />
  1454. <description>This function creates a marker. A marker is a 3D model in the world that can highlight a particular point or area, often used to instruct players where to go to perform actions such as entering buildings.</description>
  1455. </function>
  1456. <function name="getMarkerColor" ret="int, int, int, int">
  1457. <param name="marker theMarker" type="required" />
  1458. <description>This function returns the color and transparency for a marker element. Not all marker types support transparency.</description>
  1459. </function>
  1460. <function name="getMarkerCount" ret="int">
  1461. <description>Returns the number of markers that currently exist in the world.</description>
  1462. </function>
  1463. <function name="getMarkerIcon" ret="string">
  1464. <param name="marker theMarker" type="required" />
  1465. <description>This function returns the icon name for a marker.</description>
  1466. </function>
  1467. <function name="getMarkerSize" ret="float">
  1468. <param name="marker myMarker" type="required" />
  1469. <description>This function returns a float containing the size of the specified marker.</description>
  1470. </function>
  1471. <function name="getMarkerTarget" ret="float, float, float">
  1472. <param name="marker theMarker" type="required" />
  1473. <description>This function returns the position of the specified marker's target, the position it points to. This only works for checkpoint markers and ring markers. For checkpoints it returns the position the arrow is pointing to, for ring markers it returns the position the ring is facing. You can set this target with setMarkerTarget.</description>
  1474. </function>
  1475. <function name="getMarkerType" ret="string">
  1476. <param name="marker theMarker" type="required" />
  1477. <description>This function returns a marker's type.</description>
  1478. </function>
  1479. <function name="setMarkerColor" ret="bool">
  1480. <param name="marker theMarker" type="required" />
  1481. <param name="int r" type="required" />
  1482. <param name="int g" type="required" />
  1483. <param name="int b" type="required" />
  1484. <param name="int a" type="required" />
  1485. <description>This function sets the color of the specified marker by modifying the values for red, green and blue.</description>
  1486. </function>
  1487. <function name="setMarkerIcon" ret="bool">
  1488. <param name="marker theMarker" type="required" />
  1489. <param name="string icon" type="required" />
  1490. <description>This function allows changing the icon of a checkpoint marker.</description>
  1491. </function>
  1492. <function name="setMarkerSize" ret="bool">
  1493. <param name="marker theMarker" type="required" />
  1494. <param name="float size" type="required" />
  1495. <description>This function sets the size of the specified marker.</description>
  1496. </function>
  1497. <function name="setMarkerTarget" ret="bool">
  1498. <param name="marker theMarker" type="required" />
  1499. <param name="float x" type="required" />
  1500. <param name="float y" type="required" />
  1501. <param name="float z" type="required" />
  1502. <description>This function sets the 'target' for a marker. Only the checkpoint and ring marker types can have a target.</description>
  1503. </function>
  1504. <function name="setMarkerType" ret="bool">
  1505. <param name="marker theMarker" type="required" />
  1506. <param name="string markerType" type="required" />
  1507. <description>This function changes a marker's type. The type controls how the marker is displayed in the game. It's important that you use marker types that users are used to from the single player game. For example, checkpoints are used in races, rings are used for aircraft races, arrows are used for entering buildings etc.</description>
  1508. </function>
  1509. </group>
  1510. <group name="Object functions">
  1511. <function name="createObject" ret="object">
  1512. <param name="int modelid" type="required" />
  1513. <param name="float x" type="required" />
  1514. <param name="float y" type="required" />
  1515. <param name="float z" type="required" />
  1516. <param name="float rx" type="optional" />
  1517. <param name="float ry" type="optional" />
  1518. <param name="float rz" type="optional" />
  1519. <description>Creates an object in the GTA world.</description>
  1520. </function>
  1521. <function name="moveObject" ret="bool">
  1522. <param name="object theObject" type="required" />
  1523. <param name="int time" type="required" />
  1524. <param name="float targetx" type="required" />
  1525. <param name="float targety" type="required" />
  1526. <param name="float targetz" type="required" />
  1527. <param name="float moverx" type="optional" />
  1528. <param name="float movery" type="optional" />
  1529. <param name="float moverz" type="optional" />
  1530. <description>This function will smoothly move an object from its current position to a specified rotation and position.</description>
  1531. </function>
  1532. <function name="getObjectRotation" ret="float, float, float">
  1533. <param name="object theObject" type="required" />
  1534. <description>Object rotation can be retrieved from objects in mapfiles or objects that are created in scripts.</description>
  1535. </function>
  1536. <function name="setObjectRotation" ret="bool">
  1537. <param name="object theObject" type="required" />
  1538. <param name="float rotX" type="required" />
  1539. <param name="float rotY" type="required" />
  1540. <param name="float rotZ" type="required" />
  1541. <description>Allows you to change an object's rotation while playing a map. The object can be from the map file or created in a script.</description>
  1542. </function>
  1543. <function name="setObjectScale" ret="bool">
  1544. <param name="object theObject" type="required" />
  1545. <param name="float scale" type="required" />
  1546. <description>This function changes the visible size of an object. It is very important to note that this does not affect the collision models for the object, as such this is unsuitable for use for interaction with players, vehicles or other objects.</description>
  1547. </function>
  1548. <function name="stopObject" ret="bool">
  1549. <param name="object theobject" type="required" />
  1550. <description>This will allow you to stop an object that is currently moving.</description>
  1551. </function>
  1552. <function name="isObjectStatic" ret="bool">
  1553. <param name="object theObject" type="required" />
  1554. <description>Use this function to test whether an object is static (unaffected by gravity or pushing) or not.</description>
  1555. </function>
  1556. <function name="setObjectStatic" ret="bool">
  1557. <param name="object theObject" type="required" />
  1558. <param name="bool toggle" type="required" />
  1559. <description>Makes an object static or non-static. Static objects are rock solid in one place, unaffected by gravity and pushing. Nonstatic objects can fall, be pushed around etc.</description>
  1560. </function>
  1561. </group>
  1562. <group name="Output functions">
  1563. <function name="outputChatBox" ret="bool">
  1564. <param name="string text" type="required" />
  1565. <param name="int r=255" type="optional" />
  1566. <param name="int g=255" type="optional" />
  1567. <param name="int b=255" type="optional" />
  1568. <param name="bool colorCoded=false" type="optional" />
  1569. <description>This outputs the specified text string to the chatbox. It can be specified as a message to certain player(s) or all players. It can optionally allow you to embed color changes into the string by setting the colorCoded boolean to true.</description>
  1570. </function>
  1571. <function name="outputConsole" ret="bool">
  1572. <param name="string text" type="required" />
  1573. <description>This outputs the specified text string to the console window (accessed with F8 or ~ key). It can be specified as a message to certain player(s) or all players.</description>
  1574. </function>
  1575. <function name="outputDebugString" ret="bool">
  1576. <param name="string text" type="required" />
  1577. <param name="int level=3" type="optional" />
  1578. <param name="int red=255" type="optional" />
  1579. <param name="int green=255" type="optional" />
  1580. <param name="int blue=255" type="optional" />
  1581. <description>This function outputs scripting debug messages, which can be read by enabling the debug textbox. The debug display level can then be set so that info or warning messages get filtered out.</description>
  1582. </function>
  1583. <function name="showChat" ret="bool">
  1584. <param name="bool show" type="required" />
  1585. <description>This function is used to show or hide the player's chat.</description>
  1586. </function>
  1587. </group>
  1588. <group name="Ped functions">
  1589. <function name="canPedBeKnockedOffBike" ret="bool">
  1590. <param name="ped thePed" type="required" />
  1591. <description>This function checks if the given ped can fall off bikes.</description>
  1592. </function>
  1593. <function name="createPed" ret="ped">
  1594. <param name="int modelid" type="required" />
  1595. <param name="float x" type="required" />
  1596. <param name="float y" type="required" />
  1597. <param name="float z" type="required" />
  1598. <description>Creates a Ped in the GTA world.</description>
  1599. </function>
  1600. <function name="doesPedHaveJetPack" ret="bool">
  1601. <param name="ped thePed" type="required" />
  1602. <description>Checks whether or not a ped currently has a jetpack.</description>
  1603. </function>
  1604. <function name="getPedAmmoInClip" ret="int">
  1605. <param name="ped thePed" type="required" />
  1606. <param name="int weaponSlot=current" type="optional" />
  1607. <description>This function returns an integer that contains the ammo in a specified ped's weapon. See Weapon Info</description>
  1608. </function>
  1609. <function name="getPedAnimation" ret="string, string">
  1610. <param name="ped thePed" type="required" />
  1611. <description>Gets the animation of a player or ped that was set using setPedAnimation.</description>
  1612. </function>
  1613. <function name="getPedAnimationData" ret="table">
  1614. <param name="ped thePed" type="required" />
  1615. <description>This function is used to return the animation data of a player or ped that was set using setPedAnimation or blendPedAnimation.</description>
  1616. </function>
  1617. <function name="getPedArmor" ret="float">
  1618. <param name="ped thePed" type="required" />
  1619. <description>This function returns the current armor of the specified ped.</description>
  1620. </function>
  1621. <function name="getPedBonePosition" ret="float, float, float">
  1622. <param name="ped thePed" type="required" />
  1623. <param name="int bone" type="required" />
  1624. <description>Returns the 3D world coordinates of a specific bone of a given ped.</description>
  1625. </function>
  1626. <function name="getPedClothes" ret="string, string">
  1627. <param name="ped thePed" type="required" />
  1628. <param name="int clothesType" type="required" />
  1629. <description>This function is used to get the current clothes texture and model of a certain type on a ped.</description>
  1630. </function>
  1631. <function name="getPedContactElement" ret="element">
  1632. <param name="ped thePed" type="required" />
  1633. <description>This function detects the element a ped is standing on. This can be a vehicle or an object.</description>
  1634. </function>
  1635. <function name="getPedControlState" ret="bool">
  1636. <param name="ped thePed" type="required" />
  1637. <param name="string control" type="required" />
  1638. <description>Checks whether a ped has a certain control pressed.</description>
  1639. </function>
  1640. <function name="getPedWeaponMuzzlePosition" ret="float, float, float">
  1641. <param name="ped thePed" type="required" />
  1642. <description>This function gets the world position of the current weapon's muzzle.</description>
  1643. </function>
  1644. <function name="getPedOccupiedVehicle" ret="vehicle">
  1645. <param name="ped thePed" type="required" />
  1646. <description>This function gets the vehicle that the ped is currently in, if any.</description>
  1647. </function>
  1648. <function name="getPedRotation" ret="float">
  1649. <param name="ped thePed" type="required" />
  1650. <description>Gets the rotation of a ped.</description>
  1651. </function>
  1652. <function name="getPedSimplestTask" ret="string">
  1653. <param name="ped thePed" type="required" />
  1654. <description>This function is used to get the name of a specified ped's current simplest task.</description>
  1655. </function>
  1656. <function name="getPedSkin" ret="int">
  1657. <param name="ped thePed" type="required" />
  1658. <description>This function returns the specified ped's skin.</description>
  1659. </function>
  1660. <function name="getPedStat" ret="float">
  1661. <param name="ped thePed" type="required" />
  1662. <param name="int stat" type="required" />
  1663. <description>This function returns the value of the specified statistic of a specific ped.</description>
  1664. </function>
  1665. <function name="getPedTarget" ret="element">
  1666. <param name="ped thePed" type="required" />
  1667. <description>This function is used to get the element a ped is currently targeting.</description>
  1668. </function>
  1669. <function name="getPedTargetCollision" ret="float, float, float">
  1670. <param name="ped targetingPed" type="required" />
  1671. <description>This function allows retrieval of where a ped's target is blocked. It will only be blocked if there is an obstacle within a ped's target range.</description>
  1672. </function>
  1673. <function name="getPedTargetEnd" ret="float, float, float">
  1674. <param name="ped targetingPed" type="required" />
  1675. <description>This function allows retrieval of the position where a ped's target range ends, when he is aiming with a weapon.</description>
  1676. </function>
  1677. <function name="getPedTargetRange" ret="float">
  1678. <param name="ped targetingPed" type="required" />
  1679. <description>This function allows retrieval of a ped's target range when he is aiming with a weapon.</description>
  1680. </function>
  1681. <function name="getPedTargetStart" ret="float, float, float">
  1682. <param name="ped targetingPed" type="required" />
  1683. <description>This function allows retrieval of the position a ped's target range begins, when he is aiming with a weapon.</description>
  1684. </function>
  1685. <function name="getPedTask" ret="string">
  1686. <param name="ped thePed" type="required" />
  1687. <param name="string priority" type="required" />
  1688. <param name="int taskType" type="required" />
  1689. <param name="int index=0" type="optional" />
  1690. <description>This function is used to get the name of the current task of a certain type for a ped.</description>
  1691. </function>
  1692. <function name="getPedTotalAmmo" ret="int">
  1693. <param name="ped thePed" type="required" />
  1694. <param name="int weaponSlot=current" type="optional" />
  1695. <description>This function returns an integer that contains the total ammo in a specified ped's weapon. See Weapon Info</description>
  1696. </function>
  1697. <function name="getPedVoice" ret="string, string">
  1698. <param name="ped thePed" type="required" />
  1699. <description>Gets the current voice of a ped.</description>
  1700. </function>
  1701. <function name="getPedWeapon" ret="int">
  1702. <param name="ped thePed" type="required" />
  1703. <param name="int weaponSlot=current" type="optional" />
  1704. <description>This function tells you which weapon type is in a certain weapon slot of a ped. See Weapon Info</description>
  1705. </function>
  1706. <function name="getPedWeaponSlot" ret="int">
  1707. <param name="ped thePed" type="required" />
  1708. <description>This function gets a ped's selected weapon slot.</description>
  1709. </function>
  1710. <function name="isPedChoking" ret="bool">
  1711. <param name="ped thePed" type="required" />
  1712. <description>This function checks if the specified ped is choking (coughing) or not. This happens as a result of weapons that produce smoke - smoke grenades, fire extinguisher and the spray can.</description>
  1713. </function>
  1714. <function name="isPedDoingGangDriveby" ret="bool">
  1715. <param name="ped thePed" type="required" />
  1716. <description>This function checks if the ped is in the driveby state.</description>
  1717. </function>
  1718. <function name="isPedDoingTask" ret="bool">
  1719. <param name="ped thePed" type="required" />
  1720. <param name="string taskName" type="required" />
  1721. <description>This function checks if the specified ped is carrying out a certain task.</description>
  1722. </function>
  1723. <function name="isPedDucked" ret="bool">
  1724. <param name="ped thePed" type="required" />
  1725. <description>This function checks if the specified ped is ducked (crouched) or not.</description>
  1726. </function>
  1727. <function name="isPedHeadless" ret="bool">
  1728. <param name="ped thePed" type="required" />
  1729. <description>With this function, you can check if a ped has a head or not.</description>
  1730. </function>
  1731. <function name="isPedInVehicle" ret="bool">
  1732. <param name="ped thePed" type="required" />
  1733. <description>Checks whether or not a given ped is currently in a vehicle.</description>
  1734. </function>
  1735. <function name="isPedInWater" ret="bool">
  1736. <param name="ped thePed" type="required" />
  1737. <description>Checks whether or not a ped is currently in water.</description>
  1738. </function>
  1739. <function name="isPedOnFire" ret="bool">
  1740. <param name="ped thePed" type="required" />
  1741. <description>This function checks if the specified ped is on fire or not.</description>
  1742. </function>
  1743. <function name="isPedOnGround" ret="bool">
  1744. <param name="ped thePed" type="required" />
  1745. <description>This function is used to determine whether or not a ped is on the ground. This is for on-foot usage only.</description>
  1746. </function>
  1747. <function name="setPedAimTarget" ret="bool">
  1748. <param name="ped thePed" type="required" />
  1749. <param name="float x" type="required" />
  1750. <param name="float y" type="required" />
  1751. <param name="float z" type="required" />
  1752. <description>This function allows you to set a ped's aim target to a specific point.</description>
  1753. </function>
  1754. <function name="setPedAnimation" ret="bool">
  1755. <param name="ped thePed" type="required" />
  1756. <param name="string block=nil" type="optional" />
  1757. <param name="string anim=nil" type="optional" />
  1758. <param name="int time=-1" type="optional" />
  1759. <param name="bool loop=true" type="optional" />
  1760. <param name="bool updatePosition=true" type="optional" />
  1761. <param name="bool interruptable=true" type="optional" />
  1762. <description>Sets the current animation of a player or ped. Not specifying the type of animation will automatically cancel the current one.</description>
  1763. </function>
  1764. <function name="setPedCameraRotation" ret="bool">
  1765. <param name="ped thePed" type="required" />
  1766. <param name="float cameraRotation" type="required" />
  1767. <description>This function sets the camera rotation of a ped.</description>
  1768. </function>
  1769. <function name="setPedCanBeKnockedOffBike" ret="bool">
  1770. <param name="ped thePed" type="required" />
  1771. <param name="bool canBeKnockedOffBike" type="required" />
  1772. <description>This function controls if a ped can fall of his bike by accident - namely by banging into a wall.</description>
  1773. </function>
  1774. <function name="setPedControlState" ret="bool">
  1775. <param name="ped thePed" type="required" />
  1776. <param name="string control" type="required" />
  1777. <param name="bool state" type="required" />
  1778. <description>Makes a ped press or release a certain control.</description>
  1779. </function>
  1780. <function name="setPedDoingGangDriveby" ret="bool">
  1781. <param name="ped thePed" type="required" />
  1782. <param name="bool state" type="required" />
  1783. <description>This function sets the driveby state of a ped.</description>
  1784. </function>
  1785. <function name="setPedHeadless" ret="bool">
  1786. <param name="ped thePed" type="required" />
  1787. <param name="bool headState" type="required" />
  1788. <description>With this function, you can set if a ped has a head or not.</description>
  1789. </function>
  1790. <function name="setPedLookAt" ret="bool">
  1791. <param name="ped thePed" type="required" />
  1792. <param name="float x" type="required" />
  1793. <param name="float y" type="required" />
  1794. <param name="float z" type="required" />
  1795. <param name="int time=3000" type="optional" />
  1796. <param name="element target" type="optional" />
  1797. <description>Makes a ped turn his head and look at a specific world position or element.</description>
  1798. </function>
  1799. <function name="setPedOnFire" ret="bool">
  1800. <param name="ped thePed" type="required" />
  1801. <param name="bool isOnFire" type="required" />
  1802. <description>This function can be used to set a ped on fire or extinguish a fire on it.</description>
  1803. </function>
  1804. <function name="setPedRotation" ret="bool">
  1805. <param name="ped thePed" type="required" />
  1806. <param name="float rotation" type="required" />
  1807. <description>This function allows you to set the current rotation of the specified ped.</description>
  1808. </function>
  1809. <function name="setPedSkin" ret="bool">
  1810. <param name="ped thePed" type="required" />
  1811. <param name="int skinID" type="required" />
  1812. <description>This function changes the skin of a ped.</description>
  1813. </function>
  1814. <function name="setPedVoice" ret="bool">
  1815. <param name="ped thePed" type="required" />
  1816. <param name="string voiceType" type="required" />
  1817. <param name="string voiceName" type="required" />
  1818. <description>Changes the voice of a ped.</description>
  1819. </function>
  1820. <function name="setPedWeaponSlot" ret="bool">
  1821. <param name="ped thePed" type="required" />
  1822. <param name="int weaponSlot" type="required" />
  1823. <description>This function changes the selected weapon slot of a ped.</description>
  1824. </function>
  1825. </group>
  1826. <group name="Pickup functions">
  1827. <function name="createPickup" ret="pickup">
  1828. <param name="float x" type="required" />
  1829. <param name="float y" type="required" />
  1830. <param name="float z" type="required" />
  1831. <param name="int type" type="required" />
  1832. <param name="int amount/weapon/model" type="required" />
  1833. <param name="int respawnTime=30000" type="optional" />
  1834. <param name="int ammo=50" type="optional" />
  1835. <description>This function creates a pickup element, which is placed in the GTA world and can be picked up to retrieve a health, armour or a weapon.</description>
  1836. </function>
  1837. <function name="getPickupAmmo" ret="int">
  1838. <param name="pickup thePickup" type="required" />
  1839. <description>This function retrieves the amount of ammo in a weapon pickup.</description>
  1840. </function>
  1841. <function name="getPickupAmount" ret="int">
  1842. <param name="pickup thePickup" type="required" />
  1843. <description>This function retrieves the amount of health or armor given from a pickup.</description>
  1844. </function>
  1845. <function name="getPickupType" ret="int">
  1846. <param name="pickup thePickup" type="required" />
  1847. <description>This function retrieves the type of a pickup, either a health, armour or weapon pickup.</description>
  1848. </function>
  1849. <function name="getPickupWeapon" ret="int">
  1850. <param name="pickup thePickup" type="required" />
  1851. <description>This function retrieves the weapon ID of a weapon pickup.</description>
  1852. </function>
  1853. <function name="setPickupType" ret="bool">
  1854. <param name="pickup thePickup" type="required" />
  1855. <param name="int type" type="required" />
  1856. <param name="int amount/weapon" type="required" />
  1857. <param name="int ammo" type="optional" />
  1858. <description>This function allows changing the type of a pickup to a Weapon, Armour or Health pickup, and allows you to set the health points or the weapon and ammo that the pickup will give.</description>
  1859. </function>
  1860. </group>
  1861. <group name="Player functions">
  1862. <function name="getLocalPlayer" ret="player">
  1863. <description>This function gets the player element of the client running the current script.</description>
  1864. </function>
  1865. <function name="getPlayerName" ret="string">
  1866. <param name="player thePlayer" type="required" />
  1867. <description>This function returns a string containing the name of the specified player.</description>
  1868. </function>
  1869. <function name="getPlayerNametagColor" ret="int, int, int">
  1870. <param name="player thePlayer" type="required" />
  1871. <description>This function gets the current color of a player's name tag as RGB values. These are in the range 0-255.</description>
  1872. </function>
  1873. <function name="getPlayerNametagText" ret="string">
  1874. <param name="player thePlayer" type="required" />
  1875. <description>This will allow you to retrieve the name tag a player is currently using.</description>
  1876. </function>
  1877. <function name="getPlayerPing" ret="int">
  1878. <param name="player thePlayer" type="required" />
  1879. <description>This function returns the ping of a specified player. The ping is the number of milliseconds that data takes to travel from the player's client to the server or vice versa.</description>
  1880. </function>
  1881. <function name="getPlayerTeam" ret="team">
  1882. <param name="player thePlayer" type="required" />
  1883. <description>This function gets the current team a player is on.</description>
  1884. </function>
  1885. <function name="isPlayerDead" ret="bool">
  1886. <param name="player thePlayer" type="required" />
  1887. <description>This function checks if the specified player is dead or not.</description>
  1888. </function>
  1889. <function name="isPlayerMapForced" ret="bool">
  1890. <description>This function checks if the specified player's radar map has been forced on or not.</description>
  1891. </function>
  1892. <function name="isPlayerMapVisible" ret="bool">
  1893. <description>This function checks if the local player has their map showing</description>
  1894. </function>
  1895. <function name="isPlayerMuted" ret="bool">
  1896. <param name="player thePlayer" type="required" />
  1897. <description>Use this function to check if a player has been muted.</description>
  1898. </function>
  1899. <function name="showPlayerHudComponent" ret="bool">
  1900. <param name="string component" type="required" />
  1901. <param name="bool show" type="required" />
  1902. <description>This function will show or hide a part of the player's HUD.</description>
  1903. </function>
  1904. <function name="getPlayerMapBoundingBox" ret="int,int,int,int">
  1905. <description>This function gets the GUI bounding box of the radar map texture.</description>
  1906. </function>
  1907. <function name="getPlayerMoney" ret="int">
  1908. <description>Returns the amount of money the local player currently has.</description>
  1909. </function>
  1910. <function name="givePlayerMoney" ret="bool">
  1911. <param name="int amount" type="required" />
  1912. <description>This function adds money to the local player's current money amount. To set absolute values, setPlayerMoney can be used.</description>
  1913. </function>
  1914. <function name="setPlayerMoney" ret="bool">
  1915. <param name="int amount" type="required" />
  1916. <description>Sets the local player's money to a certain value, regardless of current player money. It should be noted that setting negative values does not work and in fact gives the player large amounts of money.</description>
  1917. </function>
  1918. <function name="setPlayerNametagColor" ret="bool">
  1919. <param name="player thePlayer" type="required" />
  1920. <param name="int r" type="required" />
  1921. <param name="int g" type="required" />
  1922. <param name="int b" type="required" />
  1923. <description>This allows you to change the RGB color mixture in the name tags of players.</description>
  1924. </function>
  1925. <function name="setPlayerNametagShowing" ret="bool">
  1926. <param name="player thePlayer" type="required" />
  1927. <param name="bool showing" type="required" />
  1928. <description>Use this to define whether the player's name tag is visible or invisible.</description>
  1929. </function>
  1930. <function name="setPlayerNametagText" ret="bool">
  1931. <param name="player thePlayer" type="required" />
  1932. <param name="string text" type="required" />
  1933. <description>This will change the text of a player's nickname in the world to something besides the nickname he chose. This will not change the player's actual nickname, it only changes the visible aspect inside the world (you will see his original nickname in the scoreboard and will refer to his original name in scripts).</description>
  1934. </function>
  1935. <function name="takePlayerMoney" ret="bool">
  1936. <param name="int amount" type="required" />
  1937. <description>This function subtracts money from the local player's current money amount.</description>
  1938. </function>
  1939. </group>
  1940. <group name="Projectile functions">
  1941. <function name="createProjectile" ret="projectile">
  1942. <param name="element creator" type="required" />
  1943. <param name="int weaponType" type="required" />
  1944. <param name="float posX" type="optional" />
  1945. <param name="float posY" type="optional" />
  1946. <param name="float posZ" type="optional" />
  1947. <param name="float force=1.0" type="optional" />
  1948. <param name="element target=nil" type="optional" />
  1949. <param name="float rotX" type="optional" />
  1950. <param name="float rotY" type="optional" />
  1951. <param name="float rotZ" type="optional" />
  1952. <param name="float velX" type="optional" />
  1953. <param name="float velY" type="optional" />
  1954. <param name="float velZ" type="optional" />
  1955. <param name="int model" type="optional" />
  1956. <description>This function creates a projectile of the specified type on the specified coordinates.</description>
  1957. </function>
  1958. <function name="getProjectileType" ret="int">
  1959. <param name="projectile theProjectile" type="required" />
  1960. <description>This function returns the type of the specified projectile.</description>
  1961. </function>
  1962. </group>
  1963. <group name="Radar-area functions">
  1964. <function name="createRadarArea" ret="radararea">
  1965. <param name="float centerX" type="required" />
  1966. <param name="float centerY" type="required" />
  1967. <param name="float sizeX" type="required" />
  1968. <param name="float sizeY" type="required" />
  1969. <param name="int r=255" type="optional" />
  1970. <param name="int g=0" type="optional" />
  1971. <param name="int b=0" type="optional" />
  1972. <param name="int a=255" type="optional" />
  1973. <description>This function can be used to create custom radar areas on the radar.</description>
  1974. </function>
  1975. <function name="getRadarAreaColor" ret="int, int, int, int">
  1976. <param name="radararea theRadararea" type="required" />
  1977. <description>This function can be used to retrieve the current color of a radar area.</description>
  1978. </function>
  1979. <function name="getRadarAreaSize" ret="float, float">
  1980. <param name="radararea theRadararea" type="required" />
  1981. <description>This function is used for getting the X and Y size of an existing radar area.</description>
  1982. </function>
  1983. <function name="isInsideRadarArea" ret="bool">
  1984. <param name="radararea theArea" type="required" />
  1985. <param name="float posX" type="required" />
  1986. <param name="float posY" type="required" />
  1987. <description>This function checks if a 2D position is inside a radararea or not.</description>
  1988. </function>
  1989. <function name="isRadarAreaFlashing" ret="bool">
  1990. <param name="radararea theRadararea" type="required" />
  1991. <description>This function allows detection of whether a radar area is flashing or not.</description>
  1992. </function>
  1993. <function name="setRadarAreaColor" ret="bool">
  1994. <param name="radararea theRadarArea" type="required" />
  1995. <param name="int r" type="required" />
  1996. <param name="int g" type="required" />
  1997. <param name="int b" type="required" />
  1998. <param name="int a" type="required" />
  1999. <description>Sets the color of an existing radar area.</description>
  2000. </function>
  2001. <function name="setRadarAreaFlashing" ret="bool">
  2002. <param name="radararea theRadarArea" type="required" />
  2003. <param name="bool flash" type="required" />
  2004. <description>This function makes an existing radar area flash in transparency.</description>
  2005. </function>
  2006. <function name="setRadarAreaSize" ret="bool">
  2007. <param name="radararea theRadararea" type="required" />
  2008. <param name="float x" type="required" />
  2009. <param name="float y" type="required" />
  2010. <description>This function changes the size of an existing radar area.</description>
  2011. </function>
  2012. </group>
  2013. <group name="Resource functions">
  2014. <function name="call" ret="var...">
  2015. <param name="resource theResource" type="required" />
  2016. <param name="string theFunction" type="required" />
  2017. <param name="arguments..." type="optional" />
  2018. <description>This function is used to call a function from another resource (which must be running).</description>
  2019. </function>
  2020. <function name="getResourceConfig" ret="xmlnode">
  2021. <param name="string filepath" type="optional" />
  2022. <description>This function is used to return the root node of a configuration file. Config files must be predefined in a resource's meta file. An alternative way to load XML files is to use xmlLoadFile.</description>
  2023. </function>
  2024. <function name="getResourceFromName" ret="resource">
  2025. <param name="string resourceName" type="required" />
  2026. <description>This function is used to retrieve a resource from its name. A resource's name is the same as its folder or file archive name on the server (without the extension).</description>
  2027. </function>
  2028. <function name="getResourceGUIElement" ret="element">
  2029. <description>This function gets the resource GUI element.</description>
  2030. </function>
  2031. <function name="getResourceName" ret="string">
  2032. <param name="resource res" type="required" />
  2033. <description>This function gets the name of the specified resource.</description>
  2034. </function>
  2035. <function name="getResourceRootElement" ret="element">
  2036. <param name="resource theResource=getThisResource()" type="optional" />
  2037. <description>This function retrieves a resource's root element. The resource's root element is the element in the element tree which is the parent of all elements that belong to a particular resource (except for elements specifically created elsewhere). You can attach event handlers to this element to easily capture events that originate from your resource (and global events that originate from the root element).</description>
  2038. </function>
  2039. <function name="getThisResource" ret="resource">
  2040. <description>This function retrieves the resource from which the function call was made.</description>
  2041. </function>
  2042. </group>
  2043. <group name="Serial functions">
  2044. <function name="getPlayerUserName" ret="string">
  2045. <description>This function returns the community.mtasa.com (or mtabeta.com) account of the specified user.</description>
  2046. </function>
  2047. </group>
  2048. <group name="Team functions">
  2049. <function name="countPlayersInTeam" ret="int">
  2050. <param name="team theTeam" type="required" />
  2051. <description>This function is for returning the number of players in the specified team.</description>
  2052. </function>
  2053. <function name="getTeamColor" ret="int, int, int">
  2054. <param name="team theTeam" type="required" />
  2055. <description>This function retrieves the color of a team.</description>
  2056. </function>
  2057. <function name="getTeamFriendlyFire" ret="bool">
  2058. <param name="team theTeam" type="required" />
  2059. <description>This function tells you if friendly fire is turned on for the specified team.</description>
  2060. </function>
  2061. <function name="getTeamFromName" ret="team">
  2062. <param name="string teamName" type="required" />
  2063. <description>This function finds a team object by the team's name.</description>
  2064. </function>
  2065. <function name="getTeamName" ret="string">
  2066. <param name="team theTeam" type="required" />
  2067. <description>This function gets the team name of a team object.</description>
  2068. </function>
  2069. <function name="getPlayersInTeam" ret="table">
  2070. <param name="team theTeam" type="required" />
  2071. <description>This function retrieves all the players of the specified team.</description>
  2072. </function>
  2073. </group>
  2074. <group name="Utility functions">
  2075. <function name="getDistanceBetweenPoints2D" ret="float">
  2076. <param name="float x1" type="required" />
  2077. <param name="float y1" type="required" />
  2078. <param name="float x2" type="required" />
  2079. <param name="float y2" type="required" />
  2080. <description>This function returns the distance between two 2 dimensional points using the pythagorean theorem.</description>
  2081. </function>
  2082. <function name="getDistanceBetweenPoints3D" ret="float">
  2083. <param name="float x1" type="required" />
  2084. <param name="float y1" type="required" />
  2085. <param name="float z1" type="required" />
  2086. <param name="float x2" type="required" />
  2087. <param name="float y2" type="required" />
  2088. <param name="float z2" type="required" />
  2089. <description>This function returns the distance between two 3 dimensional points using the pythagorean theorem.</description>
  2090. </function>
  2091. <function name="getRealTime" ret="table">
  2092. <param name="int seconds=current" type="optional" />
  2093. <description>This function gets the real server time and returns it in a table. If you want to get the in-game time (shown on GTA's clock) use getTime.</description>
  2094. </function>
  2095. <function name="getTickCount" ret="int">
  2096. <description>This function returns amount of time that your system has been running in milliseconds. By comparing two values of getTickCount, you can determine how much time has passed (in milliseconds) between two events. This could be used to determine how efficient your code is, or to time how long a player takes to complete a task.</description>
  2097. </function>
  2098. <function name="getTimers" ret="table">
  2099. <param name="time" type="optional" />
  2100. <description>This function returns a table of all active timers. Alternatively, only the timers with a remaining time less than or equal to a certain value can be retrieved.</description>
  2101. </function>
  2102. <function name="gettok" ret="string">
  2103. <param name="string text" type="required" />
  2104. <param name="int tokenNumber" type="required" />
  2105. <param name="int separatingCharacter" type="required" />
  2106. <description>This function splits a string using the given separating character and returns one specified substring.</description>
  2107. </function>
  2108. <function name="killTimer" ret="bool">
  2109. <param name="timer theTimer" type="required" />
  2110. <description>This function allows you to kill/halt existing timers.</description>
  2111. </function>
  2112. <function name="setTimer" ret="timer">
  2113. <param name="function theFunction" type="required" />
  2114. <param name="int timeInterval" type="required" />
  2115. <param name="int timesToExecute" type="required" />
  2116. <param name="var arguments..." type="optional" />
  2117. <description>This function allows you to trigger a function after a number of milliseconds have elapsed. You can call one of your own functions or a built-in function. For example, you could set a timer to spawn a player after a number of seconds have elapsed.</description>
  2118. </function>
  2119. <function name="split" ret="table">
  2120. <param name="string, stringToSplit" type="required" />
  2121. <param name="int separatingChar" type="required" />
  2122. <description>This function splits a string into substrings. You specify a character that will act as a separating character; this will determine where to split the sub-strings. For example, it can split the string "Hello World" into two strings containing the two words, by spliting using a space as a separator.</description>
  2123. </function>
  2124. <function name="getVersion" ret="table">
  2125. <description>This function gives you various version information about MTA and the operating system.</description>
  2126. </function>
  2127. <function name="isTimer" ret="bool">
  2128. <param name="var theVariable" type="required" />
  2129. <description>This function checks if a variable is a timer.</description>
  2130. </function>
  2131. <function name="md5" ret="string">
  2132. <param name="string str" type="required" />
  2133. <description>Calculates the MD5 hash of the specified string and returns its hexadecimal representation.</description>
  2134. </function>
  2135. <function name="tocolor" ret="int">
  2136. <param name="int red" type="required" />
  2137. <param name="int green" type="required" />
  2138. <param name="int blue" type="required" />
  2139. <param name="int alpha=255" type="optional" />
  2140. <description>This function retrieves the hex number of a specified color, useful for the dx functions.</description>
  2141. </function>
  2142. </group>
  2143. <group name="Vehicle functions">
  2144. <function name="addVehicleUpgrade" ret="bool">
  2145. <param name="vehicle theVehicle" type="required" />
  2146. <param name="int upgrade" type="required" />
  2147. <description>This function adds an upgrade to an existing vehicle, eg: nos, hyrdraulics.</description>
  2148. </function>
  2149. <function name="attachTrailerToVehicle" ret="bool">
  2150. <param name="vehicle theVehicle" type="required" />
  2151. <param name="vehicle theTrailer" type="required" />
  2152. <description>This function attaches a trailer type vehicle to a trailer-towing-type vehicle.</description>
  2153. </function>
  2154. <function name="blowVehicle" ret="bool">
  2155. <param name="vehicle vehicleToBlow" type="required" />
  2156. <param name="bool explode=true" type="optional" />
  2157. <description>This function will blow up a vehicle. This will cause an explosion and will kill the driver and any passengers inside it.</description>
  2158. </function>
  2159. <function name="createVehicle" ret="vehicle">
  2160. <param name="int model" type="required" />
  2161. <param name="float x" type="required" />
  2162. <param name="float y" type="required" />
  2163. <param name="float z" type="required" />
  2164. <param name="float rx" type="optional" />
  2165. <param name="float ry" type="optional" />
  2166. <param name="float rz" type="optional" />
  2167. <param name="string numberplate" type="optional" />
  2168. <description>This function creates a vehicle at the specified location.</description>
  2169. </function>
  2170. <function name="detachTrailerFromVehicle" ret="bool">
  2171. <param name="vehicle theVehicle" type="required" />
  2172. <param name="vehicle theTrailer" type="optional" />
  2173. <description>This function detaches an already attached trailer from a vehicle.</description>
  2174. </function>
  2175. <function name="fixVehicle" ret="bool">
  2176. <param name="vehicle theVehicle" type="required" />
  2177. <description>This function will set a vehicle's health to full and fix its damage model. If you wish to only change the vehicle's health, without affecting its damage model, use setElementHealth.</description>
  2178. </function>
  2179. <function name="getVehicleAdjustableProperty" ret="bool/int">
  2180. <param name="vehicle" type="required" />
  2181. <description>Use this to get the value of a vehicles adjustable property. This property relates to movable parts of a model, for example hydra jets or dump truck tray.</description>
  2182. </function>
  2183. <function name="getVehicleColor" ret="int, int, int, int">
  2184. <param name="vehicle theVehicle" type="required" />
  2185. <description>This function returns the color of the specified vehicle. A vehicle can have up to four colors.</description>
  2186. </function>
  2187. <function name="getVehicleCompatibleUpgrades" ret="table">
  2188. <param name="vehicle theVehicle" type="required" />
  2189. <param name="int slot" type="optional" />
  2190. <description>This function returns a table of all the compatible upgrades (or all for a specified slot, optionally) for a specifed vehicle.</description>
  2191. </function>
  2192. <function name="getVehicleController" ret="player">
  2193. <param name="vehicle theVehicle" type="required" />
  2194. <description>This function is used to get the player in control of the specified vehicle.</description>
  2195. </function>
  2196. <function name="getVehicleDoorState" ret="int">
  2197. <param name="vehicle theVehicle" type="required" />
  2198. <param name="int door" type="required" />
  2199. <description>This function returns the current state of a specifed door on the vehicle.</description>
  2200. </function>
  2201. <function name="getVehicleLandingGearDown" ret="bool">
  2202. <param name="vehicle theVehicle" type="required" />
  2203. <description>This function is used to check whether a vehicle's landing gear is down or not. Only planes can be used with this function.</description>
  2204. </function>
  2205. <function name="getVehicleLightState" ret="int">
  2206. <param name="vehicle theVehicle" type="required" />
  2207. <param name="int light" type="required" />
  2208. <description>This function returns the current state of the specified light on the vehicle.</description>
  2209. </function>
  2210. <function name="getVehicleMaxPassengers" ret="int">
  2211. <param name="vehicle theVehicle" type="required" />
  2212. <description>This function returns the maximum number of passengers that a specified vehicle can hold. Only passenger seats are counted, the driver seat is excluded.</description>
  2213. </function>
  2214. <function name="getVehicleName" ret="string">
  2215. <param name="vehicle theVehicle" type="required" />
  2216. <description>This function returns a string containing the name of the vehicle</description>
  2217. </function>
  2218. <function name="getVehicleOccupant" ret="player">
  2219. <param name="vehicle theVehicle" type="required" />
  2220. <param name="int seat=0" type="optional" />
  2221. <description>This function gets the player sitting in the specified vehicle.</description>
  2222. </function>
  2223. <function name="getVehicleOverrideLights" ret="int">
  2224. <param name="vehicle theVehicle" type="required" />
  2225. <description>This function is used to find out the current state of the override-lights setting of a vehicle.</description>
  2226. </function>
  2227. <function name="getVehiclePaintjob" ret="int">
  2228. <param name="vehicle theVehicle" type="required" />
  2229. <description>This function gets the current paintjob on the specified vehicle.</description>
  2230. </function>
  2231. <function name="getVehiclePanelState" ret="int">
  2232. <param name="vehicle theVehicle" type="required" />
  2233. <param name="int panel" type="required" />
  2234. <description>This function returns the current state of a specifed panel on the vehicle. A vehicle can have up to 7 panels.</description>
  2235. </function>
  2236. <function name="getVehiclePlateText" ret="string">
  2237. <param name="vehicle theVehicle" type="required" />
  2238. <description>This function is used to retrieve the text on the number plate of a specified vehicle.</description>
  2239. </function>
  2240. <function name="getVehicleRotation" ret="float, float, float">
  2241. <param name="vehicle theVehicle" type="required" />
  2242. <description>This function gets the rotation of a vehicle along the X, Y, and Z axes in degrees.</description>
  2243. </function>
  2244. <function name="getVehicleSirensOn" ret="bool">
  2245. <param name="vehicle theVehicle" type="required" />
  2246. <description>This function returns whether the sirens are turned on for the specified vehicle.</description>
  2247. </function>
  2248. <function name="getVehicleTowedByVehicle" ret="vehicle">
  2249. <param name="vehicle theVehicle" type="required" />
  2250. <description>This function is used to get the vehicle being towed by another.</description>
  2251. </function>
  2252. <function name="getVehicleTowingVehicle" ret="vehicle">
  2253. <param name="vehicle theVehicle" type="required" />
  2254. <description>This function is used to get the vehicle that is towing another.</description>
  2255. </function>
  2256. <function name="getVehicleTurnVelocity" ret="float, float, float">
  2257. <param name="vehicle theVehicle" type="required" />
  2258. <description>This function is used to retrieve a vehicle's turning velocity for each axis.</description>
  2259. </function>
  2260. <function name="getVehicleTurretPosition" ret="float, float">
  2261. <param name="vehicle turretVehicle" type="required" />
  2262. <description>This function gets the position of a vehicle's turret, if it has one. Vehicles with turrets include firetrucks and tanks.</description>
  2263. </function>
  2264. <function name="getVehicleUpgradeOnSlot" ret="int">
  2265. <param name="vehicle theVehicle" type="required" />
  2266. <param name="int slot" type="required" />
  2267. <description>This function returns the current upgrade id on the specified vehicle's 'upgrade slot'</description>
  2268. </function>
  2269. <function name="getVehicleUpgrades" ret="table">
  2270. <param name="vehicle theVehicle" type="required" />
  2271. <description>This function returns a table of all the upgrades on a specifed vehicle.</description>
  2272. </function>
  2273. <function name="getVehicleUpgradeSlotName" ret="string">
  2274. <param name="int slot/upgrade" type="required" />
  2275. <description>This function returns the name of an upgrade slot name (e.g. roof, spoiler).</description>
  2276. </function>
  2277. <function name="getVehicleWheelStates" ret="int, int, int, int">
  2278. <param name="vehicle theVehicle" type="required" />
  2279. <description>This function returns the current states of all the wheels on the vehicle.</description>
  2280. </function>
  2281. <function name="isVehicleFrozen" ret="bool">
  2282. <param name="vehicle theVehicle" type="required" />
  2283. <description>This function checks if a vehicle has been frozen.</description>
  2284. </function>
  2285. <function name="isVehicleFuelTankExplodable" ret="bool">
  2286. <param name="vehicle theVehicle" type="required" />
  2287. <description>This will tell you if a vehicle's petrol tank is explodable.</description>
  2288. </function>
  2289. <function name="isVehicleLocked" ret="bool">
  2290. <param name="vehicle theVehicle" type="required" />
  2291. <description>This will tell you if a vehicle is locked.</description>
  2292. </function>
  2293. <function name="isVehicleOnGround" ret="bool">
  2294. <param name="vehicle theVehicle" type="required" />
  2295. <description>Checks to see if a vehicle has contact with the ground.</description>
  2296. </function>
  2297. <function name="removeVehicleUpgrade" ret="bool">
  2298. <param name="vehicle theVehicle" type="required" />
  2299. <param name="int upgrade" type="required" />
  2300. <description>This function removes an already existing upgrade from the specified vehicle, eg: nos, hydraulics. Defined in San Andreas\data\maps\veh_mods\veh_mods.ide.</description>
  2301. </function>
  2302. <function name="setVehicleAdjustableProperty" ret="bool">
  2303. <param name="element theVehicle" type="required" />
  2304. <param name="int value" type="required" />
  2305. <description>This function is used for adjusting the movable parts of a model, for example hydra jets or dump truck tray. This function only works on vehicles with adjustable properties.</description>
  2306. </function>
  2307. <function name="setVehicleColor" ret="bool">
  2308. <param name="vehicle theVehicle" type="required" />
  2309. <param name="int color1" type="required" />
  2310. <param name="int color2" type="required" />
  2311. <param name="int color3" type="required" />
  2312. <param name="int color4" type="required" />
  2313. <description>This function will set the color of a vehicle. Each vehicle can have up to 4 colors, for different aspects of the vehicle. Most vehicles only use two of the colors.</description>
  2314. </function>
  2315. <function name="setVehicleDamageProof" ret="bool">
  2316. <param name="vehicle theVehicle" type="required" />
  2317. <param name="bool damageProof" type="required" />
  2318. <description>This functions makes a vehicle damage proof, so it won't take damage from bullets, hits, explosions or fire. A damage proof's vehicle health can still be changed via script. Also, flipping the vehicle still causes it to explode.</description>
  2319. </function>
  2320. <function name="setVehicleDirtLevel" ret="bool">
  2321. <param name="vehicle theVehicle" type="required" />
  2322. <param name="int dirtLevel" type="required" />
  2323. <description>This function sets the dirt level on a vehicle.</description>
  2324. </function>
  2325. <function name="setVehicleDoorState" ret="bool">
  2326. <param name="vehicle theVehicle" type="required" />
  2327. <param name="int door" type="required" />
  2328. <param name="int state" type="required" />
  2329. <description>This function sets the damage state of a specified door on a vehicle.</description>
  2330. </function>
  2331. <function name="setVehicleDoorsUndamageable" ret="bool">
  2332. <param name="vehicle theVehicle" type="required" />
  2333. <param name="bool state" type="required" />
  2334. <description>This function makes a vehicle's doors undamageable, so they won't fall off when they're hit. Note that the vehicle has to be locked using setVehicleLocked for this setting to have any effect.</description>
  2335. </function>
  2336. <function name="setVehicleEngineState" ret="bool">
  2337. <param name="vehicle theVehicle" type="required" />
  2338. <param name="bool engineState" type="required" />
  2339. <description>This function turns a vehicle's engine on or off. Note that the engine will always be turned on when someone enters the driver seat, unless you override that behaviour with scripts.</description>
  2340. </function>
  2341. <function name="setVehicleFrozen" ret="bool">
  2342. <param name="vehicle theVehicle" type="required" />
  2343. <param name="bool freezeStatus" type="required" />
  2344. <description>This function freezes a vehicle (stops it in its position and disables movement) or unfreezes it.</description>
  2345. </function>
  2346. <function name="setVehicleFuelTankExplodable" ret="bool">
  2347. <param name="vehicle theVehicle" type="required" />
  2348. <param name="bool explodable" type="required" />
  2349. <description>This function changes the 'explodable state' of a vehicle's fuel tank, which toggles the ability to blow the vehicle up by shooting the tank. This function will have no effect on vehicles with tanks that cannot be shot in single player.</description>
  2350. </function>
  2351. <function name="setVehicleGunsEnabled" ret="bool">
  2352. <param name="vehicle theVehicle" type="required" />
  2353. <param name="bool gunsEnabled" type="required" />
  2354. <description>This function enables or disables the weapons on a vehicle</description>
  2355. </function>
  2356. <function name="setVehicleLandingGearDown" ret="bool">
  2357. <param name="vehicle theVehicle" type="required" />
  2358. <param name="bool gearState" type="required" />
  2359. <description>This function is used to set the landing gear state of certain vehicles.</description>
  2360. </function>
  2361. <function name="setVehicleLightState" ret="bool">
  2362. <param name="vehicle theVehicle" type="required" />
  2363. <param name="int light" type="required" />
  2364. <param name="int state" type="required" />
  2365. <description>This function sets the state of the light on the vehicle.</description>
  2366. </function>
  2367. <function name="setVehicleLocked" ret="bool">
  2368. <param name="vehicle theVehicle" type="required" />
  2369. <param name="bool locked" type="required" />
  2370. <description>This function can be used to set a vehicle to be locked or unlocked. Locking a vehicle restricts access to all doors of a vehicle.</description>
  2371. </function>
  2372. <function name="setVehicleOverrideLights" ret="bool">
  2373. <param name="vehicle theVehicle" type="required" />
  2374. <param name="int value" type="required" />
  2375. <description>This function changes the light overriding setting on a vehicle.</description>
  2376. </function>
  2377. <function name="setVehiclePaintjob" ret="bool">
  2378. <param name="vehicle theVehicle" type="required" />
  2379. <param name="int value" type="required" />
  2380. <description>This function changes the paintjob on the specified vehicle.</description>
  2381. </function>
  2382. <function name="setVehiclePanelState" ret="bool">
  2383. <param name="vehicle theVehicle" type="required" />
  2384. <param name="int panelID" type="required" />
  2385. <param name="int state" type="required" />
  2386. <description>This function allows you to change the state of one of the six panels vehicle's can have. When executed on the server-side resources, the damage will be synched for all players, whereas the change is only client-side if the function is used in a client resource.</description>
  2387. </function>
  2388. <function name="setVehicleRotation" ret="bool">
  2389. <param name="vehicle theVehicle" type="required" />
  2390. <param name="rx" type="required" />
  2391. <param name="ry" type="required" />
  2392. <param name="rz" type="required" />
  2393. <description>This function rotates a vehicle around a single point.</description>
  2394. </function>
  2395. <function name="setVehicleSirensOn" ret="bool">
  2396. <param name="vehicle theVehicle" type="required" />
  2397. <param name="bool sirensOn" type="required" />
  2398. <description>This function changes the state of the sirens on the specified vehicle.</description>
  2399. </function>
  2400. <function name="setVehicleTurnVelocity" ret="bool">
  2401. <param name="vehicle theVehicle" type="required" />
  2402. <param name="float rx" type="required" />
  2403. <param name="float ry" type="required" />
  2404. <param name="float rz" type="required" />
  2405. <description>Sets the angular velocity of a vehicle. Basically applies a spin to it.</description>
  2406. </function>
  2407. <function name="setVehicleWheelStates" ret="bool">
  2408. <param name="vehicle theVehicle" type="required" />
  2409. <param name="int frontLeft" type="required" />
  2410. <param name="int rearLeft=-1" type="optional" />
  2411. <param name="int frontRight=-1" type="optional" />
  2412. <param name="int rearRight=-1" type="optional" />
  2413. <description>This function sets the state of wheels on the vehicle.</description>
  2414. </function>
  2415. <function name="getHelicopterRotorSpeed" ret="float">
  2416. <param name="vehicle heli" type="required" />
  2417. <description>Retrieves the speed at which the rotor of a helicopter rotates.</description>
  2418. </function>
  2419. <function name="getTrainDirection" ret="bool">
  2420. <param name="vehicle train" type="required" />
  2421. <description>Gets the direction in which a train is driving (clockwise or counterclockwise).</description>
  2422. </function>
  2423. <function name="getTrainSpeed" ret="float">
  2424. <param name="vehicle train" type="required" />
  2425. <description>Gets the speed at which a train is traveling on the rails.</description>
  2426. </function>
  2427. <function name="getVehicleGravity" ret="float, float, float">
  2428. <param name="vehicle theVehicle" type="required" />
  2429. <description>Retrieves the current gravity vector of a vehicle. This is the direction in which the vehicle falls, also the cameras of any passengers will be rotated to match it.</description>
  2430. </function>
  2431. <function name="getVehicleHeadLightColor" ret="int, int, int">
  2432. <param name="vehicle theVehicle" type="required" />
  2433. <description>This function will get the headlight color of a vehicle.</description>
  2434. </function>
  2435. <function name="getVehicleModelFromName" ret="int">
  2436. <param name="string name" type="required" />
  2437. <description>This function retrieves the model ID of a vehicle as an integer value from its name.</description>
  2438. </function>
  2439. <function name="getVehicleNameFromModel" ret="string">
  2440. <param name="int model" type="required" />
  2441. <description>Gets the name of a vehicle by its model ID.</description>
  2442. </function>
  2443. <function name="getVehicleType" ret="string">
  2444. <param name="vehicle theVehicle/int modelId" type="required" />
  2445. <description>This function retrieves the type of a vehicle (such as if it is a car or a boat).</description>
  2446. </function>
  2447. <function name="isTrainDerailable" ret="bool">
  2448. <param name="vehicle vehicleToCheck" type="required" />
  2449. <description>This function will check if a train or tram is derailable.</description>
  2450. </function>
  2451. <function name="isTrainDerailed" ret="bool">
  2452. <param name="vehicle vehicleToCheck" type="required" />
  2453. <description>This function will check if a train or tram is derailed.</description>
  2454. </function>
  2455. <function name="isVehicleBlown" ret="bool">
  2456. <param name="vehicle theVehicle" type="required" />
  2457. <description>This function allows you to determine whether a vehicle is blown or still intact.</description>
  2458. </function>
  2459. <function name="isVehicleTaxiLightOn" ret="bool">
  2460. <param name="vehicle taxi" type="required" />
  2461. <description>This function will get the taxi light state of a taxi (vehicle ID's 420 and 438)</description>
  2462. </function>
  2463. <function name="setHelicopterRotorSpeed" ret="bool">
  2464. <param name="vehicle heli" type="required" />
  2465. <param name="float speed" type="required" />
  2466. <description>Sets the rotor speed of a helicopter.</description>
  2467. </function>
  2468. <function name="setTrainDerailable" ret="bool">
  2469. <param name="vehicle derailableVehicle" type="required" />
  2470. <param name="bool derailable" type="required" />
  2471. <description>This function will set a train or tram as derailable. This is, if it can derail when it goes above the maximum speed.</description>
  2472. </function>
  2473. <function name="setTrainDerailed" ret="bool">
  2474. <param name="vehicle vehicleToDerail" type="required" />
  2475. <param name="bool derailed" type="required" />
  2476. <description>This function will set a train or tram as derailed.</description>
  2477. </function>
  2478. <function name="setTrainDirection" ret="bool">
  2479. <param name="vehicle train" type="required" />
  2480. <param name="bool clockwise" type="required" />
  2481. <description>Sets the direction in which a train or tram drives over the rails (clockwise or counterclockwise).</description>
  2482. </function>
  2483. <function name="setTrainSpeed" ret="bool">
  2484. <param name="vehicle train" type="required" />
  2485. <param name="float speed" type="required" />
  2486. <description>Sets the on-track speed of a train.</description>
  2487. </function>
  2488. <function name="setVehicleGravity" ret="bool">
  2489. <param name="vehicle theVehicle" type="required" />
  2490. <param name="float x" type="required" />
  2491. <param name="float y" type="required" />
  2492. <param name="float z" type="required" />
  2493. <description>Sets the gravity vector of a vehicle. The vehicle will fall in this direction, and the camera of any passengers will also be rotated to match it. Can be used for e.g. driving on walls or driving upside down.</description>
  2494. </function>
  2495. <function name="setVehicleHeadLightColor" ret="bool">
  2496. <param name="vehicle theVehicle" type="required" />
  2497. <param name="int red" type="required" />
  2498. <param name="int green" type="required" />
  2499. <param name="int blue" type="required" />
  2500. <description>This function will set the headlight color of a vehicle. valid Red Green and Blue arguments range from 0-255</description>
  2501. </function>
  2502. <function name="setVehicleTaxiLightOn" ret="bool">
  2503. <param name="vehicle taxi" type="required" />
  2504. <param name="bool LightState" type="required" />
  2505. <description>This function will set the taxi light on in a taxi (vehicle ID's 420 and 438)</description>
  2506. </function>
  2507. </group>
  2508. <group name="Water functions">
  2509. <function name="getWaveHeight" ret="float">
  2510. <description>This function returns the current wave height.</description>
  2511. </function>
  2512. <function name="setWaveHeight" ret="bool">
  2513. <param name="float height" type="required" />
  2514. <description>This function sets the wave height to the desired value, the default is 0.</description>
  2515. </function>
  2516. <function name="createWater" ret="water">
  2517. <param name="float x1" type="required" />
  2518. <param name="float y1" type="required" />
  2519. <param name="float z1" type="required" />
  2520. <param name="float x2" type="required" />
  2521. <param name="float y2" type="required" />
  2522. <param name="float z2" type="required" />
  2523. <param name="float x3" type="required" />
  2524. <param name="float y3" type="required" />
  2525. <param name="float z3" type="required" />
  2526. <param name="float x4" type="optional" />
  2527. <param name="float y4" type="optional" />
  2528. <param name="float z4" type="optional" />
  2529. <description>Creates an area of water.</description>
  2530. </function>
  2531. <function name="getWaterLevel" ret="bool/float">
  2532. <param name="float posX" type="required" />
  2533. <param name="float posY" type="required" />
  2534. <param name="float posZ" type="required" />
  2535. <description>This function allows you to retrieve the water level from a certain location. The water level is 0 in most places though it can vary (e.g. it's higher near the dam).</description>
  2536. </function>
  2537. <function name="getWaterVertexPosition" ret="float, float, float">
  2538. <param name="water theWater" type="required" />
  2539. <param name="int vertexIndex" type="required" />
  2540. <description>Gets the world position of a vertex (i.e. corner) of a water area. Each water area is either a triangle or quad (rectangle) so each has 3 or 4 corners.</description>
  2541. </function>
  2542. <function name="resetWaterColor" ret="bool">
  2543. <description>This function reset the water color of the GTA world to default.</description>
  2544. </function>
  2545. <function name="setWaterColor" ret="bool">
  2546. <param name="int red" type="required" />
  2547. <param name="int green" type="required" />
  2548. <param name="int blue" type="required" />
  2549. <param name="int alpha=200" type="optional" />
  2550. <description>This function changes the water color of the GTA world.</description>
  2551. </function>
  2552. <function name="setWaterLevel" ret="bool">
  2553. <param name="water theWater" type="optional" />
  2554. <param name=" float level" type="optional" />
  2555. <description>Sets the height of some or all the water in the game world.</description>
  2556. </function>
  2557. <function name="setWaterVertexPosition" ret="bool">
  2558. <param name="water theWater" type="required" />
  2559. <param name="int vertexIndex" type="required" />
  2560. <param name="float x" type="required" />
  2561. <param name="float y" type="required" />
  2562. <param name="float z" type="required" />
  2563. <description>Sets the world position of a corner point of a water area.</description>
  2564. </function>
  2565. </group>
  2566. <group name="Weapon functions">
  2567. <function name="getWeaponIDFromName" ret="int">
  2568. <param name="string name" type="required" />
  2569. <description>This function will obtain the ID of a particular weapon from its name.</description>
  2570. </function>
  2571. <function name="getWeaponNameFromID" ret="string">
  2572. <param name="int id" type="required" />
  2573. <description>This function allows you to retrieve the name of a weapon from an ID. Note it also allows you to retrieve the name of other methods of death, such as Fall and Rammed.</description>
  2574. </function>
  2575. </group>
  2576. <group name="World functions">
  2577. <function name="getGameSpeed" ret="bool">
  2578. <description>This function gets the current game speed value.</description>
  2579. </function>
  2580. <function name="getGravity" ret="float">
  2581. <description>This function returns the current gravity level for the context in which it is called (server or client).</description>
  2582. </function>
  2583. <function name="getGroundPosition" ret="float">
  2584. <param name="float x" type="required" />
  2585. <param name="float y" type="required" />
  2586. <param name="float z" type="required" />
  2587. <description>This function gets the Z level of the highest ground below a point.</description>
  2588. </function>
  2589. <function name="getScreenFromWorldPosition" ret="float, float">
  2590. <param name="float x" type="required" />
  2591. <param name="float y" type="required" />
  2592. <param name="float z" type="required" />
  2593. <param name="float edgeTolerance=0" type="optional" />
  2594. <param name="bool relative=true" type="optional" />
  2595. <description>This function gets the screen position of a point in the world. This is useful for attaching 2D gui elements to parts of the world (e.g. players) or detecting if a point is on the screen (though it does not check if it is actually visible, you should use processLineOfSight for that).</description>
  2596. </function>
  2597. <function name="getTime" ret="int, int">
  2598. <description>This function is used to get the current time in the game. If you want to get the real server time, use getRealTime.</description>
  2599. </function>
  2600. <function name="getWeather" ret="bool">
  2601. <description>This function returns the current weather id.</description>
  2602. </function>
  2603. <function name="getWorldFromScreenPosition" ret="float, float, float">
  2604. <param name="float x" type="required" />
  2605. <param name="float y" type="required" />
  2606. <param name="float depth" type="required" />
  2607. <description>This function allows you to retrieve the world position corresponding to the 2D position on the screen, at a certain depth.</description>
  2608. </function>
  2609. <function name="getZoneName" ret="string">
  2610. <param name="float x" type="required" />
  2611. <param name="float y" type="required" />
  2612. <param name="float z" type="required" />
  2613. <param name="bool citiesonly=false" type="optional" />
  2614. <description>This function allows you to retrieve the zone name of a certain location.</description>
  2615. </function>
  2616. <function name="isLineOfSightClear" ret="bool">
  2617. <param name="float startX" type="required" />
  2618. <param name="float startY" type="required" />
  2619. <param name="float startZ" type="required" />
  2620. <param name="float endX" type="required" />
  2621. <param name="float endY" type="required" />
  2622. <param name="float endZ" type="required" />
  2623. <param name="bool checkBuildings=true" type="optional" />
  2624. <param name="bool checkVehicles=true" type="optional" />
  2625. <param name="bool checkPeds=true" type="optional" />
  2626. <param name="bool checkObjects=true" type="optional" />
  2627. <param name="bool checkDummies=true" type="optional" />
  2628. <param name="bool seeThroughStuff=false" type="optional" />
  2629. <param name="bool ignoreSomeObjectsForCamera=false" type="optional" />
  2630. <param name="element ignoredElement=nil" type="optional" />
  2631. <description>This function checks if there are obstacles between two points of the game world, optionally ignoring certain kinds of elements.</description>
  2632. </function>
  2633. <function name="processLineOfSight" ret="bool, float, float, float, element">
  2634. <param name="float startX" type="required" />
  2635. <param name="float startY" type="required" />
  2636. <param name="float startZ" type="required" />
  2637. <param name="float endX" type="required" />
  2638. <param name="float endY" type="required" />
  2639. <param name="float endZ" type="required" />
  2640. <param name="bool checkBuildings=true" type="optional" />
  2641. <param name="bool checkVehicles=true" type="optional" />
  2642. <param name="bool checkPlayers=true" type="optional" />
  2643. <param name="bool checkObjects=true" type="optional" />
  2644. <param name="bool checkDummies=true" type="optional" />
  2645. <param name="bool seeThroughStuff=false" type="optional" />
  2646. <param name="bool ignoreSomeObjectsForCamera=false" type="optional" />
  2647. <param name="bool shootThroughStuff=false" type="optional" />
  2648. <param name="element ignoredElement=nil" type="optional" />
  2649. <description>This function checks if there is anything between 2 points in the world, and if there is, tells you where and what. The two positions must be within the local player's draw distance as the collision data is not loaded outside this area.</description>
  2650. </function>
  2651. <function name="resetSkyGradient" ret="bool">
  2652. <description>This function allows restoring of a changed sky gradient as a result of setSkyGradient.</description>
  2653. </function>
  2654. <function name="setGameSpeed" ret="bool">
  2655. <param name="int value" type="required" />
  2656. <description>This function sets the game speed to the given value.</description>
  2657. </function>
  2658. <function name="setGravity" ret="bool">
  2659. <param name="float level" type="required" />
  2660. <description>This function sets the server's gravity level. Note that this does not effect peds/players and their vehicles; to set ped/player gravity use setPedGravity.</description>
  2661. </function>
  2662. <function name="setSkyGradient" ret="bool">
  2663. <param name="int topRed=0" type="optional" />
  2664. <param name="int topGreen=0" type="optional" />
  2665. <param name="int topBlue=0" type="optional" />
  2666. <param name="int bottomRed=0" type="optional" />
  2667. <param name="int bottomGreen=0" type="optional" />
  2668. <param name="int bottomBlue=0" type="optional" />
  2669. <description>This function changes the sky color to a two-color gradient.</description>
  2670. </function>
  2671. <function name="setTime" ret="bool">
  2672. <param name="int hour" type="required" />
  2673. <param name="int minute" type="required" />
  2674. <description>This function sets the current GTA time to the given time.</description>
  2675. </function>
  2676. <function name="setWeather" ret="bool">
  2677. <param name="int weatherID" type="required" />
  2678. <description>This function instantly sets the current weather id to the given value.</description>
  2679. </function>
  2680. <function name="setWeatherBlended" ret="bool">
  2681. <param name="int weatherID" type="required" />
  2682. <description>This function will change the weather from the current weather (set using setWeather) to another weather state over a period of 60 seconds. The weather will be fully changed within 2 minutes. To ensure smooth weather transition, you should not call this function until getWeather indicates that no transition is already being done.</description>
  2683. </function>
  2684. <function name="testLineAgainstWater" ret="bool, float, float, float">
  2685. <param name="float startX" type="required" />
  2686. <param name="float startY" type="required" />
  2687. <param name="float startZ" type="required" />
  2688. <param name="float endX" type="required" />
  2689. <param name="float endY" type="required" />
  2690. <param name="float endZ" type="required" />
  2691. <description>This function checks to see if a line between two points collides with the water. This is similar to processLineOfSight, but only collides with water. Waves are taken into account when testing the line.</description>
  2692. </function>
  2693. <function name="getCloudsEnabled" ret="bool">
  2694. <description>This function will tell you if clouds are enabled or disabled.</description>
  2695. </function>
  2696. <function name="getGarageBoundingBox" ret="float, float, float, float">
  2697. <param name="int garageID" type="required" />
  2698. <description>This function outputs the bounding box of a garage.</description>
  2699. </function>
  2700. <function name="getGaragePosition" ret="float, float, float">
  2701. <param name="int garageID" type="required" />
  2702. <description>This function outputs X, Y and Z position of given garage.</description>
  2703. </function>
  2704. <function name="getGarageSize" ret="float, float, float">
  2705. <param name="int garageID" type="required" />
  2706. <description>This function outputs the size of garage.</description>
  2707. </function>
  2708. <function name="getMinuteDuration" ret="int">
  2709. <description>Tells you how long an ingame minute takes in real-world milliseconds. The default GTA value is 1000.</description>
  2710. </function>
  2711. <function name="getBlurLevel" ret="int">
  2712. <description>This function allows you to check the current blur level of a specified player.</description>
  2713. </function>
  2714. <function name="isGarageOpen" ret="bool">
  2715. <param name="int garageID" type="required" />
  2716. <description>This function checks whether or not a specific garage door is open.</description>
  2717. </function>
  2718. <function name="isWorldSpecialPropertyEnabled" ret="bool">
  2719. <param name="string propname" type="required" />
  2720. <description>Checks if a special world property (cheat) is enabled or not.</description>
  2721. </function>
  2722. <function name="setCloudsEnabled" ret="bool">
  2723. <param name="bool enabled" type="required" />
  2724. <description>This function will enable or disable clouds. This is useful for race maps which are placed high up as clouds can cause low FPS.</description>
  2725. </function>
  2726. <function name="setGarageOpen" ret="bool">
  2727. <param name="int garageID" type="required" />
  2728. <param name="bool open" type="required" />
  2729. <description>This function opens or closes the specified garage door in the world.</description>
  2730. </function>
  2731. <function name="setJetpackMaxHeight" ret="bool">
  2732. <param name="float Height" type="required" />
  2733. <description>This function changes the maximum flying height of jetpack.</description>
  2734. </function>
  2735. <function name="setMinuteDuration" ret="bool">
  2736. <param name="int milliseconds" type="required" />
  2737. <description>Sets the real-world duration of an ingame minute. The GTA default is 1000.</description>
  2738. </function>
  2739. <function name="setBlurLevel" ret="bool">
  2740. <param name="int level" type="required" />
  2741. <description>Sets the motion blur level on the clients screen. Accepts a value between 0 and 255.</description>
  2742. </function>
  2743. <function name="setWorldSpecialPropertyEnabled" ret="bool">
  2744. <param name="string propname" type="required" />
  2745. <param name="bool enable" type="required" />
  2746. <description>Enables or disables a special world property (cheat).</description>
  2747. </function>
  2748. </group>
  2749. <group name="XML functions">
  2750. <function name="xmlCopyFile" ret="xmlnode">
  2751. <param name="xmlnode nodeToCopy" type="required" />
  2752. <param name="string newFilename" type="required" />
  2753. <param name="resource inResource=getThisResource()" type="optional" />
  2754. <description>This function copies all contents of a certain node in a XML document to a new document file, so the copied node becomes the new file's root node.</description>
  2755. </function>
  2756. <function name="xmlCreateFile" ret="xmlnode">
  2757. <param name="string filename" type="required" />
  2758. <param name="string rootNodeName" type="required" />
  2759. <param name="resource inResource=getThisResource()" type="optional" />
  2760. <description>This function creates a new XML document, which can later be saved to a file by using xmlSaveFile. This function will overwrite the file specified if it already exists.</description>
  2761. </function>
  2762. <function name="xmlDestroyNode" ret="bool">
  2763. <param name="xmlnode theXMLNode" type="required" />
  2764. <description>This function destroys a XML node from the XML node tree.</description>
  2765. </function>
  2766. <function name="xmlLoadFile" ret="xmlnode">
  2767. <param name="string filename" type="required" />
  2768. <param name="resource fromResource=getThisResource ()" type="optional" />
  2769. <description>This function provides an alternative way to load XML files to getResourceConfig.</description>
  2770. </function>
  2771. <function name="xmlNodeGetAttribute" ret="string">
  2772. <param name="xmlnode node" type="required" />
  2773. <param name="string name" type="required" />
  2774. <description>This function is used to return an attribute of a node in a configuration file.</description>
  2775. </function>
  2776. <function name="xmlNodeGetValue" ret="string">
  2777. <param name="xmlnode theXMLNode" type="required" />
  2778. <description>This function is made to be able to read tag values in XML files (eg. &lt;something&gt;anything&lt;/something&gt;).</description>
  2779. </function>
  2780. <function name="xmlNodeSetAttribute" ret="bool">
  2781. <param name="xmlnode node" type="required" />
  2782. <param name="string name" type="required" />
  2783. <param name="var value" type="required" />
  2784. <description>This function is used to edit an attribute of a node in a configuration file.</description>
  2785. </function>
  2786. <function name="xmlNodeSetValue" ret="bool">
  2787. <param name="xmlnode theXMLNode" type="required" />
  2788. <param name="string value" type="required" />
  2789. <description>This function is made to be able to assign values to tags in XML files (eg. &lt;something&gt;anything&lt;/something&gt;).</description>
  2790. </function>
  2791. <function name="xmlSaveFile" ret="bool">
  2792. <param name="xmlnode rootNode" type="required" />
  2793. <description>This function saves a loaded XML file.</description>
  2794. </function>
  2795. <function name="xmlUnloadFile" ret="bool">
  2796. <param name="xmlnode node" type="required" />
  2797. <description>Unloads an XML document from memory.</description>
  2798. </function>
  2799. <function name="xmlCreateChild" ret="xmlnode">
  2800. <param name="xmlnode parentNode" type="required" />
  2801. <param name="string tagName" type="required" />
  2802. <description>This function creates a new child node under an XML node.</description>
  2803. </function>
  2804. <function name="xmlFindChild" ret="xmlnode">
  2805. <param name="xmlnode parent" type="required" />
  2806. <param name="string tagName" type="required" />
  2807. <param name="int index" type="required" />
  2808. <description>This function returns a named child node of an XML node.</description>
  2809. </function>
  2810. <function name="xmlNodeGetAttributes" ret="table">
  2811. <param name="xmlnode node" type="required" />
  2812. <description>Returns all the attributes of a specific XML node.</description>
  2813. </function>
  2814. <function name="xmlNodeGetChildren" ret="table/xmlnode">
  2815. <param name="xmlnode parent" type="required" />
  2816. <param name="int index" type="optional" />
  2817. <description>This function returns all children of a particular XML node, or a particular child node.</description>
  2818. </function>
  2819. <function name="xmlNodeGetName" ret="string">
  2820. <param name="xmlnode node" type="required" />
  2821. <description>Gets the tag name of the specified XML node.</description>
  2822. </function>
  2823. <function name="xmlNodeGetParent" ret="xmlnode">
  2824. <param name="xmlnode node" type="required" />
  2825. <description>Returns the parent node of an xml node.</description>
  2826. </function>
  2827. <function name="xmlNodeSetName" ret="bool">
  2828. <param name="xmlnode node" type="required" />
  2829. <param name="string name" type="required" />
  2830. <description>Sets the tag name of the specified XML node.</description>
  2831. </function>
  2832. </group>
  2833. </funcs>
Advertisement
Add Comment
Please, Sign In to add comment