MixedRealitySceneSystem.LoadContentByTag Method

Reference

Definition

Namespace:: Microsoft.MixedReality.Toolkit.SceneSystem

Assembly:: Microsoft.MixedReality.Toolkit.Services.SceneSystem.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Async method to load content scenes by tag. All scenes with the supplied tag will be loaded. If no scenes with this tag are found, no action will be taken. If a scene operation is in progress, no action will be taken.

public System.Threading.Tasks.Task LoadContentByTag (string tag, UnityEngine.SceneManagement.LoadSceneMode mode = UnityEngine.SceneManagement.LoadSceneMode.Additive, Microsoft.MixedReality.Toolkit.SceneSystem.SceneActivationToken activationToken = default);

abstract member LoadContentByTag : string * UnityEngine.SceneManagement.LoadSceneMode * Microsoft.MixedReality.Toolkit.SceneSystem.SceneActivationToken -> System.Threading.Tasks.Task
override this.LoadContentByTag : string * UnityEngine.SceneManagement.LoadSceneMode * Microsoft.MixedReality.Toolkit.SceneSystem.SceneActivationToken -> System.Threading.Tasks.Task

Public Function LoadContentByTag (tag As String, Optional mode As LoadSceneMode = UnityEngine.SceneManagement.LoadSceneMode.Additive, Optional activationToken As SceneActivationToken = Nothing) As Task

Parameters

tag: String

Scene tag.

mode: UnityEngine.SceneManagement.LoadSceneMode

Additive mode will load the content additively. Single mode will first unload all loaded content scenes first.

activationToken: SceneActivationToken

Optional token for manual scene activation. Useful for loading screens and multiplayer. If not null, operation will wait until activationToken's AllowSceneActivation value is true before activating scene objects.

Returns

Task

Implements

LoadContentByTag(String, LoadSceneMode, SceneActivationToken)

Applies to