allObjects: Difference between revisions

From Bohemia Interactive Community
m (Some wiki formatting)
(Change group to Object Detection)
(16 intermediate revisions by 4 users not shown)
Line 3: Line 3:
|game1= arma3
|game1= arma3
|version1= 2.10
|version1= 2.10
|branch= dev


|gr1= Object Manipulation
|gr1= Object Detection


|descr= Returns array of requested objects as fast as the engine allows it. The objects can be requested by object type and simulation kind.
|descr= Returns array of requested objects as fast as the engine allows it. The objects can be requested by object type and simulation kind.
{{Feature|informative|Some terrain placed objects are not part of slow vehicles collection, use [[nearestTerrainObjects]] command to return these objects}}


|s1= objectType [[allObjects]] simulationKind
|s1= objectType [[allObjects]] objectCollection


|p1= objectType: [[Number]] - type can be a combination of types according to bit flag operation (identical to [[getObjectType]]):
|p1= objectType: [[Number]] - type can be a combination of types according to bit flag operation (see [[getObjectType]]):
* -1 - {{GVI|arma3|2.12}} All types incl. nulls (nulls exist with 'objectCollection' 7 and 8)
* 1 - Primary - normal object placed in Terrain Builder, part of landscape
* 1 - Primary - normal object placed in Terrain Builder, part of landscape
* 2 - Network - road placed in Terrain Builder, part of landscape
* 2 - Network - road placed in Terrain Builder, part of landscape
Line 19: Line 20:
* 32 - LandDecal - land decal
* 32 - LandDecal - land decal
For example if required objects are both TerrainBuilder-placed ('''1''') and dynamically placed ('''8''') the combination type will be  8 + 1 = '''9'''
For example if required objects are both TerrainBuilder-placed ('''1''') and dynamically placed ('''8''') the combination type will be  8 + 1 = '''9'''
{{Feature|informative|Use '''63''' (1 + 2 + 4 + 8 + 16 + 32) to return objects of all types.}}
{{Feature|informative|Use '''63''' (1 + 2 + 4 + 8 + 16 + 32) to return objects of all types (excl. nulls).}}


|p2= simulationKind: [[Number]] - simulation kind can be:
|p2= objectCollection: [[Number]] - supported values:
* 0 - Slow (and very slow) entities: houses, rubbles, street lamps, churches, etc
* 0 - Slow (and very slow) entities: some houses, rubbles, street lamps, churches, etc
* 1 - Normal entities: vehicles etc
* 1 - Normal entities: vehicles etc
* 2 - Fast entities: shots and other high precision entities
* 2 - Fast entities: shots and other high precision entities
Line 29: Line 30:
* 5 - Animals: animals, birds, insects, etc
* 5 - Animals: animals, birds, insects, etc
* 6 - Mines: mines
* 6 - Mines: mines
* 7 - {{GVI|arma3|2.12}} Sensor map: ordered triggers. When trigger is created it is added to this collection in the order of creation. When deleted it becomes null. Use 'objectType' -1 to include nulls
* 8 - {{GVI|arma3|2.12}} Vehicle map: ordered vehicles. When vehicle is created it is added to this collection in the order of creation. When deleted it becomes null. Use 'objectType' -1 to include nulls


|r1= [[Array]] - array of [[Object]]s
|r1= [[Array]] - array of [[Object]]s


|x1= <sqf>_visitorBuildings = 1 allObjects 0;</sqf>
|s2= objectType [[allObjects]] objectCollection
|s2since= Arma3 2.12
|p21= objectType: [[String]] - type of the objects (will exact match return of [[typeOf]])
|p22= objectCollection: [[Number]] - see main syntax above


|x2= <sqf>_userPlacedBuildings = 8 allObjects 0;</sqf>
|x1= <sqf>private _visitorBuildings = 1 allObjects 0;</sqf>
 
|x2= <sqf>private _userPlacedBuildings = 8 allObjects 0;</sqf>


|x3= <sqf>onEachFrame
|x3= <sqf>onEachFrame
Line 50: Line 58:
};</sqf>
};</sqf>


|seealso= [[getObjectFOV]] [[cursorObject]] [[cursorTarget]] [[createSimpleObject]] [[allMissionObjects]] [[setObjectViewDistance]] [[getObjectViewDistance]] [[objectParent]] [[object]] [[getObjectType]]
|x4= <sqf>private _allGroundWeaponHolders = "GroundWeaponHolder" allObjects 0;
private _allSimulatedWeaponHolders = "WeaponHolderSimulated" allObjects 1;</sqf>
 
|seealso= [[getObjectFOV]] [[cursorObject]] [[cursorTarget]] [[createSimpleObject]] [[allMissionObjects]] [[setObjectViewDistance]] [[getObjectViewDistance]] [[objectParent]] [[object]] [[getObjectType]] [[allPlayers]] [[allGroups]] [[allDead]] [[playableUnits]] [[switchableUnits]] [[units]] [[vehicles]] [[allUnitsUAV]] [[allCurators]] [[playersNumber]]
}}
 
{{Note
|user= PierreMGI
|timestamp= 20221130173209
|text= This command (63 allObjects 0) will return lamps or poles but not houses. Use nearestTerrainObjects instead.
}}
}}

Revision as of 15:27, 18 February 2023

Arma 3 logo black.png 2.10
Hover & click on the images for description

Description

Description:
Returns array of requested objects as fast as the engine allows it. The objects can be requested by object type and simulation kind.
ⓘ
Some terrain placed objects are not part of slow vehicles collection, use nearestTerrainObjects command to return these objects
Groups:
Object Detection

Syntax

Syntax:
objectType allObjects objectCollection
Parameters:
objectType: Number - type can be a combination of types according to bit flag operation (see getObjectType):
  • -1 - Arma 3 logo black.png 2.12 All types incl. nulls (nulls exist with 'objectCollection' 7 and 8)
  • 1 - Primary - normal object placed in Terrain Builder, part of landscape
  • 2 - Network - road placed in Terrain Builder, part of landscape
  • 4 - Temporary - temporary object (like vehicle tracks)
  • 8 - TypeVehicle - entity added by game
  • 16 - TypeTempVehicle - temporary entity
  • 32 - LandDecal - land decal
For example if required objects are both TerrainBuilder-placed (1) and dynamically placed (8) the combination type will be 8 + 1 = 9
ⓘ
Use 63 (1 + 2 + 4 + 8 + 16 + 32) to return objects of all types (excl. nulls).
objectCollection: Number - supported values:
  • 0 - Slow (and very slow) entities: some houses, rubbles, street lamps, churches, etc
  • 1 - Normal entities: vehicles etc
  • 2 - Fast entities: shots and other high precision entities
  • 3 - Cloudlets: smokes, dust, etc
  • 4 - Out vehicles: objects that are not listed anywhere else, holders, etc
  • 5 - Animals: animals, birds, insects, etc
  • 6 - Mines: mines
  • 7 - Arma 3 logo black.png 2.12 Sensor map: ordered triggers. When trigger is created it is added to this collection in the order of creation. When deleted it becomes null. Use 'objectType' -1 to include nulls
  • 8 - Arma 3 logo black.png 2.12 Vehicle map: ordered vehicles. When vehicle is created it is added to this collection in the order of creation. When deleted it becomes null. Use 'objectType' -1 to include nulls
Return Value:
Array - array of Objects

Alternative Syntax

Syntax:
objectType allObjects objectCollection
Parameters:
objectType: String - type of the objects (will exact match return of typeOf)
objectCollection: Number - see main syntax above
Return Value:
Nothing

Examples

Example 1:
private _visitorBuildings = 1 allObjects 0;
Example 2:
private _userPlacedBuildings = 8 allObjects 0;
Example 3:
onEachFrame { hintSilent str [ count (63 allObjects 0), count (63 allObjects 1), count (63 allObjects 2), count (63 allObjects 3), count (63 allObjects 4), count (63 allObjects 5), count (63 allObjects 6) ]; };
Example 4:
private _allGroundWeaponHolders = "GroundWeaponHolder" allObjects 0; private _allSimulatedWeaponHolders = "WeaponHolderSimulated" allObjects 1;

Additional Information

See also:
getObjectFOV cursorObject cursorTarget createSimpleObject allMissionObjects setObjectViewDistance getObjectViewDistance objectParent object getObjectType allPlayers allGroups allDead playableUnits switchableUnits units vehicles allUnitsUAV allCurators playersNumber

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord.
Only post proven facts here! Add Note
PierreMGI - c
Posted on Nov 30, 2022 - 17:32 (UTC)
This command (63 allObjects 0) will return lamps or poles but not houses. Use nearestTerrainObjects instead.
Retrieved from "https://community.bistudio.com/wiki?title=allObjects&oldid=337668"