Difference between revisions of "allSimpleObjects"

From Bohemia Interactive Community
Jump to navigation Jump to search
(dev)
(format, see also, example)
Line 6: Line 6:
 
|eff=  |= Multiplayer Effects
 
|eff=  |= Multiplayer Effects
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
| Returns array of all simple objects that belong to one of the listed types / classes. If the array of types is empty all simple objects are returned.<br><br>''There is no inheritance in simple objects, so only exact class match is allowed. However classname is not case sensitive.'' |= 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.<br><br>'''NOTE''': There is no inheritance in simple objects, so only exact class match is allowed. ''className'' is not case sensitive. |= Description
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
| '''allSimpleObjects''' types |= Syntax
+
| '''allSimpleObjects''' [className1, className2,...classNameN] |= Syntax
|p1= types: [[Array]] |= Parameter 1
+
|p1= [className1, className2,...classNameN]: [[Array]] |= Parameter 1
|p2=  |= Parameter 2
+
|p2=  className: [[String]] - simple object class name to return. Use [] to return all simple objects|= Parameter 2
|p3=  |= Parameter 3
+
 
|p4=  |= Parameter 4
+
| [[Array]] - array of [[createSimpleObject|simple objects]] |= Return Value
|p5=  |= Parameter 5
+
|x1= <code>[[allSimpleObjects]] ["Box_NATO_Equip_F", "Land_CampingChair_V2_F"];</code> |= Example 1
|p6=  |= Parameter 6
+
|x2= <code>_allSimpleObjects = [[allSimpleObjects]] [];</code> |= Example 1
| simpleObjects: [[Array]] |= Return Value
+
| [[createSimpleObject]], [[isSimpleObject]], [[createVehicle]] |= See Also
|x1= '''allSimpleObjects''' ["Box_NATO_Equip_F","Land_CampingChair_V2_F"] |= Example 1
 
| [[createSimpleObject]],[[isSimpleObject]] |= See Also
 
 
}}
 
}}
  
 
<dl class='command_description'>
 
<dl class='command_description'>
<!-- BEGIN Note Section -->
+
 
<!-- For example:
 
<dd class='notedate'>Posted on Month Day, Year - Time (UTC)</dd>
 
<dt class='note'>'''[[User:User Name|User Name]]'''</dt>
 
<dd class='note'>This is an example note. It is true and verifiable, and contains a little code snippet.
 
<code>[[if]] ([[_this]] == anExample) [[then]] { [[hint]] Leave it here for others to read; };</code></dd>
 
-->
 
<!-- END Note Section -->
 
 
</dl>
 
</dl>
  

Revision as of 22:46, 13 December 2016

-wrong parameter ("arma3dev") defined!-[[:Category:Introduced with arma3dev version 1.67|1.67]]
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.

NOTE: There is no inheritance in simple objects, so only exact class match is allowed. className is not case sensitive.
Groups:
Uncategorised

Syntax

Syntax:
allSimpleObjects [className1, className2,...classNameN]
Parameters:
[className1, className2,...classNameN]: Array
className: String - simple object class name to return. 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:
createSimpleObjectisSimpleObjectcreateVehicle

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

[[Category:Introduced with arma3dev version 1.67]][[ Category: arma3dev: New Scripting Commands | ALLSIMPLEOBJECTS]][[ Category: arma3dev: Scripting Commands | ALLSIMPLEOBJECTS]]

Bottom Section