Function; SobGroup_Copy - HWRM/KarosGraveyard GitHub Wiki
SobGroup_Copy(target_group, original_group)
Description
Fills target_group
with all ships in original_group
(copying it). Both groups must exist before being passed to this function.
Note that although this function is similar to SobGroup_SobGroupAdd
, SobGroup_Copy
will overwrite the contents of target_group
instead of just adding to it.
These are therefore equivalent:
SobGroup_Clear("my-group");
SobGroup_SobGroupAdd("my-group", "source-group");
SobGroup_Copy("my-group", "source-group");
Example
-- Creates a new group referenced by the string "my-group-copy" containing anything that "my-original-group" contained.
SobGroup_Copy("my-group-copy", "my-original-group");
Arguments
Param | Type | Description |
---|---|---|
target_group |
string |
The name of the new group which will be copied to. |
original_group |
string |
The name of the original group to copy from. |
Returns
nil
Related Pages
Comments
This is a new HWRM function, but it seems that it does the exact same thing as SobGroup_Create
.