deleteGroup: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "{{Command " to "{{RV|type=command ") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
(28 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{RV|type=command | {{RV|type=command | ||
| | |game1= ofpe | ||
|version1= 1.00 | |||
|1.00 | |game2= arma1 | ||
|version2= 1.00 | |||
|game3= arma2 | |||
|version3= 1.00 | |||
|game4= arma2oa | |||
|version4= 1.50 | |||
|game5= tkoh | |||
|version5= 1.00 | |||
|game6= arma3 | |||
|version6= 0.50 | |||
|gr1= Groups | |gr1= Groups | ||
Line 10: | Line 24: | ||
|eff= global | |eff= global | ||
| Destroys the given group | |descr= Destroys the given group - the group must be empty and [[Multiplayer Scripting#Locality|local]] to the machine executing this command. | ||
{{ | {{Feature|informative|In {{arma3}} you can find out locality of the group with [[local]] command, unlike with previous games. However [[owner]] and [[setOwner]] don't work with groups anywhere. The group will always be local to the client that created it, until the client disconnects, then the group becomes local to the server. So if you need to delete a group, delete all members first then execute [[deleteGroup]] where is it [[local]].}} | ||
{{Feature|arma3|In | {{Feature|arma3|In {{arma3}} when the last unit leaves a group, the group gets automatically deleted. Manually deleting all units from a group, however, does '''not''' automatically delete the empty group. To force the group to get auto-deleted when empty, use [[deleteGroupWhenEmpty]].}} | ||
| | |s1= [[deleteGroup]] group | ||
|p1= group: [[Group]] | |p1= group: [[Group]] | ||
| [[Nothing]] | |r1= [[Nothing]] | ||
| | |x1= <sqf>deleteGroup _group;</sqf> | ||
< | |x2= <sqf>[_group] remoteExec ["deleteGroup", groupOwner _group]; // server only</sqf> | ||
< | |||
|seealso= [[deleteGroupWhenEmpty]] [[isGroupDeletedWhenEmpty]] [[createGroup]] [[units]] [[group]] [[groupFromNetId]] | |||
}} | |||
{{Note | |||
|user= ColonelSandersLite | |||
|timestamp= 20061217003400 | |||
|text= The deleteGroup Command does not work when there are living members of in the group. It doesn't error, it simply doesn't do anything. | |||
}} | |||
{{Note | |||
|user= 5133p39 | |||
|timestamp= 20070710075000 | |||
|text= Living or not doesn't matter - you can't delete the group while it contains any units - even dead ones. It takes few seconds until a dead unit is automatically removed from its group. | |||
}} | |||
{{Note | |||
|user= LongEnoughName | |||
|timestamp= 20130912035400 | |||
|text= deleteGroup will only delete local groups even if called by server. | |||
Say we have a situation where client creates a group and puts a unit there and later unit dies/gets deleted, server will not be able to delete that empty group until client leaves the game and group ownership switches to server. | |||
}} | |||
Latest revision as of 00:40, 31 August 2022
Description
- Description:
- Destroys the given group - the group must be empty and local to the machine executing this command.
- Groups:
- Groups
Syntax
- Syntax:
- deleteGroup group
- Parameters:
- group: Group
- Return Value:
- Nothing
Examples
- Example 1:
- deleteGroup _group;
- Example 2:
Additional Information
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
- Posted on Dec 17, 2006 - 00:34 (UTC)
- The deleteGroup Command does not work when there are living members of in the group. It doesn't error, it simply doesn't do anything.
- Posted on Jul 10, 2007 - 07:50 (UTC)
- Living or not doesn't matter - you can't delete the group while it contains any units - even dead ones. It takes few seconds until a dead unit is automatically removed from its group.
- Posted on Sep 12, 2013 - 03:54 (UTC)
- deleteGroup will only delete local groups even if called by server. Say we have a situation where client creates a group and puts a unit there and later unit dies/gets deleted, server will not be able to delete that empty group until client leaves the game and group ownership switches to server.
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint: Elite version 1.00
- Operation Flashpoint: Elite: New Scripting Commands
- Operation Flashpoint: Elite: Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: Groups
- Scripting Commands: Global Effect