View source for Combat group panel

[[File:CombatGroupPanel.png|none]]
<sub>An overview of the Combat Group Panel</sub><br /><br />

== Description ==


The Combat Group panel is a panel that outlines all the [[Combat Group|Combat Groups]] in the current level.

<br />
== Using the Combat Group Panel ==
=== Creating a Combat Group ===
[[File:CombatGroupPanel_ContextMenu_Add.png|none|583px]]
<sub>The Game Render View's Context Menu with Group Combat highlighted</sub>


There are 2 ways to create a new Combat Group:
# Through the game render view's context menu:
## Select the entities in the game renderview
## Right click the game render view
## Click "Group Combat"
# Through the [[#Creating a Combat Group in the Add/Modify Window|Add/Modify Window]]

<br />
=== Editing a Combat Group ===
To edit the name of a Combat Group, see [[#Changing the name of a Combat Group in the Add/Modify Window|Changing the name of a Combat Group]]

<br />
=== Adding entities to a Combat Group ===
[[File:CombatGroupPanel_AddEditorSelected.png|none]]
<sub>Combat Group Panel with Entities section Add Editor Selected button highlighted</sub>


There are 2 ways to add entities to a Combat Group:
# Select the entity in the game and click the "Add Editor Selected" button above the Entity list (see image)
# Through the [[#Adding an entity to a Combat Group in the Add/Modify Window|Add/Modify Window]]

<br />
=== Removing entities from a Combat Group ===
[[File:CombatGroupPanel_Remove.png|none]]
<sub>Combat Group Panel with Entities section Remove button highlighted</sub>


There are 3 ways to remove entities from a Combat Group:
# Through the game render view's context menu:
## Select the entities in the game render view
## Right click the game render view
## Click "Remove from Combat Group"
# Select the entity in the Entity list '''<span style="color:#FCFF27">(1)</span>''' and click the "Remove" button '''<span style="color:#FCFF27">(2)</span>''' (see image)
# Through the [[#Removing an entity from a Combat Group in the Add/Modify Window|Add/Modify Window]]


{| class="wikitable"
|-
|[[File:Warningred.png|left|30px]] Empty combat groups automatically get removed!
|-
|}

<br />
=== Deleting a Combat Group ===
[[File:CombatGroupPanel_Delete.png|none]]
<sub>Combat Group Panel with Combat Groups section Delete button highlighted</sub>


There are 2 ways to delete a Combat Group:
# Select the group and click the "Delete" button at the top of the panel (see image)
# Remove all entities from the group (see [[#Removing entities from a Combat Group|Removing entities from a Combat Group]])

<br />
=== The Add/Modify Combat Group Window ===
==== Creating a Combat Group in the Add/Modify Window ====
<sub>This article only applies to the Add/Modify Window. For more ways to create combat groups, see [[#Creating a Combat Group|Creating a Combat Group]]</sub><br />

[[File:CombatGroupPanel_AddModPanel_Add.png|none|800px]]
<sub>Numbered step-by-step of how to create a Combat Group with the Add/Modify Combat Group window</sub>


To create a new Combat Group, follow these steps:
* (Optional) Select one or more entities you want to add to your new Combat Group '''<span style="color:#FCFF27">(1)</span>'''
* Click "Add" button above the Combat Groups list '''<span style="color:#FCFF27">(2)</span>''', the "Add/Modify Combat Group" window should open
* (Optional) Name your combat group by changing the "GroupName" property under "Combat Group" to the desired name '''<span style="color:#FCFF27">(3)</span>'''
* Then, for each entity you want to add to the new Combat Group:
** (Optional) Find the entity by typing its name in the Filter textbox '''<span style="color:#FCFF27">(4)</span>'''
** Select the entity you want to add in the Available entities list '''<span style="color:#FCFF27">(5)</span>''' <sup>[1]</sup>
** Assign the entity to the combat group by pressing the ">>" button '''<span style="color:#FCFF27">(6)</span>'''
* Close the Add/Modify Combat Group window by clicking "OK" '''<span style="color:#FCFF27">(9)</span>''' <sup>[2]</sup>


<sup>[1] Note that if you have an entity selected in the editor (step 2) its name will be highlighted in yellow</sup><br />
<sup>[2] Note that you can not create an empty combat group</sup>

<br />
==== Editing a Combat Group in the Add/Modify Window ====
[[File:CombatGroupPanel_AddModPanel_Edit.png|none|800px]]
<sub>The add/modify combat group window with components marked by numbers</sub>

<br />
===== Changing the name of a Combat Group in the Add/Modify Window =====
<sub>This article refers to the image linked under [[#Editing a Combat Group in the Add/Modify Window|The Add/Modify Combat Group Window - Editing a Combat Group]]</sub>


To change the name of a Combat Group, follow these steps:
* Select your Combat Group in the Combat Group Panel '''<span style="color:#FCFF27">(1)</span>'''
* Click the "Edit" button above the Combat Groups list '''<span style="color:#FCFF27">(3)</span>''', the "Add/Modify Combat Group" window should open
* Change the "GroupName" property under "Combat Group" to the desired name '''<span style="color:#FCFF27">(4)</span>'''
* Close the Add/Modify Combat Group window by clicking "OK" '''<span style="color:#FCFF27">(9)</span>'''

<br />
===== Adding an entity to a Combat Group in the Add/Modify Window =====
<sub>This article refers to the image linked under [[#Editing a Combat Group in the Add/Modify Window|The Add/Modify Combat Group Window - Editing a Combat Group]]</sub><br />
<sub>This article only applies to the Add/Modify window. For more ways to add entities to a Combat Group, see [[#Adding entities to a Combat Group|Adding entities to a Combat Group]]</sub>


To add an entity to a Combat Group, follow these steps:
* Select the Combat Group you want to add an entity to '''<span style="color:#FCFF27">(1)</span>'''
* (Optional) Select the entity you want to add to the Combat Group '''<span style="color:#FCFF27">(2)</span>'''
* Click the "Edit" button above the Combat Groups list '''<span style="color:#FCFF27">(3)</span>''', the "Add/Modify Combat Group" window should open
* (Optional) Find the entity you want to add to the Combat Group by typing its name in the Filter textbox '''<span style="color:#FCFF27">(7)</span>'''
* Select the entity you want to add to the Combat Group in the Available entities list '''<span style="color:#FCFF27">(8)</span>''' <sup>[1] [2]</sup>
* Assign the entity to the combat group by pressing the ">>" button '''<span style="color:#FCFF27">(6)</span>'''
* Close the Add/Modify Combat Group window by clicking "OK" '''<span style="color:#FCFF27">(9)</span>'''


<sup>[1] Note that if you have an entity selected in the editor (step 2) its name will be highlighted in yellow</sup><br />
<sup>[2] If you can not find an entity in the Available entities list, it is probably already in a Combat Group</sup>

<br />
===== Removing an entity from a Combat Group in the Add/Modify Window =====
<sub>This article refers to the image linked under [[#Editing a Combat Group in the Add/Modify Window|The Add/Modify Combat Group Window - Editing a Combat Group]]</sub><br />
<sub>This article only applies to the Add/Modify window. For more ways to remove entities from a Combat Group, see [[#Removing entities from a Combat Group|Removing entities from a Combat Group]]</sub>


To remove an entity from a Combat Group, follow these steps:
* Select the Combat Group you want to remove an entity from '''<span style="color:#FCFF27">(1)</span>'''
* (Optional) Select the entity you want to remove from the Combat Group '''<span style="color:#FCFF27">(2)</span>'''
* Click the "Edit" button above the Combat Groups list '''<span style="color:#FCFF27">(3)</span>''', the "Add/Modify Combat Group" window should open
* Select the entity you want to remove from the Combat Group in the Assigned entities list '''<span style="color:#FCFF27">(5)</span>''' <sup>[1]</sup>
* Remove the entity from the combat group by pressing the "<<" button '''<span style="color:#FCFF27">(6)</span>'''
* Close the Add/Modify Combat Group window by clicking "OK" '''<span style="color:#FCFF27">(9)</span>'''


<sup>[1] Note that if you have an entity selected in the editor (step 2) its name will be highlighted in yellow</sup>

<br />
=== Navigating the Combat Group Panel ===
[[File:CombatGroupPanel_Navigation.png|none]]
<sub>Numbered step-by-step of how to navigate the Combat Group Panel</sub>

<br />
==== Finding a Combat Group in the Panel ====
<sub>This article refers to the image linked under [[#Navigating the Combat Group Panel|Navigating the Combat Group Panel]]</sub><br />


To find a combat group by name, follow these steps:
* (Optional) Either:
** Filter the visible combat groups by typing the name of the Combat Group you want to find in the Filter textbox '''<span style="color:#FCFF27">(1)</span>'''
** Turn on "Include Items" '''<span style="color:#FCFF27">(2)</span>''' and filter the visible combat groups by typing the name of an entity in the Combat Group you want to find in the Filter textbox <span style="color:#FCFF27">'''(1)'''</span>
* Locate the Combat Group you want to find in the Combat Groups list '''<span style="color:#FCFF27">(3)</span>'''

<br />

==== Finding an entity in the Panel ====
<sub>This article refers to the image linked under [[#Navigating the Combat Group Panel|Navigating the Combat Group Panel]]</sub><br />


To find an entity by name, follow these steps:
* Make sure "Include Items" '''<span style="color:#FCFF27">(2)</span>''' is turned on
* Type the name of the entity you want to find in the Filter textbox '''<span style="color:#FCFF27">(1)</span>'''
* Select the remaining combat groups and look through their Entities list '''<span style="color:#FCFF27">(4)</span>''' for the highlighted entity <sup>[1]</sup>

<sup>[1] If the Combat Gorups list is empty, the entity does not have a Combat Group</sup>


To find an entity in your level, follow these steps:
* Select the entity in the editor
* Search the Combat Groups list '''<span style="color:#FCFF27">(3)</span>''' for a highlighted (<span style="color:#FFFF8C">#FFFF8C</span> text color) Combat Group <sup>[1]</sup>
* Select the highlighted Combat Group and search its Entities list '''<span style="color:#FCFF27">(4)</span>''' for the highlighted entity

<sup>[1] If no Combat Group is highlighted, the entity does not have a Combat Group</sup>


Double clicking an Entity in the Entities list '''<span style="color:#FCFF27">(4)</span>''' will select it in the editor as well.

<br />

==== Locating a Combat Group in your level ====
<sub>This article refers to the image linked under [[#Navigating the Combat Group Panel|Navigating the Combat Group Panel]]</sub><br />


To find the location of a Combat Group in your level, simply double click it in the Combat Groups list '''<span style="color:#FCFF27">(3)</span>'''. This will select all the entities in the combat group in the editor and move the camera accordingly. <sup>[1]</sup>

If you do not know how to locate a Combat Group in the Combat Groups list, go to [[#Finding a Combat Group in the Panel|Finding a Combat Group in the Panel]] first.


<sup>[1] If you do not see your Combat Group after double clicking it, it is possible that the entities it contains are so far apart that the camera has to zoom out beyond the culling distance.</sup>

<br />
== Metadata ==
The "Metadata" tab will not be covered by this wiki as it is not used for modding. Metadata refers to data which does not affect the game, and is only used by the editor.