Artemis logo
Search Results for

    Show / Hide Table of Contents

    Class ProfileModule<T>

    Allows you to add support for new games/applications while utilizing Artemis' profile engine and your own data model

    Inheritance
    System.Object
    CorePropertyChanged
    PluginFeature
    DataModelPluginFeature
    Module
    ProfileModule
    ProfileModule<T>
    Implements
    System.IDisposable
    Inherited Members
    ProfileModule.HiddenPropertiesList
    ProfileModule.HiddenProperties
    ProfileModule.ActiveProfile
    ProfileModule.IsProfileUpdatingDisabled
    ProfileModule.OpacityOverride
    ProfileModule.AnimatingProfileChange
    ProfileModule.ProfileUpdated(Double)
    ProfileModule.ProfileRendered(Double, SKCanvas, SKImageInfo)
    ProfileModule.ActiveProfileChanged
    ProfileModule.OnActiveProfileChanged()
    Module.DisplayName
    Module.DisplayIcon
    Module.IsActivated
    Module.IsActivatedOverride
    Module.UpdateDuringActivationOverride
    Module.ActivationRequirements
    Module.ActivationRequirementMode
    Module.DefaultPriorityCategory
    Module.PriorityCategory
    Module.Priority
    Module.ModuleTabs
    Module.IsUpdateAllowed
    Module.Update(Double)
    Module.Render(Double, SKCanvas, SKImageInfo)
    Module.ModuleActivated(Boolean)
    Module.ModuleDeactivated(Boolean)
    Module.EvaluateActivationRequirements()
    DataModelPluginFeature.AddTimedUpdate(TimeSpan, Action<Double>)
    DataModelPluginFeature.AddTimedUpdate(TimeSpan, Func<Double, Task>)
    PluginFeature.Info
    PluginFeature.Plugin
    PluginFeature.IsEnabled
    PluginFeature.LoadException
    PluginFeature.Id
    PluginFeature.Enable()
    PluginFeature.Disable()
    PluginFeature.Dispose(Boolean)
    PluginFeature.Dispose()
    PluginFeature.Enabled
    PluginFeature.Disabled
    PluginFeature.OnEnabled()
    PluginFeature.OnDisabled()
    CorePropertyChanged.PropertyChanged
    CorePropertyChanged.RequiresUpdate<T>(T, T)
    CorePropertyChanged.SetAndNotify<T>(T, T, String)
    CorePropertyChanged.OnPropertyChanged(String)
    Namespace: Artemis.Core.Modules
    Assembly: Artemis.Core.dll
    Syntax
    public abstract class ProfileModule<T> : ProfileModule, INotifyPropertyChanged, IDisposable where T : DataModel
    Type Parameters
    Name Description
    T

    Properties

    | Improve this Doc View Source

    DataModel

    The data model driving this module

    Note: This default data model is automatically registered upon plugin enable

    Declaration
    public T DataModel { get; }
    Property Value
    Type Description
    T
    | Improve this Doc View Source

    ExpandsDataModel

    Gets or sets whether this module must also expand the main data model

    Note: If expanding the main data model is all you want your plugin to do, create a BaseDataModelExpansion plugin instead.

    Declaration
    public bool ExpandsDataModel { get; set; }
    Property Value
    Type Description
    System.Boolean

    Methods

    | Improve this Doc View Source

    GetDataModelDescription()

    Override to provide your own data model description. By default this returns a description matching your plugin name and description

    Declaration
    public virtual DataModelPropertyAttribute GetDataModelDescription()
    Returns
    Type Description
    DataModelPropertyAttribute
    | Improve this Doc View Source

    HideProperty<TProperty>(Expression<Func<T, TProperty>>)

    Hide the provided property using a lambda expression, e.g. HideProperty(dm => dm.TimeDataModel.CurrentTimeUTC)

    Declaration
    public void HideProperty<TProperty>(Expression<Func<T, TProperty>> propertyLambda)
    Parameters
    Type Name Description
    System.Linq.Expressions.Expression<System.Func<T, TProperty>> propertyLambda

    A lambda expression pointing to the property to ignore

    Type Parameters
    Name Description
    TProperty
    | Improve this Doc View Source

    ShowProperty<TProperty>(Expression<Func<T, TProperty>>)

    Stop hiding the provided property using a lambda expression, e.g. ShowProperty(dm => dm.TimeDataModel.CurrentTimeUTC)

    Declaration
    public void ShowProperty<TProperty>(Expression<Func<T, TProperty>> propertyLambda)
    Parameters
    Type Name Description
    System.Linq.Expressions.Expression<System.Func<T, TProperty>> propertyLambda

    A lambda expression pointing to the property to stop ignoring

    Type Parameters
    Name Description
    TProperty

    Implements

    System.IDisposable
    • Improve this Doc
    • View Source
    In This Article
    Back to top Generated by DocFX