Class SceneLookupData

Data container for looking up, loading, or unloading a scene.

Inheritance

System.Object

SceneLookupData

Implements

System.IEquatable<SceneLookupData>

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: FishNet.Managing.Scened

Assembly: FishNet.Runtime.dll

Syntax

public class SceneLookupData : IEquatable<SceneLookupData>

Constructors

SceneLookupData()

Declaration

public SceneLookupData()

SceneLookupData(Int32)

Declaration

public SceneLookupData(int handle)

Parameters

Type	Name	Description
System.Int32	handle	Scene handle to generate from.

SceneLookupData(Int32, String)

Declaration

public SceneLookupData(int handle, string name)

Parameters

Type	Name	Description
System.Int32	handle	Scene handle to generate from.
System.String	name	Name to generate from if handle is 0.

SceneLookupData(String)

Declaration

public SceneLookupData(string name)

Parameters

Type	Name	Description
System.String	name	Scene name to generate from.

SceneLookupData(Scene)

Declaration

public SceneLookupData(Scene scene)

Parameters

Type	Name	Description
UnityEngine.SceneManagement.Scene	scene	Scene to generate from.

Fields

Handle

Handle of the scene. If value is 0, then handle is not used.

Declaration

public int Handle

Field Value

Type	Description
System.Int32

Name

Name of the scene.

Declaration

public string Name

Field Value

Type	Description
System.String

Properties

IsValid

Returns if this data is valid for use. Being valid does not mean that the scene exist, rather that there is enough data to try and lookup a scene.

Declaration

public bool IsValid { get; }

Property Value

Type	Description
System.Boolean

NameOnly

Returns the scene name without a directory path should one exist.

Declaration

public string NameOnly { get; }

Property Value

Type	Description
System.String

Methods

CreateData(List<Int32>)

Returns a SceneLookupData collection.

Declaration

public static SceneLookupData[] CreateData(List<int> handles)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.Int32>	handles	Scene handles to create from.

Returns

Type	Description
SceneLookupData[]

CreateData(List<String>)

Returns a SceneLookupData collection.

Declaration

public static SceneLookupData[] CreateData(List<string> names)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.String>	names	Scene names to create from.

Returns

Type	Description
SceneLookupData[]

CreateData(List<Scene>)

Returns a SceneLookupData collection.

Declaration

public static SceneLookupData[] CreateData(List<Scene> scenes)

Parameters

Type	Name	Description
System.Collections.Generic.List<UnityEngine.SceneManagement.Scene>	scenes	Scenes to create from.

Returns

Type	Description
SceneLookupData[]

CreateData(Int32)

Returns a new SceneLookupData.

Declaration

public static SceneLookupData CreateData(int handle)

Parameters

Type	Name	Description
System.Int32	handle

Returns

Type	Description
SceneLookupData

CreateData(Int32[])

Returns a SceneLookupData collection.

Declaration

public static SceneLookupData[] CreateData(int[] handles)

Parameters

Type	Name	Description
System.Int32[]	handles	Scene handles to create from.

Returns

Type	Description
SceneLookupData[]

CreateData(String)

Returns a new SceneLookupData.

Declaration

public static SceneLookupData CreateData(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
SceneLookupData

CreateData(String[])

Returns a SceneLookupData collection.

Declaration

public static SceneLookupData[] CreateData(string[] names)

Parameters

Type	Name	Description
System.String[]	names	Scene names to create from.

Returns

Type	Description
SceneLookupData[]

CreateData(Scene)

Returns a new SceneLookupData.

Declaration

public static SceneLookupData CreateData(Scene scene)

Parameters

Type	Name	Description
UnityEngine.SceneManagement.Scene	scene	Scene to create from.

Returns

Type	Description
SceneLookupData

CreateData(Scene[])

Returns a SceneLookupData collection.

Declaration

public static SceneLookupData[] CreateData(Scene[] scenes)

Parameters

Type	Name	Description
UnityEngine.SceneManagement.Scene[]	scenes	Scenes to create from.

Returns

Type	Description
SceneLookupData[]

Equals(SceneLookupData)

Declaration

public bool Equals(SceneLookupData sld)

Parameters

Type	Name	Description
SceneLookupData	sld

Returns

Type	Description
System.Boolean

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

GetScene(out Boolean, Boolean)

Returns the first scene found using Handle or Name, preferring Handle.

Declaration

public Scene GetScene(out bool foundByHandle, bool warnIfDuplicates = true)

Parameters

Type	Name	Description
System.Boolean	foundByHandle	True if scene was found by handle. Handle is always checked first.
System.Boolean	warnIfDuplicates

Returns

Type	Description
UnityEngine.SceneManagement.Scene

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

ValidateData(SceneLookupData)

Validates SceneLookupdatas and returns only valid entries.

Declaration

public static SceneLookupData[] ValidateData(SceneLookupData data)

Parameters

Type	Name	Description
SceneLookupData	data

Returns

Type	Description
SceneLookupData[]

ValidateData(SceneLookupData[])

Validates SceneLookupdatas and returns only valid entries.

Declaration

public static SceneLookupData[] ValidateData(SceneLookupData[] datas)

Parameters

Type	Name	Description
SceneLookupData[]	datas	Datas to validate.

Returns

Type	Description
SceneLookupData[]

Operators

Equality(SceneLookupData, SceneLookupData)

Declaration

public static bool operator ==(SceneLookupData sldA, SceneLookupData sldB)

Parameters

Type	Name	Description
SceneLookupData	sldA
SceneLookupData	sldB

Returns

Type	Description
System.Boolean

Inequality(SceneLookupData, SceneLookupData)

Declaration

public static bool operator !=(SceneLookupData sldA, SceneLookupData sldB)

Parameters

Type	Name	Description
SceneLookupData	sldA
SceneLookupData	sldB

Returns

Type	Description
System.Boolean

Implements

System.IEquatable<T>