Class FunctionalityIsland

Inheritance

Object

FunctionalityIsland

Namespace: Unity.Labs.ModuleLoader

Syntax

public class FunctionalityIsland : ScriptableObject, ISerializationCallbackReceiver, IProvidesFunctionalityInjection, IFunctionalityProvider

Fields

InjectFunctionalityProfilerLabel

Declaration

public const string InjectFunctionalityProfilerLabel = "FunctionalityIsland.InjectFunctionality()"

Field Value

Type	Description
String

SetupDefaultProvidersProfilerLabel

Declaration

public const string SetupDefaultProvidersProfilerLabel = "FunctionalityIsland.SetupDefaultProviders()"

Field Value

Type	Description
String

Properties

defaultProviders

Declaration

public FunctionalityIsland.DefaultProvider[] defaultProviders { get; }

Property Value

Type	Description
FunctionalityIsland.DefaultProvider[]

providers

Declaration

public Dictionary<Type, IFunctionalityProvider> providers { get; }

Property Value

Type	Description
Dictionary<Type, IFunctionalityProvider>

uniqueProviders

Declaration

public HashSet<IFunctionalityProvider> uniqueProviders { get; }

Property Value

Type	Description
HashSet<IFunctionalityProvider>

Methods

ActivateProviderGameObjects()

Declaration

public void ActivateProviderGameObjects()

AddProvider(Type, IFunctionalityProvider)

Declaration

public void AddProvider(Type providerType, IFunctionalityProvider provider)

Parameters

Type	Name	Description
Type	providerType
IFunctionalityProvider	provider

AddProviders(List<IFunctionalityProvider>)

Declaration

public void AddProviders(List<IFunctionalityProvider> newProviders)

Parameters

Type	Name	Description
List<IFunctionalityProvider>	newProviders

CheckSetup()

Declaration

public void CheckSetup()

ConnectSubscriber(Object)

Declaration

public void ConnectSubscriber(object obj)

Parameters

Type	Name	Description
Object	obj

Implements

IFunctionalityProvider.ConnectSubscriber(Object)

GetOrCreateProviderInstance(Type, Type)

Declaration

public static IFunctionalityProvider GetOrCreateProviderInstance(Type implementorType, Type providerType)

Parameters

Type	Name	Description
Type	implementorType
Type	providerType

Returns

Type	Description
IFunctionalityProvider

InjectFunctionality(GameObject)

Declaration

public void InjectFunctionality(GameObject go)

Parameters

Type	Name	Description
GameObject	go

InjectFunctionality(Scene)

Inject functionality on an entire scene, assuming that

Declaration

public void InjectFunctionality(Scene scene)

Parameters

Type	Name	Description
Scene	scene

InjectFunctionality(List<Object>, List<IFunctionalityProvider>)

Declaration

public void InjectFunctionality(List<object> objects, List<IFunctionalityProvider> newProviders = null)

Parameters

Type	Name	Description
List<Object>	objects
List<IFunctionalityProvider>	newProviders

Implements

IProvidesFunctionalityInjection.InjectFunctionality(List<Object>, List<IFunctionalityProvider>)

InjectFunctionality(List<IFunctionalitySubscriber>, List<IFunctionalityProvider>)

Declaration

public void InjectFunctionality(List<IFunctionalitySubscriber> objects, List<IFunctionalityProvider> newProviders = null)

Parameters

Type	Name	Description
List<IFunctionalitySubscriber>	objects
List<IFunctionalityProvider>	newProviders

InjectFunctionalityInDefaultProviders(Dictionary<GameObject, GameObject>, List<IFunctionalityProvider>)

Declaration

public void InjectFunctionalityInDefaultProviders(Dictionary<GameObject, GameObject> newProvidersIn, List<IFunctionalityProvider> newProvidersOut)

Parameters

Type	Name	Description
Dictionary<GameObject, GameObject>	newProvidersIn
List<IFunctionalityProvider>	newProvidersOut

InjectFunctionalitySingle(Object)

Declaration

public void InjectFunctionalitySingle(object obj)

Parameters

Type	Name	Description
Object	obj

Implements

IProvidesFunctionalityInjection.InjectFunctionalitySingle(Object)

InjectPreparedFunctionality(List<Object>)

Inject functionality on a set of objects, assuming that all required providers have been setup.

Declaration

public void InjectPreparedFunctionality(List<object> objects)

Parameters

Type	Name	Description
List<Object>	objects

Implements

IProvidesFunctionalityInjection.InjectPreparedFunctionality(List<Object>)

InjectPreparedFunctionality(List<IFunctionalitySubscriber>)

Inject functionality on a set of objects, assuming that all required providers have been setup.

Declaration

public void InjectPreparedFunctionality(List<IFunctionalitySubscriber> objects)

Parameters

Type	Name	Description
List<IFunctionalitySubscriber>	objects

LoadProvider()

Declaration

public void LoadProvider()

Implements

IFunctionalityProvider.LoadProvider()

OnAfterDeserialize()

Declaration

public void OnAfterDeserialize()

OnBeforeSerialize()

Declaration

public void OnBeforeSerialize()

OnBehaviorDestroy()

Declaration

public void OnBehaviorDestroy()

PrintStatus()

Declaration

public string PrintStatus()

Returns

Type	Description
String

RemoveProviders(List<IFunctionalityProvider>)

Declaration

public void RemoveProviders(List<IFunctionalityProvider> providersToRemove)

Parameters

Type	Name	Description
List<IFunctionalityProvider>	providersToRemove

SetupDefaultProviders(HashSet<Type>, List<IFunctionalityProvider>)

Set up functionality providers from the list of default providers This allows custom serialized data to be set up on prefabs for providers

Declaration

public void SetupDefaultProviders(HashSet<Type> subscriberTypes, List<IFunctionalityProvider> newProviders = null)

Parameters

Type	Name	Description
HashSet<Type>	subscriberTypes	The types of subscribers that need providers
List<IFunctionalityProvider>	newProviders	(Optional) A list to which new providers will be added

Unload()

Declaration

public void Unload()

UnloadProvider()

Declaration

public void UnloadProvider()

Implements

IFunctionalityProvider.UnloadProvider()