{"name":"nearestLocations","operator":null,"title":"nearestLocations","type":"command","url":"https://community.bistudio.com/wiki/nearestLocations","revid":377540,"updated":"2026-01-02T06:54:27Z","groups":["Locations"],"status":"ok","replaced_by":[],"games":[{"game":"arma1","name":"Armed Assault","version":"1.08"},{"game":"arma2","name":"Arma 2","version":"1.00"},{"game":"arma2oa","name":"Arma 2: Operation Arrowhead","version":"1.50"},{"game":"tkoh","name":"Take On Helicopters","version":"1.00"},{"game":"arma3","name":"Arma 3","version":"0.50"}],"since":{"game":"arma1","name":"Armed Assault","version":"1.08"},"arma3_since":"0.50","branch":null,"locality":{"argument":null,"effect":null,"server_exec":false},"exec":null,"description":"Returns an array of locations of chosen type(s) within the given radius of the given position, sorted from nearest to farthest.\n\n> [!NOTE]\n> Although locations can be placed in 3D with setPosition, nearestLocations' search result is sorted in 2D.","syntaxes":[{"syntax":"nearestLocations [centre, locationTypes, radius, sortPosition]","since":null,"effect":null,"exec":null,"params":[{"name":"centre","type":"Position2D, Position3D or Object","optional":false,"default":null,"description":null,"types":["Position2D","Position3D","Object"],"since":null,"text":"centre: Position2D, Position3D or Object"},{"name":"locationTypes","type":"Array of Strings","optional":false,"default":null,"description":"list of location type names, e.g \"NameCity\"; Arma 3 v2.14 passing empty array [] will return all available locations within the radius","types":["Array","String"],"since":null,"text":"locationTypes: Array of Strings - list of location type names, e.g \"NameCity\"; Arma 3 v2.14 passing empty array [] will return all available locations within the radius"},{"name":"radius","type":"Number","optional":false,"default":null,"description":"maximum distance from the given position that returned locations may be, in metres","types":["Number"],"since":null,"text":"radius: Number - maximum distance from the given position that returned locations may be, in metres"},{"name":"sortPosition","type":"Position2D, Position3D or Object","optional":true,"default":null,"description":"results will be sorted from the distance to given *sortPosition* (nearest to farthest still)","types":["Position2D","Position3D","Object"],"since":null,"text":"sortPosition: Position2D, Position3D or Object - (Optional) results will be sorted from the distance to given *sortPosition* (nearest to farthest still)"}],"returns":{"type":"Array of Locations","types":["Array","Location"],"description":null,"text":"Array of Locations"},"form":"unary","operator":null,"left":null,"right":{"text":"[centre, locationTypes, radius, sortPosition]","types":["Array"]}}],"examples":[{"text":"```sqf\n_nearbyLocations = nearestLocations [getPosATL player, [\"RockArea\", \"VegetationFir\"], 100];\n```","code":["_nearbyLocations = nearestLocations [getPosATL player, [\"RockArea\", \"VegetationFir\"], 100];"]},{"text":"Find any of nearest locations:\n\n```sqf\nprivate _allLocationTypes = [];\n\"_allLocationTypes pushBack configName _x\" configClasses (configFile >> \"CfgLocationTypes\");\n{\n    systemChat format [\n        \"%1 (%2) - %3m\", \n        _x, \n        text _x, \n        getPosATL player distance _x\n    ];\n} forEach nearestLocations [player, _allLocationTypes, 500];\n```","code":["private _allLocationTypes = [];\n\"_allLocationTypes pushBack configName _x\" configClasses (configFile >> \"CfgLocationTypes\");\n{\n\tsystemChat format [\n\t\t\"%1 (%2) - %3m\", \n\t\t_x, \n\t\ttext _x, \n\t\tgetPosATL player distance _x\n\t];\n} forEach nearestLocations [player, _allLocationTypes, 500];"]}],"multiplayer":null,"problems":null,"aliases":[],"see_also":["createLocation","nearestLocation","locationPosition","nearestLocationWithDubbing"],"notes":[],"categories":["ArmA: Armed Assault: New Scripting Commands","ArmA: Armed Assault: Scripting Commands","Arma 2: Operation Arrowhead: Scripting Commands","Arma 2: Scripting Commands","Arma 3: Scripting Commands","Command Group: Locations","Introduced with Armed Assault version 1.08","Scripting Commands","Take On Helicopters: Scripting Commands"]}