Photon Fusion 2.1.1

NetworkProjectConfigAsset Class Reference

Manages and references the current instance of NetworkProjectConfig. More...

Inherits FusionGlobalScriptableObject< T >.

Classes

struct  SerializableSimulationBehaviourMeta
 An auto-generated list containing meta information about all the SimulationBehaviours in the project, e.g. execution order. More...

Static Public Member Functions

static bool TryGetGlobal (out NetworkProjectConfigAsset global)
 Try to get the current NetworkProjectConfig instance.
static void UnloadGlobal ()
 Unload the current NetworkProjectConfig instance.
Static Public Member Functions inherited from FusionGlobalScriptableObject
static void ClearTypesFailedToLoad ()
 Use to clear internal list marking specific type as unable to load. Types might be unable to load during bootstrap, so cleaning the list in some static initializer is a good way to ensure things can recover.

Public Attributes

SerializableSimulationBehaviourMeta[] BehaviourMeta = Array.Empty<SerializableSimulationBehaviourMeta>()
 An auto-generated list containing meta information about all the SimulationBehaviours in the project, e.g. execution order.
NetworkProjectConfig Config = new NetworkProjectConfig()
 The current NetworkProjectConfig instance.
NetworkPrefabTableOptions PrefabOptions = NetworkPrefabTableOptions.Default
 Options for the NetworkPrefabTable.
List< INetworkPrefabSourcePrefabs = new List<INetworkPrefabSource>()
 An auto-generated list containing source information (e.g. Resource path, address, static reference) for all the prefabs that can be spawned, i.e. the ones with NetworkObject component and NetworkObject.IsSpawnable enabled.
Additional prefabs can registered at runtime with NetworkPrefabTable.TryAddSource.

Protected Member Functions

override void OnDisable ()
 Unloads all prefabs.
Protected Member Functions inherited from FusionGlobalScriptableObject< T >
virtual void OnLoadedAsGlobal ()
 Invoked when the instance is loaded as global.
virtual void OnUnloadedAsGlobal (bool destroyed)
 Invoked when the instance is unloaded as global.

Properties

static NetworkProjectConfigAsset Global [get]
 The current NetworkProjectConfig instance.
static bool IsGlobalLoaded [get]
 True if the NetworkProjectConfig instance exists, otherwise false.
Properties inherited from FusionGlobalScriptableObject< T >
static T GlobalInternal [get, set]
 A singleton instance-like property. Loads or returns the current global instance. Derived classes can package it in a property with a different name. Throws if loading an instance failed.
bool IsGlobal [get]
 Is this instance a global instance.
static bool IsGlobalLoadedInternal [get]
 Returns true if a global instance is loaded. Compared to GlobalInternal, it does not attempt to load an instance.

Additional Inherited Members

Static Protected Member Functions inherited from FusionGlobalScriptableObject< T >
static async System.Threading.Tasks.Task< T > GetGlobalAsyncInternal ()
 Loads or returns the current global instance asynchronously. Returns null if loading an instance failed.
static bool TryGetGlobalInternal (out T global)
 Loads or returns the current global instance. Returns null if loading an instance failed.
static bool UnloadGlobalInternal ()
 Unloads the global instance if it is loaded.

Detailed Description

Manages and references the current instance of NetworkProjectConfig.

Member Function Documentation

◆ TryGetGlobal()

bool TryGetGlobal ( out NetworkProjectConfigAsset global)
static

Try to get the current NetworkProjectConfig instance.

Parameters
globalNetworkProjectConfig instance if it exists, otherwise null.
Returns
True if the NetworkProjectConfig instance exists, otherwise false.