Twoorb Plugins  1.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Twoorb.PrefabSystem.Editor.PrefabGroupData Class Reference

ScriptableObject asset containing all the groups and mappings in the prefab system More...

Inheritance diagram for Twoorb.PrefabSystem.Editor.PrefabGroupData:

Public Member Functions

bool DoesContentGroupExist (string groupName)
 Checks if a content group exists More...
 
string[] GetContentGroupNames ()
 Returns a string array with all the available content group names More...
 
bool RemoveContentGroup (string contentGroup)
 Removes a content group More...
 
bool CreateNewContentGroup (string groupName)
 Creates a new content group with the specified name. More...
 
int GetGroupID (string groupName)
 Gets the group ID for the specified name. Ignores casing. More...
 
string GetGroupNameFromID (int groupID)
 Gets a group name from a specified groupID More...
 
bool DoesGroupExist (int groupID)
 Checks if a groupID exists More...
 
string[] GetGroupNames ()
 Returns a string array with all the available group names More...
 
bool CreateNewGroup (string groupName)
 Creates a new group with the specified name and assigns a uniqueID to it. More...
 
bool RemoveGroup (PrefabGroupMapping groupMapping)
 Removes a group More...
 

Static Public Member Functions

static PrefabGroupData GetOrCreateGroupData ()
 Gets or creates the group data asset. More...
 

Public Attributes

List< PrefabGroupMappingm_groupMappings = new List<PrefabGroupMapping>()
 List containing all the group ID / Name mappings More...
 
int m_uniqueIDCount = 0
 The current UniqueID count More...
 
List< string > m_contentGroupNames = new List<string>()
 The available group names for content More...
 

Properties

List< PrefabGroupMappingGroupMappings [get]
 List containing all the group ID / Name mappings More...
 
int NumberOfGroups [get]
 The number of groups available More...
 

Detailed Description

ScriptableObject asset containing all the groups and mappings in the prefab system

Member Function Documentation

bool Twoorb.PrefabSystem.Editor.PrefabGroupData.CreateNewContentGroup ( string  groupName)

Creates a new content group with the specified name.

Parameters
groupNameThe group to create
Returns
Returns if the group was created successfully
bool Twoorb.PrefabSystem.Editor.PrefabGroupData.CreateNewGroup ( string  groupName)

Creates a new group with the specified name and assigns a uniqueID to it.

Parameters
groupNameThe group to create
Returns
Returns if the group was created successfully
bool Twoorb.PrefabSystem.Editor.PrefabGroupData.DoesContentGroupExist ( string  groupName)

Checks if a content group exists

Parameters
groupNameThe name of the group to check.
Returns
If the content group exists
bool Twoorb.PrefabSystem.Editor.PrefabGroupData.DoesGroupExist ( int  groupID)

Checks if a groupID exists

Parameters
groupIDThe groupID to check
Returns
If the group exists
string [] Twoorb.PrefabSystem.Editor.PrefabGroupData.GetContentGroupNames ( )

Returns a string array with all the available content group names

Returns
int Twoorb.PrefabSystem.Editor.PrefabGroupData.GetGroupID ( string  groupName)

Gets the group ID for the specified name. Ignores casing.

Parameters
groupNameThe name of the group
Returns
The integer of the group. Returns 0 upon failure
string Twoorb.PrefabSystem.Editor.PrefabGroupData.GetGroupNameFromID ( int  groupID)

Gets a group name from a specified groupID

Parameters
groupIDThe group ID
Returns
The group name. Returns "Unknown" upon failure.
string [] Twoorb.PrefabSystem.Editor.PrefabGroupData.GetGroupNames ( )

Returns a string array with all the available group names

Returns
static PrefabGroupData Twoorb.PrefabSystem.Editor.PrefabGroupData.GetOrCreateGroupData ( )
static

Gets or creates the group data asset.

Returns
The prefab group data asset.
bool Twoorb.PrefabSystem.Editor.PrefabGroupData.RemoveContentGroup ( string  contentGroup)

Removes a content group

Parameters
contentGroup
Returns
bool Twoorb.PrefabSystem.Editor.PrefabGroupData.RemoveGroup ( PrefabGroupMapping  groupMapping)

Removes a group

Parameters
groupMappingThe group mapping of the group to remove.
Returns
Whether or not the operation was successful

Member Data Documentation

List<string> Twoorb.PrefabSystem.Editor.PrefabGroupData.m_contentGroupNames = new List<string>()

The available group names for content

List<PrefabGroupMapping> Twoorb.PrefabSystem.Editor.PrefabGroupData.m_groupMappings = new List<PrefabGroupMapping>()

List containing all the group ID / Name mappings

int Twoorb.PrefabSystem.Editor.PrefabGroupData.m_uniqueIDCount = 0

The current UniqueID count

Property Documentation

List<PrefabGroupMapping> Twoorb.PrefabSystem.Editor.PrefabGroupData.GroupMappings
get

List containing all the group ID / Name mappings

int Twoorb.PrefabSystem.Editor.PrefabGroupData.NumberOfGroups
get

The number of groups available


The documentation for this class was generated from the following file: