Function; SobGroup_FillSubstract - HWRM/KarosGraveyard GitHub Wiki
SobGroup_FillSubstract(<output_group>, <source_group>, <subtract_group>)
Description
Yes, by 'substract', they mean 'subtract'. 🤷
There is also SobGroup_FillSubtract which is only usable from the scope of a GameRule.
Fills output_group with the remainder obtained after subtracting all members of subtract_group from source_group (e.g., if source_group contains A, B, and C, and subtract_group contains B, then output_group will contain only A and C).
Example
-- fills `"my_group"` with all the ships in `"Player_Ships0"` sans those in `"my-other-group"`
SobGroup_FillSubstract("my_group", "Player_Ships0", "my-other-group")
Arguments
| Param | Type | Description |
|---|---|---|
output_group |
string |
A SobGroup. The group will contain ships from source_group sans those found in subtract_group. |
source_group |
string |
A SobGroup. |
subtract_group |
string |
A SobGroup. |