Class SceneRecord

Contains a list of scenes a mod is adding to the game

Inheritance
object
Object
ScriptableObject
SceneRecord
Inherited Members
ScriptableObject.SetDirty()
ScriptableObject.CreateInstance<T>()
Namespace: WeaverCore
Assembly: WeaverCore.dll
Syntax
[CreateAssetMenu(fileName = "Scene Record", menuName = "WeaverCore/Scene Record")]
public class SceneRecord : ScriptableObject

Properties

| Edit this page View Source

SceneAdditions

A list of all the new scenes getting added to the game

Declaration
public IEnumerable<string> SceneAdditions { get; }
Property Value
Type Description
IEnumerable<string>
| Edit this page View Source

SceneReplacements

A list of all the scenes that are getting replaced with new ones

Declaration
public IEnumerable<(string SceneToReplace, string Replacement)> SceneReplacements { get; }
Property Value
Type Description
IEnumerable<(string SceneToReplace, string Replacement)>
| Edit this page View Source

SceneUnions

A list of all the scenes that are being combined with new ones

Declaration
public IEnumerable<(string SceneToUnionize, string SceneUnion)> SceneUnions { get; }
Property Value
Type Description
IEnumerable<(string SceneToReplace, string Replacement)>
| Edit this page View Source

TransitionRedirects

Declaration
public IEnumerable<SceneRecord.GateRedirect> TransitionRedirects { get; }
Property Value
Type Description
IEnumerable<SceneRecord.GateRedirect>

Methods

| Edit this page View Source

AddSceneReplacement(string, string)

Replaces the oldScene with the newScene. Anytime the old scene gets loaded, the new scene will load instead

Declaration
public bool AddSceneReplacement(string oldScene, string newScene)
Parameters
Type Name Description
string oldScene

The scene to be replaced
string newScene

The scene to replace the old one
Returns
Type Description
bool
| Edit this page View Source

AddSceneUnion(string, string)

Combines the contents of oldScene with newScene. Any time the old scene is loaded, the new scene will also get loaded, combining the two scenes together

Declaration
public bool AddSceneUnion(string oldScene, string newScene)
Parameters
Type Name Description
string oldScene

The scene to be combined with
string newScene

The scene to combine with the old one
Returns
Type Description
bool
| Edit this page View Source

RemoveSceneReplacement(string, string)

Removes a scene replacement

Declaration
public bool RemoveSceneReplacement(string oldScene, string newScene)
Parameters
Type Name Description
string oldScene

The scene that was to be replaced
string newScene

The scene that was replacing the old one
Returns
Type Description
bool
| Edit this page View Source

RemoveSceneUnion(string, string)

Removes a scene union

Declaration
public bool RemoveSceneUnion(string oldScene, string newScene)
Parameters
Type Name Description
string oldScene

The scene that was to be combined with
string newScene

The scene that was to combine with the old one
Returns
Type Description
bool

Extension Methods