allSimpleObjects: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|arma3 |= Game " to "|arma3 |Game name= ")
m (Some wiki formatting)
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________
|arma3 |Game name=
|1.68|Game Version=
|arg=  |Multiplayer Arguments=
|eff=  |Multiplayer Effects=
____________________________________________________________________________________________
| Returns array of all simple objects that belong to the listed class names. If the array of types is empty [], all simple objects are returned including those without class name.<br><br>
{{Informative |There is no inheritance in simple objects, so only exact class match is allowed. ''className'' is not case sensitive}} |DESCRIPTION=
____________________________________________________________________________________________
| '''allSimpleObjects''' [className1, className2,...classNameN] |SYNTAX=
|p1= [className1, className2,...classNameN]: [[Array]] |PARAMETER1=
|p2=  className: [[String]] - simple object class name to return. Use [] to return all simple objects|PARAMETER2=


| [[Array]] - array of [[createSimpleObject|simple objects]] |RETURNVALUE=
|game1= arma3
|x1= <code>[[allSimpleObjects]] ["Box_NATO_Equip_F", "Land_CampingChair_V2_F"];</code> |EXAMPLE1=
|version1= 1.68
|x2= <code>_allSimpleObjects = [[allSimpleObjects]] [];</code> |EXAMPLE1=
 
| [[createSimpleObject]], [[isSimpleObject]], [[nearestObjects]], [[nearObjectsReady]], [[nearObjects]], [[nearestObject]], [[createVehicle]] |SEEALSO=
|gr1= Object Detection
}}
 
|descr= Returns array of all simple objects that belong to the listed class names. If the array of types is empty [], all simple objects are returned including those without class name.{{Feature|Informative|
* There is no inheritance in simple objects, so only exact class match is allowed.
* ''className'' is not case sensitive.}}
 
|s1= [[allSimpleObjects]] classes
 
|p1= classes: [[Array]] of [[String]]s - classnames array. Use <tt>[]</tt> to return all simple objects


<dl class='command_description'>
|r1= [[Array]] - array of [[createSimpleObject|simple objects]]


</dl>
|x1= <code>[[allSimpleObjects]] ["Box_NATO_Equip_F", "Land_CampingChair_V2_F"];</code>


<h3 style='display:none'>Bottom Section</h3>
|x2= <code>_allSimpleObjects = [[allSimpleObjects]] [];</code>
<!-- Appropriate categories go here -->


[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
|seealso= [[createSimpleObject]], [[isSimpleObject]], [[nearestObjects]], [[nearObjectsReady]], [[nearObjects]], [[nearestObject]], [[createVehicle]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
}}

Revision as of 21:53, 9 June 2021

Hover & click on the images for description

Description

Description:
Returns array of all simple objects that belong to the listed class names. If the array of types is empty [], all simple objects are returned including those without class name.
  • There is no inheritance in simple objects, so only exact class match is allowed.
  • className is not case sensitive.
Groups:
Object Detection

Syntax

Syntax:
allSimpleObjects classes
Parameters:
classes: Array of Strings - classnames array. Use [] to return all simple objects
Return Value:
Array - array of simple objects

Examples

Example 1:
allSimpleObjects ["Box_NATO_Equip_F", "Land_CampingChair_V2_F"];
Example 2:
_allSimpleObjects = allSimpleObjects [];

Additional Information

See also:
createSimpleObjectisSimpleObjectnearestObjectsnearObjectsReadynearObjectsnearestObjectcreateVehicle

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note