Class GameModdingFramework

Namespace

Root

Assembly

SPZGameAssembly.dll

public class GameModdingFramework : IModdingFramework, IModdingFrameworkEnvironment

Inheritance

object

GameModdingFramework

Implements

IModdingFramework

IModdingFrameworkEnvironment

Extension Methods

EnumerableExtensions.AsArray<T>(T)

EnumerableExtensions.AsEnumerable<T>(T)

ConnectorExtenderChain.ComputeConnectors<TDescriptor, TCoordinate, TConnector, TMapLayout>(TDescriptor, IReadOnlyList<IEntityPlacementConnectors<TDescriptor, TCoordinate, TConnector>>, TMapLayout, IList<TConnector>)

ConnectorExtenderChain.ExtendedConnectorsOfType<TDescriptor, TCoordinate, TEntityConnector, TConnectorType, TMapLayout>(TDescriptor, IReadOnlyList<IEntityPlacementConnectors<TDescriptor, TCoordinate, TEntityConnector>>, TMapLayout, IList<TEntityConnector>)

ReferenceIdentifier.GetRefId<T>(T)

VectorExtensions.DecomposeManhattanPath<TVector, TAxis, TDirection>(TVector, IDiscreteSpace<TVector, TDirection, TAxis>, ICollection<TVector>)

ObjectExtensions.DeepCopy<T>(T)

ReflectionSetHelper.Set<TObject, TField>(TObject, Expression<Func<TObject, TField>>, TField)

ObjectExtensions.DeepCopy(object)

Constructors

GameModdingFramework(ModdingContext, IModDiscoverer, IModIdSerializationResolver, IEnumerable<IPostModResolveExecutor>)

public GameModdingFramework(ModdingContext context, IModDiscoverer modDiscoverer, IModIdSerializationResolver idSerializationResolver, IEnumerable<IPostModResolveExecutor> postModResolveExecutors)

Parameters

context ModdingContext

modDiscoverer IModDiscoverer

idSerializationResolver IModIdSerializationResolver

postModResolveExecutors IEnumerable<IPostModResolveExecutor>

Properties

Context

public ModdingContext Context { get; }

Property Value

ModdingContext

IdSerializationResolver

public IModIdSerializationResolver IdSerializationResolver { get; }

Property Value

IModIdSerializationResolver

ModDiscoverer

public IModDiscoverer ModDiscoverer { get; }

Property Value

IModDiscoverer

ModsHaveBeenLoadedDuringThisSession

public static ModInvolvementTypeId ModsHaveBeenLoadedDuringThisSession { get; }

Property Value

ModInvolvementTypeId

ModsPresentInBlueprint

public static ModInvolvementTypeId ModsPresentInBlueprint { get; }

Property Value

ModInvolvementTypeId

ModsPresentInSaveGame

public static ModInvolvementTypeId ModsPresentInSaveGame { get; }

Property Value

ModInvolvementTypeId

OnModsInvolvementStart

public IEvent OnModsInvolvementStart { get; }

Property Value

IEvent

OnModsInvolvementStop

public IEvent OnModsInvolvementStop { get; }

Property Value

IEvent

Methods

DeleteAllModsAvailableToLoad()

public void DeleteAllModsAvailableToLoad()

DisallowMods()

public void DisallowMods()

Dispose()

public void Dispose()

LoadMods()

public IAsyncEnumerable<ModLoadingSubstep> LoadMods()

Returns

IAsyncEnumerable<ModLoadingSubstep>

MarkModsAsInvolved(ModInvolvementTypeId)

public void MarkModsAsInvolved(ModInvolvementTypeId modInvolvementTypeId)

Parameters

modInvolvementTypeId ModInvolvementTypeId

MarkModsAsNotInvolved(ModInvolvementTypeId)

public void MarkModsAsNotInvolved(ModInvolvementTypeId involvementType)

Parameters

involvementType ModInvolvementTypeId

PotentialModsAvailableToLoad()

public Task<int> PotentialModsAvailableToLoad()

Returns

Task<int>

UnloadMods()

public void UnloadMods()