added documentation for convertClientLocation function

This commit is contained in:
Valmo Trindade
2025-05-16 00:23:34 -03:00
parent bcefc7670f
commit f2fe8b586c
2 changed files with 22 additions and 1 deletions

View File

@@ -1,3 +1,24 @@
#include "..\script_component.hpp"
/*
* Author: Valmo Trindade
* This function is used to convert the position of a unit to the world world location.
*
* Argument:
* 0: in game latitude <NUMBER> is the latitude of the unit.
* 1: in game longitude <NUMBER> is the longitude of the unit.
* 2: in game altitude <NUMBER> is the altitude of the unit.
* 3: in game bearing <NUMBER> is the bearing of the unit.
*
* Return Value:
* ARRAY -> [latitude, longitude, altitude, bearing]
*
* Example:
* [player] call armatak_client_fnc_convertClientLocation;
*
* Public: Yes
*/
params["_latitude", "_longitude", "_altitude"];
_position = [_latitude, _longitude, _altitude];