DCS func searchObjects - Revision history

Grimes at 23:40, 21 April 2023

2023-04-21T23:40:46Z

Grimes at 07:13, 17 March 2022

2022-03-17T07:13:53Z

Bailey at 16:00, 8 February 2022

2022-02-08T16:00:10Z

Grimes at 00:36, 7 June 2020

2020-06-07T00:36:25Z

Grimes at 23:24, 2 June 2020

2020-06-02T23:24:32Z

Grimes: 1 revision imported

2018-04-12T00:12:18Z

1 revision imported

New page

{{Template:dcs_funcs

|fName= searchObjects

|vNum= 1.2.4

|par1= [[DCS_singleton_world|world]]

|par2=

|par3=

|par4=

|desc= Searches a defined volume of 3d space for the specified objects within it and then can run function on each returned object.

Object category is either a single enum or a table of enums that defines the types of objects that will be searched for

Search volume is the defined 3d space that will be searched.

Handler is the function that will be run on each object that is found.

Any data is a variable that is passed to the handler function, it can be anything.

|rtnType= table

|rtnExample=

|reqType1= table/enum

|reqName1= Object.Category

|reqType2= volume

|reqName2= searchVolume

|reqType3= ObjectSearchHandler

|reqName3= Handler

|reqType4=

|reqName4=

|reqType5=

|optType1= any

|optName1= data

|optType2=

|examples= The following example would populate the table "foundUnits" of any unit found within a sphere defined by the zone "town"
local foundUnits = {}
local sphere = trigger.misc.getZone('town')
local volS = {
id = world.VolumeType.SPHERE,
params = {
point = sphere.point,
radius = sphere.radius
}
}

local ifFound = function(foundItem, val)
foundUnits[#foundUnits + 1] = foundItem:getName
return true
end

world.searchObjects(Object.Category.UNIT, volS, ifFound)

|related=
[[DCS_singleton_world|'''World Functions:''']] {{ListOfWorldFuncs}}

|notes=
}}

[[Category:Singleton Functions|searchObjects]]

@@ Line 17: / Line 17: @@
 Object category is either a single enum or a table of enums that defines the types of objects that will be searched for.
-Search volume is the defined 3d space that will be searched.
+Search volume is the defined 3d space that will be searched. See pages for the correct format of each volume type:
 Handler is the function that will be run on each object that is found.

← Older revision		Revision as of 07:13, 17 March 2022
Line 78:		Line 78:

	[[Category:Singleton Functions\|searchObjects]]		[[Category:Singleton Functions\|searchObjects]]
		+	[[Category:Game Patch 1.2.4\|searchObjects]]

@@ Line 25: / Line 25: @@
 |rtnType= table
-|rtnExample=
+|rtnExample= [[DCS_Class_Object|Object]]
 |reqType1= table/enum

@@ Line 63: / Line 63: @@
    local ifFound = function(foundItem, val)
-      foundUnits[#foundUnits + 1] = foundItem:getName
+      foundUnits[#foundUnits + 1] = foundItem:getName()
       return true
    end