Character Grouping System
Character groups are a convenient way to store/sort characters. They are for Layered Characters only. Characters in a group are automatically saved to disk and loaded again next session.
The Primary Character Slot
Every Character Type contains a Primary Character Slot which can hold a singular character. This is useful for simple setups where only one character is used.
The main use for the Primary Character Slot is for use with the Character Creation Menu.
The menu can be opened using the character contained within the Primary Character Slot.
Group Types
There are two types of groups:
Flexible Group Type
A dynamic list. Characters can be added, removed or edited at any time.
Flexibe Groups are great when you want the player to have full control of the list. For example a list of playable characters with the ability for the player to create new characters.
Fixed Group Type
A list of a pre-determined amount of characters. The number is set when the list is created and all characters are created immedietely. Characters within the list can be edited at anytime but cannot be removed and new characters cannot be added.
Best for situations where an immutable list is needed. Such as a set of pre-created characters the player can edit the designs of but not change the count. Or a set of playable characters the player can choose from.
Character Group Registries
The CharacterGroupRegistry is a wrapper class. An instance of this class exists for each Layered Character Type. This wrapper class holds the Primary Character Slot as well as all flexible and fixed groups created for the same Layered Character Type.
Character Group Manager
The LayeredCharacterGroupManager is a static class which handles all groups.
The Layered Character Group Manager contains a dictionary of type CharacterGroupRegistry. One entry for each Layered Character Type used.
The LayeredCharacterGroupManager.GetGroupRegistryForType(LayeredCharacterTypeSO type) method can be used to retrieve the registry for a specific Character Type.
Character Group Templates
A Layered Character Group Template is a scriptable object. It is a blueprint for creating a flexible or fixed group during runtime.
To create a Layered Character Group Template right click the project window and navigate to Create > BlazerTech > Character Management System > Character Templates > Layered Character Group Template
Tip
If a Layered Character Group Template is placed inside a folder titled Resources the group will be automatically created at runtime.
Fields
- Default Group Name - The name of the group when it's created. Can be overriden.
- Character Type - The Character Type the group will be for when created.
- Group Type - The type of group that will be created. Flexible or Fixed.
- Character In Group
A list of all characters that will be created and put in the group when the group is created.
Each entry has two options:
- New Character
- Creates a new character with the supplied name.
- Character Template
- Creates a new character using the supplied Layered Character Template.