isGroupDeletedWhenEmpty: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Update)
m (Text replacement - "\{\{Feature *\| *Informative *\| ([^↵]+) *\}\}" to "{{Feature|informative|$1}}")
 
(42 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.68


|1.68|= Game version
|gr1= Groups


|descr= Checks if the given group marked for auto-deletion when empty. See [[deleteGroupWhenEmpty]].
{{Feature|informative|It might take up to a minute for the groups marked for auto-deletion when empty to get deleted when they become empty.}}
{{Feature | Important | This command is only a getter for the deleteWhenEmpty flag in [[createGroup]] command or [[deleteGroupWhenEmpty]] command. All it does is it shows what the flag was set to during group creation. [[true|True]] does not mean the group will be deleted but that it was suggested to the engine that it should be deleted. It is up to the engine how it manages groups. [[false|False]] does not mean that the group will not be deleted '''at all'''. It has no influence on the engine functionality whatsoever. }}


____________________________________________________________________________________________


| Checks if the given group marked for auto-deletion when empty. See [[deleteGroupWhenEmpty]].|=
|s1= [[isGroupDeletedWhenEmpty]] group
____________________________________________________________________________________________


| '''isGroupDeletedWhenEmpty''' group |= Syntax
|p1= group: [[Group]]


|p1= group: [[Group]] |= Parameter 1
|r1= [[Boolean]] - [[true]] the group is marked for auto-deletion when empty


| [[Boolean]] - [[true]] the group is marked for auto-deletion when empty  |= Return value
|x1= <sqf>_isMarked = isGroupDeletedWhenEmpty _group;</sqf>
 
____________________________________________________________________________________________
 
|x1= <code>_isMarked = [[isGroupDeletedWhenEmpty]] _group;</code> |= Example 1
____________________________________________________________________________________________
 
| [[deleteGroup]], [[deleteGroupWhenEmpty]], [[createGroup]], [[group]], [[setGroupId]], [[groupID]], [[units]], [[groupFromNetId]], [[netId]], [[leader]], [[selectLeader]], [[join]], [[createCenter]], [[createUnit]], [[createVehicle]], [[Side]] |= See also


|seealso= [[deleteGroup]] [[deleteGroupWhenEmpty]] [[createGroup]] [[group]] [[setGroupId]] [[groupID]] [[units]] [[groupFromNetId]] [[netId]] [[leader]] [[selectLeader]] [[join]] [[createCenter]] [[createUnit]] [[createVehicle]] [[Side]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]

Latest revision as of 19:11, 15 March 2024

Hover & click on the images for description

Description

Description:
Checks if the given group marked for auto-deletion when empty. See deleteGroupWhenEmpty.
It might take up to a minute for the groups marked for auto-deletion when empty to get deleted when they become empty.
This command is only a getter for the deleteWhenEmpty flag in createGroup command or deleteGroupWhenEmpty command. All it does is it shows what the flag was set to during group creation. True does not mean the group will be deleted but that it was suggested to the engine that it should be deleted. It is up to the engine how it manages groups. False does not mean that the group will not be deleted at all. It has no influence on the engine functionality whatsoever.
Groups:
Groups

Syntax

Syntax:
isGroupDeletedWhenEmpty group
Parameters:
group: Group
Return Value:
Boolean - true the group is marked for auto-deletion when empty

Examples

Example 1:
_isMarked = isGroupDeletedWhenEmpty _group;

Additional Information

See also:
deleteGroup deleteGroupWhenEmpty createGroup group setGroupId groupID units groupFromNetId netId leader selectLeader join createCenter createUnit createVehicle Side

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