Class PluginFeatureInfo

Represents basic info about a plugin feature and contains a reference to the instance of said feature

Inheritance
object
CorePropertyChanged
PluginFeatureInfo
Implements
Namespace: Artemis.Core
Assembly: Artemis.Core.dll
Syntax
[JsonObject(MemberSerialization.OptIn)]
public class PluginFeatureInfo : CorePropertyChanged, IPrerequisitesSubject

Properties

AlwaysEnabled

Marks the feature to always be enabled as long as the plugin is enabled and cannot be disabled.

Note: always true if this is the plugin's only feature

Declaration
[JsonProperty]
public bool AlwaysEnabled { get; }
Property Value
Type Description
bool

Description

A short description of the feature

Declaration
[JsonProperty]
public string? Description { get; set; }
Property Value
Type Description
string

EnabledInStorage

Gets a boolean indicating whether the feature is enabled in persistent storage

Declaration
public bool EnabledInStorage { get; }
Property Value
Type Description
bool

FeatureType

Gets the type of the feature

Declaration
public Type FeatureType { get; }
Property Value
Type Description
Type

Instance

Gets the feature this info is associated with

Note: null if the associated Plugin is disabled

Declaration
public PluginFeature? Instance { get; }
Property Value
Type Description
PluginFeature

LoadException

Gets the exception thrown while loading

Declaration
public Exception? LoadException { get; }
Property Value
Type Description
Exception

Name

The name of the feature

Declaration
[JsonProperty(Required = Required.Always)]
public string Name { get; }
Property Value
Type Description
string

PlatformPrerequisites

Gets a list of prerequisites of the current platform for this plugin

Declaration
public IEnumerable<PluginPrerequisite> PlatformPrerequisites { get; }
Property Value
Type Description
IEnumerable<PluginPrerequisite>

Plugin

Gets the plugin this feature info is associated with

Declaration
public Plugin Plugin { get; }
Property Value
Type Description
Plugin

Prerequisites

Gets a list of prerequisites for this plugin

Declaration
public List<PluginPrerequisite> Prerequisites { get; }
Property Value
Type Description
List<PluginPrerequisite>

Methods

ArePrerequisitesMet()

Determines whether the prerequisites of this plugin are met

Declaration
public bool ArePrerequisitesMet()
Returns
Type Description
bool

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
object.ToString()

Implements

IPrerequisitesSubject