deleteGroupWhenEmpty: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Fix locality + deleteWhenEmpty description)
m (Some wiki formatting)
 
(4 intermediate revisions by 2 users not shown)
Line 12: Line 12:
|descr= Marks given group for auto-deletion when group is empty.
|descr= Marks given group for auto-deletion when group is empty.
[[true]] will mark the group for auto-deletion once empty, [[false]] will simply unmark the group that was marked previously.
[[true]] will mark the group for auto-deletion once empty, [[false]] will simply unmark the group that was marked previously.
{{Feature|important|This command does '''not''' prevent group deletion (through e.g [[deleteGroup]] or any engine group management.}}
{{Feature|important|This command does '''not''' prevent group deletion (through e.g [[deleteGroup]] or any engine group management).}}


|s1= group [[deleteGroupWhenEmpty]] delete
|s1= group [[deleteGroupWhenEmpty]] delete
Line 37: Line 37:


|seealso= [[deleteGroup]] [[isGroupDeletedWhenEmpty]] [[createGroup]] [[group]] [[setGroupId]] [[groupID]] [[units]] [[groupFromNetId]] [[netId]] [[leader]] [[selectLeader]] [[join]] [[createCenter]] [[createUnit]] [[createVehicle]] [[Side]]
|seealso= [[deleteGroup]] [[isGroupDeletedWhenEmpty]] [[createGroup]] [[group]] [[setGroupId]] [[groupID]] [[units]] [[groupFromNetId]] [[netId]] [[leader]] [[selectLeader]] [[join]] [[createCenter]] [[createUnit]] [[createVehicle]] [[Side]]
}}
{{Note
|user= PierreMGI
|timestamp= 20231201050428
|text= The auto-deletion of a group is not automatic. For example, if you place a group in editor, name it (grp1), and kill the units in preview, this group remains not null and is counted as group (checked by count allGroups).
On the other hand, if you write: <sqf inline>this deleteGroupWhenEmpty true</sqf> in composition init (group init), this group will become null sometimes after the units are killed. It takes a little time for dead units to exit the group, then an extra time for the group to be deleted once all units dead. (count allGroups decreases).
Of course, in both cases, grp1 remains a variable ("grp1" is not nil).
}}
}}

Latest revision as of 13:37, 12 March 2024

Hover & click on the images for description

Description

Description:
Marks given group for auto-deletion when group is empty. true will mark the group for auto-deletion once empty, false will simply unmark the group that was marked previously.
This command does not prevent group deletion (through e.g deleteGroup or any engine group management).
Groups:
Groups

Syntax

Syntax:
group deleteGroupWhenEmpty delete
Parameters:
group: Group
delete: Boolean - true to mark for auto-deletion on empty group, false to not use this auto-deletion system
Return Value:
Nothing

Examples

Example 1:
_group deleteGroupWhenEmpty true;
Example 2:
Executed on the server:
if (local _group) then { _group deleteGroupWhenEmpty true; } else // group is local to a client { [_group, true] remoteExec ["deleteGroupWhenEmpty", groupOwner _group]; };

Additional Information

See also:
deleteGroup isGroupDeletedWhenEmpty 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
PierreMGI - c
Posted on Dec 01, 2023 - 05:04 (UTC)
The auto-deletion of a group is not automatic. For example, if you place a group in editor, name it (grp1), and kill the units in preview, this group remains not null and is counted as group (checked by count allGroups). On the other hand, if you write: this deleteGroupWhenEmpty true in composition init (group init), this group will become null sometimes after the units are killed. It takes a little time for dead units to exit the group, then an extra time for the group to be deleted once all units dead. (count allGroups decreases). Of course, in both cases, grp1 remains a variable ("grp1" is not nil).