Photon Quantum 3.0.0

Public Attributes | Properties | List of all members
Quantum.QuantumMenuSceneInfo Class Reference

Info asset for creating configurable selectable scenes in the Photon menu. This type was moved to the SDK to simplify adding scenes automatically (e.g. when installing another unity package). More...

Inheritance diagram for Quantum.QuantumMenuSceneInfo:
Quantum.QuantumScriptableObject

Public Attributes

bool IsHidden
 Don't use this scene. More...
 
string Name
 Displayed scene name. More...
 
string NameOrSceneName => string.IsNullOrEmpty(Name) ? SceneName : Name
 Returns either Name or SceneName. More...
 
Sprite Preview
 The sprite displayed as scene preview in the scene selection UI. More...
 
RuntimeConfig RuntimeConfig
 When using a menu config the runtime config from the QuantumMenuConnectArgs.RuntimeConfig is always overwritten. More...
 
string SceneName => ScenePath == null ? null : Path.GetFileNameWithoutExtension(ScenePath)
 Gets the filename of the ScenePath to set as Unity scene to load during connection sequence. More...
 
string ScenePath
 The path to the scene asset. More...
 

Properties

AssetRef< MapMap [get, set]
 Quantum map that is loaded. Must be set. More...
 
AssetRef< SystemsConfigSystemsConfig [get, set]
 Override Quantum systems configuration for this scene. Can be null. If this is set it will overwrite the RuntimeConfig.SystemsConfig settings during the connection sequence. More...
 

Detailed Description

Info asset for creating configurable selectable scenes in the Photon menu. This type was moved to the SDK to simplify adding scenes automatically (e.g. when installing another unity package).

Member Data Documentation

◆ Name

string Quantum.QuantumMenuSceneInfo.Name

Displayed scene name.

◆ NameOrSceneName

string Quantum.QuantumMenuSceneInfo.NameOrSceneName => string.IsNullOrEmpty(Name) ? SceneName : Name

Returns either Name or SceneName.

◆ ScenePath

string Quantum.QuantumMenuSceneInfo.ScenePath

The path to the scene asset.

◆ SceneName

string Quantum.QuantumMenuSceneInfo.SceneName => ScenePath == null ? null : Path.GetFileNameWithoutExtension(ScenePath)

Gets the filename of the ScenePath to set as Unity scene to load during connection sequence.

◆ Preview

Sprite Quantum.QuantumMenuSceneInfo.Preview

The sprite displayed as scene preview in the scene selection UI.

◆ IsHidden

bool Quantum.QuantumMenuSceneInfo.IsHidden

Don't use this scene.

◆ RuntimeConfig

RuntimeConfig Quantum.QuantumMenuSceneInfo.RuntimeConfig

When using a menu config the runtime config from the QuantumMenuConnectArgs.RuntimeConfig is always overwritten.

Property Documentation

◆ Map

AssetRef<Map> Quantum.QuantumMenuSceneInfo.Map
getset

Quantum map that is loaded. Must be set.

◆ SystemsConfig

AssetRef<SystemsConfig> Quantum.QuantumMenuSceneInfo.SystemsConfig
getset

Override Quantum systems configuration for this scene. Can be null. If this is set it will overwrite the RuntimeConfig.SystemsConfig settings during the connection sequence.