docs.unity.cn
    Show / Hide Table of Contents

    Class UpgradeModule

    UpgradeModule is implemented per version to handle upgrading for that version.

    Inheritance
    Object
    UpgradeModule
    SerializedEdgeUpgrade
    SerializedNodeUpgrade
    SerializedParameterUpgrade
    Namespace: Mechatronics.SystemGraph
    Syntax
    public class UpgradeModule

    Fields

    ImplicitUpgradesHappened

    The implicit upgrades happened

    Declaration
    public static bool ImplicitUpgradesHappened
    Field Value
    Type Description
    Boolean

    Methods

    GetPatch(Int32)

    Gets the patch by version.

    Declaration
    protected virtual UpgradeModule.Patch GetPatch(int version)
    Parameters
    Type Name Description
    Int32 version

    The version.

    Returns
    Type Description
    UpgradeModule.Patch

    Patch.

    Upgrade(SystemGraphData, VersionedStruct)

    Upgrades the specified graph data.

    Declaration
    public virtual bool Upgrade(SystemGraphData ctx, VersionedStruct upgradedStruct)
    Parameters
    Type Name Description
    SystemGraphData ctx

    The graph data to upgrade.

    VersionedStruct upgradedStruct

    The upgraded structure.

    Returns
    Type Description
    Boolean

    true if upgrade happened, false otherwise.

    Back to top Copyright © 2022 Unity Technologies
    Generated by DocFX
    on Tuesday, October 18, 2022
    Terms of use