get3DENSelected: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Fix)
 
(35 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


|arma3|= Game name
|game1= arma3
|version1= 1.56


|1.56|= Game version
|gr1= Eden Editor
____________________________________________________________________________________________


| Returns an array of all selected [[Eden Entity|Eden Editor Entities]] of the given type, or, if empty string <tt>""</tt> is used, an array of 6 arrays in the following format: <br><tt>[[/*objects...*/],[/*groups...*/],[/*triggers...*/],[/*logics...*/],[/*waypoints...*/],[/*markers...*/]]</tt><br> Layers and comments are not included in the all types array return. In case a wrong type is used the command will return <tt>[[],[],[],[],[],[]]</tt> and an error message is displayed.|DESCRIPTION=
|descr= Returns an array of all selected [[Eden Entity|Eden Editor Entities]] of the given type.<br>
____________________________________________________________________________________________
If a wrong type is provided, {{hl|[[], [], [], [], [], []]}} is returned and an error message is shown.


| '''get3DENSelected''' type |SYNTAX=
|s1= [[get3DENSelected]] type
|p1= type: [[String]] - entity type, can be:<br/>
* "object"
* "group"
* "trigger"
* "logic"
* "waypoint"
* "marker"
* "layer"
* "comment"
* "" - all types except "layer" and "comment"
<br/>|PARAMETER1=
| [[Array of Eden Entities]] |RETURNVALUE=


|x1= <code>[[systemChat]] [[str]] ([[get3DENSelected]] "");
|p1= type: [[String]] - entity type, can be one of:
/* outputs: [
{{Columns|2|
[B Alpha 2-1:1],//objects
* {{hl|"object"}}
[B Alpha 2-1],//groups
* {{hl|"group"}}
[164494: <no shape>],//triggers
* {{hl|"trigger"}}
[<No center> Charlie 1-2:4],//logic
* {{hl|"logic"}}
[ [B Alpha 2-1,0] ],//waypoints
* {{hl|"waypoint"}}
["Hotel_Whiskey"]//markers
* {{hl|"marker"}}
]*/</code>|EXAMPLE1=
* {{hl|"layer"}}
|x2= <code>[[systemChat]] [[str]] ([[get3DENSelected]] "object");
* {{hl|"comment"}}
// outputs: [B Alpha 2-1:1]</code>|EXAMPLE2=
* {{hl|""}} - everything but "layer" and "comment"
____________________________________________________________________________________________
}}
 
|r1= [[Array]] - array of entities


|  
|x1= <sqf>
[[get3DENMouseOver]]
get3DENSelected "";
[[add3DENConnection]]
[[add3DENEventHandler]]
[[all3DENEntities]]
[[collect3DENHistory]]
[[create3DENComposition]]
[[create3DENEntity]]
[[current3DENOperation]]
[[delete3DENEntities]]
[[do3DENAction]]
[[get3DENActionState]]
[[get3DENAttribute]]
[[get3DENCamera]]
[[get3DENConnections]]
[[get3DENEntityID]]
[[get3DENGrid]] 
[[get3DENIconsVisible]]
[[get3DENLinesVisible]]
[[is3DEN]]
[[is3DENMultiplayer]]
[[move3DENCamera]]
[[remove3DENConnection]]
[[remove3DENEventHandler]]
[[removeAll3DENEventHandlers]]
[[set3DENAttributes]]
[[set3DENGrid]]
[[set3DENIconsVisible]]
[[set3DENLinesVisible]]
[[set3DENObjectType]]
|SEEALSO=
|  |MPBEHAVIOUR=  
____________________________________________________________________________________________
}}


<h3 style='display:none'>Notes</h3>
/*
<dl class='command_description'>
[
<!-- Note Section BEGIN -->
[B Alpha 2-1:1], // objects
<!-- Note Section END -->
[B Alpha 2-1], // groups
</dl>
[164494: <no shape>], // triggers
<!-- DISCONTINUE Notes -->
[<No center> Charlie 1-2:4], // logic
[<nowiki/>[B Alpha 2-1,0]], // waypoints
["Hotel_Whiskey"] // markers
]
*/
</sqf>


|x2= <sqf>get3DENSelected "object"; // [B Alpha 2-1:1]</sqf>


<h3 style='display:none'>Bottom Section</h3>
|seealso= [[all3DENEntities]] [[get3DENMouseOver]] [[delete3DENEntities]]
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command Group: Eden Editor|{{uc:{{PAGENAME}}}}]]

Latest revision as of 19:46, 8 October 2024

Arma 3 logo black.png1.56
Hover & click on the images for description

Description

Description:
Returns an array of all selected Eden Editor Entities of the given type.
If a wrong type is provided, [[], [], [], [], [], []] is returned and an error message is shown.
Groups:
Eden Editor

Syntax

Syntax:
get3DENSelected type
Parameters:
type: String - entity type, can be one of:
  • "object"
  • "group"
  • "trigger"
  • "logic"
  • "waypoint"
  • "marker"
  • "layer"
  • "comment"
  • "" - everything but "layer" and "comment"
Return Value:
Array - array of entities

Examples

Example 1:
get3DENSelected ""; /* [ [B Alpha 2-1:1], // objects [B Alpha 2-1], // groups [164494: <no shape>], // triggers [<No center> Charlie 1-2:4], // logic [[B Alpha 2-1,0]], // waypoints ["Hotel_Whiskey"] // markers ] */
Example 2:
get3DENSelected "object"; // [B Alpha 2-1:1]

Additional Information

See also:
all3DENEntities get3DENMouseOver delete3DENEntities

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
Retrieved from "https://community.bistudio.com/wiki?title=get3DENSelected&oldid=369792"